Skip to navigation
REST API

Overview

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.

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 explains each of these in full — authentication and admission, maker-checker, idempotency and preconditions, money and sentinels, errors — and the changelog lists every change to this document.

Resources

Organisation

ResourceDescription
UsersMembers of the organisation, and your own row.
CredentialsVenue API keys: created as proposals, approved under maker-checker, rotated and revoked. The key material is taken once and never served.
AccountsVenue accounts discovered through a credential: classified into a portfolio, approved, frozen, retired.
PortfoliosHow the organisation groups its accounts.
Account addressesDeposit and withdrawal addresses declared on an account and verified by a second user.

Risk

ResourceDescription
Trading policiesPer-instrument and organisation-wide order limits, and the trading halt.
Asset policiesPer-asset limits: ticket size, approval threshold, reconciliation tolerance.
Chain policiesPer-chain transfer limits.

Trading

ResourceDescription
OrdersSubmit, read and cancel orders.
ExecutionsFills, joined to their order by orderId.
Account balancesWhat 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.
AlgosThe 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

ResourceDescription
VenuesThe trading venues IMMIX connects to.
InstrumentsThe markets IMMIX serves, on every venue: search, filters, facets and statistics.
AssetsThe coins, tokens, fiat currencies and indexes that instruments are made of.

Operations

The outcome of a write that answered 202.