Skip to main content

Tastyworks (unofficial) API

Project description

Tastyworks (Unofficial) API

Disclaimer

This is an unofficial, reverse-engineered API for Tastyworks. There is no implied warranty for any actions and results which arise from using it.

Purpose

A simple, async-based, reverse-engineered API for tastyworks. This will allow you to create trading algorithms for whatever strategies you may have.

Please note that this is in the very early stages of development so any and all contributions are welcome. Please submit an issue and/or a pull request.

Installation

pip install tastyworks

✨ 🍰

Since it's an async-based API, please make sure you're familiar with how asynchronous python works (Note: Python 3.6 or higher).

An example use is provided in example.py in the tastyworks folder. See for yourself by adding your tastyworks username/password and running:

tasty 

Guidelines and caveats

There are a few useful things to know which will help you get the most out of this API and use it in the way it was intended.

  1. All objects are designed to be independent of each other in their steady-state. That is, unless executing an action, all objects are not bound to each other and have no knowledge of each other's awareness.
  2. One can have multiple sessions and, due to the inter-object independence, can execute identical actions on identical objects in different sessions.
  3. Given the above points, this API does not implement state management and synchronization (i.e. are my local object representations identical to the remote [Tastyworks] ones?). This is not an indefinitely closed matter and may be re-evaluated if the need arises.

Contributing

The more hands and brains that can help with this project, the better. It was implemented with the effort of getting something working rather than something beautiful as it is a reverse-engineering effort in progress. I would appreciate any input (be it in the form of issue reporting or code) on how to make this code-base better.

You can find the official GitHub repo at: https://github.com/boyan-soubachov/tastyworks_api

TODO

I would really appreciate any help/contributions with the TODO's scattered all around the codebase. If they're not descriptive enough, I'd be happy to provide more details.

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

tastyworks-3.0.1.tar.gz (15.3 kB view details)

Uploaded Source

File details

Details for the file tastyworks-3.0.1.tar.gz.

File metadata

  • Download URL: tastyworks-3.0.1.tar.gz
  • Upload date:
  • Size: 15.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0a4+

File hashes

Hashes for tastyworks-3.0.1.tar.gz
Algorithm Hash digest
SHA256 fdeea89f855d1b780ce3207912990bb97f26ccc2af7a8022fdfe15faac747299
MD5 c7ae9073d6244f84dfe3d3c429321dc4
BLAKE2b-256 9be0aa73affafbe13e6aa50013241b59c6293d58f683a5a492708a4902503508

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page