Methods
| Method | Endpoint | Description |
|---|---|---|
list(params?) | GET /v1/markets | List markets with filtering |
retrieve(id) | GET /v1/market/id/{id} | Get market by ID |
retrieveBySlug(slug) | GET /v1/market/slug/{slug} | Get market by slug |
book(slug) | GET /v1/markets/{slug}/book | Get full order book |
bbo(slug) | GET /v1/markets/{slug}/bbo | Get best bid/offer |
settlement(slug) | GET /v1/markets/{slug}/settlement | Get settlement price |
list
Fetch a paginated list of markets with optional filters.Parameters
| Parameter | Type | Description |
|---|---|---|
limit | number | Maximum results to return |
offset | number | Pagination offset |
active | boolean | Filter by active trading status |
closed | boolean | Filter by closed status |
archived | boolean | Filter by archived status |
categories | string[] | Filter by category slugs |
sportsMarketTypes | string[] | Filter by sports market type (MONEYLINE, SPREAD, TOTAL, PROP) |
volumeNumMin | number | Minimum trading volume |
liquidityNumMin | number | Minimum liquidity |
Response Fields
| Field | Type | Description |
|---|---|---|
id | number | Unique market identifier |
slug | string | URL-friendly identifier |
question | string | Market question |
description | string | Detailed description |
active | boolean | Whether market accepts orders |
lastTradePrice | number | Most recent trade price |
bestBid | number | Best bid price |
bestAsk | number | Best ask price |
volume | string | Total trading volume |
liquidity | string | Current liquidity |
retrieveBySlug
Get a single market by its URL slug.book
Get the full order book with all bid and offer levels.Response Fields
| Field | Type | Description |
|---|---|---|
marketSlug | string | Market identifier |
bids | array | Buy orders (highest price first) |
offers | array | Sell orders (lowest price first) |
state | string | Market state (OPEN, SUSPENDED, etc.) |
stats | object | Market statistics |
bbo
Get best bid/offer only. Use this lightweight endpoint when you only need top-of-book prices.Response Fields
| Field | Type | Description |
|---|---|---|
bestBid | Amount | Best (highest) bid price |
bestAsk | Amount | Best (lowest) ask price |
lastTradePx | Amount | Last trade price |
bidDepth | number | Number of bid levels |
askDepth | number | Number of ask levels |
openInterest | string | Current open interest |
settlement
Get the settlement price for a resolved market.0.00 (No) or 1.00 (Yes).