Agent-readable docs index: /llms.txt. Full docs in one file: /llms-full.txt. Download /docs.zip to grep all markdown files locally.

Account

GET /v1/account/{addr}
Every route here except POST /v1/withdraw needs a session for the address in the path. A session for one address reads nothing of another's (403).
{ "known": true, "liveThrough": 918273, "engine": { "account": "1201:3", "freeCash": 41250000, "collateral": 2000000, "security": 50000000, "active": true, "resting": ["1834:12"], "positions": { "7:859008923130267914": -1 }, "vectors": { "…": [] }, "settled": {}, "keys": [{ "key": "0x2222…", "expiresAt": 1798761600, "generation": 1 }], "through": 918270, "position": 918274 } }
FieldMeaning
knownWhether the exchange has an account for this address. It opens with your first deposit.
freeCash, collateral, securitymicro-USDC. Their sum is the account's cash. See Security.
activefalse once the account is deactivated or frozen.
restingThe engine ids of the account's resting orders.
positionsNet position per contract, keyed "<underlyingKey>:<specifier>". Positive is long.
vectorsPer expiry bucket (64 hex characters), 21 integers: the book's value at expiry if it settles at 0, 0.05, 0.10, …, 1, in contracts × micros (multiply by 100 for micro-USDC). Security is computed from this curve.
settledContracts settled recently: the quantity and what they paid (micro-USDC, negative if the book paid).
keysSigning keys the exchange holds for the account. expiresAt is unix seconds. A key appears once the block that registered it is safe.
positionThe first stream position this answer does not yet reflect.