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

Markets

Market configuration, live statistics, candles, the resting book and per-tick solution history.

Get Solution Time

get

The indexer's solution time: the newest indexed batch deadline, in microseconds. Use it as since when subscribing over the websocket after a REST read.

Cache-Control: no-store.

Responses
200

Solution time

application/json
solution_nowinteger · int64Required

Unix time in microseconds, as a JSON number

Example: 1704153600000000
get/clob/status
GET /v1/clob/status HTTP/1.1
Host: rpc.podtestnet.dev
Accept: */*
{
  "solution_now": 1704153600000000
}

List Markets

get

Every market's static configuration and lifecycle status, including markets created after the node started. Live statistics are on /clob/markets/stats.

Cache-Control: public, max-age=60.

Responses
200

Market list

application/json

Static market configuration. Numeric amounts are decimal strings.

statusstring · enumOptional

Lifecycle status.

Possible values:
idstringOptional

32-byte value, 0x hex. Orderbook ids, order ids and hashes.

Example: 0x0000000000000000000000000000000000000000000000000000000000000001Pattern: ^0x[a-fA-F0-9]{64}$
namestringOptional

{base_symbol}/{quote_symbol}

base_token_addressstringOptional

20-byte address, 0x hex

Example: 0x742d35Cc6634C0532925a3b844Bc9e7595f2bD28Pattern: ^0x[a-fA-F0-9]{40}$
quote_token_addressstringOptional

20-byte address, 0x hex

Example: 0x742d35Cc6634C0532925a3b844Bc9e7595f2bD28Pattern: ^0x[a-fA-F0-9]{40}$
base_token_symbolstringOptional
quote_token_symbolstringOptional
base_token_namestringOptional
quote_token_namestringOptional
market_typestring · enumOptional

Order rows spell this perpetual.

Possible values:
auction_interval_usinteger · int64Optional

Batch interval, microseconds

maker_feestringOptional

Fee rate as a decimal fraction, six places ("0.000150" is 1.5 bps).

taker_feestringOptional

Fee rate as a decimal fraction, six places.

tick_precisionstringOptional

Unsigned 256-bit integer, decimal string

Example: 1000000000000000000Pattern: ^[0-9]+$
lot_sizestringOptional

Unsigned 256-bit integer, decimal string

Example: 1000000000000000000Pattern: ^[0-9]+$
min_notionalstringOptional

Minimum quote notional per order, 1e18-scaled decimal string. "0" is no floor.

max_leverageintegerOptional
initial_marginstringOptional

Initial-margin rate, 1e18-scaled decimal string, unrounded (max_leverage is rounded).

funding_window_usinteger · int64Optional

Period funding_rate applies over, microseconds

live_at_usinteger · int64Optional

When a pending market goes live, microseconds. Omitted when not scheduled.

disable_at_usinteger · int64Optional

Scheduled halt, microseconds. Omitted when none.

settlement_pricestringOptional

Price open positions settle at, fixed when a perp market halts. 1e18-scaled decimal string. Omitted until then.

get/clob/markets
GET /v1/clob/markets HTTP/1.1
Host: rpc.podtestnet.dev
Accept: */*
200

Market list

[
  {
    "status": "active",
    "id": "0x0000000000000000000000000000000000000000000000000000000000000001",
    "name": "BTC/USD",
    "base_token_address": "0x0000000000000000000000000000000000000b7c",
    "quote_token_address": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
    "base_token_symbol": "BTC",
    "quote_token_symbol": "USD",
    "base_token_name": "Bitcoin",
    "quote_token_name": "US Dollar",
    "market_type": "perp",
    "auction_interval_us": 100000,
    "maker_fee": "0.000150",
    "taker_fee": "0.000450",
    "tick_precision": "1000000000000000000",
    "lot_size": "1000000000000000",
    "min_notional": "0",
    "max_leverage": 20,
    "initial_margin": "50000000000000000",
    "funding_window_us": 3600000000
  }
]

Get Market Statistics

get

Live per-market statistics, overlaying the forming candle. Same entry shape as the pod_markets websocket channel. Sorted by orderbook_id.

Cache-Control: no-store.

Query parameters
timestampinteger · int64Optional

The lowest tick deadline accepted, in microseconds — typically the highest timestamp (or solution_now) already held. The node answers once the state behind the route has reached it, otherwise 503 after its wait (default 2s, POD_RPC_TIMESTAMP_WAIT). Omitted means answer now.

Responses
200

Statistics for every market

application/json
solution_nowinteger · int64Required

Unix time in microseconds, as a JSON number

Example: 1704153600000000
get/clob/markets/stats
GET /v1/clob/markets/stats HTTP/1.1
Host: rpc.podtestnet.dev
Accept: */*
{
  "solution_now": 1704153600000000,
  "markets": [
    {
      "orderbook_id": "0x0000000000000000000000000000000000000000000000000000000000000001",
      "last_clearing_price": "65000000000000000000000",
      "volume_24h": "120000000000000000000",
      "high_24h": "66000000000000000000000",
      "low_24h": "64000000000000000000000",
      "price_change_24h": 125,
      "oracle_price": "65010000000000000000000",
      "mark_price": "65005000000000000000000",
      "funding_rate": "12500000000000",
      "open_interest": "3200000000000000000000000"
    }
  ]
}

Get Candles

get

Closed OHLCV bars in the half-open window [from, to), newest first. The forming bar is dropped after limit applies, so a page that reaches the present can hold one bar fewer than limit.

Page back with to = range.from_us / 1e6. The forming bar is the bucket containing solution_now_us; build it from the pod_candles websocket channel, subscribed with since one microsecond before that bucket's start.

An orderbook id that names no book returns an empty window.

Cache-Control: public, max-age=31536000, immutable once every bucket of the window has closed, otherwise no-store.

Path parameters
orderbookstringRequired

32-byte value, 0x hex. Orderbook ids, order ids and hashes.

Example: 0x0000000000000000000000000000000000000000000000000000000000000001Pattern: ^0x[a-fA-F0-9]{64}$
Query parameters
timestampinteger · int64Optional

The lowest tick deadline accepted, in microseconds — typically the highest timestamp (or solution_now) already held. The node answers once the state behind the route has reached it, otherwise 503 after its wait (default 2s, POD_RPC_TIMESTAMP_WAIT). Omitted means answer now.

resolutionstring · enumRequiredPossible values:
frominteger · int64Optional

Window start, unix seconds, inclusive.

Default: 0
tointeger · int64Optional

Window end, unix seconds, exclusive. Defaults to solution time.

limitinteger · max: 500Optional

Maximum bars. Above 500 is a 400.

Default: 500
Responses
200

Candle page

application/json
resolutionstring · enumRequiredPossible values:
solution_now_usinteger · int64Required

Unix time in microseconds, as a JSON number

Example: 1704153600000000
get/clob/candles/{orderbook}
GET /v1/clob/candles/{orderbook}?resolution=1m HTTP/1.1
Host: rpc.podtestnet.dev
Accept: */*
{
  "candles": [
    {
      "timestamp": 1704150000000000,
      "open": "0xdc3a8351f3d86a00000",
      "close": "0xdc3a8351f3d86a00000",
      "high": "0xdc3a8351f3d86a00000",
      "low": "0xdc3a8351f3d86a00000",
      "volume": "0x2386f26fc10000",
      "quote_volume": "0x8ac7230489e80000"
    }
  ],
  "resolution": "1h",
  "range": {
    "from_us": 1704150000000000,
    "to_us": 1704150000000000
  },
  "solution_now_us": 1704153600000000
}

Get Orderbook

get

The resting book as of the latest batch that cleared this orderbook. Optionally truncated to the best depth price levels per side; buys_count and sells_count still count the full book.

Cache-Control: no-store.

Path parameters
orderbookstringRequired

32-byte value, 0x hex. Orderbook ids, order ids and hashes.

Example: 0x0000000000000000000000000000000000000000000000000000000000000001Pattern: ^0x[a-fA-F0-9]{64}$
Query parameters
timestampinteger · int64Optional

The lowest tick deadline accepted, in microseconds — typically the highest timestamp (or solution_now) already held. The node answers once the state behind the route has reached it, otherwise 503 after its wait (default 2s, POD_RPC_TIMESTAMP_WAIT). Omitted means answer now.

depthinteger · min: 1Optional

Best price levels per side. 0 is a 400. Omit for the whole book.

Responses
200

Orderbook snapshot

application/json
orderbook_idstringOptional

32-byte value, 0x hex. Orderbook ids, order ids and hashes.

Example: 0x0000000000000000000000000000000000000000000000000000000000000001Pattern: ^0x[a-fA-F0-9]{64}$
buys_countintegerOptional

Buy levels in the full book.

sells_countintegerOptional

Sell levels in the full book.

grouping_precisionstringOptional

Unsigned 256-bit integer, 0x hex

Example: 0x6f05b59d3b200000Pattern: ^0x[a-fA-F0-9]+$
timestampinteger · int64Optional

Unix time in microseconds, as a JSON number

Example: 1704153600000000
new_orders_countintegerOptional
clearing_pricestringOptional

The orderbook's current mark, carried forward on ticks without fills.

Example: 0x6f05b59d3b200000Pattern: ^0x[a-fA-F0-9]+$
oracle_pricestring · nullableOptional

Perp only, 0x hex. null for spot.

funding_ratestring · nullableOptional

Perp only, signed decimal string. null for spot.

funding_indexstring · nullableOptional

Perp only, signed decimal string. null for spot.

funding_last_updatedinteger · int64 · nullableOptional

Perp only, microseconds. null for spot.

get/clob/orderbook/{orderbook}
GET /v1/clob/orderbook/{orderbook} HTTP/1.1
Host: rpc.podtestnet.dev
Accept: */*
{
  "orderbook_id": "0x0000000000000000000000000000000000000000000000000000000000000001",
  "buys": {
    "ANY_ADDITIONAL_PROPERTY": {
      "volume": "0x6f05b59d3b200000"
    }
  },
  "sells": {
    "ANY_ADDITIONAL_PROPERTY": {
      "volume": "0x6f05b59d3b200000"
    }
  },
  "buys_count": 1,
  "sells_count": 1,
  "grouping_precision": "0x6f05b59d3b200000",
  "timestamp": 1704153600000000,
  "new_orders_count": 1,
  "clearing_price": "0x6f05b59d3b200000",
  "oracle_price": "text",
  "funding_rate": "text",
  "funding_index": "text",
  "funding_last_updated": 1
}

Get Solutions

get

Per-tick solution history: clearing, mark and oracle prices, volume, funding, open interest and the mark/funding inputs. Newest first, in whole ticks: limit counts ticks, and a tick carries one row per orderbook.

Page back by passing the oldest timestamp of the previous page as until_us.

An orderbook id that names no book returns no rows.

Cache-Control: no-store.

Query parameters
orderbookstringOptional

32-byte value, 0x hex. Orderbook ids, order ids and hashes.

Example: 0x0000000000000000000000000000000000000000000000000000000000000001Pattern: ^0x[a-fA-F0-9]{64}$
since_usstringOptional

Unix time in microseconds, as a decimal string

Example: 1704153600000000Pattern: ^[0-9]+$
until_usstringOptional

Unix time in microseconds, as a decimal string

Example: 1704153600000000Pattern: ^[0-9]+$
limitinteger · min: 1 · max: 200Optional

Ticks per page, clamped to [1, 200].

Default: 200
Responses
200

Solution rows

application/json
get/clob/solutions
GET /v1/clob/solutions HTTP/1.1
Host: rpc.podtestnet.dev
Accept: */*
{
  "solutions": [
    {
      "orderbook_id": "0x0000000000000000000000000000000000000000000000000000000000000001",
      "timestamp": 1704153600000000,
      "clearing_price": "0x6f05b59d3b200000",
      "mark_price": "0x6f05b59d3b200000",
      "volume": "0x6f05b59d3b200000",
      "oracle_price": "0x6f05b59d3b200000",
      "funding_rate": "-1000000000000000000",
      "funding_index": "-1000000000000000000",
      "open_interest": "0x6f05b59d3b200000",
      "mark_best_bid": "0x6f05b59d3b200000",
      "mark_best_ask": "0x6f05b59d3b200000",
      "premium_ema": "-1000000000000000000",
      "book_median_ema": "0x6f05b59d3b200000",
      "impact_bid": "0x6f05b59d3b200000",
      "impact_ask": "0x6f05b59d3b200000"
    }
  ]
}

Last updated