v1

latestOpenAPI 3.1.12026-07-23195454.2 KB

get-market-by-address

Get market by address

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

get/api/v1/markets/{market_address}

Path parameters

market_addressstring required

Market contract address

Query parameters

localestring

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.

Response

addressstring

ancillaryDatastring[]

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[]

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

backgroundImagestring

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

categoriesstring[]

collateralAddressstring

collateralDecimalsinteger

collateralSymbolstring

contractVersioninteger

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

createdAtstring

curvestring

descriptionstring

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.

elapsedPctnumber

endDatestring

feeRatenumber

finalisedAtstring

imagestring

isFlaggedboolean

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

questionstring

questionIdstring

resolutionTimestring

resolvedAnswerstring

slugstring

sourceLocalestring

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

startDatestring

statusstring

subcategoriesstring[]

tagsstring[]

topicsstring[]

totalMarketCapnumber

tradersinteger

updatedAtstring

volumenumber