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

Uploaded Source

Built Distribution

tdameritrade_client-0.4.0-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for tdameritrade-client-0.4.0.tar.gz
Algorithm Hash digest
SHA256 e87218695e4bf330d3368ec3277c5532bb0ce9f7cb070e978bda241972f419fd
MD5 05158f306b9965d21f5df0b012ffe143
BLAKE2b-256 90f25a40e4f606bc80d6f0751c2e2433816d0c607de09894dc5844cab7de8621

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tdameritrade_client-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cce3d64484022d0994d1426e069ebfbf6ab392b28c263c7b716fabde72becf09
MD5 f9830bbac8f33c0fbd20d83f60990cc8
BLAKE2b-256 4d77654cc0b53f5cf46469352b85fe3eebaa1a64e3dcd993829c8d94f5525cc7

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