Tastytrade SDK

https://tastytrade.github.io/tastytrade-sdk-python/
Admin
Tastytrade SDK is a Python library that enables developers to access the Tastytrade trading...
Tokens:1,267
Snippets:13
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Tastytrade SDK

Source: https://tastytrade.github.io/tastytrade-sdk-python

Install the package using pip.

```bash
pip install tastytrade-sdk
```

--------------------------------

### Define Event Fields for Subscription

Source: https://tastytrade.github.io/tastytrade-sdk-python

Example of a dictionary mapping event types to specific fields for compact event formatting.

```json
{
    "Quote": ["eventType", "eventSymbol", "bidPrice", "askPrice", "bidSize", "askSize"]
}
```

--------------------------------

### Make Direct API GET Request with Multiple Symbols

Source: https://tastytrade.github.io/tastytrade-sdk-python

Use a list of tuples for the params argument when multiple symbols are required to handle duplicate keys in the query string.

```python
equities = tasty.api.get(
    '/instruments/equities',
    params=[('symbol[]', 'SPY'), ('symbol[]', 'AAPL')]
)
```

--------------------------------

### Initialize Tastytrade Client

Source: https://tastytrade.github.io/tastytrade-sdk-python

Create a client instance using OAuth2 credentials to validate a session.

```python
from tastytrade_sdk import Tastytrade


tasty = Tastytrade(
    client_id = YOUR_CLIENT_ID,
    client_secret = YOUR_CLIENT_SECRET,
    refresh_token = YOUR_REFRESH_TOKEN,
)

tasty.api.post('/sessions/validate')
```

--------------------------------

### Stream Market Data

Source: https://tastytrade.github.io/tastytrade-sdk-python

Initialize the client from environment variables and subscribe to real-time market data for specific symbols.

```python
from tastytrade_sdk import Tastytrade

# Instead of creating a Tastyworks object manually, you can store the details in the following
# environment variables and call this to create the object automatically. Remember, never store
# your client secret or refresh token directly in code or check it into version control.
# To use the sandbox environment instead, use api.cert.tastyworks.com as the API_BASE_URL and
# be sure to use client credentials generated for that environment.
#  API_BASE_URL=api.tastyworks.com
#  TT_CLIENT_ID=
#  TT_CLIENT_SECRET=
#  TT_REFRESH_TOKEN=

tasty = Tastytrade.from_env()

# Subscribing to symbols across different instrument types
# Please note: The option symbols here are expired. You need to subscribe to an unexpired symbol to receive quote data
symbols = [
    'BTC/USD',
    'SPY',
    '/ESU3',
    'SPY   230630C00255000',
    './ESU3 EW2N3 230714C4310'
]

subscription = tasty.market_data.subscribe(
    symbols=symbols,
    on_quote=print,
    on_candle=print,
    on_greeks=print
)

# start streaming
subscription.open()
```

--------------------------------

### Subscription Management

Source: https://tastytrade.github.io/tastytrade-sdk-python

Methods for managing real-time data stream connections.

```APIDOC
## Subscription.open()

### Description
Starts listening for feed events.

## Subscription.close()

### Description
Closes the stream connection.
```

--------------------------------

### Direct API Requests

Source: https://tastytrade.github.io/tastytrade-sdk-python

Methods for making direct HTTP requests to the Tastytrade API when specific SDK features are not yet implemented.

```APIDOC
## API Request Methods

### Description
Use the `Api` class to make direct requests. For endpoints requiring multiple symbols, use a list of tuples to handle duplicate keys (e.g., `[('symbol[]', 'SPY'), ('symbol[]', 'AAPL')]`).

### Methods
- **GET**: `get(path, params)`
- **POST**: `post(path, params, data)`
- **PUT**: `put(path, params, data)`
- **PATCH**: `patch(path, params, data)`
- **DELETE**: `delete(path, params)`

### Request Example
```python
equities = tasty.api.get(
    '/instruments/equities',
    params=[('symbol[]', 'SPY'), ('symbol[]', 'AAPL')]
)
```
```

--------------------------------

### Market Data Subscription

Source: https://tastytrade.github.io/tastytrade-sdk-python

Subscribes to real-time market data for specified symbols.

```APIDOC
## POST /market-data/subscribe

### Description
Subscribes to live feed data for a list of symbols, providing callbacks for quotes, candles, and greeks.

### Parameters
#### Request Body
- **symbols** (List[str]) - Required - List of symbols to subscribe to.
- **on_quote** (Callable) - Optional - Callback function for quote data.
- **on_candle** (Callable) - Optional - Callback function for candle data.
- **on_greeks** (Callable) - Optional - Callback function for greeks data.

### Request Example
```python
subscription = tasty.market_data.subscribe(
    symbols=['BTC/USD', 'SPY'],
    on_quote=print,
    on_candle=print,
    on_greeks=print
)
subscription.open()
```
```

--------------------------------

### POST /sessions/validate

Source: https://tastytrade.github.io/tastytrade-sdk-python

Validates the current session using OAuth2 credentials.

```APIDOC
## POST /sessions/validate

### Description
Validates the current session using the provided OAuth2 client credentials and refresh token.

### Method
POST

### Endpoint
/sessions/validate

### Request Example
```python
tasty.api.post('/sessions/validate')
```
```
Tokens:
Raw