Skip to main content
GET /usage answers two questions: which plan your request is actually running on, and, for a Dev, Pro or Enterprise key on api-pro.dexpaprika.com, how many credits the account has used and has left in the current billing period. With a paid key:
It is never served from cache, so it reflects the key and host of the call you just made. That makes it the quickest way to confirm a new key is set up right.

Which plan you need

/usage answers on every plan, but only a paid key on the paid host gets the credit figures. Without a key:
On a free key, console.dexpaprika.com shows your usage against the allowance. Allowances for every plan are on pricing.

The fields

Responses that are not served from cache carry the same value in the x-api-plan header.

Warn before you run out, in Python

This script prints the plan and, where the figures are available, how much of the period’s credits are gone, and exits with an error above a threshold. Run it from cron or a CI job. One request:
Without a key:
With a Pro key:

Things to know

No numbers? Check the host. If /usage returns only a plan while you expected credit figures, make sure the call goes to api-pro.dexpaprika.com, where paid keys belong. Upgrading to Pro has the full mapping. Treat the figures as a gauge. Two calls a second apart can return slightly different requests_used, and the number can briefly step back. Compare readings minutes apart, not consecutive calls. Watch the trend, not only the total. A share of credits used means more next to the share of the period gone. Half the credits used halfway through the period is on pace; half used in the first week is not. Plan your credit usage shows what common workloads cost. What happens at zero depends on the plan. Free tiers stop with 402. On Dev and Pro, autoscaling in the console decides whether you stop or keep going at the overage rate; see the console.

Where to go next