Usage
Free account endpointGET /api/v1/usageUse this endpoint to check your credits, billing cycle state, request activity, and rate-limit state so you can monitor API usage confidently.
Try in PlaygroundStatus Codes
200Usage payload returned.
401Invalid, missing, or revoked API key.
429Rate limit exceeded.
- The `rate_limit.limit` field is the active per-minute bucket for the authenticated API key and current plan.
Node.js / Express
const response = await fetch('https://www.animaldetect.com/api/v1/usage', {
headers: {
Authorization: 'Bearer ' + process.env.ANIMAL_DETECT_API_KEY,
},
})
const data = await response.json()Example Response
JSON
{
"credits": {
"included_total": 10000,
"included_used": 3400,
"included_remaining": 6600,
"top_up_balance": 0,
"grace_limit": 500,
"grace_used": 0,
"grace_remaining": 0,
"total_available": 6600
},
"billing": {
"plan_code": "core",
"status": "active",
"billing_interval": "monthly",
"data_policy": "private",
"scheduled_plan_code": null,
"scheduled_billing_interval": null,
"scheduled_change_at": null,
"current_period_end": "2026-04-10T00:00:00.000Z",
"grace_expires_at": null
},
"requests": {
"today": 84,
"this_month": 1240
},
"rate_limit": {
"limit": 120,
"remaining": 96,
"reset_at": "2026-02-10T11:04:00.000Z"
},
"user_id": "2b01e3ce-a8be-4ea8-9cd8-0c47859c6c87"
}