Account · Account and platform

Endpoint catalog

The endpoint catalog.

GET/v1/catalogplatformCatalog

On this page

Example request
Parameters
Response

Every route with its parameters, dataset, pagination and streaming support.

Example request

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

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

1 parameter, none required.

Parameter	Type and limits	Description
`family`queryoptional	stringoptionsfuturesindicesstocksmarketaccount	Only routes of this family.

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

dataarray<object>required24 fields inside
- datasetstringrequiredDataset release needed.optionsfuturesequitiesindicesnone
- descriptionstringDetails.
- familystringrequiredRoute family.
- history_paramsarray<string>Parameters bounded by the plan history window.
- idstringrequiredStable identifier.
- mcpbooleanrequiredExposed as an MCP tool.
- methodstringrequiredHTTP method.GET
- overnightbooleanrequiredAccepts the overnight session.
- paginatedbooleanrequiredSupports limit and cursor_id.
- paramsarray<object>requiredQuery parameters.10 fields inside
  - defaultanyDefault when absent.
  - descriptionstringrequiredWhat the parameter does.
  - enumarray<string>Allowed values.
  - itemstringList item type.
  - maxnumberMaximum.
  - max_itemsintegerList bound.
  - minnumberMinimum.
  - namestringrequiredParameter.
  - requiredbooleanrequiredMust be supplied.
  - typestringrequiredstring, int, number, decimal, bool, ms, date, enum or list.
- pathstringrequiredRoute path.
- publicbooleanrequiredNeeds no key.
- streamablebooleanrequiredAvailable as a streaming snapshot.
- summarystringrequiredOne-line summary.
metaobjectrequiredMeta object