GEgemini
Instant

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.

post/v1/instant/quote

Request

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

side'buy' | 'sell' required

"buy" or "sell"

symbolstring required

The symbol for the order. Instant includes order books denominated in a supported currency, as CCY2

totalSpendstring required

Quoted decimal amount to spend on the order. Must comply with stated minimums. The totalSpend will be CCY2 in buy orders and CCY1 in sell orders.

paymentMethodUuidstring

uuid provided as bankId in Payment Methods API

paymentMethodTypestring

Method used to specify payment method in buy order. 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.

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

Sample Responses

quoteIdinteger

Unique ID for the quote. This is used in the execution of the order

maxAgeMsinteger

Number of milliseconds until this quote price expires. Once expired, you will need to request a new quote

pairstring

The symbol passed in the quote request

pricestring

The quoted price of the asset. This will not change when attempting execution

priceCurrencystring

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

side'buy' | 'sell'

Either "buy" or "sell"

quantitystring

The quantity of the asset to be bought or sold

quantityCurrencystring

The currency label for the quantity field. Matches CCY1 in the symbol

feestring

The fee quantity to be taken for the order upon execution

feeCurrencystring

The currency label for the order

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

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

Changes

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