Trade Status update

Note: The x-zh-hook-payload-type must be set to trade_status_changed to subscribe to this event type.


Trade status notifications inform clients about the execution of trades. Zero Hash sends updates for every trade status change:

  • active - trade is pending execution.
  • accepted - trade was successfully executed and awaits settlement.
  • terminated - trade was successfully settled; no further status updates will be issued.

The schema of the event payload will closely follow the existing GET /trades/{trade_id} endpoint. Please note, it does not contain every field exposed by the endpoint. These fields will not be relayed in the webhook event:

  • accepted_timestamp
  • defaulted_timestamp
  • settled_timestamp
  • last_update
  • settlement_timestamp
  • expiry_timestamp
  • spread_notional
  • pread_bps
  • session_id
  • payment_processor
  • fees
  • batch_trade_id

Please invoke GET /trades/{trade_id} endpoint to retrieve these additional fields if needed.

This is an example payload of trade_status_changed event:

{
    "client_trade_id": "b3fbcf52-95f9-4624-9309-4f1306bdb176",
    "contract_size": "1",
    "market_identifier_code": "SCXM",
    "origin": "liquidity",
    "parties": [
        {
            "account_label": "general",
            "amount": "10",
            "asset": "USD",
            "participant_code": "PART1",
            "settling": true,
            "side": "sell"
        },
        {
            "account_label": "inventory",
            "amount": "0.0057236",
            "asset": "ETH",
            "participant_code": "00SCXM",
            "settling": true,
            "side": "buy"
        }
    ],
    "parties_anonymous": false,
    "physical_delivery": true,
    "platform_code": "00SCXM",
    "product_type": "spot",
    "quoted_currency": "USD",
    "symbol": "ETH/USD",
    "timestamp": 1745554838289,
    "total_notional": "10.00",
    "trade_id": "26d68f16-f9d2-4ab3-847e-bccf6f03a35e",
    "trade_price": "1747.1521420085261025",
    "trade_quantity": "0.0057236",
    "trade_reporter": "00SCXM",
    "trade_reporter_code": "00SCXM",
    "trade_state": "terminated",
    "trade_type": "regular",
    "transaction_timestamp": 1745554838000,
    "underlying": "ETH"
}