Headers

• PRE-ACCESS-KEY string Required

  Broker access key identifier.

  Format should match the following pattern: ^[A-Za-z0-9._~-]{1,64}$.

• PRE-ACCESS-SIGNATURE string Required

  Keyed BLAKE2b-256 signature (hex lowercase, 64 characters).

  Format should match the following pattern: ^[0-9a-f]{64}$.

• PRE-ACCESS-TIMESTAMP string(date-time) Required

  RFC3339 timestamp with milliseconds (e.g., 2025-10-30T06:00:34.075Z). Must be within clock_skew_tolerance (default 5m) of server time.

Path parameters

• account_id string Required

  Broker-supplied account identifier; length 1..128; charset [A-Za-z0-9._~-].

  Maximum length is 128. Format should match the following pattern: ^[A-Za-z0-9._~-]{1,128}$.

• order_id string(uuid) Required

Responses

• 200 application/json

  Order view

  Hide response attributes Show response attributes object

  • order_id string(uuid) Required
  • client_order_id string Required
  • market_id string Required
  • broker_id string Required
  • account_id string Required
  • side string Required

    Values are BUY or SELL.

  • type string Required

    Values are LIMIT or MARKET.

  • tif string Required

    Values are GTC, IOC, FOK, or DAY.

  • token string Required

    Values are YES or NO.

  • price object Required
    Hide price attributes Show price attributes object

    • units integer(int64) Required
    • nanos integer(int32) Required

      Minimum value is -999999999, maximum value is 999999999.

  • qty object Required
    Hide qty attributes Show qty attributes object

    • units integer(int64) Required
    • nanos integer(int32) Required

      Minimum value is -999999999, maximum value is 999999999.

  • volume object Required
    Hide volume attributes Show volume attributes object

    • units integer(int64) Required
    • nanos integer(int32) Required

      Minimum value is -999999999, maximum value is 999999999.

  • filled_qty object Required
    Hide filled_qty attributes Show filled_qty attributes object

    • units integer(int64) Required
    • nanos integer(int32) Required

      Minimum value is -999999999, maximum value is 999999999.

  • filled_volume object Required
    Hide filled_volume attributes Show filled_volume attributes object

    • units integer(int64) Required
    • nanos integer(int32) Required

      Minimum value is -999999999, maximum value is 999999999.

  • filled_fee object

    Total filled fees accumulated on this order (in quote currency units).

    Hide filled_fee attributes Show filled_fee attributes object

    • units integer(int64) Required
    • nanos integer(int32) Required

      Minimum value is -999999999, maximum value is 999999999.

  • status string Required

    Values are NEW, ACTIVE, PARTIALLY_FILLED, FILLED, CANCELLED, EXPIRED, or REJECTED.

  • status_reason string

    Machine-readable reason code for the current status

    Values are USER_REQUEST, MARKET_CLOSED, MARKET_SETTLED, MARKET_VOIDED, TIF_EXPIRATION, FOK_FAILED, IOC_PARTIAL, SELF_TRADE_PREVENTION, INSUFFICIENT_FUNDS, SYSTEM_ERROR, ORDER_ALREADY_FILLED, ORDER_ALREADY_CANCELLED, ORDER_NOT_FOUND, QTY_INVALID, QTY_BELOW_EXECUTED, NO_MATCHING_LIQUIDITY, DUPLICATE_CLIENT_ORDER_ID, EXCEEDS_MAX_ORDER_QTY, EXCEEDS_MAX_ORDER_NOTIONAL, or EXCEEDS_MAX_POSITION.

  • last_update_wall_time_ns integer(int64) Required
  • last_update_engine_seq integer(int64) Required

    Monotonic engine sequence number of the last applied change

  • last_cmd_id_hex string

    32 lowercase hex

• 404 application/json

  Resource not found

  Hide response attributes Show response attributes object

  • error_code string Required
  • message string Required
  • details object

    Additional properties are allowed.

• 503 application/json

  Backpressure / temporary unavailability

  Hide response attributes Show response attributes object

  • error_code string Required
  • message string Required
  • details object

    Additional properties are allowed.