> ## Documentation Index
> Fetch the complete documentation index at: https://docs.snek.fun/llms.txt
> Use this file to discover all available pages before exploring further.

# Orders feed

> Ledger and mempool orders for a pool, and per-address metrics

**Auth:** Public

***

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

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

### Query parameters

<ParamField query="asset" type="string" required>
  Pool token asset id.
</ParamField>

<ParamField query="offset" type="integer">
  Pagination offset (default `0`).
</ParamField>

<ParamField query="limit" type="integer">
  Page size (default `100`, max `100`).
</ParamField>

### 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

```json theme={null}
{
  "ledger": { "count": 120, "items": [ /* ApiOrder */ ] },
  "mempool": [ /* ApiOrder */ ]
}
```

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

<RequestExample>
  ```bash theme={null}
  curl -sS -X POST "https://analytics.snek.fun/v1/orders-feed/initial/state?asset=fbd4d3c3...44415645&offset=0&limit=50" \
    -H "Content-Type: application/json" \
    -d '[]'
  ```
</RequestExample>

***

## GET /v1/orders-feed/metrics

Returns optional per-address trading stats for the pool.

### Query parameters

<ParamField query="asset" type="string" required>
  Pool asset id.
</ParamField>

<ParamField query="pkh" type="string" required>
  56-character payment key hash.
</ParamField>

### Response

`Metrics` object or `null` if no data.

```bash theme={null}
curl -sS "https://analytics.snek.fun/v1/orders-feed/metrics?asset=…&pkh=…"
```

## WebSocket

Subscribe to **LiveOrdersFeed** with `asset` and optional `pkhFilter` in the subscribe payload. See [WebSocket](/api-reference/snekfun-provider/websocket).