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

# REST API

## Docs

- [Overview](https://docs.immix.xyz/trading/api-reference/rest-api/overview.md): The REST API for an organisation on Immix: its users, venue credentials and accounts, the balances those accounts hold at their venues, addresses, portfolios and policies, the orders it places, and the algo instances it runs.

## API Docs

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