Metadata-Version: 2.1
Name: tdameritrade
Version: 0.1.1
Summary: APIs for TD Ameritrade
Home-page: https://github.com/timkpaine/tdameritrade
Author: Tim Paine
Author-email: t.paine154@gmail.com
License: Apache 2.0
Description: # tdameritrade
        Python interface to TD Ameritrade Api
        
        [![Build Status](https://dev.azure.com/tpaine154/tdameritrade/_apis/build/status/timkpaine.tdameritrade?branchName=master)](https://dev.azure.com/tpaine154/tdameritrade/_build/latest?definitionId=8&branchName=master)
        [![Coverage](https://img.shields.io/azure-devops/coverage/tpaine154/tdameritrade/8)]()
        [![License](https://img.shields.io/github/license/timkpaine/tdameritrade.svg)](https://pypi.python.org/pypi/tdameritrade/)
        [![PyPI](https://img.shields.io/pypi/v/tdameritrade.svg)](https://pypi.python.org/pypi/tdameritrade/)
        [![Docs](https://img.shields.io/readthedocs/tdameritrade.svg)](https://tdameritrade.readthedocs.io)
        
        
        
        ## 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. 
        
        [Read the docs!](http://tdameritrade.readthedocs.io/en/latest/index.html)
        
        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.
        
        ![](https://raw.githubusercontent.com/timkpaine/tdameritrade/master/docs/img/client/client.png)
        
        Most data fetching methods accept the symbol as argument. For equities, this is just the ticker.
        
        ![](https://raw.githubusercontent.com/timkpaine/tdameritrade/master/docs/img/client/quote.png)
        
        For different assets, utilize the `search` and `instrument` methods to lookup symbols. For options, you can utilize the options method.
        
        ![](https://raw.githubusercontent.com/timkpaine/tdameritrade/master/docs/img/options.png)
        
        
Keywords: finance data
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
Provides-Extra: dev
