Metadata-Version: 2.1
Name: tda-api
Version: 0.0.3
Summary: An unofficial wrapper around the TD Ameritrade HTTP API.
Home-page: https://github.com/alexgolec/tda-api
Author: Alex Golec
Author-email: bottomless.septic.tank@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: requests-oauthlib
Requires-Dist: python-dateutil
Requires-Dist: selenium

# ``tda-api``: A TD Ameritrade API Wrapper

What is ``tda-api``?
--------------------

``tda-api`` is an unofficial wrapper around the
[TD Ameritrade APIs](https://developer.tdameritrade.com/apis). It strives to be
as thin and unopinionated as possible, offering an elegant programmatic
interface over each endpoint. Notable functionality includes:
* Login and authentication
* Quotes, fundamentals, and historical pricing data
* Options chains
* Trades and trade management
* Account info and preferences

How do I use ``tda-api``?
-------------------------

Before you do anything, create an account and an application on the
[TD Ameritrade developer website](https://developer.tdameritrade.com/). You'll 
receive an API key, also known as a Client Id, which you can pass to this 
wrapper. You'll also want to take note of your callback URI, as the login flow 
requires it.

Next, install ``tda-api``:

```
pip install tda-api
```

You're good to go! To demonstrate, here's how you can authenticate and fetch
daily historical price data for the past twenty years:

```python
from tda import client
import json

token_path = '/path/to/token.json'
api_key = 'MYAPIKEY@AMER.OAUTHAP'
redirect_uri = 'https://my.redirect-uri.com/'
try:
    c = client.client_from_token_file(token_path, api_key)
except FileNotFoundError:
    from selenium import webdriver
    with webdriver.Chrome() as driver:
        c = client.client_from_login_flow(
            driver, api_key, redirect_uri, token_path)

response = c.get_price_history('AAPL',
        period_type=client.Client.PriceHistory.PeriodType.YEAR,
        period=client.Client.PriceHistory.Period.TWENTY_YEARS,
        frequency_type=client.Client.PriceHistory.FrequencyType.DAILY,
        frequency=client.Client.PriceHistory.Frequency.DAILY)
assert resp.ok
print(json.dumps(resp.json(), indent=4))
```

Why should I use ``tda-api``?
-----------------------------

``tda-api`` was designed to provide a few important pieces of functionality:

1. **Safe Authentication**: TD Ameritrade's API supports OAuth authentication, 
   but too many people online end up rolling their own implementation of the 
   OAuth callback flow. This is both unnecessarily complex and dangerous. 
   ``tda-api`` handles token fetch and refreshing for you.

2. **Minimal API Wrapping**: Unlike some other API wrappers, which build in lots 
   of logic and validation, ``tda-api`` takes raw values and returns raw 
   responses, allowing you to interpret the complex API responses as you see 
   fit. Anything you can do with raw HTTP requests you can do with ``tda-api``, 
   only more easily.

What else?
----------

Bug reports, suggestions, and patches are always welcome! Submit issues
[here](https://github.com/alexgolec/tda-api/issues) and pull requests
[here](https://github.com/alexgolec/tda-api/pulls).

``tda-api`` is released under the
[MIT license](https://github.com/alexgolec/tda-api/blob/master/LICENSE).

***Disclaimer:*** *tda-api is an unofficial API wrapper. It is in no way 
endorsed by or affiliated with TD Ameritrade or any associated organization.
Make sure to read and understand the terms of service of the underlying API 
before using this package. This authors accept no responsibility for any
damage that might stem from use of this package. See the LICENSE file for
more details.*


