Gemini Crypto Exchange Logo
REST API

​Market Data (1.0.0)

Endpoint

​List Symbols

GET
https://api.gemini.com
/v1/symbols

This endpoint retrieves all available symbols for trading.

​List Symbols › Responses

    string

    An array of supported symbols.

​Get Symbol Details

GET
https://api.gemini.com
/v1/symbols/details/{symbol}

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

​Get Symbol Details › path Parameters

​Get Symbol Details › Responses

    • symbolstring

      The requested symbol. See symbols and minimums

      Example: BTCUSD
    • base_currencystring

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

      Example: BTC
    • quote_currencystring

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

      Example: USD
    • tick_sizenumber · decimal

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

      Example: 1e-8
    • quote_incrementnumber · decimal

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

      Example: 0.01
    • min_order_sizestring

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

      Example: 0.00001
    • statusstring

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

      Example: open
    • 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.

      Example: spot
    • 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.

      Example: vanilla
    • 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: USD

​Get Network

GET
https://api.gemini.com
/v1/network/{token}

This endpoint retrieves the associated network for a requested token.

​Get Network › path Parameters

​Get Network › Responses

    • tokenstring

      The requested token.

    • networkstring[]

      Network of the requested token.

​Get Ticker

GET
https://api.gemini.com
/v1/pubticker/{symbol}

This endpoint retrieves information about recent trading activity for the symbol.

​Get Ticker › path Parameters

​Get Ticker › Responses

    • bidnumber · decimal

      The highest bid currently available

      Example: 977.59
    • asknumber · decimal

      The lowest ask currently available

      Example: 977.35
    • lastnumber · decimal

      The price of the last executed trade

      Example: 977.65
    • volumeobject

      Information about the 24 hour volume on the exchange. See properties below

​List Fee Promos

GET
https://api.gemini.com
/v1/feepromos

This endpoint retrieves symbols that currently have fee promos.

​List Fee Promos › Responses

    • symbolsstring[]

      Symbols that currently have fee promos

​Get Current Order Book

GET
https://api.gemini.com
/v1/book/{symbol}

This will return the current order book as two arrays (bids / asks).

​Get Current Order Book › path Parameters

​Get Current Order Book › query Parameters

  • limit_bidsnumber · min: 1

    Limit the number of bid (offers to buy) price levels returned. Default is 50. May be 0 to return the full order book on this side.

  • limit_asksnumber · min: 1

    Limit the number of ask (offers to sell) price levels returned. Default is 50. May be 0 to return the full order book on this side.

​Get Current Order Book › Responses

    • bidsobject[]

      The bid price levels currently on the book. These are offers to buy at a given price.

    • asksobject[]

      The ask price levels currently on the book. These are offers to sell at a given price.

​List Trades

GET
https://api.gemini.com
/v1/trades/{symbol}

This will return the trades that have executed since the specified timestamp. Timestamps are either seconds or milliseconds since the epoch (1970-01-01). See the Data Types section about timestamp for information on this.

Each request will show at most 500 records.

If no since or timestamp is specified, then it will show the most recent trades; otherwise, it will show the most recent trades that occurred after that timestamp.

​List Trades › path Parameters

​List Trades › query Parameters

  • timestamp

    Only return trades after this timestamp. See Timestamps for more information. If not present, will show the most recent trades. For backwards compatibility, you may also use the alias since. With timestamp, there is a 90-day hard limit.

  • since_tidnumber

    Only retuns trades that executed after this tid. since_tid trumps timestamp parameter which has no effect if provided too. You may set since_tid to zero to get the earliest available trade history data.

  • limit_tradesnumber

    The maximum number of trades to return. The default is 50.

    Default: 50
  • include_breaksboolean

    Whether to display broken trades. False by default. Can be 1 or true to activate

​List Trades › Responses

    • timestamp

      timestamp

    • timestampms

      timestamp

    • tidinteger

      The trade ID number

      Example: 5335307668
    • pricestring · decimal

      The price the trade was executed at

      Example: 3610.85
    • amountstring · decimal

      The amount that was traded

      Example: 0.27413495
    • exchangestring

      Will always be "gemini"

      Example: gemini
    • typestring · enum
      • buy means that an ask was removed from the book by an incoming buy order.
      • sell means that a bid was removed from the book by an incoming sell order.
      Enum values:
      buy
      sell
      Example: buy
    • brokenboolean

      Whether the trade was broken or not. Broken trades will not be displayed by default; use the include_breaks to display them.

      Example: false

​List Prices

GET
https://api.gemini.com
/v1/pricefeed

​List Prices › Responses

    • pairstring

      Trading pair symbol. See symbols and minimums

    • pricestring

      Current price of the pair on the Gemini order book

    • percentChange24hstring

      24 hour change in price of the pair on the Gemini order book

​Get Funding Amount

GET
https://api.gemini.com
/v1/fundingamount/{symbol}

​Get Funding Amount › path Parameters

​Get Funding Amount › Responses

    • symbolstring

      The requested symbol. See symbols and minimums

    • fundingDateTimestring

      UTC date time in format yyyy-MM-ddThh:mm:ss.SSSZ format

    • fundingTimestampMilliSecsnumber · long

      Current funding amount Epoc time.

    • nextFundingTimestampnumber · long

      Next funding amount Epoc time.

    • amountnumber · decimal

      The dollar amount for a Long 1 position held in the symbol for funding period (1 hour)

    • estimatedFundingAmountnumber · decimal

      The estimated dollar amount for a Long 1 position held in the symbol for next funding period (1 hour)

​Get Funding Amount Report File

GET
https://api.gemini.com
/v1/fundingamountreport/records.xlsx

Examples

  • symbol=BTCGUSDPERP&fromDate=2024-04-10&toDate=2024-04-25&numRows=1000
    Compare and obtain the minimum records between (2024-04-10 to 2024-04-25) and 1000. If (2024-04-10 to 2024-04-25) contains 360 records. Then fetch the minimum between 360 and 1000 records only.

  • symbol=BTCGUSDPERP&numRows=2024-04-10&toDate=2024-04-25
    If (2024-04-10 to 2024-04-25) contains 360 records. Then fetch 360 records only.

  • symbol=BTCGUSDPERP&numRows=1000
    Fetch maximum 1000 records starting from Now to a historical date

  • symbol=BTCGUSDPERP
    Fetch maximum 8760 records starting from Now to a historical date

​Get Funding Amount Report File › query Parameters

  • symbolstring · required

    Trading pair symbol

    BTCGUSDPERP, etc. See symbols and minimums.

  • fromDatestring · date

    Mandatory if toDate is specified, else optional. If empty, will only fetch records by numRows value.

  • toDatestring · date

    Mandatory if fromDate is specified, else optional. If empty, will only fetch records by numRows value.

  • numRowsinteger

    If empty, default value '8760'

​Get Funding Amount Report File › Responses

    string

​Get Ticker V2

GET
https://api.gemini.com
/v2/ticker/{symbol}

This endpoint retrieves information about recent trading activity for the provided symbol.

​Get Ticker V2 › path Parameters

  • symbolstring · required

    Trading pair symbol

​Get Ticker V2 › Responses

    • symbolstring

      The trading pair symbol

      Example: BTCUSD
    • openstring · decimal

      Open price from 24 hours ago

      Example: 9121.76
    • highstring · decimal

      High price from 24 hours ago

      Example: 9440.66
    • lowstring · decimal

      Low price from 24 hours ago

      Example: 9106.51
    • closestring · decimal

      Close price (most recent trade)

      Example: 9347.66
    • changesstring[]

      Hourly prices descending for past 24 hours

      Example: ["9365.1","9386.16","9373.41","9322.56","9268.89","9265.38"]
    • bidstring · decimal

      Current best bid

      Example: 9345.70
    • askstring · decimal

      Current best offer

      Example: 9347.67

​List Candles

GET
https://api.gemini.com
/v2/candles/{symbol}/{time_frame}

This endpoint retrieves time-intervaled data for the provided symbol.

​List Candles › path Parameters

  • symbolstring · required

    Trading pair symbol

  • time_framestring · enum · required

    Time range for each candle:

    • 1m - 1 minute
    • 5m - 5 minutes
    • 15m - 15 minutes
    • 30m - 30 minutes
    • 1h - 1 hour
    • 6h - 6 hours
    • 1day - 1 day
    Enum values:
    1m
    5m
    15m
    30m
    1h
    6h
    1d

​List Candles › Responses

    • Candlearray
      Example: [[1559755800000,7781.6,7820.23,7776.56,7819.39,34.7624802159],[1559755800000,7781.6,7829.46,7776.56,7817.28,43.4228281059]]

​List Derivative Candles

GET
https://api.gemini.com
/v2/derivatives/candles/{symbol}/{time_frame}

This endpoint retrieves time-intervaled data for the provided perpetual symbol.

​List Derivative Candles › path Parameters

  • symbolstring · required

    Trading pair symbol. Available only for perpetual pairs like BTCGUSDPERP

  • time_framestring · enum · required

    Time range for each candle. 1m: 1 minute (only)

    Enum values:
    1m

​List Derivative Candles › Responses

    • Candlearray
      Example: [[1559755800000,7781.6,7820.23,7776.56,7819.39,34.7624802159],[1559755800000,7781.6,7829.46,7776.56,7817.28,43.4228281059]]

​FX Rate

GET
https://api.gemini.com
/v2/fxrate/{symbol}/{timestamp}

We have a growing international institutional customer base. When pulling market data for charting, it can be useful to have access to our FX rate for the relevant currency at that time.

Please note, Gemini does not offer foreign exchange services. This endpoint is for historical reference only and does not provide any guarantee of future exchange rates.

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

Supported Pairs

[AUDUSD, CADUSD, COPUSD, EURUSD, CHFUSD, HKDUSD, NZDUSD, GBPUSD, BRLUSD, INRUSD, SGDUSD, KRWUSD, JPYUSD, CNYUSD]

​FX Rate › path Parameters

  • symbolstring · required

    Trading pair symbol

    BTCUSD, etc. See symbols and minimums.

  • timestamprequired

    The timestamp to pull the FX rate for.

    Note: We likely need to round this to the closest timestamp we received an update for from BCB. Gemini strongly recommends using milliseconds instead of seconds for timestamps.

​FX Rate › 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

​FX Rate › Responses

    • fxPairstring

      The requested currency pair

      Example: AUDUSD
    • ratenumber · double

      The exchange rate

      Example: 0.69
    • asOf

      timestamp

    • providerstring

      The market data provider

      Example: bcb
    • benchmarkstring

      The market for which the retrieved price applies to

      Example: Spot
Orders