Cancel Order - DexBuilder Docs

DELETE

api

broker

event_contracts

orders

{order_id}

Cancel Order

curl --request DELETE \
  --url https://api.dexbuilder.com/api/v4/broker/event_contracts/orders/{order_id} \
  --header 'KEY: <api-key>' \
  --header 'SIGN: <sign>' \
  --header 'Timestamp: <timestamp>' \
  --header 'X-User-Wallet-Address: <x-user-wallet-address>'

import requests

url = "https://api.dexbuilder.com/api/v4/broker/event_contracts/orders/{order_id}"

headers = {
    "Timestamp": "<timestamp>",
    "SIGN": "<sign>",
    "X-User-Wallet-Address": "<x-user-wallet-address>",
    "KEY": "<api-key>"
}

response = requests.delete(url, headers=headers)

print(response.text)

{
  "cancel_status": "accepted",
  "order_id": "<string>",
  "status": "<string>"
}

{
  "label": "INVALID_ARGUMENT",
  "message": "invalid request"
}

{
  "label": "INVALID_ARGUMENT",
  "message": "invalid request"
}

{
  "label": "INVALID_ARGUMENT",
  "message": "invalid request"
}

Requests cancellation of one order. Base URL: https://api.dexbuilder.com Authentication: Use a Broker API Key and sign this request with Timestamp and SIGN. Pass a wallet address that belongs to your Broker in X-User-Wallet-Address. Calculate the signature using the external Broker path. See Broker API Key and signing and Access on behalf of a user.

Request

curl -X DELETE "https://api.dexbuilder.com/api/v4/broker/event_contracts/orders/{order_id}" \
  -H "KEY: ${BROKER_API_KEY}" \
  -H "SIGN: ${SIGN}" \
  -H "Timestamp: ${TIMESTAMP}" \
  -H "X-User-Wallet-Address: ${USER_WALLET}"

order_id identifies the order. The OpenAPI panel below is the source of truth for required parameters, types, enum values, and request-body fields. Timestamps are Unix timestamps unless the field description states otherwise.

Response

Returns the order ID, cancellation status, and current processing status. An order may have executed before cancellation completes. A successful response uses HTTP 200. Invalid parameters or request bodies return HTTP 400. Private endpoints can return HTTP 401 when authentication fails, and temporary upstream failures can return HTTP 503. The error response contains a machine-readable label and message. For order, position, claim, transfer, and account operations, treat the response as the current server result and query the resource again when the operation is asynchronous.

Authorizations

KEY

string

header

required

Broker API Key, created through the project administrator's process.

Headers

Timestamp

string

required

Unix timestamp in seconds; the gateway allows at most 60 seconds of clock skew.

SIGN

string

required

Hexadecimal HMAC-SHA512 signature over the external request path, query string, and body.

X-User-Wallet-Address

string

required

End-user wallet address. The gateway checks that this wallet belongs to the current Broker.

Path Parameters

order_id

string

required

Response

Request succeeded

Response object.

cancel_status

enum<string>

Available options:

accepted

order_id

string

status

string

Cancel Order

curl --request DELETE \
  --url https://api.dexbuilder.com/api/v4/broker/event_contracts/orders/{order_id} \
  --header 'KEY: <api-key>' \
  --header 'SIGN: <sign>' \
  --header 'Timestamp: <timestamp>' \
  --header 'X-User-Wallet-Address: <x-user-wallet-address>'

import requests

url = "https://api.dexbuilder.com/api/v4/broker/event_contracts/orders/{order_id}"

headers = {
    "Timestamp": "<timestamp>",
    "SIGN": "<sign>",
    "X-User-Wallet-Address": "<x-user-wallet-address>",
    "KEY": "<api-key>"
}

response = requests.delete(url, headers=headers)

print(response.text)

{
  "cancel_status": "accepted",
  "order_id": "<string>",
  "status": "<string>"
}

{
  "label": "INVALID_ARGUMENT",
  "message": "invalid request"
}

{
  "label": "INVALID_ARGUMENT",
  "message": "invalid request"
}

{
  "label": "INVALID_ARGUMENT",
  "message": "invalid request"
}

​Request

​Response

Authorizations

Headers

Path Parameters

Response

Request

Response