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

Uploaded Source

Built Distribution

tdameritrade_client-0.3.2-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tdameritrade-client-0.3.2.tar.gz
  • Upload date:
  • Size: 9.0 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.2.tar.gz
Algorithm Hash digest
SHA256 2a0022f7fb8bbe7b2a44a0d30e0b2d815cad0af1c532b9c4add81f7f110d3931
MD5 ab8f8e707ae379c5de8d9f56ac0b81cb
BLAKE2b-256 52ada338fbba1187a7628e251b42af3acbd680fc77abbd03a9657bf957851641

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tdameritrade_client-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9b6b00f530656f404d7539c8f0374dc3c8d6d17840c7f77d5321e8c4cd58e9f2
MD5 12609a0b771bf18a7469c0eb085d2fd1
BLAKE2b-256 cecebe0b8e5cc839da92c8215f052e09e49c3f9916beeffd3acdd385d90a4eba

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