Cancel Order
POSThttps://api.gemini.com/v1/order/cancel
This will cancel an order. If the order is already canceled, the message will succeed but have no effect.
Note
Enabled for perpetuals accounts from July 10th, 0100hrs ET onwards.
POST
curl --request POST \
--url https://api.gemini.com/v1/order/cancel \
--header 'Content-Type: application/json' \
--header 'X-GEMINI-APIKEY: <string>' \
--header 'X-GEMINI-PAYLOAD: <string>' \
--header 'X-GEMINI-SIGNATURE: <string>' \
--data '
{
"request": "/v1/order/cancel",
"nonce": "<nonce>",
"order_id": 106817811
}
'Roles
The API key you use to access this endpoint must have the Trader role assigned. See Roles for more information.
The OAuth scope must have orders:create assigned to access this endpoint. See OAuth Scopes for more information.
All Cancellation Reasons
Under unique circumstances, orders may be automatically cancelled by the exchange. These scenarios are detailed in the table below:
Headers
Request Body
Responses
Response will be the fields included in Order Status. If the order was already canceled, then the request will have no effect and the status will be returned. Note the *is_cancelled* node will have a value of 'true'
Last modified on