Skip to content

Paper-only mode

Every tenant trades paper accounts only today. Live execution is switched off platform-wide; there is no per-tenant switch and no flag to request. Build your integration against venue: "paper" and a paper account.

On every /api/v1/oms/* write, send "venue": "paper". The symbol keeps its venue suffix (BTC.HL, ETH.HL): the suffix says where the price comes from, not where the order executes.

Any other venue is refused before it reaches the OMS:

HTTP/1.1 403
{ "error": "live_accounts_disabled" }

A write aimed at an account your credential cannot act on is a different refusal: 403 { "error": "account_not_owned" }. An operator credential placing an order gets it too: orders need the account’s trader credential.

Call Status
POST /api/v1/oms/intents — market, limit, stop, stop_limit, take_profit Works. A marketable order fills synchronously and the 201 carries state and syncFill.
POST /api/v1/oms/cancel, /cancel-all, /flatten Works.
POST /api/v1/oms/brackets/attach, /attach-to-position Works.
GET /api/v1/accounts/{id}/*, /api/v1/reports/*, /api/v1/analytics/* Works.
/ws/risk pushes and the Get-Position-Update, Get-open-orders, Get-Balance, Get-Margin requests Works.
Cancel-Order-Intent over /ws/risk Works.
Call On paper Do this instead
POST /api/v1/oms/modify 400 {"error":"venue_unsupported","detail":"paper"} Cancel the working order and place a new intent.
Position-Close frame on /ws/risk Result { ok: false, error: "not_implemented" } POST /api/v1/oms/flatten with the symbol.
Get-Risk-Update frame on /ws/risk Result { ok: false, error: "not_implemented" } Get-Margin and Get-Balance, or the Account-State-Update push.
POST /api/v1/oms/leverage Live venues only. Pass leverage on the intent; on paper it margins the position it opens.
Order-Sign-Result, POST /api/v1/oms/intents/{id}/sign-result Never needed: a paper order has nothing to sign. —

There is no separate staging host. Paper accounts on the production API are the test environment — see Sandbox.