Package: td-ameritrade-python-api
Unofficial TD Ameritrade Python API LibraryTable of ContentsOverviewWhat's in the APIRequirementsAPI Key & CredentialsInstallationUsageFeaturesDocumentation & ResourcesSupport These ProjectsAuthentication WorkflowOverviewCurrent Version:0.3.5The unofficial Python API client library for TD Ameritrade allows individuals with
TD Ameritrade accounts to manage trades, pull historical and real-time data, manage
their accounts, create and modify orders all using the Python programming language.To learn more about the TD Ameritrade API, please refer to
theofficial documentation.What's in the APIAuthentication - access tokens, refresh tokens, request authentication.Accounts & TradingMarket HoursInstrumentsMoversOption ChainsPrice HistoryQuotesTransaction HistoryUser Info & PreferencesWatchlistRequirementsThe following requirements must be met to use this API:A TD Ameritrade account, you'll need your account password and account number to use the API.A TD Ameritrade Developer AccountA TD Ameritrade Developer API KeyA Consumer IDA Redirect URI, sometimes called Redirect URLPython 3.7 or later.API Key and CredentialsEach TD Ameritrade API request requires a TD Ameritrade Developer API Key, a consumer ID,
an account password, an account number, and a redirect URI. API Keys, consumer IDs, and
redirect URIs are generated from the TD Ameritrade developer portal. To set up and create
your TD Ameritrade developer account, please refer to
theofficial documentation.Additionally, to authenticate yourself using this library, you will need to provide your
account number and password for your main TD Ameritrade account.Important:Your account number, an account password, consumer ID, and API key should
be kept secret.InstallationThe project can be found at PyPI, if you'd like to view the project please use
thislink.pipinstalltd-ameritrade-python-apiTo upgrade the library run the following command:pipinstall--upgradetd-ameritrade-python-apiUsageThis example demonstrates how to login to the API and demonstrates sending a request
using theget_quotesendpoint, using your API key.Credentials:Please note, that thecredentials_pathis a file path that will house the credentials
like your refresh token and access token. You must specify thecredentials_pathargument
yourself so that you are aware of where the tokens will be stored. For example, if you
specify thecredentials_pathasC:\Users\Public\Credentials\td_state.jsonit would
store your tokens in a JSON file located in a folder called Credentials located under
the Users profile.# Import the clientfromtd.clientimportTDClient# Create a new session, credentials path is required.TDSession=TDClient(client_id='<CLIENT_ID>',redirect_uri='<REDIRECT_URI>',credentials_path='<PATH_TO_CREDENTIALS_FILE>')# Login to the sessionTDSession.login()# Grab real-time quotes for 'MSFT' (Microsoft)msft_quotes=TDSession.get_quotes(instruments=['MSFT'])# Grab real-time quotes for 'AMZN' (Amazon) and 'SQ' (Square)multiple_quotes=TDSession.get_quotes(instruments=['AMZN','SQ'])FeaturesAuthentication Workflow SupportAutomatically will handle the authentication workflow for new users, returning users, and users
with expired tokens (refresh token or access token).Request ValidationFor certain requests, in a limited fashion, it will help validate your request when possible.
For example, when using theget_moversendpoint, it will automatically validate that the
market you're requesting data from is one of the valid options.Customized Objects for Watchlists, Orders, and Option ChainsRequests for saved orders, regular orders, watchlists, and option chains can be a challenging
process that has multiple opportunities to make mistakes. This library has built-in objects
that will allow you to quickly build your request and then validate certain portions of your
request when possible.Library RequirementsThe following requirements must be met before being able to use the TD Ameritrade Python API library.You must have a TD Ameritrade Account.You must have a TD Ameritrade Developer Account. Please go to followingfolderfor instructions on how to create a Developer account.Documentation and ResourcesOfficial API DocumentationGetting StartedEndpointsGuidesSamples - Price HistorySamples - Place OrderUnofficial DocumentationTD Ameritrade API - YouTubeSupport these ProjectsPatreon:Help support this project and future projects by donating to myPatreon Page.
I'm always looking to add more content for individuals like yourself, unfortuantely some of the APIs I would require
me to pay monthly fees.YouTube:If you'd like to watch more of my content, feel free to visit my YouTube channelSigma Coding.Hire Me:If you have a project, you think I can help you with feel free to reach out atcoding.sigma@gmail.comor fill out thecontract request formAuthentication WorkflowStep 1 - Start the Script:While in Visual Studio Code, right click anywhere in the code editor while in the file that contains your code.
The following dropdown will appear:From the dropdown, clickRun Python file in Terminal, this will start the python script.Step 2 - Go to Redirect URL:The TD Library will automatically generate the redirect URL that will navigate you to the TD website for for
you authentication. You can either copy the link and paste it into a browser manually or if you're using Visual
Studio Code you can pressCTRL + Clickto have Visual Studio Code navigate you to the URL immeditately.Step 3 - Login to the TD API:Once you've arrived at the login screen, you'll need to provide your credentials to authenticate the session.
Please provide your Account Username and Account Password in the userform and then press enter. As a reminder
these, are the same username/password combination you use to login to your regular TD Account.Step 4 - Accept the Terms:Accept the Terms of the API by clickingAllow, this will redirect you.Step 5 - Copy the Authorization Code:After accepting the terms, you'll be taken to the URL that you provided as yourredirect URI. However, at
the end of that URL will beauthorization code. To complete the authentication workflow, copy the URL as
it appears below. Don't worry if the numbers don't match, as you will have a different code.Step 6 - Paste the Authorization Code in the Terminal:Take the URL and copy it into the Terminal, after you have pasted it, pressEnter. The authentication workflow
will complete and the script will start running. At this stage, we are exchanging your authorization code for
an access token. That access token is valid only for 30 minutes. However, a refresh token is also stored that
will refresh your access token when it expires.After, that the script should run. Additionally, if you go to the location you specified in thecredentials_patharugment you will now seetd_state.jsonfile. This file contains all the info used during a session. Please
DO NOT DELETE THIS FILE OR ELSE YOU WILL NEED TO GO THROUGH THE STEPS ABOVE.