Account · Account and platform

Account limits

Live state of your rate-limit windows.

GET/v1/account/limitsaccountLimits

On this page

Example request
Parameters
Response

The same values the X-RateLimit-* headers report, without spending extra budget beyond this request.

Example request

curl -sS "https://api.ordermap.si/v1/account/limits" \
  -H "Authorization: Bearer $ORDERMAP_API_KEY"

const res = await fetch("https://api.ordermap.si/v1/account/limits", {
  headers: { Authorization: `Bearer ${process.env.ORDERMAP_API_KEY}` },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data, meta } = await res.json();
console.log(data, meta.coverage);

Set ORDERMAP_API_KEY to your key. Replace the dates with a recent trading date.

Parameters

This endpoint takes no parameters.

Response

Status	Meaning	Body
`200`	Successful response.	Schema below
`400`	Invalid, unknown or repeated parameters, or an invalid cursor.	Error object
`401`	Missing or invalid API key.	Error object
`403`	The plan, dataset release or account state does not allow this request.	Error object
`429`	Rate limit, burst limit or cooldown; wait Retry-After seconds.Retry-After	Error object
`500`	Internal error.	Error object
`503`	Data temporarily unavailable; retry after Retry-After seconds.Retry-After	Error object
`504`	The request timed out.	Error object

Authenticated responses carry the X-RateLimit-* headers (see rate limits); 429 and 503 add Retry-After.

200 response body

dataobjectrequiredRate-limit windows.5 fields inside
- burst_limitintegerrequiredRequests allowed per rolling second.
- burst_remainingintegerrequiredRequests left in the one-second window.
- limitintegerrequiredRequests allowed per rolling minute.
- remainingintegerrequiredRequests left in the minute window.
- resetintegerunix-msrequiredWhen one more request is allowed in the minute window. Unix epoch milliseconds (UTC).
metaobjectrequiredMeta object