Account APIs
Usage
A single synchronous endpoint to view all your API usage across enrichment and search requests: credits consumed, monthly allocation, remaining balance, and detailed per-API breakdowns. Defaults to the current month; pass month and year to read an earlier period (future periods are rejected with invalid_date). Usage checks are free - they never consume credits.
Manual credentials take precedence over your account key.
Overview
Monitor credit consumption, allocation, and per-API breakdown (synchronous, 200).
Parameters
month integer optional
Month to get statistics for (1-12). Defaults to the current month.
year integer optional
Year to get statistics for (2020-2030). Defaults to the current year.
Credit usage
Credits are charged based on the matched configuration. The listed cost is the per-result unit price.
| Feature | Credits | Notes |
|---|---|---|
| Usage | 0 | Monitoring endpoint - usage checks are free |
Heads up
A positive credit balance is required before each request. Empty results do not burn credits.
Responses
200 Usage statistics retrieved
400 invalid_month / invalid_year / invalid_date (future months are rejected)
401 missing_api_key / invalid_api_key / missing_api_secret / invalid_api_secret
403 api_key_disabled
429 rate_limit_exceeded
500 internal_error
A successful response wraps the payload in the { success, data, timestamp } envelope (also shown live in the panel on the right):
{
"success": true,
"data": {
"month": 12,
"year": 2024,
"period": "2024-12",
"credits_used": {
"total": 68,
"search": 45,
"enrichment": 23
},
"requests_count": {
"total": 25,
"search": 15,
"enrichment": 10
},
"limits": {
"monthly_allocation": 10000,
"available_credits": 9932,
"is_unlimited": false
},
"breakdown": {
"search_results_returned": 45,
"enrichments_performed": 23,
"total_credits_consumed": 68
}
},
"timestamp": "2026-01-01T00:00:00"
}