API Workflow

The following is a specific integration flow for platforms using Zero Hash for our request for quote service to avail of our liquidity services. Platforms integrating to the /liquidity/rfq endpoint have the option to be configured to have quote expiry lengths of 5 or 30 seconds.

Get Quote

GET /liquidity/rfq

To get a quote from the Zero Hash RFQ system, you will need to define a quantity or total in the request.

The total is the amount in the quoted_currency to buy or sell.
The quantity is the amount in the underlying asset to buy or sell.

Sample request

{
  'participant_code' :'HN853Q',
  'side': 'buy',
  'underlying': 'USDC',
  'quoted_currency': 'USD',
  'total': 500,
}

Sample response

{
  "message": {
    "request_id": "d72d68f3-55ae-4c26-aebc-4298c56f10f1",
    "participant_code": "S8NSEL",
    "quoted_currency": "USD",
    "side": "buy",
    "quantity": "499.37",
    "price": "1.0012615896028997",
    "quote_id": "c2efaa66-a06f-40e7-8da4-35f525c80847",
    "expire_ts": 1714527280072,
    "account_group": "00SCXM",
    "account_label": "general",
    "obo_participant": {
      "participant_code": "HN853Q",
      "account_group": "S8NSEL",
      "account_label": "general"
    },
    "parent_link_id": "",
    "parent_link_id_source": 0,
    "underlying": "USDC.ETH",
    "asset_cost_notional": "500",
    "spread_notional": "0.625",
    "spread_bps": "12.5"
  }
}

Executing a quote

POST /liquidity/execute

To execute a quote, we need to pass the active quote_id that was obtained from the GET /liquidity/rfq endpoint.

Sample request

{
  "quote_id": "c2efaa66-a06f-40e7-8da4-35f525c80847"
}

Sample response

{
  "message": {
    "request_id": "39b54e0f-6af1-4d79-a7b5-a9cf036794f9",
    "quote": {
      "request_id": "d72d68f3-55ae-4c26-aebc-4298c56f10f1",
      "participant_code": "S8NSEL",
      "quoted_currency": "USD",
      "side": "buy",
      "quantity": "499.37",
      "price": "1.0012615896028997",
      "quote_id": "c2efaa66-a06f-40e7-8da4-35f525c80847",
      "expire_ts": 1714527280072,
      "account_group": "00SCXM",
      "account_label": "general",
      "obo_participant": {
        "participant_code": "HN853Q",
        "account_group": "S8NSEL",
        "account_label": "general"
      },
      "parent_link_id": "",
      "parent_link_id_source": 0,
      "underlying": "USDC.ETH",
      "asset_cost_notional": "500",
      "spread_notional": "0.625",
      "spread_bps": "12.5",
      "transaction_timestamp": 1714527260659
    },
    "trade_id": "041fb0aa-5382-49c3-9a6a-aff473221c8d",
    "status": "Completed",
    "trade_ids_list": [
      "041fb0aa-5382-49c3-9a6a-aff473221c8d"
    ]
  }
}

Snippets

📈

Liquidity Quote

Open Recipe