v3

OpenAPI 3.0.02026-07-31103181312.8 KB

events

Get Event Candlesticks

End-point for returning aggregated data across all markets corresponding to an event.

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

Path parameters

tickerstring required

The event ticker

series_tickerstring required

The series ticker

Query parameters

start_tsinteger required

Start timestamp for the range

end_tsinteger required

End timestamp for the range

period_interval1 | 60 | 1440 required

Specifies the length of each candlestick period, in minutes. Must be one minute, one hour, or one day.

Response

Event candlesticks retrieved successfully

market_tickersstring[] required

Array of market tickers in the event.

adjusted_end_tsinteger required

Adjusted end timestamp if the requested candlesticks would be larger than maxAggregateCandidates.

Example response

{
  "market_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"
      }
    ]
  ]
}