tastytrade.instruments¶

pydantic model tastytrade.instruments.Cryptocurrency(*, instrument_type: InstrumentType, symbol: str, id: int, short_description: str, description: str, is_closing_only: bool, active: bool, tick_size: Decimal, destination_venue_symbols: list[DestinationVenueSymbol], streamer_symbol: str)¶

Bases: TradeableTastytradeData

Dataclass that represents a Tastytrade cryptocurrency object. Contains information about the cryptocurrency and methods to populate that data using cryptocurrency symbol(s).

Show JSON schema

{
   "title": "Cryptocurrency",
   "description": "Dataclass that represents a Tastytrade cryptocurrency object. Contains\ninformation about the cryptocurrency and methods to populate that data\nusing cryptocurrency symbol(s).",
   "type": "object",
   "properties": {
      "instrument-type": {
         "$ref": "#/$defs/InstrumentType"
      },
      "symbol": {
         "title": "Symbol",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "short-description": {
         "title": "Short-Description",
         "type": "string"
      },
      "description": {
         "title": "Description",
         "type": "string"
      },
      "is-closing-only": {
         "title": "Is-Closing-Only",
         "type": "boolean"
      },
      "active": {
         "title": "Active",
         "type": "boolean"
      },
      "tick-size": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Tick-Size"
      },
      "destination-venue-symbols": {
         "items": {
            "$ref": "#/$defs/DestinationVenueSymbol"
         },
         "title": "Destination-Venue-Symbols",
         "type": "array"
      },
      "streamer-symbol": {
         "title": "Streamer-Symbol",
         "type": "string"
      }
   },
   "$defs": {
      "DestinationVenueSymbol": {
         "description": "Dataclass representing a specific destination venue symbol for a\ncryptocurrency.",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "symbol": {
               "title": "Symbol",
               "type": "string"
            },
            "destination-venue": {
               "title": "Destination-Venue",
               "type": "string"
            },
            "routable": {
               "title": "Routable",
               "type": "boolean"
            },
            "max-quantity-precision": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Max-Quantity-Precision"
            },
            "max-price-precision": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Max-Price-Precision"
            }
         },
         "required": [
            "id",
            "symbol",
            "destination-venue",
            "routable"
         ],
         "title": "DestinationVenueSymbol",
         "type": "object"
      },
      "InstrumentType": {
         "description": "Contains the valid types of instruments and their representation in the API.",
         "enum": [
            "Bond",
            "Cryptocurrency",
            "Currency Pair",
            "Equity",
            "Equity Offering",
            "Equity Option",
            "Fixed Income Security",
            "Future",
            "Future Option",
            "Index",
            "Liquidity Pool",
            "Unknown",
            "Warrant"
         ],
         "title": "InstrumentType",
         "type": "string"
      }
   },
   "required": [
      "instrument-type",
      "symbol",
      "id",
      "short-description",
      "description",
      "is-closing-only",
      "active",
      "tick-size",
      "destination-venue-symbols",
      "streamer-symbol"
   ]
}

Fields:¶

• active (bool)

• description (str)

• destination_venue_symbols (list[tastytrade.instruments.DestinationVenueSymbol])

• id (int)

• is_closing_only (bool)

• short_description (str)

• streamer_symbol (str)

• tick_size (decimal.Decimal)

field active : bool [Required]¶

field description : str [Required]¶

field destination_venue_symbols : list[DestinationVenueSymbol] [Required] (alias 'destination-venue-symbols')¶

field id : int [Required]¶

field is_closing_only : bool [Required] (alias 'is-closing-only')¶

field short_description : str [Required] (alias 'short-description')¶

field streamer_symbol : str [Required] (alias 'streamer-symbol')¶

field tick_size : Decimal [Required] (alias 'tick-size')¶

async classmethod get(session: Session, symbols: str) → Self¶

async classmethod get(session: Session, symbols: Iterable[str] | None = None) → list[Self]

Returns a list of cryptocurrency objects from the given symbols, or a single cryptocurrency if a list is not provided.

Parameters:¶

session: Session¶

the session to use for the request.

symbols: str¶

symbols: Iterable[str] | None = None

the symbol(s) to get the cryptocurrencies for.

pydantic model tastytrade.instruments.Deliverable(*, id: int, root_symbol: str, deliverable_type: str, description: str, amount: Decimal, percent: str, symbol: str | None = None, instrument_type: InstrumentType | None = None)¶

Bases: TastytradeData

Dataclass representing the deliverable for an option.

Show JSON schema

{
   "title": "Deliverable",
   "description": "Dataclass representing the deliverable for an option.",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "root-symbol": {
         "title": "Root-Symbol",
         "type": "string"
      },
      "deliverable-type": {
         "title": "Deliverable-Type",
         "type": "string"
      },
      "description": {
         "title": "Description",
         "type": "string"
      },
      "amount": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Amount"
      },
      "percent": {
         "title": "Percent",
         "type": "string"
      },
      "symbol": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Symbol"
      },
      "instrument-type": {
         "anyOf": [
            {
               "$ref": "#/$defs/InstrumentType"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "InstrumentType": {
         "description": "Contains the valid types of instruments and their representation in the API.",
         "enum": [
            "Bond",
            "Cryptocurrency",
            "Currency Pair",
            "Equity",
            "Equity Offering",
            "Equity Option",
            "Fixed Income Security",
            "Future",
            "Future Option",
            "Index",
            "Liquidity Pool",
            "Unknown",
            "Warrant"
         ],
         "title": "InstrumentType",
         "type": "string"
      }
   },
   "required": [
      "id",
      "root-symbol",
      "deliverable-type",
      "description",
      "amount",
      "percent"
   ]
}

Fields:¶

• amount (decimal.Decimal)

• deliverable_type (str)

• description (str)

• id (int)

• instrument_type (tastytrade.order.InstrumentType | None)

• percent (str)

• root_symbol (str)

• symbol (str | None)

field amount : Decimal [Required]¶

field deliverable_type : str [Required] (alias 'deliverable-type')¶

field description : str [Required]¶

field id : int [Required]¶

field instrument_type : InstrumentType | None = None (alias 'instrument-type')¶

field percent : str [Required]¶

field root_symbol : str [Required] (alias 'root-symbol')¶

field symbol : str | None = None¶

pydantic model tastytrade.instruments.DestinationVenueSymbol(*, id: int, symbol: str, destination_venue: str, routable: bool, max_quantity_precision: int | None = None, max_price_precision: int | None = None)¶

Bases: TastytradeData

Dataclass representing a specific destination venue symbol for a cryptocurrency.

Show JSON schema

{
   "title": "DestinationVenueSymbol",
   "description": "Dataclass representing a specific destination venue symbol for a\ncryptocurrency.",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "symbol": {
         "title": "Symbol",
         "type": "string"
      },
      "destination-venue": {
         "title": "Destination-Venue",
         "type": "string"
      },
      "routable": {
         "title": "Routable",
         "type": "boolean"
      },
      "max-quantity-precision": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max-Quantity-Precision"
      },
      "max-price-precision": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max-Price-Precision"
      }
   },
   "required": [
      "id",
      "symbol",
      "destination-venue",
      "routable"
   ]
}

Fields:¶

• destination_venue (str)

• id (int)

• max_price_precision (int | None)

• max_quantity_precision (int | None)

• routable (bool)

• symbol (str)

field destination_venue : str [Required] (alias 'destination-venue')¶

field id : int [Required]¶

field max_price_precision : int | None = None (alias 'max-price-precision')¶

field max_quantity_precision : int | None = None (alias 'max-quantity-precision')¶

field routable : bool [Required]¶

field symbol : str [Required]¶

pydantic model tastytrade.instruments.Equity(*, instrument_type: InstrumentType, symbol: str, id: int, is_index: bool, description: str, lendability: str, market_time_instrument_collection: str, is_closing_only: bool, is_options_closing_only: bool, active: bool, is_illiquid: bool, is_etf: bool, streamer_symbol: str, borrow_rate: Decimal | None = None, cusip: str | None = None, short_description: str | None = None, halted_at: datetime | None = None, stops_trading_at: datetime | None = None, is_fractional_quantity_eligible: bool | None = None, tick_sizes: list[TickSize] | None = None, listed_market: str | None = None, option_tick_sizes: list[TickSize] | None = None)¶

Bases: TradeableTastytradeData

Dataclass that represents a Tastytrade equity object. Contains information about the equity and methods to populate that data using equity symbol(s).

Show JSON schema

{
   "title": "Equity",
   "description": "Dataclass that represents a Tastytrade equity object. Contains information\nabout the equity and methods to populate that data using equity symbol(s).",
   "type": "object",
   "properties": {
      "instrument-type": {
         "$ref": "#/$defs/InstrumentType"
      },
      "symbol": {
         "title": "Symbol",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "is-index": {
         "title": "Is-Index",
         "type": "boolean"
      },
      "description": {
         "title": "Description",
         "type": "string"
      },
      "lendability": {
         "title": "Lendability",
         "type": "string"
      },
      "market-time-instrument-collection": {
         "title": "Market-Time-Instrument-Collection",
         "type": "string"
      },
      "is-closing-only": {
         "title": "Is-Closing-Only",
         "type": "boolean"
      },
      "is-options-closing-only": {
         "title": "Is-Options-Closing-Only",
         "type": "boolean"
      },
      "active": {
         "title": "Active",
         "type": "boolean"
      },
      "is-illiquid": {
         "title": "Is-Illiquid",
         "type": "boolean"
      },
      "is-etf": {
         "title": "Is-Etf",
         "type": "boolean"
      },
      "streamer-symbol": {
         "title": "Streamer-Symbol",
         "type": "string"
      },
      "borrow-rate": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Borrow-Rate"
      },
      "cusip": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cusip"
      },
      "short-description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Short-Description"
      },
      "halted-at": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Halted-At"
      },
      "stops-trading-at": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Stops-Trading-At"
      },
      "is-fractional-quantity-eligible": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Is-Fractional-Quantity-Eligible"
      },
      "tick-sizes": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/TickSize"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Tick-Sizes"
      },
      "listed-market": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Listed-Market"
      },
      "option-tick-sizes": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/TickSize"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Option-Tick-Sizes"
      }
   },
   "$defs": {
      "InstrumentType": {
         "description": "Contains the valid types of instruments and their representation in the API.",
         "enum": [
            "Bond",
            "Cryptocurrency",
            "Currency Pair",
            "Equity",
            "Equity Offering",
            "Equity Option",
            "Fixed Income Security",
            "Future",
            "Future Option",
            "Index",
            "Liquidity Pool",
            "Unknown",
            "Warrant"
         ],
         "title": "InstrumentType",
         "type": "string"
      },
      "TickSize": {
         "description": "Dataclass representing the tick size for an instrument.",
         "properties": {
            "value": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
                     "type": "string"
                  }
               ],
               "title": "Value"
            },
            "threshold": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Threshold"
            },
            "symbol": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Symbol"
            }
         },
         "required": [
            "value"
         ],
         "title": "TickSize",
         "type": "object"
      }
   },
   "required": [
      "instrument-type",
      "symbol",
      "id",
      "is-index",
      "description",
      "lendability",
      "market-time-instrument-collection",
      "is-closing-only",
      "is-options-closing-only",
      "active",
      "is-illiquid",
      "is-etf",
      "streamer-symbol"
   ]
}

Fields:¶

• active (bool)

• borrow_rate (decimal.Decimal | None)

• cusip (str | None)

• description (str)

• halted_at (datetime.datetime | None)

• id (int)

• is_closing_only (bool)

• is_etf (bool)

• is_fractional_quantity_eligible (bool | None)

• is_illiquid (bool)

• is_index (bool)

• is_options_closing_only (bool)

• lendability (str)

• listed_market (str | None)

• market_time_instrument_collection (str)

• option_tick_sizes (list[tastytrade.instruments.TickSize] | None)

• short_description (str | None)

• stops_trading_at (datetime.datetime | None)

• streamer_symbol (str)

• tick_sizes (list[tastytrade.instruments.TickSize] | None)

field active : bool [Required]¶

field borrow_rate : Decimal | None = None (alias 'borrow-rate')¶

field cusip : str | None = None¶

field description : str [Required]¶

field halted_at : datetime | None = None (alias 'halted-at')¶

field id : int [Required]¶

field is_closing_only : bool [Required] (alias 'is-closing-only')¶

field is_etf : bool [Required] (alias 'is-etf')¶

field is_fractional_quantity_eligible : bool | None = None (alias 'is-fractional-quantity-eligible')¶

field is_illiquid : bool [Required] (alias 'is-illiquid')¶

field is_index : bool [Required] (alias 'is-index')¶

field is_options_closing_only : bool [Required] (alias 'is-options-closing-only')¶

field lendability : str [Required]¶

field listed_market : str | None = None (alias 'listed-market')¶

field market_time_instrument_collection : str [Required] (alias 'market-time-instrument-collection')¶

field option_tick_sizes : list[TickSize] | None = None (alias 'option-tick-sizes')¶

field short_description : str | None = None (alias 'short-description')¶

field stops_trading_at : datetime | None = None (alias 'stops-trading-at')¶

field streamer_symbol : str [Required] (alias 'streamer-symbol')¶

field tick_sizes : list[TickSize] | None = None (alias 'tick-sizes')¶

async classmethod get(session: Session, symbols: str) → Self¶

async classmethod get(session: Session, symbols: Iterable[str], *, per_page: int = 250, page_offset: int | None = 0, lendability: str | None = None, is_index: bool | None = None, is_etf: bool | None = None) → list[Self]

Returns a list of Equity objects from the given symbols, or a single Equity object if a list is not provided.

Parameters:¶

session: Session¶

the session to use for the request.

symbols: str¶

symbols: Iterable[str]

the symbol(s) to get the equities for.

per_page: int = 250

the number of options to get per page.

page_offset: int | None = 0

provide a specific page to get; if None, get all pages

lendability: str | None = None

the lendability of the equities; e.g. ‘Easy To Borrow’, ‘Locate Required’, ‘Preborrow’

is_index: bool | None = None

whether the equities are indexes.

is_etf: bool | None = None

whether the equities are ETFs.

async classmethod get_active_equities(session: Session, per_page: int = 1000, page_offset: int | None = 0, lendability: str | None = None) → list[Self]¶

Returns a list of actively traded Equity objects.

Parameters:¶

session: Session¶

the session to use for the request.

per_page: int = 1000¶

the number of equities to get per page.

page_offset: int | None = 0¶

provide a specific page to get; if None, get all pages

lendability: str | None = None¶

the lendability of the equities; e.g. ‘Easy To Borrow’, ‘Locate Required’, ‘Preborrow’

pydantic model tastytrade.instruments.Forex(*, id: int, description: str, streamer_symbol: str, symbol: str, instrument_type: InstrumentType)¶

Bases: TastytradeData

Dataclass that represents a Tastytrade currency pair object. Contains information about the pair and ways to stream it.

Show JSON schema

{
   "title": "Forex",
   "description": "Dataclass that represents a Tastytrade currency pair object. Contains\ninformation about the pair and ways to stream it.",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "description": {
         "title": "Description",
         "type": "string"
      },
      "dx-symbol": {
         "title": "Dx-Symbol",
         "type": "string"
      },
      "symbol": {
         "title": "Symbol",
         "type": "string"
      },
      "instrument-type": {
         "$ref": "#/$defs/InstrumentType"
      }
   },
   "$defs": {
      "InstrumentType": {
         "description": "Contains the valid types of instruments and their representation in the API.",
         "enum": [
            "Bond",
            "Cryptocurrency",
            "Currency Pair",
            "Equity",
            "Equity Offering",
            "Equity Option",
            "Fixed Income Security",
            "Future",
            "Future Option",
            "Index",
            "Liquidity Pool",
            "Unknown",
            "Warrant"
         ],
         "title": "InstrumentType",
         "type": "string"
      }
   },
   "required": [
      "id",
      "description",
      "dx-symbol",
      "symbol",
      "instrument-type"
   ]
}

Fields:¶

• description (str)

• id (int)

• instrument_type (tastytrade.order.InstrumentType)

• streamer_symbol (str)

• symbol (str)

field description : str [Required]¶

field id : int [Required]¶

field instrument_type : InstrumentType [Required] (alias 'instrument-type')¶

field streamer_symbol : str [Required] (alias 'dx-symbol')¶

field symbol : str [Required]¶

async classmethod get(session: Session) → list[Self]¶

Returns a list of all Forex objects from the API.

Parameters:¶

session: Session¶

the session to use for the request.

pydantic model tastytrade.instruments.Future(*, instrument_type: InstrumentType, symbol: str)¶

Bases: TradeableTastytradeData

Dataclass that represents a Tastytrade future object. Contains information about the future and methods to fetch futures for symbol(s).

Show JSON schema

{
   "title": "Future",
   "description": "Dataclass that represents a Tastytrade future object. Contains information\nabout the future and methods to fetch futures for symbol(s).",
   "type": "object",
   "properties": {
      "instrument-type": {
         "$ref": "#/$defs/InstrumentType",
         "default": "Future"
      },
      "symbol": {
         "title": "Symbol",
         "type": "string"
      },
      "product-code": {
         "title": "Product-Code",
         "type": "string"
      },
      "tick-size": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Tick-Size"
      },
      "notional-multiplier": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Notional-Multiplier"
      },
      "display-factor": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Display-Factor"
      },
      "last-trade-date": {
         "format": "date",
         "title": "Last-Trade-Date",
         "type": "string"
      },
      "expiration-date": {
         "format": "date",
         "title": "Expiration-Date",
         "type": "string"
      },
      "active": {
         "title": "Active",
         "type": "boolean"
      },
      "active-month": {
         "title": "Active-Month",
         "type": "boolean"
      },
      "next-active-month": {
         "title": "Next-Active-Month",
         "type": "boolean"
      },
      "is-closing-only": {
         "title": "Is-Closing-Only",
         "type": "boolean"
      },
      "stops-trading-at": {
         "format": "date-time",
         "title": "Stops-Trading-At",
         "type": "string"
      },
      "expires-at": {
         "format": "date-time",
         "title": "Expires-At",
         "type": "string"
      },
      "product-group": {
         "title": "Product-Group",
         "type": "string"
      },
      "exchange": {
         "title": "Exchange",
         "type": "string"
      },
      "streamer-exchange-code": {
         "title": "Streamer-Exchange-Code",
         "type": "string"
      },
      "back-month-first-calendar-symbol": {
         "title": "Back-Month-First-Calendar-Symbol",
         "type": "boolean"
      },
      "streamer-symbol": {
         "default": "",
         "title": "Streamer-Symbol",
         "type": "string"
      },
      "closing-only-date": {
         "anyOf": [
            {
               "format": "date",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Closing-Only-Date"
      },
      "is-tradeable": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Is-Tradeable"
      },
      "future-product": {
         "anyOf": [
            {
               "$ref": "#/$defs/FutureProduct"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "contract-size": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Contract-Size"
      },
      "main-fraction": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Main-Fraction"
      },
      "sub-fraction": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Sub-Fraction"
      },
      "first-notice-date": {
         "anyOf": [
            {
               "format": "date",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "First-Notice-Date"
      },
      "roll-target-symbol": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Roll-Target-Symbol"
      },
      "true-underlying-symbol": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "True-Underlying-Symbol"
      },
      "future-etf-equivalent": {
         "anyOf": [
            {
               "$ref": "#/$defs/FutureEtfEquivalent"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "tick-sizes": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/TickSize"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Tick-Sizes"
      },
      "option-tick-sizes": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/TickSize"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Option-Tick-Sizes"
      },
      "spread-tick-sizes": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/TickSize"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Spread-Tick-Sizes"
      }
   },
   "$defs": {
      "FutureEtfEquivalent": {
         "description": "Dataclass that represents the ETF equivalent for a future (aka, the number\nof shares of the ETF that are equivalent to one future, leverage-wise).",
         "properties": {
            "symbol": {
               "title": "Symbol",
               "type": "string"
            },
            "share-quantity": {
               "title": "Share-Quantity",
               "type": "integer"
            }
         },
         "required": [
            "symbol",
            "share-quantity"
         ],
         "title": "FutureEtfEquivalent",
         "type": "object"
      },
      "FutureMonthCode": {
         "description": "Contains the valid month codes for futures.\n\nThis is really here for reference, as the API barely uses these codes.",
         "enum": [
            "F",
            "G",
            "H",
            "J",
            "K",
            "M",
            "N",
            "Q",
            "U",
            "V",
            "X",
            "Z"
         ],
         "title": "FutureMonthCode",
         "type": "string"
      },
      "FutureOptionProduct": {
         "description": "Dataclass that represents a Tastytrade future option product object.\nContains information about the future option product (deliverable for\nthe future option).",
         "properties": {
            "root-symbol": {
               "title": "Root-Symbol",
               "type": "string"
            },
            "cash-settled": {
               "title": "Cash-Settled",
               "type": "boolean"
            },
            "code": {
               "title": "Code",
               "type": "string"
            },
            "display-factor": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
                     "type": "string"
                  }
               ],
               "title": "Display-Factor"
            },
            "exchange": {
               "title": "Exchange",
               "type": "string"
            },
            "product-type": {
               "title": "Product-Type",
               "type": "string"
            },
            "expiration-type": {
               "title": "Expiration-Type",
               "type": "string"
            },
            "settlement-delay-days": {
               "title": "Settlement-Delay-Days",
               "type": "integer"
            },
            "market-sector": {
               "title": "Market-Sector",
               "type": "string"
            },
            "clearing-code": {
               "title": "Clearing-Code",
               "type": "string"
            },
            "clearing-exchange-code": {
               "title": "Clearing-Exchange-Code",
               "type": "string"
            },
            "clearing-price-multiplier": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
                     "type": "string"
                  }
               ],
               "title": "Clearing-Price-Multiplier"
            },
            "is-rollover": {
               "title": "Is-Rollover",
               "type": "boolean"
            },
            "future-product": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FutureProduct"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "product-subtype": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Product-Subtype"
            },
            "legacy-code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Legacy-Code"
            },
            "clearport-code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Clearport-Code"
            }
         },
         "required": [
            "root-symbol",
            "cash-settled",
            "code",
            "display-factor",
            "exchange",
            "product-type",
            "expiration-type",
            "settlement-delay-days",
            "market-sector",
            "clearing-code",
            "clearing-exchange-code",
            "clearing-price-multiplier",
            "is-rollover"
         ],
         "title": "FutureOptionProduct",
         "type": "object"
      },
      "FutureProduct": {
         "description": "Dataclass that represents a Tastytrade future product object. Contains\ninformation about the future product and a method to fetch one for a\nsymbol.\n\nUseful for fetching general information about a family of futures, without\nknowing the specific expirations or symbols.",
         "properties": {
            "root-symbol": {
               "title": "Root-Symbol",
               "type": "string"
            },
            "code": {
               "title": "Code",
               "type": "string"
            },
            "description": {
               "title": "Description",
               "type": "string"
            },
            "exchange": {
               "title": "Exchange",
               "type": "string"
            },
            "product-type": {
               "title": "Product-Type",
               "type": "string"
            },
            "listed-months": {
               "items": {
                  "$ref": "#/$defs/FutureMonthCode"
               },
               "title": "Listed-Months",
               "type": "array"
            },
            "active-months": {
               "items": {
                  "$ref": "#/$defs/FutureMonthCode"
               },
               "title": "Active-Months",
               "type": "array"
            },
            "notional-multiplier": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
                     "type": "string"
                  }
               ],
               "title": "Notional-Multiplier"
            },
            "tick-size": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
                     "type": "string"
                  }
               ],
               "title": "Tick-Size"
            },
            "display-factor": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
                     "type": "string"
                  }
               ],
               "title": "Display-Factor"
            },
            "streamer-exchange-code": {
               "title": "Streamer-Exchange-Code",
               "type": "string"
            },
            "small-notional": {
               "title": "Small-Notional",
               "type": "boolean"
            },
            "back-month-first-calendar-symbol": {
               "title": "Back-Month-First-Calendar-Symbol",
               "type": "boolean"
            },
            "first-notice": {
               "title": "First-Notice",
               "type": "boolean"
            },
            "cash-settled": {
               "title": "Cash-Settled",
               "type": "boolean"
            },
            "market-sector": {
               "title": "Market-Sector",
               "type": "string"
            },
            "clearing-code": {
               "title": "Clearing-Code",
               "type": "string"
            },
            "clearing-exchange-code": {
               "title": "Clearing-Exchange-Code",
               "type": "string"
            },
            "roll": {
               "$ref": "#/$defs/Roll"
            },
            "base-tick": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Base-Tick"
            },
            "sub-tick": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Sub-Tick"
            },
            "contract-limit": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Contract-Limit"
            },
            "product-subtype": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Product-Subtype"
            },
            "security-group": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Security-Group"
            },
            "true-underlying-code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "True-Underlying-Code"
            },
            "clearport-code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Clearport-Code"
            },
            "legacy-code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Legacy-Code"
            },
            "legacy-exchange-code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Legacy-Exchange-Code"
            },
            "option-products": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/FutureOptionProduct"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Option-Products"
            }
         },
         "required": [
            "root-symbol",
            "code",
            "description",
            "exchange",
            "product-type",
            "listed-months",
            "active-months",
            "notional-multiplier",
            "tick-size",
            "display-factor",
            "streamer-exchange-code",
            "small-notional",
            "back-month-first-calendar-symbol",
            "first-notice",
            "cash-settled",
            "market-sector",
            "clearing-code",
            "clearing-exchange-code",
            "roll"
         ],
         "title": "FutureProduct",
         "type": "object"
      },
      "InstrumentType": {
         "description": "Contains the valid types of instruments and their representation in the API.",
         "enum": [
            "Bond",
            "Cryptocurrency",
            "Currency Pair",
            "Equity",
            "Equity Offering",
            "Equity Option",
            "Fixed Income Security",
            "Future",
            "Future Option",
            "Index",
            "Liquidity Pool",
            "Unknown",
            "Warrant"
         ],
         "title": "InstrumentType",
         "type": "string"
      },
      "Roll": {
         "description": "Dataclass representing a roll for a future.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "active-count": {
               "title": "Active-Count",
               "type": "integer"
            },
            "cash-settled": {
               "title": "Cash-Settled",
               "type": "boolean"
            },
            "business-days-offset": {
               "title": "Business-Days-Offset",
               "type": "integer"
            },
            "first-notice": {
               "title": "First-Notice",
               "type": "boolean"
            }
         },
         "required": [
            "name",
            "active-count",
            "cash-settled",
            "business-days-offset",
            "first-notice"
         ],
         "title": "Roll",
         "type": "object"
      },
      "TickSize": {
         "description": "Dataclass representing the tick size for an instrument.",
         "properties": {
            "value": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
                     "type": "string"
                  }
               ],
               "title": "Value"
            },
            "threshold": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Threshold"
            },
            "symbol": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Symbol"
            }
         },
         "required": [
            "value"
         ],
         "title": "TickSize",
         "type": "object"
      }
   },
   "required": [
      "symbol",
      "product-code",
      "tick-size",
      "notional-multiplier",
      "display-factor",
      "last-trade-date",
      "expiration-date",
      "active",
      "active-month",
      "next-active-month",
      "is-closing-only",
      "stops-trading-at",
      "expires-at",
      "product-group",
      "exchange",
      "streamer-exchange-code",
      "back-month-first-calendar-symbol"
   ]
}

Fields:¶

• active (bool)

• active_month (bool)

• back_month_first_calendar_symbol (bool)

• closing_only_date (datetime.date | None)

• contract_size (decimal.Decimal | None)

• display_factor (decimal.Decimal)

• exchange (str)

• expiration_date (datetime.date)

• expires_at (datetime.datetime)

• first_notice_date (datetime.date | None)

• future_etf_equivalent (tastytrade.instruments.FutureEtfEquivalent | None)

• future_product (tastytrade.instruments.FutureProduct | None)

• instrument_type (tastytrade.order.InstrumentType)

• is_closing_only (bool)

• is_tradeable (bool | None)

• last_trade_date (datetime.date)

• main_fraction (decimal.Decimal | None)

• next_active_month (bool)

• notional_multiplier (decimal.Decimal)

• option_tick_sizes (list[tastytrade.instruments.TickSize] | None)

• product_code (str)

• product_group (str)

• roll_target_symbol (str | None)

• spread_tick_sizes (list[tastytrade.instruments.TickSize] | None)

• stops_trading_at (datetime.datetime)

• streamer_exchange_code (str)

• streamer_symbol (str)

• sub_fraction (decimal.Decimal | None)

• tick_size (decimal.Decimal)

• tick_sizes (list[tastytrade.instruments.TickSize] | None)

• true_underlying_symbol (str | None)

field active : bool [Required]¶

field active_month : bool [Required] (alias 'active-month')¶

field back_month_first_calendar_symbol : bool [Required] (alias 'back-month-first-calendar-symbol')¶

field closing_only_date : date | None = None (alias 'closing-only-date')¶

field contract_size : Decimal | None = None (alias 'contract-size')¶

field display_factor : Decimal [Required] (alias 'display-factor')¶

field exchange : str [Required]¶

field expiration_date : date [Required] (alias 'expiration-date')¶

field expires_at : datetime [Required] (alias 'expires-at')¶

field first_notice_date : date | None = None (alias 'first-notice-date')¶

field future_etf_equivalent : FutureEtfEquivalent | None = None (alias 'future-etf-equivalent')¶

field future_product : FutureProduct | None = None (alias 'future-product')¶

field instrument_type : InstrumentType = InstrumentType.FUTURE (alias 'instrument-type')¶

field is_closing_only : bool [Required] (alias 'is-closing-only')¶

field is_tradeable : bool | None = None (alias 'is-tradeable')¶

field last_trade_date : date [Required] (alias 'last-trade-date')¶

field main_fraction : Decimal | None = None (alias 'main-fraction')¶

field next_active_month : bool [Required] (alias 'next-active-month')¶

field notional_multiplier : Decimal [Required] (alias 'notional-multiplier')¶

field option_tick_sizes : list[TickSize] | None = None (alias 'option-tick-sizes')¶

field product_code : str [Required] (alias 'product-code')¶

field product_group : str [Required] (alias 'product-group')¶

field roll_target_symbol : str | None = None (alias 'roll-target-symbol')¶

field spread_tick_sizes : list[TickSize] | None = None (alias 'spread-tick-sizes')¶

field stops_trading_at : datetime [Required] (alias 'stops-trading-at')¶

field streamer_exchange_code : str [Required] (alias 'streamer-exchange-code')¶

field streamer_symbol : str = '' (alias 'streamer-symbol')¶

field sub_fraction : Decimal | None = None (alias 'sub-fraction')¶

field tick_size : Decimal [Required] (alias 'tick-size')¶

field tick_sizes : list[TickSize] | None = None (alias 'tick-sizes')¶

field true_underlying_symbol : str | None = None (alias 'true-underlying-symbol')¶

async classmethod get(session: Session, symbols: str) → Self¶

async classmethod get(session: Session, symbols: Iterable[str] | None = None, *, product_codes: list[str] | None = None, per_page: int = 250, page_offset: int | None = 0) → list[Self]

Returns a list of Future objects from the given symbols or product codes.

Parameters:¶

session: Session¶

the session to use for the request.

symbols: str¶

symbols: Iterable[str] | None = None

symbol(s) of the futures, e.g. ‘ESZ9’, ‘/ESZ9’.

product_codes: list[str] | None = None

the product codes of the futures, e.g. ‘ES’, ‘6A’. Ignored if symbols are provided.

per_page: int = 250

the number of options to get per page.

page_offset: int | None = 0

provide a specific page to get; if None, get all pages