GET /rate-limit
Get the current token's rate budget
Report the rate limits that apply to the calling account, per request
category (read, write, export, analytics): the per-minute ceiling,
how many requests remain in the current window, and when the window resets.
Use it to pace requests and avoid 429 responses.
These budgets are the ACCOUNT's, keyed by account rather than by token, and
are reported as observed by the presented token: every token on the account
shares one budget, so requests made with one token reduce the remaining
seen by another. This endpoint does not count against the categories it
reports. A limit of null means no ceiling currently applies to that
category.
Telling one 429 from another
A 429 from an endpoint throttled by these limits can carry an
X-RateLimit-Scope header naming the kind of limit that rejected it:
account— a per-account limit bound the request. That is usually one of the budgets reported here, but some endpoints carry additional per-account limits this endpoint does not report, so you can receiveaccountwhile every budget below still shows headroom.ip— a per-IP limit bound the request. HonourRetry-After. None of the budgets below is what rejected you, but a request rejected this way can still count against them, so expectremainingto have moved even though the call did not succeed.
A 429 without the header states no scope at all. Read that as "not
* stated" — not as either value, and not as a claim about which limit was
reached. Honour Retry-After and retry after the stated delay.
Responses
- 200
- 401