Skip to Content
SkewtapeDocs

List candles

GET
/v1/candles

Candles from the lake in (market_id, token_id, ts) order. With event_id, active members are read in (venue, market_id) order, each in that table order. With venue alone, the same key across the venue's markets. Exactly one selector: venue with market_id, event_id alone, or venue alone. from is inclusive and clamped to the plan's history; to is exclusive and must be after from. With venue alone, from and to are at most 7 days apart. Candles count each trade once (an order book match's maker legs, a market maker trade's one row) and arrive within an hour. event_id resolves an approved matched event the caller can see and reads its active members only; members outside the plan's candle venues are left out, and members whose venue's trades rights are not raw contribute no rows. A missing or hidden event_id is 404. Free and History include Polymarket daily candles (res=1d); other venues and resolutions need the builder plan.

Authorization

ApiKey
headerX-API-Key<token>

Data endpoints. Format st_live__ (ADR-0012).

Query Parameters

venue?string

Venue key. Required with market_id, or alone for a venue-wide range of at most 7 days. Must not be set with event_id.

market_id?string

One market. Requires venue. Must not be set with event_id or with venue alone.

event_id?string

Matched event id. Reads active members only, in (venue, market_id) order. Members outside the plan's candle venues are omitted. Must not be set with venue or market_id.

from*string

Inclusive start of the time range, UTC. Clamped to the plan's history.

Formatdate-time
to*string

Exclusive end of the time range, UTC. Must be after from. With venue alone, at most 7 days after from.

Formatdate-time
res*string

Candle bucket size.

Value in"1m""1h""1d"
limit?integer

Page size (ARCHITECTURE 9.4). Default 100, maximum 1,000. May change between pages; the cursor does not bind to limit.

Range1 <= value <= 1000
Default100
cursor?string

Opaque pagination cursor from a previous next_cursor. Bound to the operation and its query filters (not limit). Tampered, malformed, foreign-route or foreign-query cursors are 400 invalid_request with no detail.

Response Body

Candles page

application/json
  1. response
data*array<>
next_cursor*|

Opaque cursor for the next page, or null when there is no further page (ARCHITECTURE 9.4). Pass as the cursor query parameter.

Example Request
curl -X GET 'https://api.skewtape.com/v1/candles?from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&res=1m'
Example Response
{  "data": [    {      "close": 0.1,      "decimals": 0,      "high": 0.1,      "low": 0.1,      "market_id": "string",      "open": 0.1,      "res": "1m",      "schema_version": "string",      "token_id": "string",      "trades": 0,      "ts": "2019-08-24T14:15:22Z",      "venue": "string",      "volume": 0.1,      "volume_raw": 0    }  ],  "next_cursor": "string"}

Powered by Kalshi Research