v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Trades

Get trades

Returns trade details where the requestor is the Platform, either party associated with the trade, or the account group where the trade was settled. For the party information, the asset is the settlement currency (i.e asset RECEIVED). This means in the second you are receiving USD correctly, 00SCXM is receiving BTC. The "sell" side receives the quoted currency, the "buy" side receives the underlying. Our trade structure mirrors a typical back office trade report (FIX TradeCaptureReport) and we use the concept of settlement currency for the sides to help keep our system agnostic of symbol definitions. Results are limited to the last 2 months

get/trades

Query parameters

account_labelstring
Example:general

Filter by account label (e.g., general, sub_account_test). Account labels are used to categorize accounts under a participant. Each participant account_label maintains a separate balance and transaction history.

pagenumber
Example:1

Page number for pagination (starts at 1).

market_identifier_codestring

Filters for trades within a designated market_identifier_code.

omit_market_identifier_codestring

Filters for trades excluding those from a particular market_identifier_code.

platform_codestring

Filters for trades based on the specific platform_code where the trade execution took place.

omit_platform_codestring

Filters for trades based excluding those from a particular platform_code.

trade_state'accepted' | 'active' | 'terminated'

Filters for trades based on their current trade_state.

settlement_state'null' | 'obligations_outstanding' | 'current_obligations_met' | 'settled' | 'defaulted' | 'counterparty_defaulted'

Filters for trades based on their current settlement_state.

party_codestring

Filters for trades where the provided party_code is at least one of the counterparties to a trade in the parties array.

transaction_timestamp[gt]number

Filters for trades with a timestamp greater than the provided value, which can be defined in milliseconds or nanoseconds.

transaction_timestamp[gte]number

Filters for trades with a timestamp greater than or equal to the provided value, which can be defined in milliseconds or nanoseconds.

transaction_timestamp[e]number

Filters for trades with a timestamp equal to the provided value, which can be defined in milliseconds or nanoseconds.

transaction_timestamp[lt]number

Filters for trades with a timestamp less than the provided value, which can be defined in milliseconds or nanoseconds.

transaction_timestamp[lte]number

Filters for trades with a timestamp less than or equal to the provided value, which can be defined in milliseconds or nanoseconds.

client_trade_idstring

Filters for trades with the provided client_trade_id value. Note:

  • Platforms integrated to the zerohash RFQ systems, the quote_id from the RFQ will be saved as the client_trade_id once the quote has been executed.
  • Platforms integrated to the zerohash CLOB, the execution_id from the order trade execution will be saved as the client_trade_id on the resulting trade.
execution_idstring

Filters for trades with the provided execution_id in either party's execution_id field.

reporting_partystring

Filters for trades based on the reporting_party associated with each trade.

settlement_schedulestring

Filters for trades based on the settlement_schedule associated with each trade.

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.

Response

Successfully retrieved paginated list of trades with optional filters: participant_code, asset, underlying, account_label, market_identifier_code, platform_code, trade_state, settlement_state, party_code, transaction_timestamp, client_trade_id, execution_id, reporting_party, settlement_schedule.

pagenumber
page_sizenumber
total_pagesnumber
countnumber

Example response

{
  "message": [
    {
      "batch_trade_id": null,
      "trade_id": "78260d47-336e-4253-b800-d528894253b2",
      "client_trade_id": "40b402b0-22ad-4d67-ae8c-7964be34ee29",
      "trade_state": "terminated",
      "market_identifier_code": "SCXM",
      "trade_reporter_code": "00SCXM",
      "symbol": "BTC/USD",
      "trade_quantity": "0.00059241",
      "trade_price": "81531.3718539524991138",
      "trade_type": "regular",
      "physical_delivery": true,
      "comment": "",
      "last_update": 1778771702391,
      "transaction_timestamp": 1778771677000,
      "accepted_timestamp": 1778771677972,
      "defaulted_timestamp": null,
      "settled_timestamp": 1778771702360,
      "expiry_timestamp": null,
      "settlement_timestamp": null,
      "settlement_price_index_id": null,
      "contract_size": 1,
      "underlying": "BTC",
      "quoted_currency": "USD",
      "trade_reporter": "00SCXM",
      "platform_code": "00SCXM",
      "product_type": "spot",
      "parties_anonymous": false,
      "bank_fee": null,
      "reporting_party": "00SCXM",
      "settlement_schedule": null,
      "parties": [
        {
          "settling": true,
          "participant_code": "DL1BXT",
          "side": "buy",
          "asset": "BTC",
          "amount": "0.00059241",
          "liquidity_indicator": null,
          "execution_id": "",
          "order_id": "",
          "obligations_outstanding_timestamp": null,
          "current_obligations_met_timestamp": null,
          "settlement_state": "settled",
          "client_order_id": "",
          "collateral_percentage": null,
          "account_label": "general",
          "account_profile": null,
          "trader": null,
          "zrn": null,
          "manual_order_indicator": null
        },
        {
          "settling": true,
          "participant_code": "00SCXM",
          "side": "sell",
          "asset": "USD",
          "amount": "48.3",
          "liquidity_indicator": null,
          "execution_id": "",
          "order_id": "",
          "obligations_outstanding_timestamp": null,
          "current_obligations_met_timestamp": null,
          "settlement_state": "settled",
          "client_order_id": "",
          "collateral_percentage": null,
          "account_label": "inventory",
          "account_profile": null,
          "trader": null,
          "zrn": null,
          "manual_order_indicator": null
        }
      ],
      "session_id": "20260514151438",
      "fees": [
        {
          "name": "LiquidityFee",
          "amount": "1.7"
        }
      ],
      "issuer_fee_rate": "0",
      "issuer_fee_amount": "0",
      "issuer_fee_payor_type": null,
      "payment_processor": null,
      "network_fee_notional": null,
      "network_fee_quantity": null,
      "total_notional": "50.00",
      "asset_cost_notional": "48.30",
      "origin": "rest_api",
      "spread_notional": "0.12075",
      "spread_bps": "25"
    }
  ],
  "page": 1,
  "page_size": 15,
  "total_pages": 1,
  "count": 1
}