Skip to main content
POST
Auth: Public

​
POST /v1/orders-feed/initial/state

Returns confirmed orders (ledger) and pending mempool orders (mempool) for one pool.

​
Query parameters

​
string
required
Pool token asset id.
​
integer
Pagination offset (default 0).
​
integer
Page size (default 100, max 100).

​
Request body

JSON value: either null, or an array of payment key hashes (56-char hex) to restrict to specific makers.
  • null or omit: all addresses.
  • []: same as no filter in practice (all).
  • ["pkh1…"]: only orders from those PKHs.

​
Response

ApiOrder fields include entityId, beacon, from, fromAmount, to, toAmount, address, worstPrice, transaction ids, timestamp, status, orderType, pkh, etc.

​
GET /v1/orders-feed/metrics

Returns optional per-address trading stats for the pool.

​
Query parameters

​
string
required
Pool asset id.
​
string
required
56-character payment key hash.

​
Response

Metrics object or null if no data.

​
WebSocket

Subscribe to LiveOrdersFeed with asset and optional pkhFilter in the subscribe payload. See WebSocket.