v3

OpenAPI 3.0.02026-07-31103181312.8 KB
market

Batch Get Market Candlesticks

Endpoint for retrieving candlestick data for multiple markets.

  • Accepts up to 100 market tickers per request
  • Returns up to 10,000 candlesticks total across all markets
  • Returns candlesticks grouped by market_id
  • Optionally includes a synthetic initial candlestick for price continuity (see include_latest_before_start parameter)
get/markets/candlesticks

Query parameters

market_tickersstring required

Comma-separated list of market tickers (maximum 100)

start_tsinteger required

Start timestamp in Unix seconds

end_tsinteger required

End timestamp in Unix seconds

period_intervalinteger required

Candlestick period interval in minutes

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

Market candlesticks retrieved successfully

Example response

{
  "markets": [
    {
      "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"
        }
      ]
    }
  ]
}