REST API

Instant (1.0.0)

Endpointhttps://api.sandbox.gemini.com

Get Instant Quote

POST

https://api.sandbox.gemini.com

/v1/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.

Get Instant Quote › Headers

X-GEMINI-APIKEY

string · required

Your API key

X-GEMINI-SIGNATURE

string · required

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

X-GEMINI-PAYLOAD

string · required

Base64-encoded JSON payload

Content-Type

string

Default: text/plain

Content-Length

string

Default: 0

Cache-Control

string

Default: no-cache

Get Instant Quote › Request Body

request

string · required

The literal string "/v1/instant/quote/"

side

string · enum · required

"buy" or "sell"

Enum values:

buy

sell

symbol

string · required

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

required

The nonce, as described in Private API Invocation

totalSpend

string · 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.

paymentMethodUuid

string

uuid provided as bankId in Payment Methods API

paymentMethodType

string

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.

account

string

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.

Get Instant Quote › Responses

Sample Responses

quoteId

integer

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

maxAgeMs

integer

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

pair

string

The symbol passed in the quote request

price

string

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

priceCurrency

string

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

side

string · enum

Either "buy" or "sell"

Enum values:

buy

sell

quantity

string

The quantity of the asset to be bought or sold

quantityCurrency

string

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

fee

string

The fee quantity to be taken for the order upon execution

feeCurrency

string

The currency label for the order

depositFee

string

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

depositFeeCurrency

string

Currency in which depositFee is taken

totalSpend

string

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

totalSpendCurrency

string

Currency of the totalSpend to be spent on the order

POST/v1/instant/quote

curl --request POST \
  --url https://api.sandbox.gemini.com/v1/instant/quote \
  --header 'Content-Type: application/json' \
  --header 'X-GEMINI-APIKEY: <string>' \
  --header 'X-GEMINI-PAYLOAD: <string>' \
  --header 'X-GEMINI-SIGNATURE: <string>' \
  --data '
{
  "request": "/v1/instant/quote",
  "nonce": "<nonce>",
  "symbol": "btcusd",
  "side": "buy",
  "totalSpend": "100"
}
'

shell

Example Request Body

{
  "request": "/v1/instant/quote",
  "nonce": "<nonce>",
  "symbol": "btcusd",
  "side": "buy",
  "totalSpend": "100"
}

json

JSON payload for BTCUSD buy quote

application/json

Example Responses

{
  "quoteId": 1328,
  "maxAgeMs": 60000,
  "pair": "BTCUSD",
  "price": "6445.07",
  "priceCurrency": "USD",
  "side": "buy",
  "quantity": "0.01505181",
  "quantityCurrency": "BTC",
  "fee": "2.9900309233",
  "feeCurrency": "USD",
  "depositFee": "0",
  "depositFeeCurrency": "USD",
  "totalSpend": "100",
  "totalSpendCurrency": "USD"
}

json

Sample BTCUSD Buy Response

application/json

Execute Instant Order

POST

https://api.sandbox.gemini.com

/v1/instant/execute

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.

Execute Instant Order › Headers

X-GEMINI-APIKEY

string · required

Your API key

X-GEMINI-SIGNATURE

string · required

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

X-GEMINI-PAYLOAD

string · required

Base64-encoded JSON payload

Content-Type

string

Default: text/plain

Content-Length

string

Default: 0

Cache-Control

string

Default: no-cache

Execute Instant Order › Request Body

request

string · required

The literal string "/v1/instant/execute"

required

The nonce, as described in Private API Invocation

symbol

string · required

The symbol for the order.

side

string · enum · required

"buy" or "sell"

Enum values:

buy

sell

quantity

string · required

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

fee

string · required

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

quoteId

integer · required

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

account

string

Execute Instant Order › Responses

JSON response

orderId

integer

The ID for the executed order

pair

string

The symbol for the order.

price

string

The price at which the order was executed

priceCurrency

string

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

side

string

Either "buy" or "sell"

quantity

string

The quantity of the asset bought or sold

quantityCurrency

string

The currency label for the quantity field.

totalSpend

string

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

totalSpendCurrency

string

Currency of the totalSpend to be spent on the order

fee

string

The fee quantity charged for the order

feeCurrency

string

The currency label for the fee.

depositFee

string

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

depositFeeCurrency

string

Currency in which depositFee is taken

POST/v1/instant/execute

curl --request POST \
  --url https://api.sandbox.gemini.com/v1/instant/execute \
  --header 'Content-Type: application/json' \
  --header 'X-GEMINI-APIKEY: <string>' \
  --header 'X-GEMINI-PAYLOAD: <string>' \
  --header 'X-GEMINI-SIGNATURE: <string>' \
  --data '
{
  "request": "/v1/instant/execute",
  "nonce": "<nonce>",
  "symbol": "BTCUSD",
  "side": "buy",
  "quantity": "0.01505181",
  "price": "6445.07",
  "fee": "2.9900309233",
  "quoteId": 1328
}
'

shell

Example Request Body

{
  "request": "/v1/instant/execute",
  "nonce": "<nonce>",
  "symbol": "BTCUSD",
  "side": "buy",
  "quantity": "0.01505181",
  "price": "6445.07",
  "fee": "2.9900309233",
  "quoteId": 1328
}

json

Sample Instant Order Execution Request Payload BTCUSD Buy

application/json

Example Responses

{
  "orderId": 375089415,
  "pair": "BTCUSD",
  "price": "6445.07",
  "priceCurrency": "USD",
  "side": "buy",
  "quantity": "0.01505181",
  "quantityCurrency": "BTC",
  "totalSpend": "100",
  "totalSpendCurrency": "USD",
  "fee": "2.9900309233",
  "feeCurrency": "USD",
  "depositFee": "0",
  "depositFeeCurrency": "USD"
}

json

Sample Response BTCUSD Buy

application/json

Clearing Account Administration

Get Instant Quote

POST

https://api.sandbox.gemini.com

/v1/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.

Get Instant Quote › Headers

X-GEMINI-APIKEY

string · required

Your API key

X-GEMINI-SIGNATURE

string · required

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

X-GEMINI-PAYLOAD

string · required

Base64-encoded JSON payload

Content-Type

string

Default: text/plain

Content-Length

string

Default: 0

Cache-Control

string

Default: no-cache

Get Instant Quote › Request Body

request

string · required

The literal string "/v1/instant/quote/"

side

string · enum · required

"buy" or "sell"

Enum values:

buy

sell

symbol

string · required

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

required

The nonce, as described in Private API Invocation

totalSpend

string · 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.

paymentMethodUuid

string

uuid provided as bankId in Payment Methods API

paymentMethodType

string

account

string

Get Instant Quote › Responses

Sample Responses

quoteId

integer

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

maxAgeMs

integer

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

pair

string

The symbol passed in the quote request

price

string

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

priceCurrency

string

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

side

string · enum

Either "buy" or "sell"

Enum values:

buy

sell

quantity

string

The quantity of the asset to be bought or sold

quantityCurrency

string

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

fee

string

The fee quantity to be taken for the order upon execution

feeCurrency

string

The currency label for the order

depositFee

string

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

depositFeeCurrency

string

Currency in which depositFee is taken

totalSpend

string

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

totalSpendCurrency

string

Currency of the totalSpend to be spent on the order

curl --request POST \ --url https://api.sandbox.gemini.com/v1/instant/quote \ --header 'Content-Type: application/json' \ --header 'X-GEMINI-APIKEY: <string>' \ --header 'X-GEMINI-PAYLOAD: <string>' \ --header 'X-GEMINI-SIGNATURE: <string>' \ --data ' { "request": "/v1/instant/quote", "nonce": "<nonce>", "symbol": "btcusd", "side": "buy", "totalSpend": "100" } '

{ "quoteId": 1328, "maxAgeMs": 60000, "pair": "BTCUSD", "price": "6445.07", "priceCurrency": "USD", "side": "buy", "quantity": "0.01505181", "quantityCurrency": "BTC", "fee": "2.9900309233", "feeCurrency": "USD", "depositFee": "0", "depositFeeCurrency": "USD", "totalSpend": "100", "totalSpendCurrency": "USD" }

Execute Instant Order

POST

https://api.sandbox.gemini.com

/v1/instant/execute

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.

Execute Instant Order › Headers

X-GEMINI-APIKEY

string · required

Your API key

X-GEMINI-SIGNATURE

string · required

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

X-GEMINI-PAYLOAD

string · required

Base64-encoded JSON payload

Content-Type

string

Default: text/plain

Content-Length

string

Default: 0

Cache-Control

string

Default: no-cache

Execute Instant Order › Request Body

request

string · required

The literal string "/v1/instant/execute"

required

The nonce, as described in Private API Invocation

symbol

string · required

The symbol for the order.

side

string · enum · required

"buy" or "sell"

Enum values:

buy

sell

quantity

string · required

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

fee

string · required

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

quoteId

integer · required

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

account

string

Execute Instant Order › Responses

JSON response

orderId

integer

The ID for the executed order

pair

string

The symbol for the order.

price

string

The price at which the order was executed

priceCurrency

string

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

side

string

Either "buy" or "sell"

quantity

string

The quantity of the asset bought or sold

quantityCurrency

string

The currency label for the quantity field.

totalSpend

string

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

totalSpendCurrency

string

Currency of the totalSpend to be spent on the order

fee

string

The fee quantity charged for the order

feeCurrency

string

The currency label for the fee.

depositFee

string

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

depositFeeCurrency

string

Currency in which depositFee is taken

curl --request POST \ --url https://api.sandbox.gemini.com/v1/instant/execute \ --header 'Content-Type: application/json' \ --header 'X-GEMINI-APIKEY: <string>' \ --header 'X-GEMINI-PAYLOAD: <string>' \ --header 'X-GEMINI-SIGNATURE: <string>' \ --data ' { "request": "/v1/instant/execute", "nonce": "<nonce>", "symbol": "BTCUSD", "side": "buy", "quantity": "0.01505181", "price": "6445.07", "fee": "2.9900309233", "quoteId": 1328 } '

{ "orderId": 375089415, "pair": "BTCUSD", "price": "6445.07", "priceCurrency": "USD", "side": "buy", "quantity": "0.01505181", "quantityCurrency": "BTC", "totalSpend": "100", "totalSpendCurrency": "USD", "fee": "2.9900309233", "feeCurrency": "USD", "depositFee": "0", "depositFeeCurrency": "USD" }