GEgemini
Market Data

Get Symbol Details

This endpoint retrieves extra detail on supported symbols, such as minimum order size, tick size, quote increment and more.

get/v1/symbols/details/{symbol}

Request

  • Base URL
    https://api.gemini.com
  • URL
    https://api.gemini.com/v1/symbols/details/{symbol}
  • Auth
    none declared

Path parameters

symbolstring required

Trading pair symbol <br /> <br />

BTCUSD, etc. See <u>symbols and minimums</u>.

Response

Instrument responses examples

symbolstring

The requested symbol. See symbols and minimums

base_currencystring

CCY1 or the top currency. (i.e BTC in BTCUSD)

quote_currencystring

CCY2 or the quote currency. (i.e USD in BTCUSD)

tick_sizenumber

The number of decimal places in the base_currency. (i.e 1e-8)

quote_incrementnumber

The number of decimal places in the quote_currency (i.e 0.01)

min_order_sizestring

The minimum order size in base_currency units (i.e 0.00001)

statusstring

Status of the current order book. Can be open, closed, cancel_only, post_only, limit_only.

wrap_enabledboolean

When True, symbol can be wrapped using this endpoint:
POST https://api.gemini.com/v1/wrap/:symbol

product_typestring

Instrument type spot / swap -- where swap signifies perpetual swap.

contract_typestring

vanilla / linear / inverse where vanilla is for spot while linear is for perpetual swap and inverse is a special case perpetual swap where the perpetual contract will be settled in base currency.

contract_price_currencystring

CCY2 or the quote currency for spot instrument (i.e. USD in BTCUSD) Or collateral currency of the contract in case of perpetual swap instrument.

Example response

{
  "symbol": "BTCUSD",
  "base_currency": "BTC",
  "quote_currency": "USD",
  "tick_size": 1e-8,
  "quote_increment": 0.01,
  "min_order_size": "0.00001",
  "status": "open",
  "product_type": "spot",
  "contract_type": "vanilla",
  "contract_price_currency": "USD"
}

Changes

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