Create Cancel Order Transaction

Create raw bytes of an unsigned transaction to cancel open order by orderID.

This endpoint does not submit the transaction to the network.

The endpoint allows you to specify priority fees and tips to later control the transaction inclusion and propagation. Refer to the Transaction Submission & Front-Running Protection & Transaction Bundle page for additional information about these parameters.

Request

Method:

POST ./api/v2/openbook/cancel

Parameters:

Parameter	Type	Description
orderID	string	OPTIONAL. Unique order ID to be cancelled. This order ID is assigned by the orderbook after processing, and can be difficult to associate with a transaction without the clientOrderId.
clientOrderId	string	OPTIONAL. Client order id which can be customized by the user. *Leave both orderIDand clientOrderIdempty, if want to cancel all open orders.
ownerAddress	string	User's account address to cancel order
openOrdersAddress	string	Define with open order address to cancel the order in case of having multiple open order addresses.
market	string	Smart contract address/symbol of the market.
computeLimit	number	OPTIONAL. Specifies total compute limit to be allocated for all instructions within the created tx
computePrice	number	OPTIONAL. Specifies compute price in Lamport (0.000001 SOL = 1,000 Lamport) to be included as a part of instruction, known as priority fee.
tip	uint64	OPTIONAL. Specifies a tip amount that will be used to pay for front-running protection or bundle submission services. What is tip?

Request example:

HTTP

curl --header "Authorization: $AUTH_HEADER" \
-X 'POST' \
  'https://ny.solana.dex.blxrbdn.com/api/v2/openbook/cancel' \
  -H 'Content-Type: application/json' \
  -d '{
  "orderID": "5cadbc104bc9ebd75cadbc104bc9ebd7",
  "marketAddress": "9wFFyRfZBsuAha4YcuxcXLKwMxJR43S7fPfQLusDBzvT",
  "ownerAddress": "AFT8VayE7qr8MoQsW3wHsDS83HhEvhGWdbNSHRKeUDfQ",
  "openOrdersAddress": "5yyh4mzzycmjfR6arY736d1mB6vNSLiUaFWfepKLf8kZ",
  "clientOrderID": "123"
}'

WebSocket

wscat --header "Authorization: $AUTH_HEADER"
-c wss://ny.solana.dex.blxrbdn.com/ws --execute '{"jsonrpc": "2.0", "id": 1, "method": "PostCancelOrder", "params": {
  "orderID": "1234567890",
  "side": "S_ASK",
  "ownerAddress": "AFT8VayE7qr8MoQsW3wHsDS83HhEvhGWdbNSHRKeUDfQ",
  "marketAddress": "9wFFyRfZBsuAha4YcuxcXLKwMxJR43S7fPfQLusDBzvT",
  "openOrdersAddress": "5yyh4mzzycmjfR6arY736d1mB6vNSLiUaFWfepKLf8kZ"
}}'

Go

//Make sure to set environment variable AUTH_HEADER.
transaction, err := g.PostCancelOrder(
    ctx,
    "1234567890", // order ID
    pb.Side_S_ASK,
    "AFT8VayE7qr8MoQsW3wHsDS83HhEvhGWdbNSHRKeUDfQ",
    "SOL/USDC",
    "5yyh4mzzycmjfR6arY736d1mB6vNSLiUaFWfepKLf8kZ"
)

Python

#Make sure to set environment variable AUTH_HEADER.
await api.post_cancel_order(
    order_i_d="",
    side=proto.Side.S_ASK,
    market_address="SOLUSDC",
    owner_address=PUBLIC_KEY,
    open_orders_address="",  # optional
)

TypeScript

await provider.postCancelByClientOrderID({
    marketAddress: marketAddress,
    ownerAddress: ownerAddress,
    openOrdersAddress: openOrdersAddress,
    clientOrderID: testOrder.clientOrderID,
    project: "P_OPENBOOK",
})

Response:

Fields:

Field	Description
transaction	Raw bytes of unsigned transaction
openOrdersAddress	The open order address to place the order

Example:

JSON

{
  "transaction": "AgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAC3VviHhRXwajmbHjA81VWXrZn5eFs8QQgktl0zJIHYBY3t6VHnwK40CkHx94w499MTm6w2xUFNd4g/td6s0OsDAgAFD4ls26fgpAnCYufUzDrXMMpDjMYkf2Y2FHuxqKE+2+Ir4JOYQLjX3gNAS/hRzKTUUu1/FlowlWLc1wv3nKsGTt6EwvsYrtYZ9UZjJlPvBgKfAqhkvzgphnGBuyDfHXFcMEoHX5xmEhJgK0YZx3BKh/s3nhpE7IFyBzqsKBqiTDd6jfzI9XsPznt1ZnWa9u9nVKg1KibD5ElrzSfbftYpluJAIIlGU8/d+nt+YMlmaCc2otsPg4VkklsRB3oh4DbXlwD0JuFuuM8DEZF1+YBRQ0SVXONw52WUDzwpQ5VF+0Wppt/RXFB3Bfkzm5U8Gk39vJzBht0vYt9IqVgEXip2UlkfJvXwRhxAEL1cyMpwZt2lhKbucXk0xnet9MJfvRVqLWrj7TJ6D4hJp3KUHZcFDzpujLjdOrzbFHCIfIK1TT82BpuIV/6rgYT7aH9jRhjANdrEOdwa6ztVmKDwAAAAAAEGp9UXGSxcUSGMyUw9SvF/WNruCJuh/UTj29mKAAAAAAbd9uHXZaGT2cvhRs7reawctIXtX1s3kTqM9YV+/wCpAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACFDy1uAqR6+CTQmradxC1wyyjL+iSft+5XudJWwSdi72WJF7hI17QuJRRi1EmSpQkUrNAwom+Kp9LFCTP8SA/pBA0CAAE0AAAAAIB3jgYAAAAApQAAAAAAAAAG3fbh12Whk9nL4UbO63msHLSF7V9bN5E6jPWFfv8AqQwEAQoACwEBDgwCAwQFBgcBAAgJDAszAAoAAAABAAAAAOQLVAIAAAABAAAAAAAAAAAQpdToAAAAAAAAAAAAAADSBAAAAAAAAP//DAMBAAABCQ==",
  "openOrdersAddress": "5yyh4mzzycmjfR6arY736d1mB6vNSLiUaFWfepKLf8kZ"
}