# Immix API

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.immix.xyz/_mcp/server

## Docs

- [Welcome](https://docs.immix.xyz/guides/welcome.md): The Immix v3 API — market data over WebSocket; an organisation's users, custody and orders over REST
- [Quickstart](https://docs.immix.xyz/guides/quickstart.md): Stream trades from the market-data socket
- [Authentication](https://docs.immix.xyz/guides/authentication.md): One bearer token for both APIs — and the platform decides what it may do
- [Concepts](https://docs.immix.xyz/guides/concepts.md): The ideas the API is built on, each linked to its full rules
- [REST API guide](https://docs.immix.xyz/guides/rest-api-guide.md): The long form of the REST API's rules: authentication, reads and writes, maker-checker, money, errors, orders
- [Reference data guide](https://docs.immix.xyz/guides/reference-data-guide.md): How the reference data endpoints page, filter and sort, spell symbols, report freshness and answer errors
- [Overview](https://docs.immix.xyz/api-reference/market-data/overview.md): Client-facing market data distribution: OKX trades, L2 books with the syncing/stale contract, and top-of-book — raw or conflated per tier.
- [Trades](https://docs.immix.xyz/api-reference/market-data/trades.md): Per-print lane; the raw form streams every print, one frame each.
- [Top of book](https://docs.immix.xyz/api-reference/market-data/top-of-book.md): Best bid/offer images, latest-wins.
- [Ticker](https://docs.immix.xyz/api-reference/market-data/ticker.md): Last price plus derived trailing 1h/24h statistics off the rolling-stats fold — the latest-image lane: subscribing pushes the current image immediately when the instrument has ever traded (a never-traded instrument acks live and its first image arrives with its first trade), updates re-render on trades (conflated per tier) and once per elapsed stream minute — the decay edge for quiet instruments; an active topic just gets one extra image at the edge — so on-screen windows decay with the stream's consumed event-time frontier — never wall clock: under catch-up tickers slide at replay speed, a stalled stream halts decay and fires the frontier-lag alarm. seq/seqTs are fact provenance (the last trade folded — unchanged on decay re-renders); asOf is the frontier at render and advancing alone marks a frame as decay, not data.
- [Candlesticks](https://docs.immix.xyz/api-reference/market-data/candlesticks.md): Candlestick bars folded from sequenced trades: identical, bar for bar, to the candle history the ClickHouse cascade serves — one event-time axis, one set of bucket rules.
- [Index price](https://docs.immix.xyz/api-reference/market-data/index-price.md): The internal index price, PAIR-addressed — a bare BASE/QUOTE with no @, e.g. index.BTC/USDT — the venue-less datum the indexprice domain computes and owns (methodology, contribution count and freshest source time ride every event; an operator override shows methodology "override" with contributions 0).
- [Mark price](https://docs.immix.xyz/api-reference/market-data/mark-price.md): Exchange mark-price images, latest-wins (the tob pattern).
- [Funding rate](https://docs.immix.xyz/api-reference/market-data/funding-rate.md): Funding readouts for perpetual/dated swaps, latest-wins, carrying the full template surface — current rate and boundary, interval, predicted next rate, settled rate, exchange bounds, premium and interest-rate components, collection method and settlement state.
- [Open interest](https://docs.immix.xyz/api-reference/market-data/open-interest.md): Open-interest readings, latest-wins, in the instrument's native size unit (contracts for contract-sized instruments — notional conversion is the consumer's join through the instrument record).
- [Order book](https://docs.immix.xyz/api-reference/market-data/order-book.md): L2 books under the sync contract.
- [Aggregated book](https://docs.immix.xyz/api-reference/market-data/aggregated-book.md): Client-configured aggregated multi-exchange books, computed merge-on-read over the gateway's book folds and conflated at the topic's mandatory tier (composites have no raw lane).
- [Volume ladder](https://docs.immix.xyz/api-reference/market-data/volume-ladder.md): Client-configured volume ladders — cumulative-quantity buckets priced from the same merge the agg_book channel renders, over the same source vocabulary (margins and MID normalisation included), conflated at the topic's mandatory tier.
- [Venue health](https://docs.immix.xyz/api-reference/market-data/venue-health.md): The ops lane, symbol-less and tier-less, at the exchange altitude: one entry per exchange with any market-data presence, each carrying a connectivity rollup, the per-feed staleness census (classified lazily at the proven 10x/20x-of-rolling-mean thresholds against stream time), and the books sync-state counts — re-rendered every health interval while subscribed.
- [Overview](https://docs.immix.xyz/api-reference/trading/overview.md): One WebSocket session on which an organization's principals watch their trading state.
- [Place order](https://docs.immix.xyz/api-reference/trading/place-order.md): A success is an offer, not an acceptance: it says the command reached the stream.
- [Cancel order](https://docs.immix.xyz/api-reference/trading/cancel-order.md): Name the order by orderId or by clientOrderId, exactly one.
- [Orders](https://docs.immix.xyz/api-reference/trading/orders.md): An order's applied image (msgType orderUpdate)
- [Executions](https://docs.immix.xyz/api-reference/trading/executions.md): A fill
- [Account balances](https://docs.immix.xyz/api-reference/trading/account-balances.md): A pool's latest readout
- [Accounts](https://docs.immix.xyz/api-reference/trading/accounts.md): An account row
- [Credentials](https://docs.immix.xyz/api-reference/trading/credentials.md): A venue credential and its observed health
- [Venue capabilities](https://docs.immix.xyz/api-reference/trading/venue-capabilities.md): What a venue accepts
- [Python SDK](https://docs.immix.xyz/sdk/python.md): Private preview — both APIs from Python
- [Changelog](https://docs.immix.xyz/changelog/overview.md): The version of each API this portal documents, and what changed
- [REST API changelog](https://docs.immix.xyz/changelog/rest-api.md)
- [Market Data WebSocket changelog](https://docs.immix.xyz/changelog/market-data.md)
- [Trading WebSocket changelog](https://docs.immix.xyz/changelog/trading.md)

## API Docs

- REST API > Organisation > Users [List users](https://docs.immix.xyz/api-reference/rest-api/users/list.md)
- REST API > Organisation > Users [Create a user](https://docs.immix.xyz/api-reference/rest-api/users/create.md)
- REST API > Organisation > Users [Get a user](https://docs.immix.xyz/api-reference/rest-api/users/get.md)
- REST API > Organisation > Users [Update a user](https://docs.immix.xyz/api-reference/rest-api/users/update.md)
- REST API > Organisation > Users [Disable a user](https://docs.immix.xyz/api-reference/rest-api/users/disable.md)
- REST API > Organisation > Users [Get the authenticated user](https://docs.immix.xyz/api-reference/rest-api/users/get-me.md)
- REST API > Organisation > Credentials [List credentials](https://docs.immix.xyz/api-reference/rest-api/credentials/list.md)
- REST API > Organisation > Credentials [Create a credential](https://docs.immix.xyz/api-reference/rest-api/credentials/create.md)
- REST API > Organisation > Credentials [Get a credential](https://docs.immix.xyz/api-reference/rest-api/credentials/get.md)
- REST API > Organisation > Credentials [Update a credential](https://docs.immix.xyz/api-reference/rest-api/credentials/update.md)
- REST API > Organisation > Credentials [Approve a credential](https://docs.immix.xyz/api-reference/rest-api/credentials/approve.md)
- REST API > Organisation > Credentials [Suspend a credential](https://docs.immix.xyz/api-reference/rest-api/credentials/suspend.md)
- REST API > Organisation > Credentials [Reactivate a credential](https://docs.immix.xyz/api-reference/rest-api/credentials/reactivate.md)
- REST API > Organisation > Credentials [Revoke a credential](https://docs.immix.xyz/api-reference/rest-api/credentials/revoke.md)
- REST API > Organisation > Credentials [Rotate a credential's key](https://docs.immix.xyz/api-reference/rest-api/credentials/rotate.md)
- REST API > Organisation > Credentials [Withdraw a credential proposal](https://docs.immix.xyz/api-reference/rest-api/credentials/withdraw.md)
- REST API > Organisation > Accounts [List accounts](https://docs.immix.xyz/api-reference/rest-api/accounts/list.md)
- REST API > Organisation > Accounts [Get an account](https://docs.immix.xyz/api-reference/rest-api/accounts/get.md)
- REST API > Organisation > Accounts [Classify an account](https://docs.immix.xyz/api-reference/rest-api/accounts/classify.md)
- REST API > Organisation > Accounts [Approve an account](https://docs.immix.xyz/api-reference/rest-api/accounts/approve.md)
- REST API > Organisation > Accounts [Freeze an account](https://docs.immix.xyz/api-reference/rest-api/accounts/freeze.md)
- REST API > Organisation > Accounts [Unfreeze an account](https://docs.immix.xyz/api-reference/rest-api/accounts/unfreeze.md)
- REST API > Organisation > Accounts [Retire an account](https://docs.immix.xyz/api-reference/rest-api/accounts/retire.md)
- REST API > Organisation > Accounts [Withdraw an account proposal](https://docs.immix.xyz/api-reference/rest-api/accounts/withdraw.md)
- REST API > Organisation > Portfolios [List portfolios](https://docs.immix.xyz/api-reference/rest-api/portfolios/list.md)
- REST API > Organisation > Portfolios [Create a portfolio](https://docs.immix.xyz/api-reference/rest-api/portfolios/create.md)
- REST API > Organisation > Portfolios [Get a portfolio](https://docs.immix.xyz/api-reference/rest-api/portfolios/get.md)
- REST API > Organisation > Portfolios [Update a portfolio](https://docs.immix.xyz/api-reference/rest-api/portfolios/update.md)
- REST API > Organisation > Portfolios [Retire a portfolio](https://docs.immix.xyz/api-reference/rest-api/portfolios/retire.md)
- REST API > Organisation > Account addresses [List account addresses](https://docs.immix.xyz/api-reference/rest-api/account-addresses/list.md)
- REST API > Organisation > Account addresses [Declare an account address](https://docs.immix.xyz/api-reference/rest-api/account-addresses/create.md)
- REST API > Organisation > Account addresses [Get an account address](https://docs.immix.xyz/api-reference/rest-api/account-addresses/get.md)
- REST API > Organisation > Account addresses [Verify an account address](https://docs.immix.xyz/api-reference/rest-api/account-addresses/verify.md)
- REST API > Organisation > Account addresses [Retire an account address](https://docs.immix.xyz/api-reference/rest-api/account-addresses/retire.md)
- REST API > Risk > Trading policies [List trading policies](https://docs.immix.xyz/api-reference/rest-api/trading-policies/list.md)
- REST API > Risk > Trading policies [Create a trading policy](https://docs.immix.xyz/api-reference/rest-api/trading-policies/create.md)
- REST API > Risk > Trading policies [Get a trading policy](https://docs.immix.xyz/api-reference/rest-api/trading-policies/get.md)
- REST API > Risk > Trading policies [Update a trading policy](https://docs.immix.xyz/api-reference/rest-api/trading-policies/update.md)
- REST API > Risk > Trading policies [Approve a trading policy](https://docs.immix.xyz/api-reference/rest-api/trading-policies/approve.md)
- REST API > Risk > Trading policies [Retire a trading policy](https://docs.immix.xyz/api-reference/rest-api/trading-policies/retire.md)
- REST API > Risk > Trading policies [Withdraw a trading policy proposal](https://docs.immix.xyz/api-reference/rest-api/trading-policies/withdraw.md)
- REST API > Risk > Trading policies [Halt trading under a policy](https://docs.immix.xyz/api-reference/rest-api/trading-policies/halt.md)
- REST API > Risk > Trading policies [Resume trading under a policy](https://docs.immix.xyz/api-reference/rest-api/trading-policies/resume.md)
- REST API > Risk > Asset policies [List asset policies](https://docs.immix.xyz/api-reference/rest-api/asset-policies/list.md)
- REST API > Risk > Asset policies [Create an asset policy](https://docs.immix.xyz/api-reference/rest-api/asset-policies/create.md)
- REST API > Risk > Asset policies [Get an asset policy](https://docs.immix.xyz/api-reference/rest-api/asset-policies/get.md)
- REST API > Risk > Asset policies [Update an asset policy](https://docs.immix.xyz/api-reference/rest-api/asset-policies/update.md)
- REST API > Risk > Asset policies [Approve an asset policy](https://docs.immix.xyz/api-reference/rest-api/asset-policies/approve.md)
- REST API > Risk > Asset policies [Retire an asset policy](https://docs.immix.xyz/api-reference/rest-api/asset-policies/retire.md)
- REST API > Risk > Asset policies [Withdraw an asset policy proposal](https://docs.immix.xyz/api-reference/rest-api/asset-policies/withdraw.md)
- REST API > Risk > Chain policies [List chain policies](https://docs.immix.xyz/api-reference/rest-api/chain-policies/list.md)
- REST API > Risk > Chain policies [Create a chain policy](https://docs.immix.xyz/api-reference/rest-api/chain-policies/create.md)
- REST API > Risk > Chain policies [Get a chain policy](https://docs.immix.xyz/api-reference/rest-api/chain-policies/get.md)
- REST API > Risk > Chain policies [Update a chain policy](https://docs.immix.xyz/api-reference/rest-api/chain-policies/update.md)
- REST API > Risk > Chain policies [Approve a chain policy](https://docs.immix.xyz/api-reference/rest-api/chain-policies/approve.md)
- REST API > Risk > Chain policies [Retire a chain policy](https://docs.immix.xyz/api-reference/rest-api/chain-policies/retire.md)
- REST API > Risk > Chain policies [Withdraw a chain policy proposal](https://docs.immix.xyz/api-reference/rest-api/chain-policies/withdraw.md)
- REST API > Trading > Orders [List orders](https://docs.immix.xyz/api-reference/rest-api/orders/list.md)
- REST API > Trading > Orders [Submit an order](https://docs.immix.xyz/api-reference/rest-api/orders/submit.md)
- REST API > Trading > Orders [Get an order](https://docs.immix.xyz/api-reference/rest-api/orders/get.md)
- REST API > Trading > Orders [Cancel an order](https://docs.immix.xyz/api-reference/rest-api/orders/cancel.md)
- REST API > Trading > Executions [List executions](https://docs.immix.xyz/api-reference/rest-api/executions/list.md)
- REST API > Trading > Executions [Get an execution](https://docs.immix.xyz/api-reference/rest-api/executions/get.md)
- REST API > Trading > Account balances [List account balances](https://docs.immix.xyz/api-reference/rest-api/account-balances/list.md)
- REST API > Reference data > Venues [List venues](https://docs.immix.xyz/api-reference/rest-api/venues/list.md)
- REST API > Reference data > Venues [Get a venue](https://docs.immix.xyz/api-reference/rest-api/venues/get.md)
- REST API > Reference data > Instruments [Search and list instruments](https://docs.immix.xyz/api-reference/rest-api/instruments/list.md)
- REST API > Reference data > Instruments [Get an instrument](https://docs.immix.xyz/api-reference/rest-api/instruments/get.md)
- REST API > Reference data > Assets [List assets](https://docs.immix.xyz/api-reference/rest-api/assets/list.md)
- REST API > Reference data > Assets [Get an asset](https://docs.immix.xyz/api-reference/rest-api/assets/get.md)
- REST API > Operations [Get an operation](https://docs.immix.xyz/api-reference/rest-api/operations/get.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.immix.xyz/openapi.json)
- [OpenAPI YAML](https://docs.immix.xyz/openapi.yaml)