All services on this page use the public transport — no authentication required. Methods marked stream return an unsubscribe function () => void and take handler fields
(onEvent required; onOpen / onClose / onError optional) alongside the listed inputs.
client.marketData
Public spot trades, spot configuration, and live trade streams.
| Method | Input → Result | Notes |
|---|---|---|
listTrades(input, options?) | symbolId, limit?, side?, startTsNs?, endTsNs?, pageToken? → { trades, nextPageToken } | Newest first. |
getSpotConfig(options?) | → SpotConfig | Raw reference data; feeds the catalog. |
subscribeTrades(input) | symbolId → stream of MarketTrade |
client.marketOverview
Ticker-style per-market stats.
| Method | Input → Result | Notes |
|---|---|---|
list(input?, options?) | symbols?, limit? (default 500), pageToken?, orderBy? (default "volume_24h_quote"), sort? ("asc"/"desc"), includeSparklines? → { markets, nextPageToken } | |
subscribe(input) | → stream of MarketOverview[] | Snapshot-then-stream; emits the merged full set, refetches on reconnect. |
client.candles
OHLCV candles. Timeframes: 1s 1m 5m 15m 30m 1h 4h 12h 1d 1w 1mo.
| Method | Input → Result | Notes |
|---|---|---|
list(input, options?) | symbolId, timeframe, limit?, startTsSec?, endTsSec? → Candle[] | Row objects. |
listColumnar(input, options?) | same → CandleColumnar | Parallel arrays, oldest first. |
listColumnarInts(input, options?) | same → CandleColumnarInt | Keyed by numeric tsSec. |
subscribe(input) | symbolId, timeframe → stream of Candle | |
subscribeInts(input) | symbolId, timeframe → stream of CandleInt |
client.orderbook
Depth snapshots and a stateful live book.
| Method | Input → Result | Notes |
|---|---|---|
get(input, options?) | symbol, depth? (default 50) → OrderbookData | bids / asks as decimal-string levels. |
createSubscription(input) | symbol, symbolId, depth?, bucket? + handlers → OrderbookSubscription | Snapshot + sequence-checked deltas; refetches on gaps/reconnect. |
subscribe(input) | same → stream of OrderbookData | Shorthand for createSubscription(...).unsubscribe. |
OrderbookSubscription: unsubscribe(), setBucket(bucket) — change local price-bucket
aggregation without reconnecting.
client.heatmap
Order book liquidity heatmaps. Intervals: 1s 1m 5m 1h; depths: 1–1000 (fixed steps).
| Method | Input → Result | Notes |
|---|---|---|
getOrderbookHeatmap(input, options?) | symbolId, interval?, depth?, quantityMode?, limit?, startTsSec? / endTsSec? or pageToken → OrderbookHeatmapResponse | Time-range or cursor pagination; one of the two required. |
subscribeLive(input) | symbolId, interval → stream of live buckets |
client.chainAnalytics
Public chain chart series (columnar).
| Method | Input → Result |
|---|---|
getZippedAssetSupply(input, options?) | zippedAssetId + window → ZippedAssetSupplyResponse |
getZippedAssetSupplyGroup(input, options?) | groupId + window → ZippedAssetSupplyGroupResponse |
getUnifiedAssetBalances(input, options?) | assetId + window → UnifiedAssetBalancesResponse |
client.zipper
Deposit/withdraw configuration and supply streams.
| Method | Input → Result | Notes |
|---|---|---|
getDepositWithdrawConfig(options?) | → DepositWithdrawConfig | Chains, unified assets, routes, fees, minimums. Feeds catalog.zipper. |
subscribeZippedAssetSupply(input) | → stream of route supply updates |
client.lifecycle
Cross-chain flow state (deposits, withdrawals, …) — history, detail, and live progress.
| Method | Input → Result | Notes |
|---|---|---|
listFlows(input, options?) | kind/state/scope/account/tx/chain/asset filters → { flows, nextPageToken } | |
getFlow(input, options?) | flowId → flow summary, steps, timeline, live state | |
listFlowsByTx(input, options?) | txHash (+ mode) → matching flows | Source-only or any-reference matching. |
subscribeOpenFlows(input) | account scope → stream of open-flow summaries | Private channel when an accountId is given, public otherwise. |
subscribeFlowDetail(input) | flowId → stream of flow detail | Invalid flowId returns a no-op unsubscribe. |
Related
- Reference data, symbol lookups, and conversions: the catalog — Catalog & precision.
- Handler contract and reconnect semantics for all streams: Streaming.