Description
Check the status and metadata of an API key. This endpoint is useful for verifying that your API key is valid and active, monitoring usage, and checking rate limits.Authentication
This endpoint requires:- The API key you want to check status for
Request Headers
Header | Type | Required | Description |
---|---|---|---|
X-API-Key | string | Yes | The API key to check |
Response Fields
Field | Type | Description |
---|---|---|
success | boolean | Whether the operation was successful |
status | string | Status of the key: active or inactive |
wallet_address | string | The wallet address associated with this key |
created_at | string | ISO 8601 timestamp of when the key was created |
last_used_at | string | ISO 8601 timestamp of last API call (null if never used) |
request_count | number | Total number of requests made with this key |
rate_limit | object | Current rate limit status |
Rate Limit Object
Field | Type | Description |
---|---|---|
limit | number | Maximum requests allowed in the window |
remaining | number | Requests remaining in current window |
reset_at | string | ISO 8601 timestamp when the rate limit resets |
Error Codes
Code | Description |
---|---|
INVALID_API_KEY | The provided key is invalid or has been revoked |
API_KEY_NOT_FOUND | No API key was provided |
UNAUTHORIZED | Authentication failed |
Use Cases
1. Health Check / Monitoring
2. Validate Key Before Trading
3. Rate Limit Management
4. Key Rotation Reminder
Rate Limiting
This endpoint itself has minimal rate limiting:- 60 requests per minute per API key
- Does not count against your trading rate limits
Notes
- This endpoint is useful for debugging authentication issues
- The
request_count
is a lifetime counter for the key - The
last_used_at
field helps identify inactive keys - Rate limit information is real-time and updates with each request
- Use this endpoint to implement smart rate limit management in your applications
Best Practices
- Check key validity before starting trading sessions
- Monitor rate limits to avoid hitting limits during critical trades
- Use the request count to track API usage
- Check key age and rotate periodically for security
- Validate keys after configuration changes