Account · Account and platform

Account and plan

Your plan, entitlements and rate limits.

GET/v1/accountaccountInfo

On this page

Example request
Parameters
Response

Reports the plan of the calling key, the dataset releases and history window it may read, and the account-wide rate limits.

Example request

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

const res = await fetch("https://api.ordermap.si/v1/account", {
  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

dataobjectrequiredPlan and entitlements.10 fields inside
- entitlementsobjectrequiredWhat the plan allows.4 fields inside
  - datasetsarray<string>requiredDataset releases enabled for API keys.optionsfuturesequitiesindices
  - history_daysintegerrequiredDays of history the plan may query.
  - overnightbooleanrequiredOvernight (gth) session data is included.
  - streamingbooleanrequiredWebSocket streams are included.
- key_prefixstringrequiredPublic prefix of the calling key.
- planstringrequiredAPI plan.api_developerapi_pro
- rate_limitobjectrequiredAccount-wide limits shared by all keys.2 fields inside
  - burst_per_secondintegerrequiredRequests per rolling second.
  - per_minuteintegerrequiredRequests per rolling minute.
metaobjectrequiredMeta object