Gemini Functions


Note

Even though the functions are written as robin_stocks.module.function, the module name is unimportant when calling a function. Simply use robin_stocks.function for all functions.

Sending Requests to API


robin_stocks.gemini.helper.request_get(url, payload, parse_json)[source]

Generic function for sending a get request.

Parameters:
  • url (str) – The url to send a get request to.
  • payload (dict) – Dictionary of parameters to pass to the url. Will append the requests url as url/?key1=value1&key2=value2.
  • parse_json (bool) – Requests serializes data in the JSON format. Set this parameter true to parse the data to a dictionary using the JSON format.
Returns:

Returns a tuple where the first entry is the response and the second entry will be an error message from the get request. If there was no error then the second entry in the tuple will be None. The first entry will either be the raw request response or the parsed JSON response based on whether parse_json is True or not.

robin_stocks.gemini.helper.request_post(url, payload, parse_json)[source]

Generic function for sending a post request.

Parameters:
  • url (str) – The url to send a post request to.
  • payload (dict) – Dictionary of parameters to pass to the url. Will append the requests url as url/?key1=value1&key2=value2.
  • parse_json (bool) – Requests serializes data in the JSON format. Set this parameter true to parse the data to a dictionary using the JSON format.
Returns:

Returns a tuple where the first entry is the response and the second entry will be an error message from the get request. If there was no error then the second entry in the tuple will be None. The first entry will either be the raw request response or the parsed JSON response based on whether parse_json is True or not.

Logging In and Authentication


robin_stocks.gemini.authentication.login(api_key, secret_key)[source]

Set the authorization token so the API can be used.

robin_stocks.gemini.authentication.heartbeat(jsonify=None)[source]

Generate a heartbeat response to keep a session alive.

Returns:{“result”: “ok”}

Getting Crypto Information


robin_stocks.gemini.crypto.get_notional_volume(jsonify=None)[source]

Gets information about notional volume

Parameters:

jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.

Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a dictionary parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionary are listed below.

Dictionary Keys:
 
  • date - UTC date in yyyy-MM-dd format
  • last_updated_ms - Unix timestamp in millisecond of the last update
  • web_maker_fee_bps - Integer value representing the maker fee for all symbols in basis point for web orders
  • web_taker_fee_bps - Integer value representing the taker fee for all symbols in basis point for web orders
  • web_auction_fee_bps - Integer value representing the auction fee for all symbols in basis point for web orders
  • api_maker_fee_bps - Integer value representing the maker fee for all symbols in basis point for API orders
  • api_taker_fee_bps - Integer value representing the taker fee for all symbols in basis point for API orders
  • api_auction_fee_bps - Integer value representing the auction fee for all symbols in basis point for API orders
  • fix_maker_fee_bps - Integer value representing the maker fee for all symbols in basis point for FIX orders
  • fix_taker_fee_bps - Integer value representing the taker fee for all symbols in basis point for FIX orders
  • fix_auction_fee_bps - Integer value representing the auction fee for all symbols in basis point for FIX orders
  • block_maker_fee_bps - Integer value representing the maker fee for all symbols in basis point for block orders
  • block_taker_fee_bps - Integer value representing the taker fee for all symbols in basis point for block orders
  • notional_30d_volume - Maker plus taker trading volume for the past 30 days, including auction volume
  • notional_1d_volume - A list of 1 day notional volume for the past 30 days
robin_stocks.gemini.crypto.get_price(ticker, side)[source]

Returns either the bid or the ask price as a string.

Parameters:
  • ticker (str) – The ticker of the crypto.
  • side (str) – Either ‘buy’ or ‘sell’.
Returns:

Returns the bid or ask price as a string.

robin_stocks.gemini.crypto.get_pubticker(ticker, jsonify=None)[source]

Gets the pubticker information for a crypto.

Parameters:
  • ticker (str) – The ticker of the crypto.
  • jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.
Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a dictionary parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionary are listed below.

Dictionary Keys:
 
  • bid - The highest bid currently available
  • ask - The lowest ask currently available
  • last - The price of the last executed trade
  • volume - Information about the 24 hour volume on the exchange
robin_stocks.gemini.crypto.get_symbol_details(ticker, jsonify=None)[source]

Gets detailed information for a crypto.

Parameters:
  • ticker (str) – The ticker of the crypto.
  • jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.
Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a dictionary parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionary are listed below.

Dictionary Keys:
 
  • symbol - BTCUSD etc.
  • base_currency - CCY1 or the top currency. (ie BTC in BTCUSD)
  • quote_currency - CCY2 or the quote currency. (ie USD in BTCUSD)
  • tick_size - The number of decimal places in the quote_currency
  • quote_increment - The number of decimal places in the base_currency
  • min_order_size - The minimum order size in base_currency units.
  • status - Status of the current order book. Can be open, closed, cancel_only, post_only, limit_only.
robin_stocks.gemini.crypto.get_symbols(jsonify=None)[source]

Gets a list of all available crypto tickers.

Parameters:jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.
Returns:Returns a tuple where the first entry in the tuple is a requests reponse object or a list of strings and the second entry is an error string or None if there was not an error.
robin_stocks.gemini.crypto.get_ticker(ticker, jsonify=None)[source]

Gets the recent trading information for a crypto.

Parameters:
  • ticker (str) – The ticker of the crypto.
  • jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.
Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a dictionary parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionary are listed below.

Dictionary Keys:
 
  • symbol - BTCUSD etc.
  • open - Open price from 24 hours ago
  • high - High price from 24 hours ago
  • low - Low price from 24 hours ago
  • close - Close price (most recent trade)
  • changes - Hourly prices descending for past 24 hours
  • bid - Current best bid
  • ask - Current best offer
robin_stocks.gemini.crypto.get_trade_volume(jsonify=None)[source]

Gets information about trade volume. The response will be an array of up to 30 days of trade volume for each symbol.

Parameters:

jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.

Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a dictionary parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionary are listed below.

Dictionary Keys:
 
  • symbol - The symbol.
  • base_currency - quantity is denominated in this currency.
  • notional_currency - price is denominated as the amount of notional currency per one unit of base currency. Notional values are denominated in this currency.
  • data_date - UTC date in yyyy-MM-dd format.
  • total_volume_base - Total trade volume for this day.
  • maker_buy_sell_ratio - Maker buy/sell ratio is the proportion of maker base volume on trades where the account was on the buy side versus all maker trades. If there is no maker base volume on the buy side, then this value is 0.
  • buy_maker_base - Quantity for this day where the account was a maker on the buy side of the trade.
  • buy_maker_notional - Notional value for this day where the account was a maker on the buy side of the trade.
  • buy_maker_count - Number of trades for this day where the account was a maker on the buy side of the trade.
  • sell_maker_base - Quantity for this day where the account was a maker on the sell side of the trade.
  • sell_maker_notional - Notional value for this day where the account was a maker on the sell side of the trade.
  • sell_maker_count - Number of trades for this day where the account was a maker on the sell side of the trade.
  • buy_taker_base- Quantity for this day where the account was a taker on the buy side of the trade.
  • buy_taker_notional - Notional value for this day where the account was a taker on the buy side of the trade.
  • buy_taker_count - Number of trades for this day where the account was a taker on the buy side of the trade.
  • sell_taker_base - Quantity for this day where the account was a taker on the sell side of the trade.
  • sell_taker_notional - Notional value for this day where the account was a taker on the sell side of the trade.
  • sell_taker_count - Number of trades for this day where the account was a taker on the sell side of the trade.

Placing and Cancelling Orders


robin_stocks.gemini.orders.active_orders(jsonify=None)[source]

Get a list of all active orders.

Parameters:

jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.

Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a list of dictionaries parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionaries are listed below.

Dictionary Keys:
 
  • order_id - The order id
  • client_order_id - An optional client-specified order id
  • symbol - The symbol of the order
  • exchange - Will always be “gemini”
  • price - The price the order was issued at
  • avg_execution_price - The average price at which this order as been executed so far. 0 if the order has not been executed at all.
  • side - Either “buy” or “sell”.
  • type - Description of the order.
  • options - An array containing at most one supported order execution option.
  • timestamp - The timestamp the order was submitted. Note that for compatibility reasons, this is returned as a string. We recommend using the timestampms field instead.
  • timestampms - The timestamp the order was submitted in milliseconds.
  • is_live - true if the order is active on the book (has remaining quantity and has not been canceled)
  • is_cancelled - true if the order has been canceled. Note the spelling, “cancelled” instead of “canceled”. This is for compatibility reasons.
  • reason - Populated with the reason your order was canceled, if available.
  • was_forced - Will always be false.
  • executed_amount - The amount of the order that has been filled.
  • remaining_amount - The amount of the order that has not been filled.
  • original_amount - The originally submitted amount of the order.
  • is_hidden - Will always return false unless the order was placed with the indication-of-interest execution option.
robin_stocks.gemini.orders.cancel_all_active_orders(jsonify=None)[source]

Cancel all orders for all sessions opened by the account.

Parameters:

jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.

Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a dictionary parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionary are listed below.

Dictionary Keys:
 
  • result
  • details
robin_stocks.gemini.orders.cancel_all_session_orders(jsonify=None)[source]

Cancel all orders opened by the session.

Parameters:

jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.

Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a dictionary parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionary are listed below.

Dictionary Keys:
 
  • result
  • details
robin_stocks.gemini.orders.cancel_order(order_id, jsonify=None)[source]

Cancel a specific order based on ID.

Parameters:
  • order_id (str) – The id of the order. This is not the same as the client order ID.
  • jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.
Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a dictionary parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionary are listed below.

Dictionary Keys:
 
  • order_id - The order id
  • client_order_id - An optional client-specified order id
  • symbol - The symbol of the order
  • exchange - Will always be “gemini”
  • price - The price the order was issued at
  • avg_execution_price - The average price at which this order as been executed so far. 0 if the order has not been executed at all.
  • side - Either “buy” or “sell”.
  • type - Description of the order.
  • options - An array containing at most one supported order execution option.
  • timestamp - The timestamp the order was submitted. Note that for compatibility reasons, this is returned as a string. We recommend using the timestampms field instead.
  • timestampms - The timestamp the order was submitted in milliseconds.
  • is_live - true if the order is active on the book (has remaining quantity and has not been canceled)
  • is_cancelled - true if the order has been canceled. Note the spelling, “cancelled” instead of “canceled”. This is for compatibility reasons.
  • reason - Populated with the reason your order was canceled, if available.
  • was_forced - Will always be false.
  • executed_amount - The amount of the order that has been filled.
  • remaining_amount - The amount of the order that has not been filled.
  • original_amount - The originally submitted amount of the order.
  • is_hidden - Will always return false unless the order was placed with the indication-of-interest execution option.
robin_stocks.gemini.orders.get_trades_for_crypto(ticker, limit_trades=50, timestamp=None, jsonify=None)[source]

Gets a list of all transactions for a certain crypto.

Parameters:
  • ticker (str) – The ticker of the crypto.
  • limit_trades (Optional[int]) – The maximum number of trades to return. Default is 50, max is 500.
  • timestamp (Optional[str]) – Only return trades on or after this timestamp. If not present, will show the most recent orders
  • jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.
Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a list of dictionaries parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionaries are listed below.

Dictionary Keys:
 
  • price
  • amount
  • timestamp
  • timestampms
  • type
  • aggressor
  • fee_currency
  • fee_amount
  • tid
  • order_id
  • exchange
  • is_auction_fill
  • client_order_id
robin_stocks.gemini.orders.order(ticker, quantity, side, price=None, stop_limit_price=None, min_amount=None, options=None, jsonify=None)[source]

A generic order that can be used for any cryptocurrency.

Parameters:
  • ticker (str) – The ticker of the crypto.
  • quantity (str) – The amount to trade.
  • side (str) – Either “buy” or “sell”.
  • price (Optional[str]) – Set this value to set a limit price.
  • stop_limit_price (Optional[str]) – Set this value to set a stop price.
  • min_amount (Optional[str]) – Minimum decimal amount to purchase, for block trades only.
  • options (Optional[str]) – An optional array containing at most one supported order execution option.
  • jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.
Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a dictionary parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionary are listed below.

Dictionary Keys:
 
  • order_id - The order id
  • client_order_id - An optional client-specified order id
  • symbol - The symbol of the order
  • exchange - Will always be “gemini”
  • price - The price the order was issued at
  • avg_execution_price - The average price at which this order as been executed so far. 0 if the order has not been executed at all.
  • side - Either “buy” or “sell”.
  • type - Description of the order.
  • options - An array containing at most one supported order execution option.
  • timestamp - The timestamp the order was submitted. Note that for compatibility reasons, this is returned as a string. We recommend using the timestampms field instead.
  • timestampms - The timestamp the order was submitted in milliseconds.
  • is_live - true if the order is active on the book (has remaining quantity and has not been canceled)
  • is_cancelled - true if the order has been canceled. Note the spelling, “cancelled” instead of “canceled”. This is for compatibility reasons.
  • reason - Populated with the reason your order was canceled, if available.
  • was_forced - Will always be false.
  • executed_amount - The amount of the order that has been filled.
  • remaining_amount - The amount of the order that has not been filled.
  • original_amount - The originally submitted amount of the order.
  • is_hidden - Will always return false unless the order was placed with the indication-of-interest execution option.
robin_stocks.gemini.orders.order_market(ticker, quantity, side, jsonify=None)[source]

Gemini does not directly support market orders. This function will try to immediately place an order or it will cancel it.

Parameters:
  • ticker (str) – The ticker of the crypto.
  • quantity (str) – The amount to trade.
  • side (str) – Either “buy” or “sell”.
  • jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.
Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a dictionary parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionary are listed below.

Dictionary Keys:
 
  • order_id - The order id
  • client_order_id - An optional client-specified order id
  • symbol - The symbol of the order
  • exchange - Will always be “gemini”
  • price - The price the order was issued at
  • avg_execution_price - The average price at which this order as been executed so far. 0 if the order has not been executed at all.
  • side - Either “buy” or “sell”.
  • type - Description of the order.
  • options - An array containing at most one supported order execution option.
  • timestamp - The timestamp the order was submitted. Note that for compatibility reasons, this is returned as a string. We recommend using the timestampms field instead.
  • timestampms - The timestamp the order was submitted in milliseconds.
  • is_live - true if the order is active on the book (has remaining quantity and has not been canceled)
  • is_cancelled - true if the order has been canceled. Note the spelling, “cancelled” instead of “canceled”. This is for compatibility reasons.
  • reason - Populated with the reason your order was canceled, if available.
  • was_forced - Will always be false.
  • executed_amount - The amount of the order that has been filled.
  • remaining_amount - The amount of the order that has not been filled.
  • original_amount - The originally submitted amount of the order.
  • is_hidden - Will always return false unless the order was placed with the indication-of-interest execution option.
robin_stocks.gemini.orders.order_status(order_id, jsonify=None)[source]

Get the status for an order.

Parameters:
  • order_id (str) – The id of the order. This is not the same as the client order ID.
  • jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.
Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a dictionary parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionary are listed below.

Dictionary Keys:
 
  • order_id - The order id
  • client_order_id - An optional client-specified order id
  • symbol - The symbol of the order
  • exchange - Will always be “gemini”
  • price - The price the order was issued at
  • avg_execution_price - The average price at which this order as been executed so far. 0 if the order has not been executed at all.
  • side - Either “buy” or “sell”.
  • type - Description of the order.
  • options - An array containing at most one supported order execution option.
  • timestamp - The timestamp the order was submitted. Note that for compatibility reasons, this is returned as a string. We recommend using the timestampms field instead.
  • timestampms - The timestamp the order was submitted in milliseconds.
  • is_live - true if the order is active on the book (has remaining quantity and has not been canceled)
  • is_cancelled - true if the order has been canceled. Note the spelling, “cancelled” instead of “canceled”. This is for compatibility reasons.
  • reason - Populated with the reason your order was canceled, if available.
  • was_forced - Will always be false.
  • executed_amount - The amount of the order that has been filled.
  • remaining_amount - The amount of the order that has not been filled.
  • original_amount - The originally submitted amount of the order.
  • is_hidden - Will always return false unless the order was placed with the indication-of-interest execution option.

Getting Account Information


robin_stocks.gemini.account.check_available_balances(jsonify=None)[source]

Gets a list of all available balances in every currency.

Parameters:

jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.

Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a list of dictionaries parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionaries are listed below.

Dictionary Keys:
 
  • currency - The currency code.
  • amount - The current balance
  • available - The amount that is available to trade
  • availableForWithdrawal - The amount that is available to withdraw
  • type - “exchange”
robin_stocks.gemini.account.check_notional_balances(jsonify=None)[source]

Gets a list of all available balances in every currency.

Parameters:

jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.

Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a list of dictionaries parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionaries are listed below.

Dictionary Keys:
 
  • currency - The currency code.
  • amount - The current balance
  • amountNotional - Amount, in notional
  • available - The amount that is available to trade
  • availableNotional - Available, in notional
  • availableForWithdrawal - The amount that is available to withdraw
  • availableForWithdrawalNotional - AvailableForWithdrawal, in notional
robin_stocks.gemini.account.check_transfers(timestamp=None, limit_transfers=10, show_completed_deposit_advances=False, jsonify=None)[source]

Gets a list of all transfers.

Parameters:
  • timestamp (Optional[str]) – Only return transfers on or after this timestamp. If not present, will show the most recent transfers.
  • limit_transfers (Optional[int]) – The maximum number of transfers to return. Default is 10, max is 50.
  • show_completed_deposit_advances (Optional[int]) – Whether to display completed deposit advances. False by default. Must be set True to activate.
  • jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.
Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a list of dictionaries parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionaries are listed below.

Dictionary Keys:
 
  • type - Transfer type. Deposit or Withdrawal.
  • status - Transfer status. Advanced or Complete.
  • timestampms - The time that the trade was executed in milliseconds
  • eid - Transfer event id
  • advanceEid - Deposit advance event id
  • currency - Currency code
  • amount - The transfer amount
  • method - Optional. When currency is a fiat currency, the method field will attempt to supply ACH, Wire, or SEN. If the transfer is an internal transfer between subaccounts the method field will return Internal.
  • txHash - Optional. When currency is a cryptocurrency, supplies the transaction hash when available.
  • outputIdx - Optional. When currency is a cryptocurrency, supplies the output index in the transaction when available.
  • destination - Optional. When currency is a cryptocurrency, supplies the destination address when available.
  • purpose - Optional. Administrative field used to supply a reason for certain types of advances.
robin_stocks.gemini.account.get_account_detail(jsonify=None)[source]

Gets information about the profile attached to your API key.

Parameters:

jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.

Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a dictionary parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionary are listed below.

Dictionary Keys:
 
  • account - Contains information on the requested account – accountName - The name of the account provided upon creation. Will default to Primary – shortName - Nickname of the specific account (will take the name given, remove all symbols, replace all ” ” with “-” and make letters lowercase) – type - The type of account. Will return either exchange or custody – created - The timestamp of account creation, displayed as number of milliseconds since 1970-01-01 UTC. This will be transmitted as a JSON number
  • users - Contains an array of JSON objects with user information for the requested account – name - Full legal name of the user – lastSignIn - Timestamp of the last sign for the user. Formatted as yyyy-MM-dd’T’HH:mm:ss.SSS’Z’ – status - Returns user status. Will inform of active users or otherwise not active – countryCode - 2 Letter country code indicating residence of user. – isVerified - Returns verification status of user.
  • memo_reference_code - Returns wire memo reference code for linked bank account.
robin_stocks.gemini.account.get_approved_addresses(network, jsonify=None)[source]

Allows viewing of Approved Address list.

Parameters:
  • network (str) – The network of the approved address. Network can be bitcoin, ethereum, bitcoincash, litecoin, zcash, or filecoin
  • jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.
Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a dictionary parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionary are listed below.

Dictionary Keys:
 
  • approvedAddresses - Array of approved addresses on both the account and group level.

– network - The network of the approved address. Network can be bitcoin, ethereum, bitcoincash, litecoin, zcash, or filecoin – scope - Will return the scope of the address as either “account” or “group” – label - The label assigned to the address – status - The status of the address that will return as “active”, “pending-time” or “pending-mua”. The remaining time is exactly 7 days after the initial request. “pending-mua” is for multi-user accounts and will require another administator or fund manager on the account to approve the address. – createdAt - UTC timestamp in millisecond of when the address was created. – address - The address on the approved address list.

robin_stocks.gemini.account.get_deposit_addresses(network, timestamp=None, jsonify=None)[source]

Gets a list of all deposit addresses.

Parameters:
  • network (str) – network can be bitcoin, ethereum, bitcoincash, litecoin, zcash, filecoin.
  • timestamp (Optional[str]) – Only returns addresses created on or after this timestamp.
  • jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.
Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a list of dictionaries parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionaries are listed below.

Dictionary Keys:
 
  • address - String representation of the new cryptocurrency address.
  • timestamp - Creation date of the address.
  • label - Optional. if you provided a label when creating the address, it will be echoed back here.
robin_stocks.gemini.account.withdraw_crypto_funds(currency_code, address, amount, jsonify=None)[source]

Before you can withdraw cryptocurrency funds to an approved address, you need three things:

  1. You must have an approved address list for your account
  2. The address you want to withdraw funds to needs to already be on that approved address list
  3. An API key with the Fund Manager role added
Parameters:
  • currency_code (str) – the three-letter currency code of a supported crypto-currency, e.g. btc or eth.
  • address (str) – Standard string format of cryptocurrency address.
  • amount (str) – Quoted decimal amount to withdraw.
  • jsonify (Optional[str]) – If set to false, will return the raw response object. If set to True, will return a dictionary parsed using the JSON format.
Returns:

Returns a tuple where the first entry in the tuple is a requests reponse object or a dictionary parsed using the JSON format and the second entry is an error string or None if there was not an error. The keys for the dictionary are listed below.

Dictionary Keys:
 
  • address - Standard string format of the withdrawal destination address.
  • amount - The withdrawal amount.
  • txHash - Standard string format of the transaction hash of the withdrawal transaction. Only shown for ETH and GUSD withdrawals.
  • withdrawalID - A unique ID for the withdrawal. Only shown for BTC, ZEC, LTC and BCH withdrawals.
  • message - A human-readable English string describing the withdrawal. Only shown for BTC, ZEC, LTC and BCH withdrawals.