Skip to main content

A simple yet robust API client for Robinhood

Project description

fast_arrow

A simple yet robust API client for Robinhood

Build Status   Coverage Status   Version

NOTE - changes coming with version >= 1.0

Sometime during Spring 2019, Robinhood changed how their API handles authentication. In order to adapt to those changes, I've moved "authentication" outside this library to fast_arrow_auth, https://github.com/westonplatter/fast_arrow_auth.

Please see:

  • issue 35 for a detailed account of the issue
  • this comment for the approach I've taken to remediate auth issues
  • this PR for a run down on exact code changes

I will be releasing these changes under version 1.0.0 to follow semantic version guidelines (since auth changes are incompatible API changes).

example

from fast_arrow import Client, Stock, OptionChain, Option

#
# new auth process as of 1.0.0.rc1
# get auth_data (see https://github.com/westonplatter/fast_arrow_auth)
#
with open("fast_arrow_auth.json") as f:
    auth_data = json.loads(f.read())

#
# initialize client with auth_data
#
client = Client(auth_data)

#
# fetch the stock info for TLT
#
symbol = "TLT"
stock = Stock.fetch(client, symbol)

#
# get the TLT option chain
#
stock_id = stock["id"]
option_chain = OptionChain.fetch(client, stock_id)

#
# let's get TLT options (calls and puts) for next 4 expiration dates
#
oc_id = option_chain["id"]
eds = option_chain['expiration_dates'][0:3]

#
# get all options on the TLT option chain
#
ops = Option.in_chain(client, oc_id, expiration_dates=eds)

#
# merge in market data fro TLT option instruments (ask, bid, delta, theta, etc)
#
ops = Option.mergein_marketdata_list(client, ops)

install

Install the package from pypi,

pip install fast_arrow

design principles

You might be asking, "yet another Robinhood client? There's already a few out there. What's different about this one?"

fast_arrow holds to these design principles,

  • focus on simple features that expose data. Don't interpret data.
  • make stock & option operations easy to talk about and do with code
  • organize code in small and discrete python classes
  • use fast_arrow_auth to handle authentication process

features

Here's what you can do with fast_arrow (some features still in development)

Stocks

  • [x] get quotes
  • [ ] fetch historical data
  • [x] fetch all stock trades
  • [ ] submit orders
  • [ ] fetch earning events (past and future)
  • [ ] fetch company news articles
  • [ ] fetch company fundamentals
  • [ ] fetch popularity data

Options

  • [x] fetch option quotes (example)
  • [x] fetch open option positions (example)
  • [x] fetch all option orders (filled, canceled, rejected)
  • [x] fetch historical options data (example)
  • [x] fetch option events (example)
  • [ ] generate option strategy orders
  • [ ] generate humanized names for option strategies
  • [x] submit order (example)
  • [x] cancel order (example)
  • [x] replace order (example)

Portfolio

  • [x] fetch historical value of portfolio (example)

Authentication/Security

  • [x] Authentication has moved to fast_arrow_auth.
  • [x] pin SSL certificate (see this PR)
  • [x] automatically refreshes oauth2

Want to propose a feature? Open a feature request or open a Pull Request.

development

Install pipenv, and then run,

pipenv install --dev

Run the test suite via,

make test

Run all the examples (make sure you add username/password to config.debug.ini),

sh run_all_examples.sh

Run the test suite against a specific python version,

pipenv run tox -e py36

releases

Adding so I don't forget the next time I release a version,

python setup.py sdist bdist_wheel
twine upload dist/*

supporting libraries

projects using fast_arrow

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for fast-arrow, version 1.0.0
Filename, size & hash File type Python version Upload date
fast_arrow-1.0.0-py3-none-any.whl (163.1 kB) View hashes Wheel py3
fast_arrow-1.0.0.tar.gz (155.7 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page