Skip to main content

Accounts, scopes & IDs

A few identifiers and concepts show up across the whole API. This page clears them up so the rest of the docs read smoothly.

account_id vs session_id

IDWhat it is
account_idThe trading account — the thing that holds balance, positions and orders. You log in as an account.
session_idOne logged-in device/session for that account. A single account can have several live sessions (multi-device). The WebSocket handshake authenticates with session_id.

When an endpoint path contains /accounts/me, it operates on the account your token belongs to. When it contains /accounts/{account_id}, it operates on another account and requires a Dealer/Admin token.

Scopes (roles)

The scope returned at login decides what your token can do:

ScopeCan do
TraderFull read/write on its own account (/accounts/me, place/close orders).
InvestorRead-only view of one account (logged in with the investor password). No order/position changes.
DealerManage the accounts in the groups they own.
AdminFull broker administration — every account, group, symbol.
API_Trader / API_AdminProgrammatic equivalents for server-to-server integrations.

Order ID vs Position ID

A common point of confusion (same as on other platforms):

  • An order is an instruction (market or pending). It has an order_id. A market order executes immediately; a pending order waits for its trigger price.
  • A position is an open trade that resulted from a filled order. It has a position_id, its own floating P/L, and is what you later modify or close.

So you place an order, and once it fills you manage a position. Cancelling a pending order (before it triggers) is different from closing a position (after it's open).

The /me endpoints

Most trader integrations only need the /me family — they always act on the token's own account, so you never pass an account_id:

  • GET /api/v1/accounts/me — balance, equity, margin, leverage.
  • GET /api/v1/positions/accounts/me — open positions.
  • GET /api/v1/orders/accounts/me — pending orders.
  • POST /api/v1/orders/accounts/me — place an order.
  • GET /api/v1/symbols/me — the instruments your account can trade.

See Errors & status codes next, then jump into the Recipes.