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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: tdameritrade-client-0.3.1.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.1.tar.gz
Algorithm Hash digest
SHA256 493e0f3298b9c72c75c59f798c1474dceae521d5d88559bb7c7d1d6694412e2c
MD5 b35128d933f46ece7b0a5bd220830927
BLAKE2b-256 e39e30154dde45a947061859437f3abe92435eb7fd3fbae16d673ffbffae70b2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tdameritrade_client-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8c3bd9432b6a322d6dd0b8b84f06a136eacc522de0a4568bdf8c6cda488da0b3
MD5 ed298be1ed8d5e801898e61d1f579d3b
BLAKE2b-256 f0f90a7187bcbd447cd5ead880f93cef8bd73cc73a7c13b62496732c68b2e036

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