For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get market by address

GET /api/v1/markets/{market_address}

Get market by address

get

Returns full market details for a single market identified by its on-chain contract address, including outcomes, collateral info, status, volume, and proposer.

Path parameters
market_addressstringRequired

Market contract address

Query parameters
localestringOptional

BCP-47 locale (e.g. zh, id) for the sibling translation wrapper. Source fields (question, outcome name, ancillaryData) stay raw; translation:{title,ancillary[]} and outcome translation:{name} are populated when a matching locale exists. Wrapper is null otherwise.

Responses
200

OK

application/json

Full market representation.

addressstringOptional
ancillaryDatastring[]Optional

Ancillary metadata entries posted on-chain by the question creator, oldest-first. Each entry is a comma-separated "key:value" pair list with \,, \:, and \\ as escapes. Empty array for legacy markets. Always the raw on-chain form; translated human-readable bodies surface inside translation.ancillary (parallel array, same indexing).

availableLocalesstring[]Optional

Locales with an approved translation. Lets clients build a language switcher. Empty array when none. The internal pipeline status is intentionally not exposed.

backgroundImagestringOptional

Admin-set background image for the market's grid card (off-chain metadata only). Null when unset.

categoriesstring[]Optional
collateralAddressstringOptional
collateralDecimalsintegerOptional
collateralSymbolstringOptional
contractVersionintegerOptional

On-chain contract version that produced this market (1 = legacy, 2 = v2).

createdAtstringOptional
curvestringOptional
descriptionstringOptional

Deprecated: populated from on-chain metadata for legacy v1 markets. For v2 markets, use AncillaryData — the first entry carries the creator's metadata including a description key.

elapsedPctnumberOptional
endDatestringOptional
feeRatenumberOptional
finalisedAtstringOptional
imagestringOptional
isFlaggedbooleanOptional

True when the question currently has an active creator-issued flag whose expiry (if any) is in the future.

metadataDescriptionstringOptional

Admin-curated description from question_metadata (off-chain). Null when unset.

questionstringOptional
questionIdstringOptional
resolutionTimestringOptional
resolvedAnswerstringOptional
slugstringOptional
sourceLocalestringOptional

Source locale of the on-chain question/ancillaryData fields (defaults to "en").

startDatestringOptional
statusstringOptional
subcategoriesstring[]Optional
tagsstring[]Optional
topicsstring[]Optional
totalMarketCapnumberOptional
tradersintegerOptional
updatedAtstringOptional
volumenumberOptional
get/api/v1/markets/{market_address}

Last updated