> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.immix.xyz/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.immix.xyz/_mcp/server.

# Overview

**Base URL** — No public environment serves this API yet.

* **Authentication** — a bearer token from your identity provider. Your organisation and your user are taken from the token: no request carries an `orgId` or a `userId`.
* **Reads** serve the platform's current state: every row carries the position it was read at (`X-Immix-Global-Sequence`) and an entity its version (`ETag`).
* **Writes** take an `Idempotency-Key`; entity writes take `If-Match`; a write not answered within the deadline returns `202` and is polled on `/operations/{key}`.
* **Money** is a decimal string, in and out; ids are opaque integers, unique per resource.

The [API guide](/guides/rest-api-guide) explains each of these in full — authentication and admission, maker-checker, idempotency and preconditions, money and sentinels, errors — and the [changelog](/changelog/rest-api) lists every change to this document.

## Resources

### Organisation

| Resource          | Description                                                                                                                               |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Users             | Members of the organisation, and your own row.                                                                                            |
| Credentials       | Venue API keys: created as proposals, approved under maker-checker, rotated and revoked. The key material is taken once and never served. |
| Accounts          | Venue accounts discovered through a credential: classified into a portfolio, approved, frozen, retired.                                   |
| Portfolios        | How the organisation groups its accounts.                                                                                                 |
| Account addresses | Deposit and withdrawal addresses declared on an account and verified by a second user.                                                    |

### Risk

| Resource         | Description                                                                  |
| ---------------- | ---------------------------------------------------------------------------- |
| Trading policies | Per-instrument and organisation-wide order limits, and the trading halt.     |
| Asset policies   | Per-asset limits: ticket size, approval threshold, reconciliation tolerance. |
| Chain policies   | Per-chain transfer limits.                                                   |

### Trading

| Resource         | Description                                                                                                                                                                                                                               |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Orders           | Submit, read and cancel orders.                                                                                                                                                                                                           |
| Executions       | Fills, joined to their order by `orderId`.                                                                                                                                                                                                |
| Account balances | 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.                                             |
| Algos            | The organisation's algo instances: created with a config document, started and stopped, re-configured while they run, halted all at once; the documents' history, the orders an instance placed, and the catalog of loaded algo versions. |

### Reference data

| Resource    | Description                                                                       |
| ----------- | --------------------------------------------------------------------------------- |
| Venues      | The trading venues IMMIX connects to.                                             |
| Instruments | The markets IMMIX serves, on every venue: search, filters, facets and statistics. |
| Assets      | The coins, tokens, fiat currencies and indexes that instruments are made of.      |

### Operations

The outcome of a write that answered `202`.