Query parameters
seriesstringqueryoptionalSeries id, e.g. btc-up-down-5m
Response
200Up/down viewseriesstringCurrent series id
seriesListstring[]Switchable active series ids
serverTimeMsstringServer clock, as a millisecond string
windowMsstringLength of one round window, as a millisecond string (5 minutes = 300000)
roundsobjectpreviousobjectnullablePrevious round; null if none
marketIdstringEngine market id
eventIdstringParent event
questionstringMarket question
slugstringMarket slug
groupItemTitlestringnullableShort title within the group
outcomeALabelstringYES side display text
outcomeBLabelstringNO side display text
statusstringCatalog-side market status
resolutionstringnullableResolution
priceTickE6stringnullableTick size, as an E6 string
minOrderSizeE6stringnullableMinimum order size, as an E6 string
outcomeAPriceE6stringnullableLatest YES-side price, as an E6 string
outcomeBPriceE6stringnullableLatest NO-side price, as an E6 string
volume24hUsdE6stringnullable24h traded volume, as an E6 string
volumeUsdE6stringnullableLifetime traded volume, as an E6 string
liquidityUsdE6stringnullableBook liquidity, as an E6 string
endDateMsstringnullableCutoff as a millisecond string
hasBooksbooleanWhether a book exists
iconUrlstringnullableIcon URL
oneDayPriceChangestringnullable24h up/down display string
roundStartMsstringThis round's open as a millisecond string
roundEndMsstringThis round's close as a millisecond string
openPriceE8stringnullableOpen anchor price (Pyth e8 string) — the previous round's closePriceE8
closePriceE8stringnullableClose anchor price (Pyth e8 string)
anchorPendingbooleantrue = the anchor price is not sealed yet; show it as pending — never substitute 0 or the previous round value
currentobjectnullableCurrent round; null if none
marketIdstringEngine market id
eventIdstringParent event
questionstringMarket question
slugstringMarket slug
groupItemTitlestringnullableShort title within the group
outcomeALabelstringYES side display text
outcomeBLabelstringNO side display text
statusstringCatalog-side market status
resolutionstringnullableResolution
priceTickE6stringnullableTick size, as an E6 string
minOrderSizeE6stringnullableMinimum order size, as an E6 string
outcomeAPriceE6stringnullableLatest YES-side price, as an E6 string
outcomeBPriceE6stringnullableLatest NO-side price, as an E6 string
volume24hUsdE6stringnullable24h traded volume, as an E6 string
volumeUsdE6stringnullableLifetime traded volume, as an E6 string
liquidityUsdE6stringnullableBook liquidity, as an E6 string
endDateMsstringnullableCutoff as a millisecond string
hasBooksbooleanWhether a book exists
iconUrlstringnullableIcon URL
oneDayPriceChangestringnullable24h up/down display string
roundStartMsstringThis round's open as a millisecond string
roundEndMsstringThis round's close as a millisecond string
openPriceE8stringnullableOpen anchor price (Pyth e8 string) — the previous round's closePriceE8
closePriceE8stringnullableClose anchor price (Pyth e8 string)
anchorPendingbooleantrue = the anchor price is not sealed yet; show it as pending — never substitute 0 or the previous round value
nextobjectnullablePre-opened next round; null if none
marketIdstringEngine market id
eventIdstringParent event
questionstringMarket question
slugstringMarket slug
groupItemTitlestringnullableShort title within the group
outcomeALabelstringYES side display text
outcomeBLabelstringNO side display text
statusstringCatalog-side market status
resolutionstringnullableResolution
priceTickE6stringnullableTick size, as an E6 string
minOrderSizeE6stringnullableMinimum order size, as an E6 string
outcomeAPriceE6stringnullableLatest YES-side price, as an E6 string
outcomeBPriceE6stringnullableLatest NO-side price, as an E6 string
volume24hUsdE6stringnullable24h traded volume, as an E6 string
volumeUsdE6stringnullableLifetime traded volume, as an E6 string
liquidityUsdE6stringnullableBook liquidity, as an E6 string
endDateMsstringnullableCutoff as a millisecond string
hasBooksbooleanWhether a book exists
iconUrlstringnullableIcon URL
oneDayPriceChangestringnullable24h up/down display string
roundStartMsstringThis round's open as a millisecond string
roundEndMsstringThis round's close as a millisecond string
openPriceE8stringnullableOpen anchor price (Pyth e8 string) — the previous round's closePriceE8
closePriceE8stringnullableClose anchor price (Pyth e8 string)
anchorPendingbooleantrue = the anchor price is not sealed yet; show it as pending — never substitute 0 or the previous round value
historyobject(PxUpdownRound)[]Historical rounds (excluding current/next)
marketIdstringEngine market id
eventIdstringParent event
questionstringMarket question
slugstringMarket slug
groupItemTitlestringnullableShort title within the group
outcomeALabelstringYES side display text
outcomeBLabelstringNO side display text
statusstringCatalog-side market status
resolutionstringnullableResolution
priceTickE6stringnullableTick size, as an E6 string
minOrderSizeE6stringnullableMinimum order size, as an E6 string
outcomeAPriceE6stringnullableLatest YES-side price, as an E6 string
outcomeBPriceE6stringnullableLatest NO-side price, as an E6 string
volume24hUsdE6stringnullable24h traded volume, as an E6 string
volumeUsdE6stringnullableLifetime traded volume, as an E6 string
liquidityUsdE6stringnullableBook liquidity, as an E6 string
endDateMsstringnullableCutoff as a millisecond string
hasBooksbooleanWhether a book exists
iconUrlstringnullableIcon URL
oneDayPriceChangestringnullable24h up/down display string
roundStartMsstringThis round's open as a millisecond string
roundEndMsstringThis round's close as a millisecond string
openPriceE8stringnullableOpen anchor price (Pyth e8 string) — the previous round's closePriceE8
closePriceE8stringnullableClose anchor price (Pyth e8 string)
anchorPendingbooleantrue = the anchor price is not sealed yet; show it as pending — never substitute 0 or the previous round value
spotobjectnullableSpot snapshot; null if none
symbolstringDisplay symbol, e.g. BTC
priceTextstringSpot price for display (e.g. 97350.00) — not a fixed-point integer
tsMsstringQuote time, as a millisecond string
Switch status codes in the response example to view errors. For all codes, see the Errors page.