tastytrade.search¶

pydantic model tastytrade.search.SymbolData(*, symbol: str, description: str)¶

Bases: TastytradeData

Dataclass holding search results for an individual item.

Show JSON schema

{
   "title": "SymbolData",
   "description": "Dataclass holding search results for an individual item.",
   "type": "object",
   "properties": {
      "symbol": {
         "title": "Symbol",
         "type": "string"
      },
      "description": {
         "title": "Description",
         "type": "string"
      }
   },
   "required": [
      "symbol",
      "description"
   ]
}

Fields:¶

• description (str)

• symbol (str)

field description : str [Required]¶

field symbol : str [Required]¶

async tastytrade.search.symbol_search(session: Session, symbol: str) → list[SymbolData]¶

Performs a symbol search using the Tastytrade API and returns a list of symbols that are similar to the given search phrase.

Parameters:¶

session: Session¶

active user session to use

symbol: str¶

search phrase