gemini
gemini cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.
gemini
Kind: global class
Extends: Exchange
- fetchCurrencies
- fetchMarkets
- fetchOrderBook
- fetchTicker
- fetchTickers
- fetchTrades
- fetchTradingFees
- fetchBalance
- fetchOrder
- fetchOpenOrders
- createOrder
- cancelOrder
- fetchMyTrades
- withdraw
- fetchDepositsWithdrawals
- fetchDepositAddress
- fetchDepositAddressesByNetwork
- createDepositAddress
- fetchOHLCV
- fetchOpenInterest
- watchTrades
- watchTradesForSymbols
- watchOHLCV
- watchOrderBook
- watchOrderBookForSymbols
- watchBidsAsks
- fetchOrders
fetchCurrencies
fetches all available currencies on an exchange
Kind: instance method of gemini
Returns: object - an associative dictionary of currencies
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the endpoint |
gemini.fetchCurrencies (params?)fetchMarkets
retrieves data on all markets for gemini
Kind: instance method of gemini
Returns: Array<object> - an array of objects representing market data
See: https://docs.gemini.com/rest-api/#symbols
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.fetchMarkets (params?)fetchOrderBook
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of gemini
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://docs.gemini.com/rest-api/#current-order-book
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch the order book for |
| limit | int | No | the maximum amount of order book entries to return |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.fetchOrderBook (symbol, limit?, params?)fetchTicker
fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of gemini
Returns: object - a ticker structure
See
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch the ticker for |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.fetchTickerMethod | object | No | 'fetchTickerV2', 'fetchTickerV1' or 'fetchTickerV1AndV2' - 'fetchTickerV1' for original ccxt.gemini.fetchTicker - 'fetchTickerV1AndV2' for 2 api calls to get the result of both fetchTicker methods - default = 'fetchTickerV1' |
gemini.fetchTicker (symbol, params?)fetchTickers
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of gemini
Returns: object - a dictionary of ticker structures
See: https://docs.gemini.com/rest-api/#price-feed
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string>, undefined | Yes | unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.fetchTickers (symbols, params?)fetchTrades
get the list of most recent trades for a particular symbol
Kind: instance method of gemini
Returns: Array<Trade> - a list of trade structures
See: https://docs.gemini.com/rest-api/#trade-history
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch trades for |
| since | int | No | timestamp in ms of the earliest trade to fetch |
| limit | int | No | the maximum amount of trades to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.fetchTrades (symbol, since?, limit?, params?)fetchTradingFees
fetch the trading fees for multiple markets
Kind: instance method of gemini
Returns: object - a dictionary of fee structures indexed by market symbols
See: https://docs.gemini.com/rest-api/#get-notional-volume
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.fetchTradingFees (params?)fetchBalance
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of gemini
Returns: object - a balance structure
See: https://docs.gemini.com/rest-api/#get-available-balances
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.fetchBalance (params?)fetchOrder
fetches information on an order made by the user
Kind: instance method of gemini
Returns: object - An order structure
See: https://docs.gemini.com/rest-api/#order-status
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id |
| symbol | string | Yes | unified symbol of the market the order was made in |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.fetchOrder (id, symbol, params?)fetchOpenOrders
fetch all unfilled currently open orders
Kind: instance method of gemini
Returns: Array<Order> - a list of order structures
See: https://docs.gemini.com/rest-api/#get-active-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| since | int | No | the earliest time in ms to fetch open orders for |
| limit | int | No | the maximum number of open orders structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.fetchOpenOrders (symbol, since?, limit?, params?)createOrder
create a trade order
Kind: instance method of gemini
Returns: object - an order structure
See: https://docs.gemini.com/rest-api/#new-order
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to create an order in |
| type | string | Yes | must be 'limit' |
| side | string | Yes | 'buy' or 'sell' |
| amount | float | Yes | how much of currency you want to trade in units of base currency |
| price | float | No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.createOrder (symbol, type, side, amount, price?, params?)cancelOrder
cancels an open order
Kind: instance method of gemini
Returns: object - An order structure
See: https://docs.gemini.com/rest-api/#cancel-order
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id |
| symbol | string | Yes | unified symbol of the market the order was made in |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.cancelOrder (id, symbol, params?)fetchMyTrades
fetch all trades made by the user
Kind: instance method of gemini
Returns: Array<Trade> - a list of trade structures
See: https://docs.gemini.com/rest-api/#get-past-trades
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| since | int | No | the earliest time in ms to fetch trades for |
| limit | int | No | the maximum number of trades structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.fetchMyTrades (symbol, since?, limit?, params?)withdraw
make a withdrawal
Kind: instance method of gemini
Returns: object - a transaction structure
See: https://docs.gemini.com/rest-api/#withdraw-crypto-funds
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code |
| amount | float | Yes | the amount to withdraw |
| address | string | Yes | the address to withdraw to |
| tag | string | Yes | |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.withdraw (code, amount, address, tag, params?)fetchDepositsWithdrawals
fetch history of deposits and withdrawals
Kind: instance method of gemini
Returns: object - a list of transaction structure
See: https://docs.gemini.com/rest-api/#transfers
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | No | unified currency code for the currency of the deposit/withdrawals, default is undefined |
| since | int | No | timestamp in ms of the earliest deposit/withdrawal, default is undefined |
| limit | int | No | max number of deposit/withdrawals to return, default is undefined |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.fetchDepositsWithdrawals (code?, since?, limit?, params?)fetchDepositAddress
fetch the deposit address for a currency associated with this account
Kind: instance method of gemini
Returns: object - an address structure
See: https://docs.gemini.com/rest-api/#get-deposit-addresses
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code |
| params | object | No | extra parameters specific to the endpoint |
| params.network | string | No | required The chain of currency |
gemini.fetchDepositAddress (code, params?)fetchDepositAddressesByNetwork
fetch a dictionary of addresses for a currency, indexed by network
Kind: instance method of gemini
Returns: object - a dictionary of address structures indexed by the network
See: https://docs.gemini.com/rest-api/#get-deposit-addresses
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code of the currency for the deposit address |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.network | string | No | required The chain of currency |
gemini.fetchDepositAddressesByNetwork (code, params?)createDepositAddress
create a currency deposit address
Kind: instance method of gemini
Returns: object - an address structure
See: https://docs.gemini.com/rest-api/#new-deposit-address
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code of the currency for the deposit address |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.createDepositAddress (code, params?)fetchOHLCV
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of gemini
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://docs.gemini.com/rest-api/#candles
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string | Yes | the length of time each candle represents |
| since | int | No | timestamp in ms of the earliest candle to fetch |
| limit | int | No | the maximum amount of candles to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.fetchOHLCV (symbol, timeframe, since?, limit?, params?)fetchOpenInterest
retrieves the open interest of a contract trading pair
Kind: instance method of gemini
Returns: object - an open interest structure/docs/manual#open-interest-structure
See: https://docs.gemini.com/rest/derivatives#get-risk-stats
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified CCXT market symbol |
| params | object | No | exchange specific parameters |
gemini.fetchOpenInterest (symbol, params?)watchTrades
watch the list of most recent trades for a particular symbol
Kind: instance method of gemini
Returns: Array<object> - a list of trade structures
See: https://docs.gemini.com/websocket-api/#market-data-version-2
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch trades for |
| since | int | No | timestamp in ms of the earliest trade to fetch |
| limit | int | No | the maximum amount of trades to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.watchTrades (symbol, since?, limit?, params?)watchTradesForSymbols
get the list of most recent trades for a list of symbols
Kind: instance method of gemini
Returns: Array<object> - a list of trade structures
See: https://docs.gemini.com/websocket-api/#multi-market-data
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified symbol of the market to fetch trades for |
| since | int | No | timestamp in ms of the earliest trade to fetch |
| limit | int | No | the maximum amount of trades to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.watchTradesForSymbols (symbols, since?, limit?, params?)watchOHLCV
watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of gemini
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://docs.gemini.com/websocket-api/#candles-data-feed
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string | Yes | the length of time each candle represents |
| since | int | No | timestamp in ms of the earliest candle to fetch |
| limit | int | No | the maximum amount of candles to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.watchOHLCV (symbol, timeframe, since?, limit?, params?)watchOrderBook
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of gemini
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://docs.gemini.com/websocket-api/#market-data-version-2
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch the order book for |
| limit | int | No | the maximum amount of order book entries to return |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.watchOrderBook (symbol, limit?, params?)watchOrderBookForSymbols
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of gemini
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://docs.gemini.com/websocket-api/#multi-market-data
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified array of symbols |
| limit | int | No | the maximum amount of order book entries to return |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.watchOrderBookForSymbols (symbols, limit?, params?)watchBidsAsks
watches best bid & ask for symbols
Kind: instance method of gemini
Returns: object - a ticker structure
See: https://docs.gemini.com/websocket-api/#multi-market-data
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified symbol of the market to fetch the ticker for |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.watchBidsAsks (symbols, params?)fetchOrders
watches information on multiple orders made by the user
Kind: instance method of gemini
Returns: Array<object> - a list of order structures
See: https://docs.gemini.com/websocket-api/#order-events
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol of the market orders were made in |
| since | int | No | the earliest time in ms to fetch orders for |
| limit | int | No | the maximum number of order structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
gemini.fetchOrders (symbol, since?, limit?, params?)