KAkalshi
market

Get Markets

Changed on

Filter by market status. Possible values: unopened, open, closed, settled. Leave empty to return markets with any status.

  • Only one status filter may be supplied at a time.
  • Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters.
Compatible Timestamp FiltersAdditional Status FiltersExtra Notes
min_created_ts, max_created_tsunopened, open, empty
min_close_ts, max_close_tsclosed, empty
min_settled_ts, max_settled_tssettled, empty
min_updated_ts, max_updated_tsemptyIncompatible with all filters besides mve_filter=exclude. May be combined with series_ticker, which requires mve_filter=exclude

Markets that settled before the historical cutoff are only available via GET /historical/markets. See Historical Data for details.

get/markets

Request

Query parameters

limitinteger

Number of results per page. Defaults to 100. Maximum value is 1000.

cursorstring

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

event_tickerstring

Event ticker to filter by. Only a single event ticker is supported.

series_tickerstring

Filter by series ticker

min_created_tsinteger

Filter items that created after this Unix timestamp

max_created_tsinteger

Filter items that created before this Unix timestamp

min_updated_tsinteger

Return markets with metadata updated later than this Unix timestamp (in seconds). Tracks non-trading changes only. May be combined with max_updated_ts and mve_filter=exclude. May also be combined with series_ticker, which requires mve_filter=exclude. Incompatible with other filters.

max_updated_tsinteger

Return markets with metadata updated at or before this Unix timestamp (in seconds). Tracks non-trading changes only. May be combined with min_updated_ts and mve_filter=exclude. May also be combined with series_ticker, which requires mve_filter=exclude. Incompatible with other filters.

max_close_tsinteger

Filter items that close before this Unix timestamp

min_close_tsinteger

Filter items that close after this Unix timestamp

min_settled_tsinteger

Filter items that settled after this Unix timestamp

max_settled_tsinteger

Filter items that settled before this Unix timestamp

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

Filter by market status. Leave empty to return markets with any status.

tickersstring

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

mve_filter'only' | 'exclude'

Filter by multivariate events (combos). 'only' returns only multivariate events, 'exclude' excludes multivariate events.

Response

Markets retrieved successfully

cursorstring required

Example response

{
  "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",
      "settlement_value_dollars": "0.5600",
      "settlement_floor_dollars": "0.5600",
      "mve_selected_legs": [
        {
          "yes_settlement_value_dollars": "0.5600"
        }
      ]
    }
  ]
}

Changes

  • e6691cdd1915Revision changes
    • info

      response property markets/items/no_sub_title deprecated

  • dde105932d49Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status