Skip to main content
The REST method playground defaults to mainnet and offers testnet in its server dropdown:
It exposes the latest retained proposed, voted, and finalized projections. Market history and candles are served by the Data Source REST API.

L2 order book

Read a bounded finalized order-book snapshot.

Best bid and offer

Read the current top of book.

User balances

Read all current spot balances in the retained snapshot.

User open orders

Read a user’s current open-order snapshot.

​
Projection states

/api/depth, /api/bbo, and the user snapshot routes accept proposed, voted, or finalized. Short forms p, v, and f are also accepted.

​
Numeric units

  • Addresses are lowercase 0x-prefixed 20-byte values.
  • User IDs are unsigned decimal path values.
  • Book sequence cursors are JSON integers.
  • Book prices are native pp integer strings; sizes are native sp integer strings.
  • Order prices are signed native pp integer strings; sizes remain native market size-precision integers.
  • Base sizes use the market’s native sizePrecision domain.
  • Token balances use the token’s native decimal domain.
  • Percentage fields are decimal ratios: "0.01" means one percent.
Never parse these quantities through binary floating point. User orders and balances are bounded snapshots rather than paginated collections. Each returns at most 2,000 entries and sets truncated when additional entries were omitted.

​
Errors

Errors use one envelope:
Stable codes are BadRequest, NotFound, Unsupported, RateLimited, and Internal.