API 文档API 端点
API令牌信息
获取Twitter API使用剩余量的API
API令牌信息
获取当前Twitter API令牌的使用情况,包括剩余请求配额和重置时间。
请求
URL: /api/twitter/token-info
方法: GET 或 POST
请求参数:
无特定参数要求,只需提供API密钥进行认证。
响应
成功响应会返回当前API令牌的使用情况,包括剩余请求数量、配额上限、重置时间等信息。
示例
请求示例
# GET 请求
curl --request GET \
--url 'https://www.aidir.fun/api/twitter/token-info' \
--header 'X-API-Key: <api-key>'
# POST 请求
curl --request POST \
--url 'https://www.aidir.fun/api/twitter/token-info' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>'响应示例
{
"data": {
"token_type": "bearer",
"app_limit": 1500,
"remaining": 1375,
"reset_at": "2023-04-15T15:00:00.000Z",
"account": {
"app_id": "12345",
"app_name": "My Twitter App",
"organization": "My Organization"
},
"request_history": [
{
"endpoint": "/user-profile",
"timestamp": "2023-04-15T14:34:12.000Z",
"status": "success"
},
{
"endpoint": "/user-tweets",
"timestamp": "2023-04-15T14:30:05.000Z",
"status": "success"
}
]
}
}错误响应
| 状态码 | 描述 |
|---|---|
| 401 | 认证失败,API密钥无效或缺失 |
| 500 | 服务器内部错误 |
使用场景
使用此API可以:
- 监控API使用情况:了解当前API使用情况,避免超出配额限制
- 优化请求策略:根据剩余配额数量调整请求频率
- 调试问题:在API请求失败时,检查是否因为达到速率限制
注意事项
- API配额通常基于滑动时间窗口计算,具体限制取决于您的Twitter API订阅等级
- 超出配额限制可能导致请求被临时封锁
- 此API不消耗Twitter API的请求配额,可以频繁调用以监控使用情况
MkSaaS文档