v1

latestOpenAPI 3.1.02026-07-241653251.3 MB

CLOB

Get order executions

Search for order executions on the CLOB matching the given filters. This endpoint returns all the executions for the given filters, and is paginated. Note: This executions means all the events that has been triggered for your orders on the CLOB.

post/orders/v1/search_executions

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[]

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.

client_account_idstring

The client account identifier

client_participant_idstring

The client participant identifier

clord_idstring

The client order ID

end_timestring date-time

The end time for the search

newest_firstboolean

Indicates if the newest executions should be returned first

order_idstring

The order ID

page_sizeinteger

The number of results to return per page

page_tokenstring

The token for the next page of results

parent_order_idstring

The parent order ID

start_timestring date-time

The start time for the search

symbolstring

The symbol to search for

symbol_sub_typestring

The sub-type of the symbol

typesstring[]

Example request

{
  "accounts": [
    "CUST01-label"
  ],
  "user": "firms/F-PLAT01/user/CUST01",
  "client_account_id": "08155fae-7dec-11d0-a765-00a0c91e6bf6",
  "client_participant_id": "981d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "clord_id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "end_time": "2023-01-01T00:00:00Z",
  "newest_first": true,
  "order_id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "page_size": 100,
  "page_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "parent_order_id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "start_time": "2023-01-01T00:00:00Z",
  "symbol": "AAPL",
  "symbol_sub_type": "STK"
}

Response

A successful response.(streaming responses)

eofboolean

next_page_tokenstring

Example response

{
  "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"
    }
  ]
}