tradier-api-client 0.1.1__tar.gz

tradier_api_client-0.1.1/MANIFEST.in

@@ -0,0 +1,7 @@
+# Exclude tests from source distributions
+prune tests
+
+# Also prune common local build artifacts
+prune build
+prune dist
+prune .pytest_cache

tradier_api_client-0.1.1/PKG-INFO

@@ -0,0 +1,203 @@
+Metadata-Version: 2.4
+Name: tradier-api-client
+Version: 0.1.1
+Summary: Tradier REST + Streaming API client
+Author: Your Name
+License: Proprietary
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.25.1
+Requires-Dist: cryptography>=41
+Requires-Dist: websocket-client>=1.5
+
+# tradier_api_client
+
+Python client for the Tradier Brokerage API (REST) plus optional streaming helpers.
+
+This repo is intended to give you a lightweight, script-friendly way to call Tradier endpoints (quotes, options, orders, account data) using a single `RestClient`.
+
+> Note: Some examples below are adapted from `tests/real_data.py` which is intended for *local* use with a real API key. Don’t commit keys.
+
+---
+
+## Installation
+
+From source (editable):
+
+```bash
+python -m pip install -U pip
+python -m pip install -e .
+```
+
+Regular install (from the cloned repo):
+
+```bash
+python -m pip install .
+```
+
+---
+
+## Authentication
+
+Set your Tradier API key in an environment variable.
+
+### Windows (cmd.exe)
+
+```bat
+set API_KEY=your_key_here
+```
+
+### macOS/Linux
+
+```bash
+export API_KEY=your_key_here
+```
+
+---
+
+## Quick start
+
+### Create a `RestClient`
+
+The tests create a client like this:
+
+```python
+import os
+from tradier_api_client import RestClient
+
+client = RestClient(
+    base_url="https://sandbox.tradier.com/v1",  # use https://api.tradier.com/v1 for production
+    api_key=os.environ.get("API_KEY"),
+    verbose=True,
+)
+
+print("Account:", client.account_number)
+```
+
+---
+
+## Common REST examples
+
+### 1) Quotes
+
+```python
+quotes = client.get_quotes(["AAPL", "MSFT"])
+print(quotes)
+```
+
+### 2) Historical quotes
+
+```python
+history = client.get_historical_quotes("AAPL", start="1979-01-01")
+print(history)
+```
+
+### 3) Option expirations + option chains
+
+```python
+expirations_resp = client.get_option_expirations("AAPL")
+expirations = expirations_resp.get("expirations", {}).get("date", [])
+print(expirations)
+
+if expirations:
+    chain = client.get_option_chains("AAPL", expirations[0])
+    print(chain)
+```
+
+### 4) Options helper workflow (OCC symbols)
+
+The repo includes an `OptionsWrapper` and helper utilities used by `tests/real_data.py`.
+
+```python
+from tradier_api_client.rest.extensions.options import (
+    OptionsWrapper,
+    parse_occ,
+    filter_options_occ,
+    filter_for_tradable_options_strike_plus_bid,
+)
+
+ow = OptionsWrapper(client)
+occ_symbols = ow.get_call_options_occ_symbols_list("AAPL")
+
+# Parse OCC symbols into structured info
+parsed = parse_occ(occ_symbols)
+
+# Filter by expiration window and strike constraints (example)
+filtered_occ = filter_options_occ(options=occ_symbols, exp_end="2027-08-30", exp_start="2027-01-01")
+
+# Quote options and filter for tradable candidates
+quotes = client.get_quotes(filtered_occ)
+tradable = filter_for_tradable_options_strike_plus_bid(
+    quotes=quotes,
+    occ_symbols=filtered_occ,
+    target_price=5.5,
+)
+print(tradable)
+```
+
+### 5) Account endpoints (example: gain/loss)
+
+```python
+gain_loss = client.get_gain_loss(client.account_number)
+print(gain_loss)
+```
+
+---
+
+## Orders
+
+The order helpers live under `tradier_api_client.rest.extensions.orders`.
+
+### Equity limit buy (example)
+
+```python
+from tradier_api_client.rest.extensions.orders import equity_limit
+
+order_request = equity_limit(
+    symbol="AAPL",
+    side="buy",
+    quantity=1,
+    price=150,
+    duration="gtc",
+)
+
+resp = client.place_order(client.account_number, order_request)
+print(resp)
+```
+
+### Read / cancel orders
+
+```python
+orders = client.get_orders(client.account_number)
+print(orders)
+
+# If you have an order id:
+# order = client.get_order(client.account_number, "12345678")
+# print(order)
+
+# cancel_resp = client.cancel_order(client.account_number, "12345678")
+# print(cancel_resp)
+```
+
+---
+
+## Running tests (local repo)
+
+This project includes tests/integration scripts under `tests/`.
+
+- Some scripts (like `tests/real_data.py`) may call live/sandbox endpoints and require `API_KEY`.
+- The `tests/` folder is **not** intended to be installed with the client distribution.
+
+To run tests locally:
+
+```bash
+python -m pip install -U pytest
+pytest -q
+```
+
+---
+
+## Notes / troubleshooting
+
+- **Sandbox vs production**: use `https://sandbox.tradier.com/v1` for paper testing and `https://api.tradier.com/v1` for production.
+- If you see authentication errors, confirm `API_KEY` is set in the environment used by your Python interpreter.

tradier_api_client-0.1.1/README.md

@@ -0,0 +1,191 @@
+# tradier_api_client
+
+Python client for the Tradier Brokerage API (REST) plus optional streaming helpers.
+
+This repo is intended to give you a lightweight, script-friendly way to call Tradier endpoints (quotes, options, orders, account data) using a single `RestClient`.
+
+> Note: Some examples below are adapted from `tests/real_data.py` which is intended for *local* use with a real API key. Don’t commit keys.
+
+---
+
+## Installation
+
+From source (editable):
+
+```bash
+python -m pip install -U pip
+python -m pip install -e .
+```
+
+Regular install (from the cloned repo):
+
+```bash
+python -m pip install .
+```
+
+---
+
+## Authentication
+
+Set your Tradier API key in an environment variable.
+
+### Windows (cmd.exe)
+
+```bat
+set API_KEY=your_key_here
+```
+
+### macOS/Linux
+
+```bash
+export API_KEY=your_key_here
+```
+
+---
+
+## Quick start
+
+### Create a `RestClient`
+
+The tests create a client like this:
+
+```python
+import os
+from tradier_api_client import RestClient
+
+client = RestClient(
+    base_url="https://sandbox.tradier.com/v1",  # use https://api.tradier.com/v1 for production
+    api_key=os.environ.get("API_KEY"),
+    verbose=True,
+)
+
+print("Account:", client.account_number)
+```
+
+---
+
+## Common REST examples
+
+### 1) Quotes
+
+```python
+quotes = client.get_quotes(["AAPL", "MSFT"])
+print(quotes)
+```
+
+### 2) Historical quotes
+
+```python
+history = client.get_historical_quotes("AAPL", start="1979-01-01")
+print(history)
+```
+
+### 3) Option expirations + option chains
+
+```python
+expirations_resp = client.get_option_expirations("AAPL")
+expirations = expirations_resp.get("expirations", {}).get("date", [])
+print(expirations)
+
+if expirations:
+    chain = client.get_option_chains("AAPL", expirations[0])
+    print(chain)
+```
+
+### 4) Options helper workflow (OCC symbols)
+
+The repo includes an `OptionsWrapper` and helper utilities used by `tests/real_data.py`.
+
+```python
+from tradier_api_client.rest.extensions.options import (
+    OptionsWrapper,
+    parse_occ,
+    filter_options_occ,
+    filter_for_tradable_options_strike_plus_bid,
+)
+
+ow = OptionsWrapper(client)
+occ_symbols = ow.get_call_options_occ_symbols_list("AAPL")
+
+# Parse OCC symbols into structured info
+parsed = parse_occ(occ_symbols)
+
+# Filter by expiration window and strike constraints (example)
+filtered_occ = filter_options_occ(options=occ_symbols, exp_end="2027-08-30", exp_start="2027-01-01")
+
+# Quote options and filter for tradable candidates
+quotes = client.get_quotes(filtered_occ)
+tradable = filter_for_tradable_options_strike_plus_bid(
+    quotes=quotes,
+    occ_symbols=filtered_occ,
+    target_price=5.5,
+)
+print(tradable)
+```
+
+### 5) Account endpoints (example: gain/loss)
+
+```python
+gain_loss = client.get_gain_loss(client.account_number)
+print(gain_loss)
+```
+
+---
+
+## Orders
+
+The order helpers live under `tradier_api_client.rest.extensions.orders`.
+
+### Equity limit buy (example)
+
+```python
+from tradier_api_client.rest.extensions.orders import equity_limit
+
+order_request = equity_limit(
+    symbol="AAPL",
+    side="buy",
+    quantity=1,
+    price=150,
+    duration="gtc",
+)
+
+resp = client.place_order(client.account_number, order_request)
+print(resp)
+```
+
+### Read / cancel orders
+
+```python
+orders = client.get_orders(client.account_number)
+print(orders)
+
+# If you have an order id:
+# order = client.get_order(client.account_number, "12345678")
+# print(order)
+
+# cancel_resp = client.cancel_order(client.account_number, "12345678")
+# print(cancel_resp)
+```
+
+---
+
+## Running tests (local repo)
+
+This project includes tests/integration scripts under `tests/`.
+
+- Some scripts (like `tests/real_data.py`) may call live/sandbox endpoints and require `API_KEY`.
+- The `tests/` folder is **not** intended to be installed with the client distribution.
+
+To run tests locally:
+
+```bash
+python -m pip install -U pytest
+pytest -q
+```
+
+---
+
+## Notes / troubleshooting
+
+- **Sandbox vs production**: use `https://sandbox.tradier.com/v1` for paper testing and `https://api.tradier.com/v1` for production.
+- If you see authentication errors, confirm `API_KEY` is set in the environment used by your Python interpreter.

tradier_api_client-0.1.1/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tradier-api-client"
+dynamic=["version"]
+description = "Tradier REST + Streaming API client"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "Proprietary" }  # or: { file = "LICENSE" }
+authors = [{ name = "Your Name" }]
+
+# This replaces install_requires from setup.py
+dependencies = [
+    "requests>=2.25.1",
+    "cryptography>=41",
+    "websocket-client>=1.5"
+]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["tradier_api_client*"]
+exclude = ["tests", "build", "dist"]
+
+[tool.setuptools.dynamic]
+version = {attr = "tradier_api_client.__version__"}

tradier_api_client-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tradier_api_client-0.1.1/tradier_api_client/__init__.py

@@ -0,0 +1,12 @@
+"""
+Tradier REST and Streaming client
+"""
+import logging
+
+from tradier_api_client.rest import RestClient
+from tradier_api_client.streaming.streaming_client import StreamingClient
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())
+
+__version__ = "0.1.1"
+__all__ = ["StreamingClient", "RestClient"]

tradier_api_client-0.1.1/tradier_api_client/decorators.py

@@ -0,0 +1,21 @@
+"""
+Common decorators
+"""
+import functools
+
+
+def is_authenticated():
+    """
+    Checks whether the api_key is set on the object
+    """
+
+    def decorator(method):
+        @functools.wraps(method)
+        def wrapper(self, *args, **kwargs):
+            if not getattr(self, "authenticated", None):
+                raise Exception("API key is not set, API call will fail")
+            return method(self, *args, **kwargs)
+
+        return wrapper
+
+    return decorator

tradier_api_client-0.1.1/tradier_api_client/enc_dec.py

@@ -0,0 +1,103 @@
+"""
+EndDec util
+"""
+import os
+import string
+from cryptography.hazmat.primitives.ciphers.aead import AESGCM
+from cryptography.hazmat.primitives import hashes
+from cryptography.hazmat.primitives.kdf.pbkdf2 import PBKDF2HMAC
+
+
+class EncDec:
+    """
+    EndDec util
+    """
+
+    def __init__(self):
+        # Base62 alphabet: only alphanumeric characters.
+        self.BASE62_ALPHABET = string.digits + string.ascii_uppercase + string.ascii_lowercase  # 0-9, A-Z, a-z
+
+    def base62_encode(self, data: bytes) -> str:
+        """
+        EndDec util
+        """
+        num = int.from_bytes(data, 'big')
+        if num == 0:
+            return self.BASE62_ALPHABET[0]
+        base = len(self.BASE62_ALPHABET)
+        encoded = []
+        while num:
+            num, rem = divmod(num, base)
+            encoded.append(self.BASE62_ALPHABET[rem])
+        encoded.reverse()
+        return ''.join(encoded)
+
+    def base62_decode(self, s: str) -> bytes:
+        """
+        EndDec util
+        """
+        base = len(self.BASE62_ALPHABET)
+        num = 0
+        for char in s:
+            num = num * base + self.BASE62_ALPHABET.index(char)
+        # Calculate the number of bytes needed.
+        byte_length = (num.bit_length() + 7) // 8
+        return num.to_bytes(byte_length, 'big')
+
+    def derive_key(self, secret: str, salt: bytes) -> bytes:
+        """
+        EndDec util
+        """
+        # Derive a 32-byte key using PBKDF2HMAC (AES-256 needs 32 bytes).
+        kdf = PBKDF2HMAC(
+            algorithm=hashes.SHA256(),
+            length=32,
+            salt=salt,
+            iterations=100000,
+        )
+        return kdf.derive(secret.encode())
+
+    def encrypt_base62(self, plaintext: str, secret: str) -> str:
+        """
+        EndDec util
+        """
+        # Generate a random 16-byte salt.
+        salt = os.urandom(16)
+        key = self.derive_key(secret, salt)
+        aesgcm = AESGCM(key)
+        # Generate a random 12-byte nonce (recommended for AESGCM).
+        nonce = os.urandom(12)
+        ciphertext = aesgcm.encrypt(nonce, plaintext.encode(), None)
+
+        # Combine salt + nonce + ciphertext.
+        encrypted_bytes = salt + nonce + ciphertext
+
+        # Encode using Base62.
+        encrypted_b62 = self.base62_encode(encrypted_bytes)
+
+        # Enforce the length constraint.
+        if len(encrypted_b62) >= 255:
+            raise ValueError("Encrypted string exceeds the length limit of 255 characters.")
+
+        return encrypted_b62
+
+    def decrypt_base62(self, encrypted_b62: str, secret: str) -> str:
+        """
+        EndDec util
+        """
+        encrypted_bytes = self.base62_decode(encrypted_b62)
+
+        # Extract salt (first 16 bytes), nonce (next 12 bytes), and the ciphertext.
+        salt = encrypted_bytes[:16]
+        nonce = encrypted_bytes[16:28]
+        ciphertext = encrypted_bytes[28:]
+        key = self.derive_key(secret, salt)
+        aesgcm = AESGCM(key)
+        plaintext = aesgcm.decrypt(nonce, ciphertext, None)
+        return plaintext.decode('utf-8')
+
+
+if __name__ == '__main__':
+    encrypted = EncDec().encrypt_base62("yunind7.tradier", "Xjyrmnfg@321")
+    print(encrypted)
+    print(EncDec().decrypt_base62(encrypted, "Xjyrmnfg@321"))

tradier_api_client-0.1.1/tradier_api_client/helper_functions.py

@@ -0,0 +1,41 @@
+"""
+General utility functions for the Tradier API client.
+"""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+
+def log_for_level(
+        logger,
+        level: int,
+        message: str,
+        *,
+        exc: Optional[BaseException] = None,
+        exc_info: Any = None,
+        stack_info: bool = False,
+        extra: Optional[dict] = None,
+):
+    """Log *message* if *logger* is enabled for *level*.
+
+    This is a tiny helper to avoid building/logging messages when the level is disabled.
+
+    Args:
+        logger: A ``logging.Logger`` instance.
+        level: A stdlib logging level (e.g. ``logging.INFO``).
+        message: The message string to log.
+        exc: Optional exception instance to attach (equivalent to ``exc_info=exc``).
+        exc_info: Passed through to ``logger.log(..., exc_info=...)``. If both ``exc`` and
+            ``exc_info`` are provided, ``exc_info`` wins.
+        stack_info: Passed through to the logger.
+        extra: Passed through to the logger.
+    """
+    if not logger or not logger.isEnabledFor(level):
+        return
+
+    # Support passing an exception instance directly.
+    if exc_info is None and exc is not None:
+        exc_info = exc
+
+    logger.log(level, message, exc_info=exc_info, stack_info=stack_info, extra=extra)

tradier_api_client-0.1.1/tradier_api_client/rest/__init__.py

@@ -0,0 +1,6 @@
+"""
+Tradier Rest Client
+"""
+from .rest_client import RestClient
+
+__all__ = ["RestClient"]

tradier_api_client-0.1.1/tradier_api_client/rest/extensions/__init__.py

@@ -0,0 +1,4 @@
+from .options import OptionsWrapper
+from .orders import OrderWrapper
+
+__all__ = ['OptionsWrapper', 'OrderWrapper']