Skip to main content

A client for the TDA API

Project description

Pipeline Status Documentation Status Coverage Report PyPI Version

TDAmeritrade Client

A tool that links to the TDA API to perform requests.

Read the docs.

Installation:

Run pip install tdameritrade-client within a virtual environment

Basic Usage:

To get started, use the following code snippet:

from tdameritrade_client.client import TDClient

td_client = TDClient(acct_number=<your account number>,
                     oauth_user_id=<the id registered to the TD app you would like to authenticate with>,
                     redirect_uri=<the redirect URI registered to the TD app>,
                     token_path=<optional path to an existing access token>)
td_client.run_auth()
acct_info = td_client.get_positions()

Tests

This package uses poetry, which can be installed by running:

curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python

To run the tests, first install the package by cloning the repo and running poetry install from the root of the repository. Then, run poetry run pytest tests/ from the root directory of this repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tdameritrade-client-0.3.0.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

tdameritrade_client-0.3.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file tdameritrade-client-0.3.0.tar.gz.

File metadata

  • Download URL: tdameritrade-client-0.3.0.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.12 CPython/3.6.8 Linux/4.19.23-coreos-r1

File hashes

Hashes for tdameritrade-client-0.3.0.tar.gz
Algorithm Hash digest
SHA256 6a629618e06ab24cc5fb78eed673e4851ea6c433473456c76755f73cf5ed149e
MD5 cbd403e2ba729041e5124980ef9e4e39
BLAKE2b-256 b3e01fdaa19d4599997bc9542f0412cc3bf17ceb30e0e703de400b2920f7b610

See more details on using hashes here.

File details

Details for the file tdameritrade_client-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for tdameritrade_client-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 62905f60e4cb2c63a082961bc8bee19ef3a65573e38c943a0a7b06fd9c38ba5f
MD5 8e5adf887ac3c5419ae91748c8da8002
BLAKE2b-256 b459f15f6428f652025ef555eb7c940a39ec2fd27baf3c9cbe85f87b60aadb42

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page