Skip to content

Latest commit

 

History

History
52 lines (31 loc) · 2.09 KB

README.md

File metadata and controls

52 lines (31 loc) · 2.09 KB

tdameritrade

Python interface to TD Ameritrade Api

Build Status Coverage License PyPI

Getting Started

Install

Install from pip

pip install tdameritrade

or from source

python setup.py install

Docs

Major changes in the v0.1.0 update to the way tokens are handled.
You will still need the original authentication instructions, but the TDClient now takes the refresh token and client id, not the access token. A new session class handles token expiration and will automatically call a new token as needed.

It is recommended that you store these as environmental variables.

client_id = os.getenv('TDAMERITRADE_CLIENT_ID')
account_id = os.getenv('TDAMERITRADE_ACCOUNT_ID')
refresh_token = os.getenv('TDAMERITRADE_REFRESH_TOKEN')

tdclient = tdameritrade.TDClient(client_id=client_id, refresh_token=refresh_token, account_ids=[account_id])

See the tests\test_client.py file for examples on current usage.

All functionality is available as methods on the TDClient object. For most methods, there is a convenience method to return the result as a pandas DataFrame.

Most data fetching methods accept the symbol as argument. For equities, this is just the ticker.

For different assets, utilize the search and instrument methods to lookup symbols. For options, you can utilize the options method.