GEgemini
Instant

Execute Instant Order

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/instant/execute

Request

  • Base URL
    https://api.gemini.com
  • URL
    https://api.gemini.com/v1/instant/execute
  • 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/instant/execute"

symbolstring required

The symbol for the order.

side'buy' | 'sell' required

"buy" or "sell"

quantitystring required

The quantity of the asset bought or sold. quantity must match quantity returned in the quote

pricestring required

The price from the quote. price must match price returned in the quote

feestring required

The fee for the order. fee must match fee returned in the quote

quoteIdinteger required

Unique ID for the quote. quoteId must match quoteId returned in the quote

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 place the order. Only available for exchange accounts.

Example request

{
  "nonce": "1495127793000"
}

Response

JSON response

orderIdinteger

The ID for the executed order

pairstring

The symbol for the order.

pricestring

The price at which the order was executed

priceCurrencystring

The currency in which the order is priced. Matches CCY2 in the symbol

sidestring

Either "buy" or "sell"

quantitystring

The quantity of the asset bought or sold

quantityCurrencystring

The currency label for the quantity field.

totalSpendstring

Total quantity to spend for the order. Will be the sum inclusive of all fees and amount to be traded.

totalSpendCurrencystring

Currency of the totalSpend to be spent on the order

feestring

The fee quantity charged for the order

feeCurrencystring

The currency label for the fee.

depositFeestring

The deposit fee quantity. Will be applied if a debit card is used for the order. Will return 0 if there is no depositFee

depositFeeCurrencystring

Currency in which depositFee is taken

Changes

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