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", "through": 918270, "freeCash": 41250000, "collateral": 2000000, "security": 50000000, "active": true, "premium": false, "resting": ["1834:12"], "positions": { "7:859008923130267914": -1 }, "vectors": { "0000000000000000000000000000000000000000000000070000002e9124be80": [0, 0, "…"] }, "settled": { "7:859008921287065866": { "quantity": -2, "amount": -1500000 } }, "position": 918274 }, "keys": [{ "key": "0x2222…", "expiresAt": 1798761600, "generation": 1 }] }
For an address the exchange has no account for, known is false, engine holds zeros and its position, and keys is empty.
FieldMeaning
knownWhether the exchange has an account for this address. It opens with your first deposit.
liveThroughThe input sequence this gateway's view has reached.
engine.accountThe engine's id for the account.
engine.throughThe input sequence the account's state is complete to; stream events carry the same number as seq.
engine.freeCash, engine.collateral, engine.securitymicro-USDC. Their sum is the account's cash. See Security.
engine.activefalse once the account is deactivated or frozen.
engine.premiumWhether the account is in the premium class.
engine.restingThe engine ids of the account's resting orders. Their terms are at resting orders.
engine.positionsNet position per contract, keyed "<underlyingKey>:<specifier>". Positive is long.
engine.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.
engine.settledPositions settled in the last eight days, by contract: the quantity held and what the settlement paid (micro-USDC, negative if the book paid). Every settlement ever is at settlements.
engine.positionThe first stream position this answer does not yet reflect. Events at or after it are not in it.
keysThe signing keys the exchange holds for the account, at the top level beside engine. expiresAt is unix seconds. A key appears once the block that registered it is a few seconds old (confirmationSeconds in config), and an order it signs is refused until then.