Sign in

v3

OpenAPI 3.0.02026-07-31103181312.8 KB
market

Get Market Candlesticks

Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day). Candlesticks for markets that settled before the historical cutoff are only available via GET /historical/markets/{ticker}/candlesticks. See Historical Data for details.

get/series/{series_ticker}/markets/{ticker}/candlesticks

Path parameters

series_tickerstring required

Series ticker - the series that contains the target market

tickerstring required

Market ticker - unique identifier for the specific market

Query parameters

start_tsinteger required

Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.

end_tsinteger required

End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.

period_interval1 | 60 | 1440 required

Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).

include_latest_before_startboolean

If true, prepends the latest candlestick available before the start_ts. This synthetic candlestick is created by:

  1. Finding the most recent real candlestick before start_ts
  2. Projecting it forward to the first period boundary (calculated as the next period interval after start_ts)
  3. Setting all OHLC prices to null, and previous_price to the close price from the real candlestick

Response

Candlesticks retrieved successfully

tickerstring required

Unique identifier for the market.

Example response

{
  "candlesticks": [
    {
      "yes_bid": {
        "open_dollars": "0.5600",
        "low_dollars": "0.5600",
        "high_dollars": "0.5600",
        "close_dollars": "0.5600"
      },
      "yes_ask": {
        "open_dollars": "0.5600",
        "low_dollars": "0.5600",
        "high_dollars": "0.5600",
        "close_dollars": "0.5600"
      },
      "price": {
        "open_dollars": "0.5600",
        "low_dollars": "0.5600",
        "high_dollars": "0.5600",
        "close_dollars": "0.5600",
        "mean_dollars": "0.5600",
        "previous_dollars": "0.5600",
        "min_dollars": "0.5600",
        "max_dollars": "0.5600"
      },
      "volume_fp": "10.00",
      "open_interest_fp": "10.00"
    }
  ]
}