ZEzerohash
CLOB

Cancel order

Changed on

Cancel an order on the CLOB.

post/orders/v1/cancel_order

Request

  • Base URL
    https://api.cert.zerohash.com
  • URL
    https://api.cert.zerohash.com/orders/v1/cancel_order
  • 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

clord_idstring

Client-provided order ID. Client order ID's are unique only on open orders. If a client order ID is reused on a new order, the previous order with that ID must be fully filled or canceled before the new order can be placed. Platforms should ensure that the order_id field is is used to along with the client order ID to uniquely identify an order.

order_idstring required

Unique order identifier assigned by the system.

symbolstring

The trading pair for the order.

userstring

Fully-qualified user. Format: firms/F-{platform_code}/users/{participant_code}. This value is case sensitive.

Example:- Customer User firms/F-PLAT01/users/CUST01.- Platform User firms/F-PLAT01/users/PLAT01.

Example request

{
  "clord_id": "1245567889",
  "order_id": "51H5D2K2A00M",
  "symbol": "ETH/USD",
  "user": "firms/F-PLAT01/users/CUST01"
}

Response

A successful response

PostCancelOrderResponse required

Changes

  • 47cf70ae701cRevision changes
    • breaking

      the request property became required

    • breaking

      removed the enum value firms/F-{platform_code}/users/{account_label} of the request property

    • breaking

      removed the enum value firms/F-{platform_code}/users/{participant_code} of the request property

    • breaking

      removed the enum value firms/{zerohash}/users/{platform_code} of the request property