ZEzerohash
Liquidity

Execute quote

Changed on

Executes the quote identified by quote_id. Returns the executed quote, the booked trade_id(s), and the trade status.

post/liquidity/execute

Request

  • Base URL
    https://api.cert.zerohash.com
  • URL
    https://api.cert.zerohash.com/liquidity/execute
  • Auth
    API key in header X-SCX-API-KEY and API key in header X-SCX-PASSPHRASE

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

quote_idstring required

The identifier for the quote Note: this is required to execute the quote

withdrawal_request_idstring

Optional withdrawal request ID to associate with the execution. Used by flows that pre-create a withdrawal record and then execute a quote against it.

always_allocateboolean

When true, force allocation of the trade even if the quote has expired or partially filled.

Example request

{
  "quote_id": "32ad471b-824e-4f04-94ff-45c4439b4fe9",
  "withdrawal_request_id": "a81bc81b-dead-4e5d-abff-90865d1e13b1"
}

Response

Successfully executed quote. Returns the executed quote, the booked trade_id, and the trade status.

Example response

{
  "message": {
    "request_id": "14f8ebb8-7530-4aa4-bef9-9d73d56313f3",
    "quote": {
      "request_id": "ce819fe8-b1d7-43bb-961c-e09ede0988d3",
      "participant_code": "CUST01",
      "quoted_currency": "USD",
      "side": "buy",
      "quantity": "1",
      "price": "11430.90",
      "quote_id": "32ad471b-824e-4f04-94ff-45c4439b4fe9",
      "expire_ts": 1568311649602,
      "account_group": "GRP001",
      "account_label": "sub_account_test",
      "obo_participant": {
        "participant_code": "CUST01",
        "account_group": "PLAT01",
        "account_label": "general"
      },
      "total_notional": "2.00",
      "underlying": "BTC",
      "asset_cost_notional": "2.00",
      "spread_notional": "2.12",
      "spread_bps": "50",
      "commission_notional": "5.00",
      "commission_bps": "25"
    },
    "trade_id": "ba97133e-ab15-4c86-86c1-86671b8420bc",
    "trade_ids_list": [
      "ba97133e-ab15-4c86-86c1-86671b8420bc",
      "ce819fe8-b1d7-43bb-961c-e09ede0988d3"
    ],
    "status": "Completed"
  }
}

Changes

  • 47cf70ae701cRevision changes
    • warning

      added the new USDC.ETH enum value to the /// response property for the response status

    • warning

      added the new USDC.ETH enum value to the /// response property for the response status

    • warning

      added the new USDC.ETH enum value to the /// response property for the response status

    • warning

      added the new USDC.ETH enum value to the /// response property for the response status

    • warning

      added the new USDC.ETH enum value to the /// response property for the response status