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

Uploaded Source

Built Distribution

tdameritrade_client-0.2.0-py3-none-any.whl (19.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for tdameritrade-client-0.2.0.tar.gz
Algorithm Hash digest
SHA256 db1b459809c0c2b06c6b6ad2279eb9fb58367932c4f82c82fe39f59eb692bbe3
MD5 1a7fb0ac7cb494fb286b6de96520cca2
BLAKE2b-256 b723699e5c4b37095abd76b3053d57a8107fb161100c7780e971807c196b2454

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tdameritrade_client-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 77877ca779e74c76f2ba4ab98342d93c042b1254dd144bb8a17980f843479efb
MD5 fdbf9bdc1fb3118de731150565568d6f
BLAKE2b-256 5cd22b95d8e4677cb8ca4052815c88fc760460d7a9d9c32ace10f0cc7a0a465a

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