Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Authentication-workflow section in readme is unclear #227

Open
clarson99 opened this issue Nov 25, 2021 · 4 comments
Open

Authentication-workflow section in readme is unclear #227

clarson99 opened this issue Nov 25, 2021 · 4 comments

Comments

@clarson99
Copy link

The authentication-workflow section of the readme is unclear. It suggests running a file from VS Code, but it never says what file to run.

@alanoatwork
Copy link

The python code to run is the code just under Usage:

# Import the client
from td.client import TDClient

# 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 session
TDSession.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'])

@clarson99
Copy link
Author

I think it would be helpful if you added something like 'The python code to run is the code just under Usage' to step 1 in https://github.com/areed1192/td-ameritrade-python-api#authentication-workflow

If you are reading the authentication workflow, it is not clear what code to run to trigger the oauth path.

@alanoatwork
Copy link

You would need to appeal to a higher authority. I'm just an observer, not a developer for this library.

@akshaygulabrao
Copy link

Thank you @alanoatwork

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants