Skip to main content
Every REST request is a path plus query parameters. The path picks the venue family and symbol; the query narrows the window and shape of the result. The per-data-type pages list the exact parameters for each route; this page is the shared grammar across all of them.

​
Path: venue family and symbol

The symbol sits in the path, and its shape depends on the venue family: Keep the symbol shape intact. A HIP-3 prefix or a HIP-4 # is part of the identifier, not decoration.

​
Query: time windows

Most routes accept a start and end window. Snapshot-at-time routes use timestamp instead. The format is not uniform, so check the route:
  • Market-state routes (order books, trades, candles, funding, open interest, liquidations) take Unix milliseconds. start defaults to 24h ago, end to now.
  • Order routes (order history, order flow, take profits & stop losses) also take Unix milliseconds, e.g. 1767225600000. ISO 8601 strings are rejected.
When in doubt, the data-type page and the OpenAPI contract give the exact type per route.

​
Query: shape and size

Use start and end on /history and /diffs routes. Use timestamp only on snapshot routes such as /orderbook/{symbol} or /orderbook/{symbol}/l2.

​
Keep requests bounded

Start with one symbol, one route, and one short window before widening. A bounded request is cheaper, easier to retry, and easier to reason about than an open-ended pull. Size the window and limit to the question, then paginate rather than asking for everything at once. For the exact parameter table per data type, open the matching page under Market data; for the generated contract, use OpenAPI.
Last modified on July 13, 2026