Skip to main content
GET
Get Snapshots

Get Snapshots

Returns the market details along with its time-series snapshots, including price data and optional order book depth.

Request

Headers

string
required
Your API key. See Authentication.

Path parameters

string
required
The market slug, e.g. btc-updown-5m-1774975800

Query parameters

integer
default:"1000"
Number of snapshots to return (1-1000)
integer
default:"0"
Pagination offset
boolean
default:"false"
Include full order book data (bids and asks) in each snapshot. Set to false for lower latency.

Response

object
The market object (same as Get Market)
array
Array of snapshot objects, each containing:
  • time (string) — Snapshot timestamp (ISO 8601)
  • coin_price (number) — Coin price at snapshot time
  • price_up (number) — Price of the “Up” outcome (0-1)
  • price_down (number) — Price of the “Down” outcome (0-1)
  • orderbook_up (object, optional) — Order book for “Up” outcome
  • orderbook_down (object, optional) — Order book for “Down” outcome
integer
Total number of snapshots available

Examples

Get snapshots without order book (faster)

Get snapshots with full order book

Response

Response truncated — 10 snapshots are returned with limit=10. Each snapshot includes full order book data when include_orderbook=true.
Set include_orderbook=false (default) for significantly lower latency and smaller response sizes when you only need price data.