GET/v1/usageFreeYour plan, the credits used and left this period, when they reset, and your rate limit. Free to call.
Send your key in the Authorization header as a Bearer token. Keys start with cd_live_ (or cd_test_ for test keys, which return sample data and use no credits). Keep keys on your server, never in front-end code. More on keys
planstring | Your plan: free, starter, pro or business. |
|---|---|
creditsobject | This period’s credits, shared by all your keys. |
credits.integer | Credits a period on your plan. |
Test keys (cd_test_…) return sample data for any domain and use no credits. Make one in your account, then run the call above.
credits.integer | Used so far. |
|---|
credits.integer | Left until the period ends. |
|---|
period_ends_atstring · date-time | When the credits reset (UTC). |
|---|
rate_limitobject | Your plan’s rate limit. |
|---|
rate_limit.integer | Requests a second, per key. |
|---|
test_keyboolean | Whether this call used a test key. |
|---|
Credits are counted by period. A period lasts a month; when it ends, the credits reset and a new one starts. period_ends_at says when.
Errors return JSON like {"error": {"code": "rate_limited", "message": "…"}} and use no credits. All about errors
| Status | Code | Meaning |
|---|---|---|
| 401 | invalid_key | The API key is missing, wrong or revoked. |
| 403 | account_blocked | API access is blocked on this account. Contact us. |
| 403 | ip_not_allowed | The key can’t be used from this IP address (its allowlist). |
| 429 | rate_limited | Too many requests this second. Wait for Retry-After seconds. |
| 500 | server_error | Our side failed. You weren’t charged; try again later. |
| 503 | api_unavailable | The API isn’t open. |
| 503 | maintenance | The API is down for maintenance. Try again shortly. |