robin-stocks 0.8.3

A Python wrapper around the Robinhood API

Robinhood API Library

Introduction

This library aims to create simple to use functions to interact with the Robinhood API. This is a pure python interface and it requires Python3. The purpose of this library is to allow people to make their own robo-investors or to view stock information in real time.

Installing

There is no need to download these files directly. This project is published on PyPi, so it can be installed by typing into terminal:

>>> pip install robin_stocks

Example Usage

In your python code write:

>>> from robin_stocks.robin_stocks import robin_stocks
>>> r = robin_stocks()
>>> login = r.login('[e-mail]','password')
>>> my_stocks = r.build_holdings()

This will build a dictionary called “my_stocks” where the keys are the ticker symbols of all the stocks you hold, and the values of those keys are another dictionary containing important information about the stocks. If you then wanted to print this dictionary, you could type

>>> for key,value in my_stocks.items():
>>>   print(key,value)

Keep in mind that the functions contained in the library are just helper functions, and you are free to write your own functions that interact with the Robinhood API.

Functions Contained

(NOTE: parameters that are equal to a value are optional when calling the function.)

Logging in and out

• login(username,password)

• logout()

Getting ids

• get_id(symbol)

• get_option_id(symbol)

• get_tradable_chain_id(symbol)

• get_specific_option_id(symbol)

Getting profile information

• get_user_profile(info=None)

• get_investment_profile(info=None)

• get_basic_profile(info=None)

• get_portfolios_profile(info=None)

• get_accounts_profile(info=None)

• get_security_profile(info=None)

Getting stock information

• get_quotes(*inputSymbols,info=None)

• get_latest_price(*inputSymbols)

• get_fundamentals(*inputSymbols,info=None)

• get_instruments_by_symbols(*inputSymbols,info=None)

• get_instruments_by_url(url,info=None)

• get_name_by_symbol(symbol)

• get_name_by_url(url)

• get_historicals(*inputSymbols,span=’week’,bounds=’regular’)

• query_instruments(query)

• get_ratings(symbol,info=None)

• get_popularity(symbol,info=None)

• get_events(symbol,info=None)

• get_earnings(symbol,info=None)

• get_news(symbol,info=None)

• get_splits(symbol,info=None)

Getting position information

• get_positions(info=None)

• get_owned_positions(info=None)

• get_dividends(info=None)

• get_total_dividends()

Getting documents

• get_documents(info=None)

• download_document(url,name=None,dirpath=None)

• download_all_documents(doctype=None,dirpath=None)

Manipulating watchlists

• get_all_watchlists(info=None)

• get_watchlist_by_name(name=’Default’,info=None)

• post_symbols_to_watchlist(*inputSymbols,name=’Default’)

• delete_symbols_from_watchlist(*inputSymbols,name=’Default’)

Getting market information

• get_notifications(info=None)

• get_latest_notification()

• get_top_movers(direction,info=None)

• get_markets(info=None)

• get_wire_transfers(info=None)

• get_margin_calls(symbol)

• get_deposits()

Manipulating orders

• get_all_orders(info=None)

• get_all_open_orders(info=None)

• get_order_info(order_id)

• query_orders(**arguments)

• cancel_all_open_orders()

• cancel_order(order_id)

Placing orders

• order_buy_market(symbol,quantity,timeInForce=’gtc’)

• order_buy_limit(symbol,quantity,limitPrice,timeInForce=’gtc’)

• order_buy_stop_loss(symbol,quantity,stopPrice,timeInForce=’gtc’)

• order_buy_stop_limit(symbol,quantity,limitPrice,stopPrice,timeInForce=’gtc’)

• order_sell_market(symbol,quantity,timeInForce=’gtc’)

• order_sell_limit(symbol,quantity,limitPrice,timeInForce=’gtc’)

• order_sell_stop_loss(symbol,quantity,stopPrice,timeInForce=’gtc’)

• order_sell_stop_limit(symbol,quantity,limitPrice,stopPrice,timeInForce=’gtc’)

• order(symbol,quantity,type,limitPrice,stopPrice,trigger,side,timeInForce)

Options

• get_aggregate_positions(info=None)

• get_market_options(info=None)

• get_open_option_positions(info=None)

• get_all_option_positions(info=None)

• get_chains(symbol,info=None)

• find_options_for_stock_by_expiration(symbol,expirationDate,type=’both’)

• find_options_for_stock_by_strike(symbol,strike,type=’both’)

• find_options_for_stock_by_expiration_and_strike(symbol,expirationDate,strike,type=’both’)

• get_available_option_calls(symbol,info=None)

• get_available_option_puts(symbol,info=None)

• get_specific_option_market_data(symbol,expirationDate,strike,type,info=None)

• get_specific_option_instrument_data(symbol,expirationDate,strike,type,info=None)

Building core user info

• build_holdings()

• build_user_profile()