GEgemini
Orders

Cancel All Session Orders

This will cancel all orders opened by this session.

This will have the same effect as heartbeat expiration if "Require Heartbeat" is selected for the session.

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.

post/v1/order/cancel/session

Request

  • Base URL
    https://api.gemini.com
  • URL
    https://api.gemini.com/v1/order/cancel/session
  • Auth
    API key in header X-GEMINI-APIKEY and API key in header X-GEMINI-SIGNATURE and API key in header X-GEMINI-PAYLOAD

Headers

X-GEMINI-APIKEYstring required

Your API key

X-GEMINI-SIGNATUREstring required

HEX-encoded HMAC-SHA384 of payload signed with API secret

X-GEMINI-PAYLOADstring required

Base64-encoded JSON payload

Content-Typestring
Content-Lengthstring
Cache-Controlstring

Request body

requeststring required

The literal string "/v1/order/cancel/session"

accountstring

Required for Master API keys as described in Private API Invocation. The name of the account within the subaccount group. Specifies the account on which you intend to cancel the orders. Only available for exchange accounts.

Example request

{
  "request": "/v1/order/cancel/session",
  "nonce": "1495127793000",
  "account": "primary"
}

Response

JSON response

resultstring

Example response

{
  "result": "ok"
}

Changes

No recorded changes to this operation across all 1 revision of this API.