Get Market Details

{ "title": "<string>", "parameters": { "conditions": [ { "key": "<string>", "label": "<string>", "avatar_path": "<string>", "options": [ { "label": "<string>", "determination_formula": "<string>" } ] } ], "metadata": {} }, "currency": "<string>", "id": 123, "qid": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "market_processing_config": "MARKET_ASSET_ORDER_PROCESSING", "logo_path": "<string>", "description": "<string>", "expires_at": "2023-11-07T05:31:56Z", "market_category_id": 123, "regeneration_interval_value": 123, "regeneration_timezone": "<string>", "regeneration_schedule": { "regenerates_at_minute": 123, "regenerates_at_hour": 123, "regenerates_at_day": 123, "regenerates_at_month": 123, "active_days": [ "<string>" ] }, "ticker_symbol": "<string>", "tracking_identifier": "<string>", "dispute_window_length": "<string>", "display_group": "ALL", "locked_at": "2023-11-07T05:31:56Z", "is_active": true, "should_auto_determine_outcome": true, "should_auto_close": true, "should_auto_payout": true, "manual_market_order": 123, "resolution_delay": "<string>", "payout_tariff_id": 123, "slug": "<string>", "status": "<string>", "allows_trading": true, "total_buy_in": "0", "total_participants": 0, "market_total_share": "<string>", "participant_total_share": "<string>", "winning_prediction_key": "<string>", "winning_prediction_keys": [ "<string>" ], "mini_markets": [], "market_assets": [], "all_market_assets": [ { "id": 123, "qid": "<string>", "asset_identifier": "<string>", "market_id": 123, "current_price": 123, "yes_price": 123, "no_price": 123, "volume": 123, "status": "active", "title": "<string>", "options": null, "avatar_path": "<string>", "outcome": { "id": 123, "qid": "<string>", "winning_prediction_key": "<string>", "market_determined_at": "2023-11-07T05:31:56Z" } } ], "last_regenerated_at": "2023-11-07T05:31:56Z", "next_regeneration_at": "2023-11-07T05:31:56Z", "market_category": { "id": 123, "name": "<string>", "slug": "<string>", "description": "<string>", "icon": "<string>" }, "regeneration_history": [ { "generated_at": "2023-11-07T05:31:56Z", "id": 123, "all_market_assets": [ { "id": 123, "qid": "<string>", "asset_identifier": "<string>", "market_id": 123, "current_price": 123, "yes_price": 123, "no_price": 123, "volume": 123, "status": "active", "title": "<string>", "options": null, "avatar_path": "<string>", "outcome": { "id": 123, "qid": "<string>", "winning_prediction_key": "<string>", "market_determined_at": "2023-11-07T05:31:56Z" } } ] } ], "regenerated_title": "<string>", "active_regeneration_history": { "generated_at": "2023-11-07T05:31:56Z", "id": 123, "all_market_assets": [ { "id": 123, "qid": "<string>", "asset_identifier": "<string>", "market_id": 123, "current_price": 123, "yes_price": 123, "no_price": 123, "volume": 123, "status": "active", "title": "<string>", "options": null, "avatar_path": "<string>", "outcome": { "id": 123, "qid": "<string>", "winning_prediction_key": "<string>", "market_determined_at": "2023-11-07T05:31:56Z" } } ] }, "regeneration_count": 123, "open_to_dispute_at": "2023-11-07T05:31:56Z" }

Path Parameters

market_id

string

required

The ID, QID or slug of the market to get details for

Response

Successful Response

Full market detail object. Includes all fields from MarketCreateSchema plus computed fields (id, qid, slug, status, prices, participants, winning keys, mini markets, market assets, and regeneration history for SERIES markets).

title

string

required

Market title

parameters

MarketParams · object

required

Market conditions and metadata

Show child attributes

currency

string

required

Currency used for transactions in this market

market_type

enum<string>

required

Available options:

DEFAULT,

SERIES

integer

required

Unique identifier for the market

qid

string

required

Query identifier for the market

created_at

string<date-time>

required

Timestamp when the market was created

updated_at

string<date-time>

required

Timestamp when the market was last updated

market_processing_config

enum<string>

default:MARKET_ASSET_ORDER_PROCESSING

Configure how the market orders are going to be processed

Available options:

DEFAULT_ORDER_PROCESSING,

MARKET_ASSET_ORDER_PROCESSING

logo_path

string | null

URL of the market logo

description

string | null

Detailed description of the market

expires_at

string<date-time> | null

Expiration date of the market

market_category_id

integer | null

Market category ID

regeneration_interval_type

enum<string> | null

Regeneration interval

Available options:

HOUR,

DAY,

WEEK,

MONTH,

YEAR,

CUSTOM

regeneration_interval_value

integer | null

Inverval value

regeneration_timezone

string | null

IANA timezone name for custom schedules

regeneration_schedule

SimpleRegenerationSchedule · object

Custom regeneration schedule

SimpleRegenerationSchedule
RegenerationSchedule
MixedRegenerationSchedule

Show child attributes

ticker_symbol

string | null

Ticker symbol for the market

tracking_identifier

string | null

Tracking identifier (e.g. ticker symbol) for querying and analytics

regeneration_template_format

enum<string> | null

Regeneration template format

Available options:

DEFAULT,

ABOVE_AT_OR_BELOW_PERCENTAGE

dispute_window_length

string<duration> | null

Duration of the dispute window after resolution. When set, a resolved market transitions to OPEN_TO_DISPUTE for this duration before payout is triggered. Omit or set to null to skip the dispute window entirely.

display_group

enum<string>

default:ALL

Display group of the market

Available options:

TRENDING,

POPULAR,

DISCOVER,

NEW,

FEATURED,

RECENT,

TOP,

ALL

locked_at

string<date-time> | null

Time when the market gets locked

is_active

boolean

default:true

Whether the market is currently active

should_auto_determine_outcome

boolean | null

Whether to auto-determine the market outcome

should_auto_close

boolean | null

Whether to auto-close the market at expiry

should_auto_payout

boolean | null

Whether to auto-payout after settlement

auto_determination_api

enum<string> | null

API to use for automatic outcome determination

Available options:

INTERNAL_TICKER_DATABASE,

API_FOOTBALL,

API_CRYPTO,

API_STOCKS,

API_ETF,

API_CURRENCY,

API_INDEX,

API_COMMODITY,

API_BOND,

ORACLE

market_domain

enum<string> | null

Market domain (SPORTS, FINANCE, CRYPTO, GENERAL)

Available options:

SPORTS,

FINANCE,

CRYPTO,

GENERAL

manual_market_order

integer | null

Manual display order for this market

resolution_delay

string<duration> | null

How long to wait after market close before auto-resolution is attempted. NULL means resolve as soon as the market closes.

payout_tariff_id

integer | null

ID of the payout tariff to apply to this market

slug

string | null

Slug of the market

status

string | null

Current status of the market

allows_trading

boolean

default:true

Whether the market allows trading (based on status, active state, and expiration)

total_buy_in

string

default:0

Total amount of buy-in in the market

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

total_participants

integer

default:0

Total number of participants in the market

Total share of the market

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Total share of participants in the market

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

winning_prediction_key

string | null

The prediction key of the winning option for this market. Matches market_asset.options[n].key for the winning option. Populated after the market is resolved.

winning_prediction_keys

string[] | null

The prediction keys of all winning options (multi-outcome markets). Each value matches a market_asset.options[n].key. Populated after the market is resolved.

mini_markets

MiniMarketResponseSchema · object[] | null

List of mini markets under this market

Show child attributes

market_assets

MarketAssetSchema · object[] | null

List of market assets under this market

Show child attributes

all_market_assets

MarketAssetSchema · object[] | null

All market assets including closed ones (used for settled markets)

Show child attributes

last_regenerated_at

string<date-time> | null

Timestamp when the market was last regenerated

next_regeneration_at

string<date-time> | null

Timestamp when the market will be regenerated next

market_category

MarketCategorySchema · object

Category of the market

Show child attributes

regeneration_history

SeriesMarketRegenerationHistory · object[] | null

List of market regeneration cycles

Show child attributes

regenerated_title

string | null

Regenerated title only available for series markets

active_regeneration_history

SeriesMarketRegenerationHistory · object

Active market regeneration cycle

Show child attributes

regeneration_count

integer | null

Total number of regeneration cycles

open_to_dispute_at

string<date-time> | null

Timestamp when the dispute window opened (OPEN_TO_DISPUTE state entry time)

Overview

Markets

Orders

Account

Referrals

Path Parameters

Response

Overview

Markets

Orders

Account

Referrals

Documentation Index

Path Parameters

Response