Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
CLOB

Create order subscription

Create a subscription to receive updates on working orders.

post/orders/v1/create_order_subscription

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Request body

accountsstring[]

The list of account IDs to subscribe to order updates for on working orders.

user'firms/F-{platform_code}/users/{participant_code}' | 'firms/F-{platform_code}/users/{account_label}' | 'firms/{zerohash}/users/{platform_code}'

Fully-qualified user. Format: firms/F-{platform_code}/users/{participant_code}. This value is case sensitive.

Clearing House Designations

  • USA: 00SXCM (ZH Clearing House)
  • EU: ZHDSEU

Prefunded Model

  • USD balances are ledgered directly to the participants on their CLOB account.
    • Participants will be credit checked against their available balance on the zerohash platform.
  • Accounts must be registed with the prefunded field as true on the POST /accounts endpoint.
  • Trade settlement is handled directly between participants and occurs instantly upon execution.

Novated Model

  • Utilizes a central float account to manage the cumulative buying power of your customers.
    • USD balance is ledgeder to the platforms float account.
    • USD credit checks must be performed by the platform prior to order placement.
  • Accounts must be registed with the prefunded field as false on the POST /accounts endpoint.
  • Allows platforms to manage the buying power of their customers effectively, allowing for better operational efficiency.
subscription_idstring

The identifier of the subscription

Example request

{
  "user": "firms/F-PLAT01/user/CUST01",
  "subscription_id": "subscription-id"
}

Response

A successful response.(streaming responses)

Example response

{
  "result": {
    "session_id": "session-id",
    "snapshot": {
      "orders": [
        {
          "id": "51H5D2K2A00M",
          "type": "ORDER_TYPE_LIMIT",
          "side": "SIDE_BUY",
          "order_qty": "200000",
          "symbol": "ETH/USD",
          "clord_id": "1245567889",
          "time_in_force": "TIME_IN_FORCE_GOOD_TILL_CANCEL",
          "account": "firms/F-PLAT01/accounts/CUST01-customlabel",
          "user": "firms/F-PLAT01/user/CUST01",
          "cum_qty": "0",
          "avg_px": "0",
          "leaves_qty": "200000",
          "state": "ORDER_STATE_NEW",
          "participant": "firms/F-PLAT01/users/CUST01",
          "price": "420000",
          "insert_time": "2025-09-11T18:07:22.155905574Z",
          "stop_price": "0",
          "min_qty": "0",
          "create_time": "2025-09-11T18:07:22.152425620Z",
          "commissions_basis_points": "40",
          "cash_order_qty": "0",
          "risk_check_time": "2025-09-11T18:07:22.155871055Z",
          "collateral_memo": "Fully Collateralized",
          "priority_weight": "0",
          "good_till_time": "2025-09-12T18:07:22.155905574Z",
          "context": {
            "fix_context": {
              "begin_string": "FIXT.1.1",
              "target_comp_id": "C-F-PLAT01-1",
              "sender_comp_id": "ZERO",
              "orig_clord_id": "1f19d5e1-344b-4aac-b737-a467be69e4fe",
              "target_sub_id": "1f19d5e1-344b-4aac-b737-a467be69e4fe",
              "target_location_id": "1f19d5e1-344b-4aac-b737-a467be69e4fe",
              "sender_sub_id": "CUST01"
            },
            "validation_contexts": []
          },
          "last_trade_id": "1f19d5e1-344b-4aac-b737-a467be69e4fe",
          "trigger_method": "CONDITION_TRIGGER_METHOD_UNDEFINED",
          "price_to_quantity_filled": {},
          "commission_notional_total_collected": "10",
          "self_match_prevention_instruction": "SELF_MATCH_PREVENTION_INSTRUCTION_UNDEFINED",
          "order_capacity": "ORDER_CAPACITY_INDIVIDUAL",
          "last_transact_time": "2025-09-11T18:07:22.155905574Z",
          "price_scale": "100",
          "fractional_quantity_scale": "100000000",
          "maker_commissions_basis_points": "0",
          "manual_order_indicator": "MANUAL_ORDER_INDICATOR_MANUAL"
        }
      ]
    },
    "update": {
      "executions": [
        {
          "aggressor": true,
          "commission_notional_collected": "100.00",
          "id": "90VSYQ3YJ076",
          "last_px": "100.00",
          "last_shares": "10",
          "leg_prices": [
            {
              "px": "100.00",
              "qty": "10",
              "reference_px": "100.00",
              "side": "SIDE_BUY",
              "symbol": "BTC/USD"
            }
          ],
          "order": {
            "id": "51H5D2K2A00M",
            "type": "ORDER_TYPE_LIMIT",
            "side": "SIDE_BUY",
            "order_qty": "200000",
            "symbol": "ETH/USD",
            "clord_id": "1245567889",
            "time_in_force": "TIME_IN_FORCE_GOOD_TILL_CANCEL",
            "account": "firms/F-PLAT01/accounts/CUST01-customlabel",
            "user": "firms/F-PLAT01/user/CUST01",
            "cum_qty": "0",
            "avg_px": "0",
            "leaves_qty": "200000",
            "state": "ORDER_STATE_NEW",
            "participant": "firms/F-PLAT01/users/CUST01",
            "price": "420000",
            "insert_time": "2025-09-11T18:07:22.155905574Z",
            "stop_price": "0",
            "min_qty": "0",
            "create_time": "2025-09-11T18:07:22.152425620Z",
            "commissions_basis_points": "40",
            "cash_order_qty": "0",
            "risk_check_time": "2025-09-11T18:07:22.155871055Z",
            "collateral_memo": "Fully Collateralized",
            "priority_weight": "0",
            "good_till_time": "2025-09-12T18:07:22.155905574Z",
            "context": {
              "fix_context": {
                "begin_string": "FIXT.1.1",
                "target_comp_id": "C-F-PLAT01-1",
                "sender_comp_id": "ZERO",
                "orig_clord_id": "1f19d5e1-344b-4aac-b737-a467be69e4fe",
                "target_sub_id": "1f19d5e1-344b-4aac-b737-a467be69e4fe",
                "target_location_id": "1f19d5e1-344b-4aac-b737-a467be69e4fe",
                "sender_sub_id": "CUST01"
              },
              "validation_contexts": []
            },
            "last_trade_id": "1f19d5e1-344b-4aac-b737-a467be69e4fe",
            "trigger_method": "CONDITION_TRIGGER_METHOD_UNDEFINED",
            "price_to_quantity_filled": {},
            "commission_notional_total_collected": "10",
            "self_match_prevention_instruction": "SELF_MATCH_PREVENTION_INSTRUCTION_UNDEFINED",
            "order_capacity": "ORDER_CAPACITY_INDIVIDUAL",
            "last_transact_time": "2025-09-11T18:07:22.155905574Z",
            "price_scale": "100",
            "fractional_quantity_scale": "100000000",
            "maker_commissions_basis_points": "0",
            "manual_order_indicator": "MANUAL_ORDER_INDICATOR_MANUAL"
          },
          "order_reject_reason": "ORDER_REJECT_REASON_UNDEFINED",
          "transact_time": "2025-09-11T18:07:22.155905574Z",
          "type": "EXECUTION_TYPE_NEW",
          "unsolicited_cancel_reason": "UNSOLICITED_CXL_REASON_CONNECTION_LOSS"
        }
      ]
    }
  }
}