v3

OpenAPI 3.0.02026-07-31103181312.8 KB

events

Get Events

Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint. All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.

get/events

Query parameters

limitinteger

Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200.

cursorstring

Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.

with_nested_marketsboolean

Parameter to specify if nested markets should be included in the response. When true, each event will include a 'markets' field containing a list of Market objects associated with that event. Historical markets settled before the historical cutoff will not be included.

with_milestonesboolean

If true, includes related milestones as a field alongside events.

status'unopened' | 'open' | 'closed' | 'settled'

Filter by event status. Possible values are 'unopened', 'open', 'closed', 'settled'. Leave empty to return events with any status.

series_tickerstring

Filter by series ticker

tickersstring

Filter by specific event tickers. Comma-separated list of event tickers to retrieve.

min_close_tsinteger

Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).

min_updated_tsinteger

Filter events with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes.

Response

Events retrieved successfully

cursorstring required

Pagination cursor for the next page. Empty if there are no more results.

Example response

{
  "events": [
    {
      "markets": [
        {
          "yes_bid_dollars": "0.5600",
          "yes_bid_size_fp": "10.00",
          "yes_ask_dollars": "0.5600",
          "yes_ask_size_fp": "10.00",
          "no_bid_dollars": "0.5600",
          "no_ask_dollars": "0.5600",
          "last_price_dollars": "0.5600",
          "volume_fp": "10.00",
          "volume_24h_fp": "10.00",
          "open_interest_fp": "10.00",
          "notional_value_dollars": "0.5600",
          "previous_yes_bid_dollars": "0.5600",
          "previous_yes_ask_dollars": "0.5600",
          "previous_price_dollars": "0.5600",
          "liquidity_dollars": "0.5600",
          "settlement_value_dollars": "0.5600",
          "mve_selected_legs": [
            {
              "yes_settlement_value_dollars": "0.5600"
            }
          ]
        }
      ]
    }
  ],
  "milestones": [
    {
      "category": "Sports",
      "type": "football_game"
    }
  ]
}