Skip to main content
Version: 1.0.2

Public Trader API

Clean domain model:

  • Order = trading instruction
  • Position = open exposure
  • Operational and Trading history via Trading
  • Realtime updates via Server Events
  • Static and semi-static settings via Configuration

General API rules:

Date and time:

  • all date-time values are returned in UTC
  • ISO 8601 format with explicit offset is used, for example: 2026-03-16T12:54:30+00:00

Pagination:

  • cursor is an opaque continuation token
  • cursor must not be parsed or modified by the client
  • when cursor is used, it cannot be combined with filters except limit, unless explicitly stated otherwise

Sorting:

  • historical collections are returned in ascending chronological order, from older to newer, unless explicitly stated otherwise

Monetary values:

  • monetary and volume values are represented as decimal strings to avoid precision loss

Idempotency:

  • mutating trading methods require Idempotency-Key
  • clients should use the same idempotency key when safely retrying the same request
  • if the same Idempotency-Key is reused for the same account, operation kind, and request payload, the duplicate request is accepted with the original operation_id and is not executed again
  • if the same Idempotency-Key is reused for the same account and operation kind with a different request payload, the request is rejected as a duplicate key conflict
  • idempotency records are retained for a limited time; after the retention period expires, the same key may be treated as a new request
  • when Idempotency-Key is provided, it is echoed back as client_request_id in the ACK response, in the corresponding transaction_event, and in the operation status response; this allows correlating events with originating requests without storing the operation_id mapping
  • idempotency key length must be 1..128 characters
  • allowed characters are A-Z, a-z, 0-9, ., _, -, ~

Async trading operations:

  • mutating trading methods return ACK with operation_id
  • final execution result is delivered through Server Events
  • clients should use operation_id or client_request_id to correlate REST requests with operation and transaction events

Current state vs history:

  • current trading state is available through Trading Snapshot and Server Events
  • historical closed orders and deals are available through Trading History
  • open orders and open positions are not returned by Trading History

Authentication

Authorization header format: Authorization: <schema> <payload>

Example: Authorization: Bearer <token>

Security Scheme Type:

apiKey

Header parameter name:

Authorization