Market API

The Market API provides access to market information, pricing, and settlement data.

Endpoints

Method	Endpoint	Description
`GET`	`/v1/markets`	Get all markets with filtering
`GET`	`/v1/market/id/{id}`	Get market by ID
`GET`	`/v1/market/slug/{slug}`	Get market by slug
`GET`	`/v1/markets/sides/{marketSideId}`	Get market side by ID
`GET`	`/v1/markets/{marketId}/sides`	Get market sides by market ID
`GET`	`/v1/markets/{slug}/book`	Get full market order book and stats
`GET`	`/v1/markets/{slug}/bbo`	Get best bid/offer (lightweight)
`GET`	`/v1/markets/{slug}/settlement`	Get market settlement price

Key Market Fields

Field	Description
`id`	Unique market identifier
`slug`	URL-friendly identifier
`question`	Market question
`description`	Detailed market description
`category`	Market category
`subcategory`	Market subcategory
`active`	Whether market is accepting orders
`closed`	Whether market has closed
`archived`	Whether market is archived

Pricing Fields

Field	Description
`lastTradePrice`	Most recent trade price
`bestBid`	Best bid price
`bestAsk`	Best ask price
`spread`	Current bid-ask spread
`oneDayPriceChange`	24-hour price change
`oneWeekPriceChange`	7-day price change

Volume & Liquidity

Field	Description
`liquidity`	Current market liquidity
`liquidityNum`	Liquidity as number
`volume`	Total trading volume
`volumeNum`	Volume as number
`volume24hr`	24-hour volume
`volume1wk`	7-day volume
`volume1mo`	30-day volume

Sports Market Fields

Field	Type	Description
`sportsMarketTypeV2`	string (enum)	Type: MONEYLINE, SPREAD, TOTAL, or PROP
`gameId`	string	Sports provider game ID
`line`	number	Line value for spread/total markets

Filtering Markets

Query markets with various filters:

GET /v1/markets?active=true&categories=sports&limit=50

Pagination & Ordering

Parameter	Type	Description
`limit`	integer	Maximum number of markets to return per page. Default varies by endpoint. Example: `50`
`offset`	integer	Number of markets to skip for pagination. Use with `limit` to page through results. Example: `100` to skip the first 100
`orderBy`	string[]	Fields to sort results by. Supports multiple fields for multi-level sorting. Example: `["volumeNum", "createdAt"]`
`orderDirection`	string	Sort direction for the `orderBy` fields. Values: `asc` (ascending) or `desc` (descending). Default: `desc`

Status Filters

Parameter	Type	Description
`active`	boolean	Filter markets by active trading status. `true` returns only markets currently accepting orders, `false` returns inactive markets
`closed`	boolean	Filter markets by closed status. `true` returns only markets that have closed (resolved or expired), `false` returns open markets
`archived`	boolean	Filter markets by archived status. `true` returns only archived/hidden markets, `false` excludes archived markets from results

Category & Type Filters

Parameter	Type	Description
`categories`	string[]	Filter by market categories. Example: `["sports", "politics", "crypto"]`
`marketTypes`	string[]	Filter by market format types. Example: `["binary", "scalar"]`
`sportsMarketTypes`	enum[]	Filter by sports market type. Values: `SPORTS_MARKET_TYPE_MONEYLINE` (winner), `SPORTS_MARKET_TYPE_SPREAD` (point spread), `SPORTS_MARKET_TYPE_TOTAL` (over/under), `SPORTS_MARKET_TYPE_PROP` (player/game props)
`tagId`	integer	Filter markets associated with a specific tag ID. Returns markets that have this tag applied
`relatedTags`	boolean	When `true` and `tagId` is provided, also includes markets with tags related to the specified tag
`includeTag`	boolean	When `true`, includes full tag information in the response for each market
`cyom`	boolean	Filter “Create Your Own Market” submissions. `true` returns only user-submitted markets, `false` excludes them

ID Filters

Parameter	Type	Description
`id`	integer[]	Filter by specific market IDs. Returns only markets matching these numeric IDs. Example: `[123, 456, 789]`
`slug`	string[]	Filter by market URL slugs. Returns only markets matching these slug identifiers. Example: `["will-team-a-win", "super-bowl-winner"]`
`questionIds`	string[]	Filter by question IDs (UUIDs). Returns markets associated with these question identifiers
`gameId`	string	Filter by sports game ID from the data provider. Returns all markets associated with a specific sporting event

Volume & Liquidity Filters

Parameter	Type	Description
`volumeNumMin`	number	Minimum total trading volume in USD. Only returns markets with `volumeNum` >= this value. Example: `1000.00`
`volumeNumMax`	number	Maximum total trading volume in USD. Only returns markets with `volumeNum` <= this value. Example: `100000.00`
`liquidityNumMin`	number	Minimum available liquidity in USD. Only returns markets with `liquidityNum` >= this value. Example: `500.00`
`liquidityNumMax`	number	Maximum available liquidity in USD. Only returns markets with `liquidityNum` <= this value. Example: `50000.00`
`rewardsMinSize`	number	Minimum order size eligible for liquidity rewards. Filters to markets where reward-eligible orders must be at least this size

Date Filters

All date parameters accept ISO 8601 format strings (e.g., 2025-01-20T00:00:00Z).

Parameter	Type	Description
`startDateMin`	string (ISO 8601)	Filter markets with a start date on or after this timestamp. Example: `2025-01-01T00:00:00Z`
`startDateMax`	string (ISO 8601)	Filter markets with a start date on or before this timestamp. Example: `2025-12-31T23:59:59Z`
`endDateMin`	string (ISO 8601)	Filter markets with an end/expiration date on or after this timestamp
`endDateMax`	string (ISO 8601)	Filter markets with an end/expiration date on or before this timestamp

Market Sides

Each market has sides representing the possible outcomes. Query market sides:

GET /v1/markets/{marketId}/sides

Market Side Fields

Field	Description
`id`	Market side ID
`marketSideType`	Type (ERC1155 or INSTRUMENT)
`identifier`	Market side identifier
`description`	Side description
`long`	Whether this is the long side
`participantId`	Associated participant ID

Real-Time Market DataFor real-time price updates and order book data, use the WebSocket Markets Stream instead of polling the REST API.

Market Book (Full)

Get real-time order book data and market statistics for a specific market:

GET /v1/markets/{slug}/book

Path Parameters

Parameter	Type	Required	Description
`slug`	string	Yes	Market slug identifier

Response

{
  "marketData": {
    "marketSlug": "will-team-a-win",
    "bids": [
      { "px": { "value": "0.55", "currency": "USD" }, "qty": "1000" },
      { "px": { "value": "0.54", "currency": "USD" }, "qty": "500" }
    ],
    "offers": [
      { "px": { "value": "0.56", "currency": "USD" }, "qty": "750" },
      { "px": { "value": "0.57", "currency": "USD" }, "qty": "1200" }
    ],
    "state": "MARKET_STATE_OPEN",
    "stats": {
      "lastTradePx": { "value": "0.55", "currency": "USD" },
      "openPx": { "value": "0.50", "currency": "USD" },
      "highPx": { "value": "0.58", "currency": "USD" },
      "lowPx": { "value": "0.48", "currency": "USD" },
      "sharesTraded": "50000",
      "openInterest": "125000",
      "notionalTraded": { "value": "27500.00", "currency": "USD" }
    },
    "transactTime": "2025-01-20T12:30:45.123Z"
  }
}

Market Data Fields

Field	Type	Description
`marketSlug`	string	Market identifier
`bids`	array	Buy orders (highest price first)
`offers`	array	Sell orders (lowest price first)
`state`	string	Current market state
`stats`	object	Market statistics
`transactTime`	string	Timestamp of data

Book Entry

Field	Type	Description
`px`	Amount	Price level
`qty`	string	Quantity available at this price

Market States

State	Description
`MARKET_STATE_OPEN`	Market is open for trading
`MARKET_STATE_PREOPEN`	Market is in pre-open phase
`MARKET_STATE_SUSPENDED`	Trading temporarily suspended
`MARKET_STATE_HALTED`	Trading halted
`MARKET_STATE_EXPIRED`	Market has expired
`MARKET_STATE_TERMINATED`	Market terminated
`MARKET_STATE_MATCH_AND_CLOSE_AUCTION`	Market in closing auction

Market Stats

Field	Type	Description
`openPx`	Amount	Opening price
`closePx`	Amount	Closing price
`highPx`	Amount	High price
`lowPx`	Amount	Low price
`lastTradePx`	Amount	Last trade price
`indicativeOpenPx`	Amount	Indicative opening price (pre-open)
`settlementPx`	Amount	Settlement price
`sharesTraded`	string	Total shares traded
`notionalTraded`	Amount	Total notional value traded
`lastTradeQty`	string	Last trade quantity
`openInterest`	string	Current open interest
`currentPx`	Amount	Current market price

Market BBO (Lightweight)

Get best bid/offer and basic market statistics in a lightweight format. Use this endpoint when you only need top-of-book prices without the full order book depth.

GET /v1/markets/{slug}/bbo

Path Parameters

Parameter	Type	Required	Description
`slug`	string	Yes	Market slug identifier

Response

{
  "marketDataLite": {
    "marketSlug": "will-team-a-win",
    "currentPx": { "value": "0.55", "currency": "USD" },
    "lastTradePx": { "value": "0.55", "currency": "USD" },
    "bestBid": { "value": "0.54", "currency": "USD" },
    "bestAsk": { "value": "0.56", "currency": "USD" },
    "bidDepth": 5,
    "askDepth": 4,
    "sharesTraded": "50000",
    "openInterest": "125000",
    "settlementPx": { "value": "0.00", "currency": "USD" }
  }
}

Market Data Lite Fields

Field	Type	Description
`marketSlug`	string	Market identifier
`currentPx`	Amount	Current market price
`lastTradePx`	Amount	Price of the most recent trade
`bestBid`	Amount	Best (highest) bid price
`bestAsk`	Amount	Best (lowest) ask price
`bidDepth`	integer	Number of price levels on the bid side
`askDepth`	integer	Number of price levels on the ask side
`sharesTraded`	string	Total shares traded
`openInterest`	string	Current open interest
`settlementPx`	Amount	Settlement price (if resolved)

When to Use BBO vs Book

Endpoint	Use Case
`/v1/markets/{slug}/bbo`	Display current prices, check spreads, lightweight polling
`/v1/markets/{slug}/book`	View full order book depth, analyze liquidity at each level

Real-Time UpdatesFor continuous order book updates, use the WebSocket Markets Stream instead of polling these endpoints.

Settlement

After a market resolves, query the settlement price:

GET /v1/markets/will-x-happen/settlement

Response:

{
  "slug": "will-x-happen",
  "settlement": 1.00
}

Settlement values are typically 0.00 (No) or 1.00 (Yes).

Getting Started

Orders

Portfolio

Events

Market

Series

Sports

WebSocket

Sample Code

Market API Overview

Market API

Endpoints

Key Market Fields

Pricing Fields

Volume & Liquidity

Sports Market Fields

Filtering Markets

Status Filters

Category & Type Filters

ID Filters

Volume & Liquidity Filters

Date Filters

Market Sides

Market Side Fields

Market Book (Full)

Path Parameters

Response

Market Data Fields

Book Entry

Market States

Market Stats

Market BBO (Lightweight)

Path Parameters

Response

Market Data Lite Fields

When to Use BBO vs Book

Settlement

Getting Started

Orders

Portfolio

Events

Market

Series

Sports

WebSocket

Sample Code

​Market API

​Endpoints

​Key Market Fields

​Pricing Fields

​Volume & Liquidity

​Sports Market Fields

​Filtering Markets

​Pagination & Ordering

​Status Filters

​Category & Type Filters

​ID Filters

​Volume & Liquidity Filters

​Date Filters

​Market Sides

​Market Side Fields

​Market Book (Full)

​Path Parameters

​Response

​Market Data Fields

​Book Entry

​Market States

​Market Stats

​Market BBO (Lightweight)

​Path Parameters

​Response

​Market Data Lite Fields

​When to Use BBO vs Book

​Settlement

Market API

Endpoints

Key Market Fields

Pricing Fields

Volume & Liquidity

Sports Market Fields

Filtering Markets

Pagination & Ordering

Status Filters

Category & Type Filters

ID Filters

Volume & Liquidity Filters

Date Filters

Market Sides

Market Side Fields

Market Book (Full)

Path Parameters

Response

Market Data Fields

Book Entry

Market States

Market Stats

Market BBO (Lightweight)

Path Parameters

Response

Market Data Lite Fields

When to Use BBO vs Book

Settlement