- Market discovery tells you which venue markets exist for an asset and window.
- Orderbook depth tells you how much liquidity sits behind the displayed Yes/No odds.
- Reference prices tell you the current underlying asset price used to evaluate the market.
Endpoint map
Reference prices are underlying asset prices, not prediction-market prices. A BTC/USD
reference price belongs next to market odds; it should not be treated as a Yes/No midpoint.
Orderbook depth is prediction-market liquidity for an outcome, not an underlying asset price.
What you get
- Deterministic windows grouped by
asset,quoteAsset,duration,windowStart, andwindowEnd. - Venue market rows for each window, including outcomes, midpoint-style market odds, metrics, routeability flags, and reference-price metadata.
- Optional per-outcome
orderbookDepthwith buy/sell levels, notional totals, average and worst sweep prices, and fill-completeness fields. - Fresh USD reference prices with
softRefreshMs,hardMaxAgeMs,ageMs,stale, and target-levelerrorfields so your UI can degrade cleanly. - Cross-venue comparison fields for reference prices and up/down outcome prices.
Cadence filters
AGG exposes recurrence filters as fixed enum values. There is no separate cadence catalog endpoint to call from your frontend. Venue event discovery accepts the full recurrence enum, while recurring crypto discovery currently supports the short-window crypto durations listed below.durations and interval also accept the friendly aliases 5m, 15m, 30m, 1h, 4h, and
1d for those same windows. Venue-event recurrence is a wider enum and is not this alias list.
Venue event discovery also accepts broader recurrence filters:
The SDK exports the supported cadence list:
listRecurringCryptoMarkets, use the RecurringCryptoDuration values PT5M,
PT15M, PT30M, PT1H, PT4H, and P1D.
Use these same ISO values with venue event discovery.
Calls List venue events.
There is no recurrence-cadence catalog endpoint. If your integration previously
expected a dynamic cadence list, read
RECURRENCE_CADENCES from the SDK or use
the enum shown in the API reference. Use the literal null only when filtering
venue events with no recurring schedule.1. Create the client
2. List recurring crypto windows
listRecurringCryptoMarkets groups venue markets by asset, quote asset, duration, and
window. Use it for crypto-specific market views where the user expects “current BTC 15m”,
“current ETH 1h”, or similar rows.
asset,quoteAsset,duration,windowStart, andwindowEndmarkets[], one item per venue market in that window- per-market
outcomes[]with market odds such asmidpoint,bestBid, andbestAsk - per-market
resolution, which can be passed back when polling reference prices
includeDirectVenueMarkets is deprecated and ignored. Every recurring window is listed from
AGG’s own market data before it opens, so you can drop the parameter; the response is the same
with or without it.3. Add depth for visible markets
UseincludeOrderbookDepth when the user is looking at a small, active set of current windows
and you need liquidity context next to the displayed odds. Keep it off for broad catalog pages,
then opt in for the rows that are actually on screen. Same route as above:
List recurring crypto window markets.
orderbookDepth accepts 1 through 15 levels per side. orderbookDepthAmountUsd has no fixed
public upper cap, but it must be positive. Use the size your UI wants to inspect or simulate.
Outcomes without a live book return orderbookDepth: null, so keep the depth display optional.
Use the recurring endpoint for grouped crypto windows. For a dedicated orderbook view or a
larger explicit set of venue markets, use the
/orderbooks API or WebSocket orderbook stream.4. Poll reference prices
UsegetCryptoReferencePrices with the windows or markets returned by discovery. The SDK will
build the correct target payload for each venue market.
Calls Get live crypto reference prices.
softRefreshMs and hardMaxAgeMs. Use softRefreshMs as your normal
poll interval for active views. Treat any row with error, stale: true, or a null
normalized price as unavailable for display. Chainlink-sourced rows can be up to 2 seconds old
(Chainlink publishes about once a second); judge freshness by each row’s stale flag rather than
comparing ageMs to hardMaxAgeMs.
5. Match prices back to markets
Reference-price rows include the same venue-facing identifiers you already have from discovery. Index byvenueMarketId for normal UI work.
API reference
Use the generated API Reference for request parameters, response schemas, and try-it-out examples:Trading behavior
Recurring crypto discovery can include venue markets that are useful for display but not valid inputs to AGG smart order routing. Check these fields before enabling trade controls:market.routeablemarket.splitOrdersAllowedoutcome.routeableoutcome.splitOrdersAllowed
routeable is false, do not pass that market to smart routing. If splitOrdersAllowed is
false, do not split an order across venues for that market.
Integration notes
- Reference prices are USD-only (
quoteAsset: "USD") and are separate from prediction-market odds. listRecurringCryptoMarketssupports deterministic crypto durations:PT5M,PT15M,PT30M,PT1H,PT4H, andP1D, plus aliases5m,15m,30m,1h,4h, and1d.getCryptoReferencePricesaccepts up to 100 targets. For active views, pass the visible windows or venue market ids rather than polling every discovered market.- Prefer
getCryptoReferencePricesfor live reference-price polling. The discovery endpoint can include reference prices, but the dedicated polling endpoint is built for fresh active views. - Use
includeOrderbookDepthonly for visible rows that need liquidity context. Depth is capped at 15 levels per side, andorderbookDepthAmountUsdmust be greater than 0. - Treat rows with
error,stale: true, ornormalized: nullas unavailable for display. source.confidencecan beverified,inferred, ormissing. Show low-confidence or missing sources conservatively in production trading experiences.
Recommended UI flow
- Call
listRecurringCryptoMarketsfor the current window and render the market cards. - Include
orderbookDepthonly for rows where the user needs liquidity or sweep context. - Call
getCryptoReferencePricesfor the visible windows. - Display market odds, orderbook depth, and reference prices as separate values.
- Poll reference prices using
softRefreshMswhile the view is visible. - Stop polling when the user leaves the view or the window status is no longer
open.
FAQ
Are reference prices the same as market prices?
No. Reference prices are underlying crypto prices, such as BTC/USD or ETH/USD. Market prices are the prediction market odds for outcomes such as Up or Down. Orderbook depth is liquidity behind those outcome prices.Which crypto windows are supported?
The recurring crypto endpoint supportsPT5M, PT15M, PT30M, PT1H, PT4H, and P1D, and the
aliases 5m, 15m, 30m, 1h, 4h, and 1d. Venue event discovery can still filter broader
recurrence cadences, but this crypto-specific endpoint is intentionally scoped to deterministic
recurring crypto windows.
What should I do when a reference price is stale or unavailable?
Do not render it as a current price. Hide it, show an unavailable state, or keep the last accepted value visually distinct from live data. Always readerror, stale, ageMs, and normalized
before displaying a reference price.
Related
aggKey
Optional fetch filter when a crypto window key converges.
Ids
Which id to store. aggKey is not that id.
Real-Time Orderbook
Stream live orderbook changes for tradable venue markets.