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

Markets V2

List markets v2 with pagination and sorting

get
Query parameters
orderBystring · enumOptionalDefault: volumeTotalCreditsPossible values:
orderDirectionstring · enumOptionalDefault: descPossible values:
filterQuerystring · min: 2 · max: 100Optional
limitinteger · min: 1 · max: 100OptionalDefault: 50
cursorinteger · max: 9007199254740991Optional
Responses
200

Successful response

application/json
nextCursornumber · nullableRequired
get/markets-v2

List markets v2 a user currently holds, ranked by position value desc

get
Query parameters
holderUserkeystringRequired
limitinteger · min: 1 · max: 100OptionalDefault: 50
cursorinteger · max: 9007199254740991Optional
Responses
200

Successful response

application/json
nextCursornumber · nullableRequired
get/markets-v2/holdings

Get the markets v2 market whose subject is the given user, or null

get
Query parameters
userkeystringRequired
Responses
200

Successful response

application/json
idnumberRequired
marketOnchainIdnumberRequired
userkeystring · nullableRequired
creatorAddressstringRequired

Ethereum address (0x-prefixed, 20 bytes)

trustPriceinteger · int64Required
distrustPriceinteger · int64Required
trustSupplyinteger · int64Required
distrustSupplyinteger · int64Required
poolBackinginteger · int64Required
volumeTotalCreditsinteger · int64Required
volume24hCreditsinteger · int64Required
priceChange24hPercentnumberRequired
createdAtstringRequired
get/markets-v2/for-subject

Get globally-recent trades across all markets v2

get
Query parameters
limitinteger · min: 1 · max: 50OptionalDefault: 20
Responses
200

Successful response

application/json
get/markets-v2/recent-trades

Cursor-paginated trades across all markets v2, with optional score/size filters

get
Query parameters
minScoreinteger · max: 2800Optional
minPaymentAmountstringOptional
limitinteger · min: 1 · max: 100OptionalDefault: 50
cursorinteger · max: 9007199254740991Optional
Responses
200

Successful response

application/json
nextCursornumber · nullableRequired
get/markets-v2/all-trade-history

Rank traders by realized or unrealized PNL over a rolling window or all-time

get
Query parameters
directionstring · enumRequiredPossible values:
limitinteger · min: 1 · max: 20OptionalDefault: 10
metricstring · enumOptionalDefault: realizedPossible values:
windowstring · enumOptionalDefault: 1dPossible values:
Responses
200

Successful response

application/json
metricstring · enumRequiredPossible values:
get/markets-v2/pnl-leaderboard

Aggregate markets v2 portfolio value and unrealized PNL for a user

get
Query parameters
holderUserkeystringRequired
Responses
200

Successful response

application/json
portfolioValueinteger · int64Required
unrealizedPnlinteger · int64Required
get/markets-v2/portfolio-stats

Get a single market v2 by on-chain ID

get
Path parameters
marketOnchainIdinteger · max: 9007199254740991Required
Responses
200

Successful response

application/json
idnumberRequired
marketOnchainIdnumberRequired
userkeystring · nullableRequired
creatorAddressstringRequired

Ethereum address (0x-prefixed, 20 bytes)

trustPriceinteger · int64Required
distrustPriceinteger · int64Required
trustSupplyinteger · int64Required
distrustSupplyinteger · int64Required
poolBackinginteger · int64Required
volumeTotalCreditsinteger · int64Required
volume24hCreditsinteger · int64Required
priceChange24hPercentnumberRequired
createdAtstringRequired
pricingContractstringRequired

Ethereum address (0x-prefixed, 20 bytes)

trustTokenstringRequired

Ethereum address (0x-prefixed, 20 bytes)

distrustTokenstringRequired

Ethereum address (0x-prefixed, 20 bytes)

get/markets-v2/{marketOnchainId}

Get trade history for a market v2

get
Path parameters
marketOnchainIdinteger · max: 9007199254740991Required
Query parameters
traderAddressstringOptional

Ethereum address (0x-prefixed, 20 bytes)

limitinteger · min: 1 · max: 100OptionalDefault: 50
cursorinteger · max: 9007199254740991Optional
Responses
200

Successful response

application/json
nextCursornumber · nullableRequired
get/markets-v2/{marketOnchainId}/trade-history

Get continuous per-side price candlestick history for a market v2

get
Path parameters
marketOnchainIdinteger · max: 9007199254740991Required
Query parameters
durationstring · enumOptionalDefault: 1dPossible values:
sidestring · enumOptionalDefault: trustPossible values:
Responses
200

Successful response

application/json
durationstring · enumRequiredPossible values:
metricconst: priceRequired
sidestring · enumRequiredPossible values:
get/markets-v2/{marketOnchainId}/price-history

Get recent news posted by a market’s subject

get
Path parameters
marketOnchainIdinteger · max: 9007199254740991Required
Responses
200

Successful response

application/json
get/markets-v2/{marketOnchainId}/recent-news

List holders of a market v2, sorted by balance desc

get
Path parameters
marketOnchainIdinteger · max: 9007199254740991Required
Query parameters
sidestring · enumOptionalPossible values:
limitinteger · min: 1 · max: 100OptionalDefault: 50
cursorinteger · max: 9007199254740991Optional
Responses
200

Successful response

application/json
nextCursornumber · nullableRequired
get/markets-v2/{marketOnchainId}/holders

Count open holder positions in a market v2

get
Path parameters
marketOnchainIdinteger · max: 9007199254740991Required
Responses
200

Successful response

application/json
countinteger · max: 9007199254740991Required
get/markets-v2/{marketOnchainId}/holder-count

Get a user’s position in a market

get
Path parameters
marketOnchainIdinteger · max: 9007199254740991Required
Query parameters
isPositivebooleanRequired
userAddressstringRequired

Ethereum address (0x-prefixed, 20 bytes)

Responses
200

Successful response

application/json
balanceinteger · int64Required
get/markets-v2/{marketOnchainId}/position

Get a user’s open positions in a market, valued at the sell quote

get
Path parameters
marketOnchainIdinteger · max: 9007199254740991Required
Query parameters
holderUserkeystringRequired
Responses
200

Successful response

application/json
get/markets-v2/{marketOnchainId}/position-values

Simulate opening a position on a market v2

get
Path parameters
marketOnchainIdinteger · max: 9007199254740991Required
Query parameters
isPositivebooleanRequired
paymentAmountinteger · int64Required
slippagePercentagenumber · max: 0.5OptionalDefault: 0.01
Responses
200

Successful response

application/json
tokensMintedinteger · int64Required
minTokensOutinteger · int64Required
protocolFeeinteger · int64Required
effectivePriceinteger · int64Required
priceImpactPctnumberRequired
get/markets-v2/{marketOnchainId}/simulate-open-position

Simulate closing a position on a market v2

get
Path parameters
marketOnchainIdinteger · max: 9007199254740991Required
Query parameters
isPositivebooleanRequired
positionTokenAmountinteger · int64Required
sellerAddressstringRequired

Ethereum address (0x-prefixed, 20 bytes)

slippagePercentagenumber · max: 0.5OptionalDefault: 0.01
Responses
200

Successful response

application/json
netCreditsOutinteger · int64Required
minCreditsOutinteger · int64Required
curveRevenueinteger · int64Required
exitFeeinteger · int64Required
effectivePriceinteger · int64Required
priceImpactPctnumberRequired
get/markets-v2/{marketOnchainId}/simulate-close-position

Last updated