Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/areed1192/tradestation-python-api
A Python Client library for the TradeStation API.
https://github.com/areed1192/tradestation-python-api
api finance python tradestation tradestation-api trading
Last synced: about 2 months ago
JSON representation
A Python Client library for the TradeStation API.
- Host: GitHub
- URL: https://github.com/areed1192/tradestation-python-api
- Owner: areed1192
- License: mit
- Created: 2020-06-10T23:23:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-07-10T21:46:54.000Z (over 3 years ago)
- Last Synced: 2023-03-04T21:03:11.072Z (almost 2 years ago)
- Topics: api, finance, python, tradestation, tradestation-api, trading
- Language: Python
- Homepage:
- Size: 15.6 KB
- Stars: 79
- Watchers: 7
- Forks: 47
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tradestation Python API
A Python Client library for the TradeStation API.
## Table of Contents
- [Overview](#overview)
- [What's in the API](#whats-in-the-api)
- [Requirements](#requirements)
- [API Key & Credentials](#api-key-and-credentials)
- [Installation](#installation)
- [Usage](#usage)
- [Features](#features)
- [Documentation & Resources](#documentation-and-resources)
- [Support These Projects](#support-these-projects)
## Overview
The unofficial Python API client library for TradeStation allows individuals with TradeStation accounts to manage trades, pull historical and real-time data, manage their accounts, create and modify orders all using the Python programming language.
To learn more about the TradeStation API, please refer to the [official documentation](https://developer.tdameritrade.com/apis).
## What's in the API
- Authentication - access tokens, refresh tokens, request authentication.
- Accounts & Trading
- Symbols
- Index
- Orders
- Paper Trading
- Quotes
- Transaction History
## Requirements
The following requirements must be met to use this API:
- A TradeStation account, you'll need your account password and account number to use the API.
- A TradeStation Developer API Key
- A Redirect URI, sometimes called Redirect URL
- Python 3.8 or later.
## API Key and Credentials
Each TradeStation API request requires a TradeStation Developer API Key, a consumer ID, an account password, an account number, and a redirect URI. API Keys, consumer IDs, and redirect URIs are generated from the TradeStation developer portal. To set up and create your TradeStation developer account, please refer to the [official documentation](https://developer.tdameritrade.com/content/phase-1-authentication-update-xml-based-api).
Additionally, to authenticate yourself using this library, you will need to provide your account number and password for your main TradeStation account.
**Important:** Your account number, an account password, consumer ID, and API key should be kept secret.
## Installation
```bash
pip install -e .
```
## Usage
This example demonstrates how to login to the API and demonstrates sending a request using the `quotes`, and `stream_bars_start_date` endpoint, using your API key.
```python
# Import the client
from ts.client import TradeStationClient
# Create the Client.
ts_client = TradeStationClient(
username="USERNAME",
client_id="CLIENT_ID",
client_secret="CLIENT_SECRET",
redirect_uri="REDIRECT_URI",
paper_trading="PAPER_TRADING"
)
# Get quotes for Oil Futures.
ts_client.quotes(symbols=['@CL'])
# Stream quotes for Amazon.
ts_client.stream_quotes_changes(symbols=['AMZN'])
# Stream bars for a certain date.
ts_client.stream_bars_start_date(
symbol='AMZN',
interval=5,
unit='Minute',
start_date='02-25-2020',
session='USEQPreAndPost'
)
```
## Features
### Authentication Workflow Support
Automatically will handle the authentication workflow for new users, returning users, and users with expired tokens (refresh token or access token).
### Request Validation
For certain requests, in a limited fashion, it will help validate your request when possible. For example, when using the `get_bars` endpoint, it will automatically validate that the market you're requesting data from is one of the valid options.
## Documentation and Resources
- [Overview](https://tradestation.github.io/api-docs/#section/Overview)
- [Paper Trading](https://tradestation.github.io/api-docs/#section/Overview/SIM-vs-LIVE)
- [Authentication](https://tradestation.github.io/api-docs/#section/Authentication)
## Support these Projects
**Patreon:**
Help support this project and future projects by donating to my [Patreon Page](https://www.patreon.com/sigmacoding). I'm always looking to add more content for individuals like yourself, unfortuantely some of the APIs I would require me to pay monthly fees.
**YouTube:**
If you'd like to watch more of my content, feel free to visit my YouTube channel [Sigma Coding](https://www.youtube.com/c/SigmaCoding).
**Hire Me:**
If you have a project, you think I can help you with feel free to reach out at [email protected]