Skip to main content
GET
curl
The response body shown here is a static example, not live data. After you click Send, your live result appears in a separate panel headed 200 OK. The panel under the status-code tabs is a fixed sample from the spec — its field values (fees, prices, sizes, IDs, timestamps) are placeholders. Use Send, or call the endpoint, for current values.
Returns the rate-limit state of both per-subaccount pools (order and cancel) so callers can self-pace and inspect which throttle is constraining them. The pools have independent consumed counters and different BaseSeeds (20K order, 40K cancel) — an HFT cancel-heavy pattern can saturate one while the other sits idle. Each pool reports {used, cap, nextAvailableMs}:
  • cap = BaseSeed + lifetime_filled_usd / 0.10 (10 pool units per USD of lifetime realized notional). Lifetime volume is shared across both pools, so the two caps grow in lockstep.
  • nextAvailableMs is 0 while used < cap. Past the cap, it carries the millisecond-until-next-drip-token (1 action per 10 seconds in production).
No authentication header is required.

Query Parameters

address
string
required

Master Ethereum address for this API key (must match address from POST /createApiKey for the same key). Required on REST for account-scoped reads and for place/cancel. Invalid hex → 400; mismatch with key → 403.

20-byte EVM address as hex: optional 0x or 0X prefix and exactly 40 hexadecimal digits. API responses normalize to lowercase af after 0x.

Pattern: ^(0x|0X)?[0-9a-fA-F]{40}$
accountIndex
integer
default:0

Subaccount index (0–9) to scope the request to. Defaults to 0 (the primary account). Values above 9 → 400.

Required range: 0 <= x <= 9

Response

Subaccount rate-limit pool state.

address
string
required

0x-prefixed 40-character hex Ethereum address echoed from the request.

Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb"

accountIndex
integer
required

Subaccount index echoed from the request (0-9).

Required range: 0 <= x <= 9
order
object
required

Order pool — charges placeOrder / modifyOrder / batchPlaceOrders. BaseSeed: 20,000.

cancel
object
required

Cancel pool — charges cancelOrder / batchCancelOrders / cancelAllOrders (latter charges 5,000 flat). BaseSeed: 40,000. Independent consumed counter from order; a cancel-heavy pattern can saturate this while order still has headroom.