Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: REST Account balances API
version: 1.0.0
description: 'What each account holds at its venue, as the venue last stated it: the latest reading per account and asset, published by the platform''s account connectors — never the platform''s own books.'
servers:
- url: https://api.immix.xyz/v1
description: prod
tags:
- name: Account balances
description: 'What each account holds at its venue, as the venue last stated it: the latest reading per account and asset, published by the platform''s account connectors — never the platform''s own books.'
paths:
/account-balances:
get:
operationId: accountBalances_list
summary: List account balances
description: Lists the organisation's account balances — the latest reading per account and asset, as the venue last stated it; `accountId` narrows to one account's. A `DISCOVERED` account's balances are served while it is being classified. Rows are ordered by `accountId` then `assetId`; a `view` other than `latest` is 400. A member deployed without the surface answers 503 `BALANCES_UNAVAILABLE`.
tags:
- Account balances
parameters:
- name: accountId
in: query
description: Only one account's balances — the `accountId` its rows carry and `GET /accounts` serves. An account outside your organisation, or one this member does not hold, yields an empty collection, like an account with no reading; `0`, a negative or a non-integer refuses 400.
required: false
schema:
type: integer
minimum: 1
- name: limit
in: query
description: Page size, 1-100; larger values are clamped. Without it the whole collection is served as one page.
required: false
schema:
type: integer
minimum: 1
- name: cursor
in: query
description: '`nextCursor` or `prevCursor` from a previous page, sent with the same filters. One that does not decode, or that came from another query, is refused 400 `INVALID_CURSOR`: drop it and fetch the first page.'
required: false
schema:
type: string
maxLength: 2048
- name: include
in: query
description: '`total` adds the exact number of rows matching the filters.'
required: false
schema:
$ref: '#/components/schemas/accountBalances_ListAccountBalancesRequestIncludeItem'
- name: X-Request-Id
in: header
description: 'Your own id for the request: 8 to 128 of `[A-Za-z0-9._-]`. It becomes the request''s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.'
required: false
schema:
type: string
responses:
'200':
description: A page of the readings inside the principal's org, account then asset ascending — all of them unless `limit` is sent; the position it was read at rides the body and the headers.
content:
application/json:
schema:
$ref: '#/components/schemas/accountBalances_ListAccountBalancesResponse'
'400':
description: 'The request''s shape is wrong: a non-positive id, an unknown `view` or filter value, a query string that does not decode, a query parameter the operation does not take, or a cursor that does not decode or came from another query (`INVALID_CURSOR`). No position rides a refusal that consulted no state.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: No bearer token, or one that does not verify.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: 'Authenticated, but not admitted. `NOT_REGISTERED`: no row and no open invitation at your verified address (ask to be invited), an unknown organisation, or a row nobody has claimed (an administrator admits it; no invitation binds a held subject). `EMAIL_UNVERIFIED`: verify your address, then sign in again. `INVITATION_EXPIRED`: an administrator re-invites. `FORBIDDEN_PRINCIPAL`: no `org_id`, a non-ASCII ref, a disabled user, a binding with no user. `ORG_NOT_ACTIVE`: suspended, pending or retired. The record owners'' 403s carry the position header and replay with `Idempotent-Replay`.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'503':
description: 'This member cannot serve balances now: `NOT_PRIMED` — it is still catching up; retry shortly — or `BALANCES_UNAVAILABLE` — it is deployed without the balance surface, because no account connector publishes readings into its environment yet, so no balance is readable here and a retry changes nothing; every other route is unaffected.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
components:
schemas:
Error:
type: object
properties:
error:
$ref: '#/components/schemas/ErrorBody'
currentVersion:
type: string
pattern: ^-?[0-9]+$
description: 'On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance''s config write: the row''s current version (the `ETag` carries the same token) — re-read, reapply, retry.'
required:
- error
description: 'The one error envelope, on every refusal: error.code is the machine surface, error.message display text, error.requestId the request''s id and error.retryable whether a plain retry can succeed. A 412 adds currentVersion.'
title: Error
ErrorBody:
type: object
properties:
code:
type: string
description: 'The code to branch on — stable and append-only: treat one you do not know by its HTTP status. The gateway''s:
- 400: `MALFORMED_REQUEST`, `MISSING_IDEMPOTENCY_KEY`, `INVALID_IDEMPOTENCY_KEY`, `INVALID_IF_MATCH`, `INVALID_CURSOR`
- 401: `UNAUTHENTICATED`
- 403: `FORBIDDEN_PRINCIPAL`, `NOT_REGISTERED`, `INVITATION_EXPIRED`, `EMAIL_UNVERIFIED`, `ORG_NOT_ACTIVE`, `CAPABILITY_DENIED`, `AWAITING_ADMISSION`
- 404: `NOT_FOUND`, `UNKNOWN_OPERATION`, `ROUTE_NOT_FOUND` (no route answers the path)
- 405: `METHOD_NOT_ALLOWED`
- 409: `IDEMPOTENCY_KEY_REUSED`, `INTAKE_KEY_REUSED`
- 413: `TOO_LARGE`, `PAYLOAD_TOO_LARGE`, `DOCUMENT_TOO_LARGE`
- 422: a reference this member will not send: `INSTRUMENT_NOT_LIVE`, `ACCOUNT_NOT_ACTIVE` (`POST /orders`), `REFERENCE_UNKNOWN_INSTRUMENT`, `REFERENCE_INSTRUMENT_NOT_LIVE`, `REFERENCE_UNKNOWN_ACCOUNT` (an algo document); `VENUE_UNSUPPORTED`; `SCALE_UNKNOWN` (retired at `0.3.4`)
- 428: `PRECONDITION_REQUIRED`
- 429: `INBOX_FULL`, `IN_FLIGHT_FULL`, `RATE_LIMITED`
- 500: `INTERRUPTED`, `INTERNAL_ERROR`, `PROJECTION_MISS`
- 503: `NOT_PRIMED`, `NOT_SERVING`, `OWNER_ABSENT`, `INTAKE_UNAVAILABLE`, `BALANCES_UNAVAILABLE`, `ALGOS_UNAVAILABLE`, `TICKETS_UNAVAILABLE`, `INVITATIONS_UNAVAILABLE`, `REGISTRATION_PENDING`, `LOST`, `REJECTED_NOT_REGISTERED`, `REJECTED_NOT_ACTIVE`
The record owners'' refusals ride verbatim — `OrgRegisterRejected.reason`, `OrderRejected.reason` and `AlgoRejected.reason` list them; the guide maps each to its status.'
message:
type: string
description: For display only; its wording may change at any time.
requestId:
type: string
description: The request's id, also sent as X-Request-Id; quote it to support.
retryable:
type: boolean
description: 'Whether sending the identical request again, its `Idempotency-Key` included, after `Retry-After` or a short pause, can succeed with nothing else changed. `false` where something must change first: the request, its key, its precondition, the caller''s standing, or the platform''s own records or deployment. A refusal the record owner judged is always `false`: it is the recorded answer to its key, which replays it.'
required:
- code
- message
- requestId
- retryable
description: What a refusal states. Since `0.12.0` every refusal carries all four members; a member below it sends `code`, sometimes `message`, and neither of the others.
title: ErrorBody
accountBalances_ListAccountBalancesResponse:
type: object
properties:
nextCursor:
type:
- string
- 'null'
description: Pass as `cursor` for the next page. Null on the last page.
prevCursor:
type:
- string
- 'null'
description: Pass as `cursor` for the previous page. Null on the first page.
total:
type:
- integer
- 'null'
description: Exact count matching the filter. Null unless `include=total`.
globalSequence:
$ref: '#/components/schemas/GlobalSequenceValue'
asOfSeqTsNs:
type:
- string
- 'null'
pattern: ^[0-9]+$
description: The sequencer timestamp (epoch-ns) the data is complete through; also sent as X-Immix-As-Of-Seq-Ts. Null when unknown.
items:
type: array
items:
$ref: '#/components/schemas/AccountBalanceRow'
unscaled:
type: boolean
description: 'Never present since 0.3.1: a balance states its own scale, so no item is ever served raw. Kept, deprecated, so a client generated from 0.3.0 still compiles.'
deprecated: true
required:
- nextCursor
- prevCursor
- total
- globalSequence
- asOfSeqTsNs
- items
title: ListAccountBalancesResponse
GlobalSequenceValue:
type: string
pattern: ^[0-9]+$
description: The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.
title: GlobalSequenceValue
AccountBalanceRow:
type: object
properties:
accountId:
type: integer
description: The account this reading belongs to.
assetId:
type: integer
description: The asset the amounts are stated in.
credentialId:
type: integer
description: The credential the reading was taken through — the account's own.
total:
type: string
pattern: ^-?[0-9]+(\.[0-9]+)?$
maxLength: 64
description: 'The venue''s stated total holding in this asset. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value''s own scale — every fractional digit that scale states, trailing zeros included; never raw'
available:
type: string
pattern: ^-?[0-9]+(\.[0-9]+)?$
maxLength: 64
description: 'What the venue would let move now — a withdrawal or transfer amount, never what is usable as margin: collateral eligibility and haircuts are the venue''s own gates. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value''s own scale — every fractional digit that scale states, trailing zeros included; never raw'
held:
type: string
pattern: ^-?[0-9]+(\.[0-9]+)?$
maxLength: 64
description: 'What the venue itself has locked — order margin, pending withdrawals, venue-side freezes. total is available plus held only where the venue''s own model is additive. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value''s own scale — every fractional digit that scale states, trailing zeros included; never raw'
venueTsNs:
type:
- string
- 'null'
pattern: ^-?[0-9]+$
description: The venue's own clock for this reading; 0 = the venue stated none, and the platform's time of the reading is the clock to read. int64 as a decimal JSON string
venueRevision:
type:
- string
- 'null'
pattern: ^-?[0-9]+$
description: The venue's own sequence or revision number where it has one; 0 = none. A revision bump republishes the reading even when the amounts are unchanged. int64 as a decimal JSON string
observedAtNs:
type: string
pattern: ^[0-9]+$
description: The platform time of this reading — epoch nanoseconds as a decimal string, never null. A changed reading and a restatement on the connector's heartbeat both move it, so a row whose `observedAtNs` stops advancing is an account the venue has stopped reporting. Judge freshness from it, not from `venueTsNs`, the venue's own clock.
unscaled:
type: boolean
description: 'Never present since 0.3.1: each amount carries its own scale on the wire, so this row''s amounts are exact decimals whether or not this member holds the asset — nothing about it needs distrusting. Kept, deprecated, so a client generated from 0.3.0 still compiles.'
deprecated: true
required:
- accountId
- assetId
- credentialId
- total
- available
- held
- observedAtNs
description: 'One account''s latest balance in one asset as the API serves it: the `AccountBalance` reading plus `observedAtNs`, the platform time of the reading (the deprecated `unscaled` is never present: a balance states its own scale). `total`, `available` and `held` are the venue''s partition of the holding: `available` is what the venue would let move now, `held` what it has locked, `total` the whole. Zero is a reading: every amount is a decimal, never null. Rows carry no version — a reading supersedes the last — so there is no `ETag` and no entity route.'
title: AccountBalanceRow
accountBalances_ListAccountBalancesRequestIncludeItem:
type: string
enum:
- total
title: ListAccountBalancesRequestIncludeItem
securitySchemes:
bearerAuth:
type: http
scheme: bearer