Get Instant Quote
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.
Headers
X-GEMINI-APIKEYstring · requiredYour API key
X-GEMINI-SIGNATUREstring · requiredHEX-encoded HMAC-SHA384 of payload signed with API secret
X-GEMINI-PAYLOADstring · requiredBase64-encoded JSON payload
Content-TypestringDefault: text/plainContent-LengthstringDefault: 0Cache-ControlstringDefault: no-cache
Request Body
requeststring · requiredThe literal string "/v1/instant/quote/"
sidestring · enum · required"buy" or "sell"
Enum values:buysellsymbolstring · requiredThe symbol for the order. Instant includes order books denominated in a supported currency, as
CCY2totalSpendstring · requiredQuoted decimal amount to spend on the order. Must comply with stated minimums. The
totalSpendwill beCCY2inbuyorders andCCY1insellorders.
paymentMethodUuidstringuuid provided as
bankIdin Payment Methods APIpaymentMethodTypestringMethod used to specify payment method in
buyorder. Can be "AccountBalancePaymentType" to use funds available in USD balance held on Gemini, "BankAccountType" to initial an ACH from a linked bank account, or "CardAccountType" to use a linked debit card to fund the purchase.accountstringRequired 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.
Responses
Sample Responses
quoteIdintegerUnique ID for the quote. This is used in the execution of the order
maxAgeMsintegerNumber of milliseconds until this quote price expires. Once expired, you will need to request a new quote
pairstringThe symbol passed in the quote request
pricestringThe quoted price of the asset. This will not change when attempting execution
priceCurrencystringThe currency in which the order is priced. Matches
CCY2in the symbolsidestring · enumEither "buy" or "sell"
Enum values:buysellquantitystringThe quantity of the asset to be bought or sold
quantityCurrencystringThe currency label for the
quantityfield. MatchesCCY1in the symbolfeestringThe fee quantity to be taken for the order upon execution
feeCurrencystringThe currency label for the order
depositFeestringThe deposit fee quantity. Will be applied if a debit card is used for the order. Will return 0 if there is no
depositFeedepositFeeCurrencystringCurrency in which
depositFeeis takentotalSpendstringTotal quantity to spend for the order. Will be the sum inclusive of all fees and amount to be traded.
totalSpendCurrencystringCurrency of the
totalSpendto be spent on the order
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.
Headers
X-GEMINI-APIKEYstring · requiredYour API key
X-GEMINI-SIGNATUREstring · requiredHEX-encoded HMAC-SHA384 of payload signed with API secret
X-GEMINI-PAYLOADstring · requiredBase64-encoded JSON payload
Content-TypestringDefault: text/plainContent-LengthstringDefault: 0Cache-ControlstringDefault: no-cache
Request Body
requeststring · requiredThe literal string "/v1/instant/execute"
symbolstring · requiredThe symbol for the order.
sidestring · enum · required"buy" or "sell"
Enum values:buysellquantitystring · requiredThe quantity of the asset bought or sold. quantity must match quantity returned in the quote
feestring · requiredThe fee for the order. fee must match fee returned in the quote
quoteIdinteger · requiredUnique ID for the quote. quoteId must match quoteId returned in the quote
accountstringRequired 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.
Responses
JSON response
orderIdintegerThe ID for the executed order
pairstringThe symbol for the order.
pricestringThe price at which the order was executed
priceCurrencystringThe currency in which the order is priced. Matches
CCY2in the symbolsidestringEither "buy" or "sell"
quantitystringThe quantity of the asset bought or sold
quantityCurrencystringThe currency label for the
quantityfield.totalSpendstringTotal quantity to spend for the order. Will be the sum inclusive of all fees and amount to be traded.
totalSpendCurrencystringCurrency of the
totalSpendto be spent on the orderfeestringThe fee quantity charged for the order
feeCurrencystringThe currency label for the fee.
depositFeestringThe deposit fee quantity. Will be applied if a debit card is used for the order. Will return 0 if there is no
depositFeedepositFeeCurrencystringCurrency in which
depositFeeis taken

