API Reference

Book

Read-side endpoints for the orderbook: depth ladder, single snapshot, recent fills. All three are live and back the trade.taifoon.dev UI directly.

GET/book/v1/depth/{market}

REAL

Returns the full bid/ask ladder for the given market. Each level is an aggregated price + quantity. Prices and quantities are decimal strings on the wire.

Query parameters

Field	Type	Required	Description
market	string (path)	yes	e.g. "BTC-PERP".

Response

Field	Type	Required	Description
market	string	no	Echoed.
bids	array	no	Descending by price. Each: { price: string, qty: string }.
asks	array	no	Ascending by price. Same shape as bids.

Code

curl -s https://api.taifoon.dev/book/v1/depth/BTC-PERP | jq '{bids:.bids[:3], asks:.asks[:3]}'

GET/book/v1/snapshot

STUB · 400

A single snapshot of the top of book. Returns 400 today — schema not finalised. Use /book/v1/depth/<market> and take bids[0] / asks[0].

Query parameters

Field	Type	Required	Description
market	string	yes	Required once wired.

GET/book/v1/fills

REAL

Recent fills for a market, newest first. Used by the RECENT FILLS panel.

Query parameters

Field	Type	Required	Description
market	string	yes	e.g. "BTC-PERP".
limit	integer	no	Default 50, max 500.
attribution	string	no	Prefix-match server-side filter. Returns fills where attribution starts with this value (both maker and taker sides).

Response

Field	Type	Required	Description
fills	array	no	Most recent first.
fills[].fill_id	string	no	UUID.
fills[].order_id	string	no	Originating order UUID.
fills[].side	string	no	"buy" \| "sell" — the taker side.
fills[].qty	string	no	Filled qty.
fills[].price	string	no	Cross price.
fills[].attribution	string	no	Originating attribution.
fills[].was_maker	boolean	no	True iff the resting side; false for the crosser.
fills[].t_logical	integer	no	Unix seconds.

Code

curl -s 'https://api.taifoon.dev/book/v1/fills?market=BTC-PERP&limit=3' | jq