Skip to main content

A client for the TDA API

Project description

Pipeline Status Documentation Status Coverage Report PyPI Version PyPI download month

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.5.0.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

tdameritrade_client-0.5.0-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for tdameritrade-client-0.5.0.tar.gz
Algorithm Hash digest
SHA256 e9d2ab5bb684b3d0552f40358b9f877b9ed7948bcbeb727a7cc8b6fbab019a5c
MD5 ea642e9df5d7839375763a49e2f27899
BLAKE2b-256 ece308c99d4ad4e387ddd7abc0d0caec538a7633a5a3e17dae1326634aaff9c9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tdameritrade_client-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ce9e1f33cbcbd89d31762685479f0e36175dff31b4c9d914faac364aa6e1e70c
MD5 47e7470f72660879c65c9f9a13a1e9c6
BLAKE2b-256 c2e5c5426ed83bd3d8d53e00adcde2ca49d7888e83e49acfdedf1db9e099cb90

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