Gemini Crypto Exchange Logo
REST API

​Orders (1.0.0)

Endpoint

​Create New Order

POST
https://api.gemini.com
/v1/order/new

If you wish orders to be automatically cancelled when your session ends, see the require heartbeat section, or manually send the cancel all session orders message.

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.

Stop-Limit Orders

A Stop-Limit order is an order type that allows for order placement when a price reaches a specified level. Stop-Limit orders take in both a price and and a stop_price as parameters. The stop_price is the price that triggers the order to be placed on the continous live order book at the price. For buy orders, the stop_price must be below the price while sell orders require the stop_price to be greater than the price.

What about market orders?

The API doesn't directly support market orders because they provide you with no price protection.

Instead, use the “immediate-or-cancel” order execution option, coupled with an aggressive limit price (i.e. very high for a buy order or very low for a sell order), to achieve the same result.

Order execution options

Note that options is an array. If you omit options or provide an empty array, your order will be a standard limit order - it will immediately fill against any open orders at an equal or better price, then the remainder of the order will be posted to the order book.

If you specify more than one option (or an unsupported option) in the options array, the exchange will reject your order.

No options can be applied to stop-limit orders at this time.

The available limit order options are:

OptionDescription
"maker-or-cancel"This order will only add liquidity to the order book.

If any part of the order could be filled immediately, the whole order will instead be canceled before any execution occurs.

If that happens, the response back from the API will indicate that the order has already been canceled ("is_cancelled": true in JSON).

Note: some other exchanges call this option "post-only".
"immediate-or-cancel"This order will only remove liquidity from the order book.

It will fill whatever part of the order it can immediately, then cancel any remaining amount so that no part of the order is added to the order book.

If the order doesn't fully fill immediately, the response back from the API will indicate that the order has already been canceled ("is_cancelled": true in JSON).
"fill-or-kill"This order will only remove liquidity from the order book.

It will fill the entire order immediately or cancel.

If the order doesn't fully fill immediately, the response back from the API will indicate that the order has already been canceled ("is_cancelled": true in JSON).

​Create New Order › 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
    Default: text/plain
  • Content-Lengthstring
    Default: 0
  • Cache-Controlstring
    Default: no-cache

​Create New Order › Request Body

  • requeststring · required

    The literal string "/v1/order/new"

    Example: /v1/order/new
  • noncenumber · required

    The nonce, as described in Private API Invocation

  • symbolstring · required

    The symbol for the new order

    Example: BTCUSD
  • amountstring · required

    Quoted decimal amount to purchase

    Example: 5
  • pricestring · required

    Quoted decimal amount to spend per unit

    Example: 3633.00
  • sidestring · enum · required
    Enum values:
    buy
    sell
    Example: buy
  • typestring · enum · required

    The order type. "exchange limit" for all order types except for stop-limit orders. "exchange stop limit" for stop-limit orders.

    Enum values:
    exchange limit
    exchange stop limit
    exchange market
    Example: exchange limit
  • client_order_idstring

    Recommended. A client-specified order id

  • optionsstring[]

    An optional array containing at most one supported order execution option. See Order execution options for details.

    Enum values:
    maker-or-cancel
    immediate-or-cancel
    fill-or-kill
    Example: ["maker-or-cancel"]
  • stop_pricestring

    The price to trigger a stop-limit order. Only available for stop-limit orders.

  • 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.

​Create New Order › Responses

    • order_idstring
    • idstring
    • symbolstring
    • exchangestring
    • avg_execution_pricestring
    • sidestring · enum
      Enum values:
      buy
      sell
    • typestring · enum
      Enum values:
      exchange limit
      exchange stop limit
      exchange market
    • timestamp

      timestamp

    • timestampms

      timestamp

    • is_liveboolean
    • is_cancelledboolean
    • is_hiddenboolean
    • was_forcedboolean
    • executed_amountstring
    • remaining_amountstring · double
    • client_order_idstring
    • optionsstring[]
    • pricestring · double
    • original_amountstring · double
    • order_idstring
    • idstring
    • symbolstring
    • exchangestring
    • avg_execution_pricestring
    • sidestring · enum
      Enum values:
      buy
      sell
    • typestring · enum
      Enum values:
      exchange stop limit
    • timestamp

      timestamp

    • timestampms

      timestamp

    • is_liveboolean
    • is_cancelledboolean
    • is_hiddenboolean
    • was_forcedboolean
    • executed_amountstring
    • optionsstring[]
    • stop_pricestring · double
    • pricestring · double
    • original_amountstring · double

​Cancel Order

POST
https://api.gemini.com
/v1/order/cancel

This will cancel an order. If the order is already canceled, the message will succeed but have no effect.

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.

All Cancellation Reasons

Under unique circumstances, orders may be automatically cancelled by the exchange. These scenarios are detailed in the table below:

Cancel ReasonDescription
MakerOrCancelWouldTakeOccurs when the "maker-or-cancel" execution option is included in the order request and any part of the requested order could be filled immediately.
ExceedsPriceLimitsOccurs when there is not sufficient liquidity on the order book to support the entered trade. Orders will be automatically cancelled when liquidity conditions are such that the order would move price +/- 5%.
SelfCrossPreventedOccurs when a user enters a bid that is higher than that user's lowest open ask or enters an ask that is lower than their highest open bid on the same pair.
ImmediateOrCancelWouldPostOccurs when the "immediate-or-cancel" execution option is included in the order request and the requested order cannot be fully filled immediately. This type of cancellation will only cancel the unfulfilled part of any impacted order.
FillOrKillWouldNotFillOccurs when the "fill-or-kill" execution option is included in the new order request and the entire order cannot be filled immediately.

Unlike "immediate-or-cancel" orders, this execution option will result in the entire order being cancelled rather than just the unfulfilled portion.
RequestedCancelled via user request to /v1/order/cancel endpoint.
MarketClosedOccurs when an order is placed for a trading pair that is currently closed.
TradingClosedOccurs when an order is placed while the exchange is closed for trading.

​Cancel Order › 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
    Default: text/plain
  • Content-Lengthstring
    Default: 0
  • Cache-Controlstring
    Default: no-cache

​Cancel Order › Request Body

  • requeststring · required

    The literal string "/v1/order/cancel"

    Example: /v1/order/cancel
  • noncerequired

    timestamp

  • order_idinteger · required

    The order ID given by /order/new

    Example: 106817811
  • 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 order. Only available for exchange accounts.

    Example: primary

​Cancel Order › Responses

    • order_idstring · integer
    • idstring · integer
    • symbolstring
    • exchangestring
    • avg_execution_pricestring · double
    • sidestring · enum
      Enum values:
      buy
      sell
    • typestring · enum
      Enum values:
      exchange limit
      exchange stop limit
      exchange market
    • timestamp

      timestamp

    • timestampms

      timestamp

    • is_liveboolean
    • is_cancelledboolean
    • is_hiddenboolean
    • was_forcedboolean
    • executed_amountstring · double
    • remaining_amountstring · double
    • reasonstring · enum
      Enum values:
      MakerOrCancelWouldTake
      ExceedsPriceLimits
      SelfCrossPrevented
      ImmediateOrCancelWouldPost
      FillOrKillWouldNotFill
      Requested
      MarketClosed
      TradingClosed
    • optionsstring[]
    • pricestring · double
    • original_amountstring · double

​Cancel All Active Orders

POST
https://api.gemini.com
/v1/order/cancel/all

This will cancel all outstanding orders created by all sessions owned by this account, including interactive orders placed through the UI.

Typically Cancel All Session Orders is preferable, so that only orders related to the current connected session are cancelled.

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.

​Cancel All Active Orders › 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
    Default: text/plain
  • Content-Lengthstring
    Default: 0
  • Cache-Controlstring
    Default: no-cache

​Cancel All Active Orders › Request Body

  • requeststring · required

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

    Example: /v1/order/cancel/all
  • noncerequired

    timestamp

  • 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: primary

​Cancel All Active Orders › Responses

    • resultstring
      Example: ok
    • detailsobject

      cancelledOrders/cancelRejects with IDs of both

​Cancel All Session Orders

POST
https://api.gemini.com
/v1/order/cancel/session

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.

​Cancel All Session Orders › 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
    Default: text/plain
  • Content-Lengthstring
    Default: 0
  • Cache-Controlstring
    Default: no-cache

​Cancel All Session Orders › Request Body

  • requeststring · required

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

    Example: /v1/order/cancel/session
  • noncerequired

    timestamp

  • 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: primary

​Cancel All Session Orders › Responses

    • resultstring
      Example: ok
    • detailsobject

      cancelledOrders/cancelRejects with IDs of both

​Get Order Status

POST
https://api.gemini.com
/v1/order/status

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:read assigned to access this endpoint. See OAuth Scopes for more information.

​Get Order Status › 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
    Default: text/plain
  • Content-Lengthstring
    Default: 0
  • Cache-Controlstring
    Default: no-cache

​Get Order Status › Request Body

  • requeststring · required

    The API endpoint path

    Example: /v1/order/status
  • noncerequired

    timestamp

  • order_idinteger · required

    The order id to get information on. The order_id represents a whole number and is transmitted as an unsigned 64-bit integer in JSON format. order_id cannot be used in combination with client_order_id.

    Example: 123456789012345
  • 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: primary
  • client_order_idstring

    The client_order_id used when placing the order. client_order_id cannot be used in combination with order_id

  • include_tradesboolean

    Either True or False. If True the endpoint will return individual trade details of all fills from the order.

​Get Order Status › Responses

    • order_idstring · integer

      The order id

    • client_order_idstring · integer

      An optional client-specified order id

    • symbolstring

      The symbol of the order

    • exchangestring

      Will always be "gemini"

    • pricestring · decimal

      The price the order was issued at

    • avg_execution_pricestring · decimal

      The average price at which this order as been executed so far. 0 if the order has not been executed at all.

    • sidestring · enum
      Enum values:
      buy
      sell
    • typestring · enum

      Description of the order

      Enum values:
      exchange limit
      exchange stop limit
      exchange market
    • optionsstring[]

      An array containing at most one supported order execution option. See Order execution options for details.

    • timestamp

      timestamp

    • timestampms

      timestamp

    • is_liveboolean

      true if the order is active on the book (has remaining quantity and has not been canceled)

    • is_cancelledboolean

      true if the order has been canceled. Note the spelling, "cancelled" instead of "canceled". This is for compatibility reasons.

    • reasonstring

      Populated with the reason your order was canceled, if available.

    • was_forcedboolean

      Will always be false.

    • executed_amountstring · decimal

      The amount of the order that has been filled.

    • remaining_amountstring · decimal

      The amount of the order that has not been filled.

    • original_amountstring · decimal

      The originally submitted amount of the order.

    • is_hiddenboolean

      Will always return false.

    • tradesobject[]

      Contains an array of JSON objects with trade details.

​List Active Orders

POST
https://api.gemini.com
/v1/orders

Roles

The API key you use to access this endpoint must have the Trader or Auditor role assigned. See Roles for more information.

The OAuth scope must have orders:read assigned to access this endpoint. See OAuth Scopes for more information.

​List Active Orders › 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
    Default: text/plain
  • Content-Lengthstring
    Default: 0
  • Cache-Controlstring
    Default: no-cache

​List Active Orders › Request Body

  • requeststring · required

    The API endpoint path

    Example: /v1/orders
  • noncerequired

    timestamp

  • 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: primary

​List Active Orders › Responses

    • order_idstring · integer

      The order id

    • client_order_idstring · integer

      An optional client-specified order id

    • symbolstring

      The symbol of the order

    • exchangestring

      Will always be "gemini"

    • pricestring · decimal

      The price the order was issued at

    • avg_execution_pricestring · decimal

      The average price at which this order as been executed so far. 0 if the order has not been executed at all.

    • sidestring · enum
      Enum values:
      buy
      sell
    • typestring · enum

      Description of the order

      Enum values:
      exchange limit
      exchange stop limit
      exchange market
    • optionsstring[]

      An array containing at most one supported order execution option. See Order execution options for details.

    • timestamp

      timestamp

    • timestampms

      timestamp

    • is_liveboolean

      true if the order is active on the book (has remaining quantity and has not been canceled)

    • is_cancelledboolean

      true if the order has been canceled. Note the spelling, "cancelled" instead of "canceled". This is for compatibility reasons.

    • reasonstring

      Populated with the reason your order was canceled, if available.

    • was_forcedboolean

      Will always be false.

    • executed_amountstring · decimal

      The amount of the order that has been filled.

    • remaining_amountstring · decimal

      The amount of the order that has not been filled.

    • original_amountstring · decimal

      The originally submitted amount of the order.

    • is_hiddenboolean

      Will always return false.

    • tradesobject[]

      Contains an array of JSON objects with trade details.

​List Past Orders

POST
https://api.gemini.com
/v1/orders/history

This API retrieves (closed) orders history for an account.

Roles

The API key you use to access this endpoint must have the Trader or Auditor role assigned. See Roles for more information.

The OAuth scope must have history:read assigned to access this endpoint. See OAuth Scopes for more information.

How to retrieve your order history

To retrieve your full order history walking backwards,

  1. Initial request: POST to https://api.gemini.com/v1/orders/history with a JSON payload including a timestamp key with value 0 and a limit_orders key with value 500
  2. When you receive the list of orders, it will be sorted by timestamp descending - so the first element in the list will have the highest timestamp value. For this example, say that value is X.
  3. Create a second POST request with a JSON payload including a timestamp key with value X+1 and a limit_orders key with value 500.
  4. Take the first element of the list returned with highest timestamp value Y and create a third POST request with a JSON payload including a timestamp key with value Y+1 and a limit_orders key with value 500.
  5. Continue creating POST requests and retrieving orders until an empty list is returned.

Break Types

In the rare event that a trade has been reversed (broken), the trade that is broken will have this flag set. The field will contain one of these values

ValueDescription
manualThe trade was reversed manually. This means that all fees, proceeds, and debits associated with the trade have been credited or debited to the account seperately. That means that this reported trade must be included for order for the account balance to be correct.
fullThe trade was fully broken. The reported trade should not be accounted for. It will be as though the transfer of fund associated with the trade had simply not happened.

​List Past Orders › 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
    Default: text/plain
  • Content-Lengthstring
    Default: 0
  • Cache-Controlstring
    Default: no-cache

​List Past Orders › Request Body

  • requeststring · required

    The API endpoint /v1/orders/history

  • noncerequired

    The nonce, as described in Private API Invocation

  • symbolstring

    The symbol to retrieve orders for

  • limit_ordersinteger

    The maximum number of orders to return. Default is 50, max is 500.

    Default: 50
  • timestamp

    In iso datetime with timezone format from that date you will get order history

  • accountstring

    Required for Master API keys as described in Private API Invocation. The name of the account within the subaccount group.

​List Past Orders › Responses

    • order_idstring · integer

      The order id

    • client_order_idstring · integer

      An optional client-specified order id

    • symbolstring

      The symbol of the order

    • exchangestring

      Will always be "gemini"

    • pricestring · decimal

      The price the order was issued at

    • avg_execution_pricestring · decimal

      The average price at which this order as been executed so far. 0 if the order has not been executed at all.

    • sidestring · enum
      Enum values:
      buy
      sell
    • typestring · enum

      Description of the order

      Enum values:
      exchange limit
      exchange stop limit
      exchange market
    • optionsstring[]

      An array containing at most one supported order execution option. See Order execution options for details.

    • timestamp

      timestamp

    • timestampms

      timestamp

    • is_liveboolean

      true if the order is active on the book (has remaining quantity and has not been canceled)

    • is_cancelledboolean

      true if the order has been canceled. Note the spelling, "cancelled" instead of "canceled". This is for compatibility reasons.

    • reasonstring

      Populated with the reason your order was canceled, if available.

    • was_forcedboolean

      Will always be false.

    • executed_amountstring · decimal

      The amount of the order that has been filled.

    • remaining_amountstring · decimal

      The amount of the order that has not been filled.

    • original_amountstring · decimal

      The originally submitted amount of the order.

    • is_hiddenboolean

      Will always return false.

    • tradesobject[]

      Contains an array of JSON objects with trade details.

​List Past Trades

POST
https://api.gemini.com
/v1/mytrades

Roles

The API key you use to access this endpoint must have the Trader or Auditor role assigned. See Roles for more information.

The OAuth scope must have history:read assigned to access this endpoint. See OAuth Scopes for more information.

How to retrieve your trade history

To retrieve your full trade history walking backwards,

  1. Initial request: POST to https://api.gemini.com/v1/mytrades with a JSON payload including a timestamp key with value 0 and a limit_trades key with value 500
  2. When you receive the list of trades, it will be sorted by timestamp descending - so the first element in the list will have the highest timestamp value. For this example, say that value is X.
  3. Create a second POST request with a JSON payload including a timestamp key with value X+1 and a limit_trades key with value 500.
  4. Take the first element of the list returned with highest timestamp value Y and create a third POST request with a JSON payload including a timestamp key with value Y+1 and a limit_trades key with value 500.
  5. Continue creating POST requests and retrieving trades until an empty list is returned.

Break Types

In the rare event that a trade has been reversed (broken), the trade that is broken will have this flag set. The field will contain one of these values

ValueDescription
manualThe trade was reversed manually. This means that all fees, proceeds, and debits associated with the trade have been credited or debited to the account seperately. That means that this reported trade must be included for order for the account balance to be correct.
fullThe trade was fully broken. The reported trade should not be accounted for. It will be as though the transfer of fund associated with the trade had simply not happened.

​List Past Trades › 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
    Default: text/plain
  • Content-Lengthstring
    Default: 0
  • Cache-Controlstring
    Default: no-cache

​List Past Trades › Request Body

  • requeststring · required

    The API endpoint path

    Example: /v1/mytrades
  • noncerequired

    timestamp

  • 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: primary
  • symbolstring

    The symbol to retrieve trades for

    Example: btcusd
  • limit_tradesinteger

    The maximum number of trades to return. Default is 50, max is 500.

    Example: 50
  • timestamp

    timestamp

​List Past Trades › Responses

    • pricestring
      Example: 9100
    • amountstring
      Example: 1.5
    • timestamp

      timestamp

    • timestampms

      timestamp

    • typestring · enum
      Enum values:
      Buy
      Sell
      Example: Buy
    • aggressorboolean
      Example:
    • fee_currencystring
      Example: USD
    • fee_amountstring
      Example: 13.65
    • tidinteger
      Example: 123456789
    • order_idstring
      Example: 123456789
    • client_order_idstring
    • exchangestring
      Example: gemini
    • is_auction_fillboolean
    • breakstring · enum
      Enum values:
      trade correct

​Get Trading Volume

POST
https://api.gemini.com
/v1/tradevolume

Roles

The API key you use to access this endpoint must have the Trader or Auditor role assigned. See Roles for more information.

The OAuth scope must have history:read assigned to access this endpoint. See OAuth Scopes for more information.

​Get Trading Volume › 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
    Default: text/plain
  • Content-Lengthstring
    Default: 0
  • Cache-Controlstring
    Default: no-cache

​Get Trading Volume › Request Body

  • requeststring · required

    The API endpoint path

    Example: /v1/tradevolume
  • noncerequired

    timestamp

  • 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: primary

​Get Trading Volume › Responses

    • symbolstring
      Example: btcusd
    • base_currencystring
      Example: BTC
    • quote_currencystring
      Example: USD
    • notional_currencystring
      Example: USD
    • data_datestring
      Example: 2020-06-02
    • total_volume_basestring
      Example: 10.5
    • maker_buy_sell_ratiostring
      Example: 1.2
    • buy_maker_basestring
      Example: 5.5
    • buy_maker_notionalstring
      Example: 50050
    • buy_maker_countinteger
      Example: 10
    • sell_maker_basestring
      Example: 5
    • sell_maker_notionalstring
      Example: 45500
    • sell_maker_countinteger
      Example: 8
    • buy_taker_basestring
      Example: 8.5
    • buy_taker_notionalstring
      Example: 77350
    • buy_taker_countinteger
      Example: 15
    • sell_taker_basestring
      Example: 7.5
    • sell_taker_notionalstring
      Example: 68250
    • sell_taker_countinteger
      Example: 12

​Get Notional Trading Volume

POST
https://api.gemini.com
/v1/notionalvolume

Roles

The API key you use to access this endpoint must have the Trader or Auditor role assigned. See Roles for more information.

The OAuth scope must have history:read assigned to access this endpoint. See OAuth Scopes for more information.

​Get Notional Trading Volume › 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
    Default: text/plain
  • Content-Lengthstring
    Default: 0
  • Cache-Controlstring
    Default: no-cache

​Get Notional Trading Volume › Request Body

  • requeststring · required

    The API endpoint path

    Example: /v1/notionalvolume
  • noncerequired

    timestamp

  • 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: primary

​Get Notional Trading Volume › Responses

    • datestring · date
      Example: 2020-06-02
    • last_updated_msinteger
      Example: 1591084414622
    • web_maker_fee_bpsinteger
      Example: 25
    • web_taker_fee_bpsinteger
      Example: 35
    • web_auction_fee_bpsinteger
      Example: 25
    • api_maker_fee_bpsinteger
      Example: 10
    • api_taker_fee_bpsinteger
      Example: 35
    • api_auction_fee_bpsinteger
      Example: 20
    • fix_maker_fee_bpsinteger
      Example: 10
    • fix_taker_fee_bpsinteger
      Example: 35
    • fix_auction_fee_bpsinteger
      Example: 20
    • notional_30d_volumestring
      Example: 1000000
    • notional_1d_volumeobject[]
    • api_notional_30d_volumestring
      Example: 750000
    • fee_tierobject

​Wrap Order

POST
https://api.gemini.com
/v1/wrap/{symbol}

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.

​Wrap Order › path Parameters

​Wrap Order › 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
    Default: text/plain
  • Content-Lengthstring
    Default: 0
  • Cache-Controlstring
    Default: no-cache

​Wrap Order › Request Body

  • requeststring · required

    The literal string "/v1/wrap/symbol"

  • noncerequired

    The nonce, as described in Private API Invocation

  • amountstring · required

    The amount to wrap

  • sidestring · enum

    "buy" or "sell"

    Enum values:
    buy
    sell
  • client_order_idstring

    A client-specified order id

  • accountstring

    Required for Master API keys. The name of the account within the subaccount group.

​Wrap Order › Responses

    • orderIdstring

      The order ID

    • pairstring

      Trading pair symbol

    • pricestring

      The price of the order

    • priceCurrencystring

      The currency in which the order is priced

    • sidestring

      Either "buy" or "sell"

    • quantitystring

      The amount that was executed

    • quantityCurrencystring

      The currency label for the quantity field

    • totalSpendstring

      Total quantity spent for the order

    • totalSpendCurrencystring

      Currency of the totalSpend

    • feestring

      The amount charged

    • feeCurrencystring

      Currency that the fee was paid in

    • depositFeestring

      The deposit fee quantity

    • depositFeeCurrencystring

      Currency in which depositFee is taken

Market DataFund Management