tastytrade.order¶

pydantic model tastytrade.order.AdvancedInstructions(*, strict_position_effect_validation: bool = False)¶

Bases: TastytradeData

Dataclass containing advanced order rules.

Show JSON schema

{
   "title": "AdvancedInstructions",
   "description": "Dataclass containing advanced order rules.",
   "type": "object",
   "properties": {
      "strict-position-effect-validation": {
         "default": false,
         "title": "Strict-Position-Effect-Validation",
         "type": "boolean"
      }
   }
}

Fields:¶

• strict_position_effect_validation (bool)

field strict_position_effect_validation : bool = False (alias 'strict-position-effect-validation')¶

By default, if a position meant to be closed by a closing order is no longer open, the API will turn it into an opening order. With this flag, the API would instead discard the closing order.

pydantic model tastytrade.order.BuyingPowerEffect(*, change_in_margin_requirement: Decimal, change_in_buying_power: Decimal, current_buying_power: Decimal, new_buying_power: Decimal, isolated_order_margin_requirement: Decimal, is_spread: bool, impact: Decimal, effect: PriceEffect)¶

Bases: TastytradeData

Dataclass containing information about the effect of a trade on buying power.

Show JSON schema

{
   "title": "BuyingPowerEffect",
   "description": "Dataclass containing information about the effect of a trade on buying\npower.",
   "type": "object",
   "properties": {
      "change-in-margin-requirement": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Change-In-Margin-Requirement"
      },
      "change-in-buying-power": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Change-In-Buying-Power"
      },
      "current-buying-power": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Current-Buying-Power"
      },
      "new-buying-power": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "New-Buying-Power"
      },
      "isolated-order-margin-requirement": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Isolated-Order-Margin-Requirement"
      },
      "is-spread": {
         "title": "Is-Spread",
         "type": "boolean"
      },
      "impact": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Impact"
      },
      "effect": {
         "$ref": "#/$defs/PriceEffect"
      }
   },
   "$defs": {
      "PriceEffect": {
         "description": "This is an :class:`~enum.Enum` that shows the sign of a price effect, since\nTastytrade is apparently against negative numbers.",
         "enum": [
            "Credit",
            "Debit",
            "None"
         ],
         "title": "PriceEffect",
         "type": "string"
      }
   },
   "required": [
      "change-in-margin-requirement",
      "change-in-buying-power",
      "current-buying-power",
      "new-buying-power",
      "isolated-order-margin-requirement",
      "is-spread",
      "impact",
      "effect"
   ]
}

Fields:¶

• change_in_buying_power (decimal.Decimal)

• change_in_margin_requirement (decimal.Decimal)

• current_buying_power (decimal.Decimal)

• effect (tastytrade.utils.PriceEffect)

• impact (decimal.Decimal)

• is_spread (bool)

• isolated_order_margin_requirement (decimal.Decimal)

• new_buying_power (decimal.Decimal)

Validators:¶

• validate_price_effects » all fields

enum tastytrade.order.ComplexOrderType(value)¶

Bases: str, Enum

This is an Enum that contains the valid complex order types.

Member Type:¶

str

Valid values are as follows:

OCO = <ComplexOrderType.OCO: 'OCO'>¶

OTOCO = <ComplexOrderType.OTOCO: 'OTOCO'>¶

pydantic model tastytrade.order.ComputedData(*, open: bool, updated_at: datetime, total_fees: Decimal, total_commissions: Decimal, realized_gain: Decimal, realized_gain_with_fees: Decimal, winner_realized_and_closed: bool, winner_realized: bool, winner_realized_with_fees: bool, roll_count: int, opened_at: datetime, last_occurred_at: datetime, started_at_days_to_expiration: int, duration: int, total_opening_cost: Decimal, total_closing_cost: Decimal, total_cost: Decimal, gcd_open_quantity: Decimal, fees_missing: bool, open_entries: list[OrderChainEntry], total_cost_per_unit: Decimal | None = None)¶

Bases: TastytradeData

Dataclass containing computed data about an order chain.

Show JSON schema

{
   "title": "ComputedData",
   "description": "Dataclass containing computed data about an order chain.",
   "type": "object",
   "properties": {
      "open": {
         "title": "Open",
         "type": "boolean"
      },
      "updated-at": {
         "format": "date-time",
         "title": "Updated-At",
         "type": "string"
      },
      "total-fees": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Total-Fees"
      },
      "total-commissions": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Total-Commissions"
      },
      "realized-gain": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Realized-Gain"
      },
      "realized-gain-with-fees": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Realized-Gain-With-Fees"
      },
      "winner-realized-and-closed": {
         "title": "Winner-Realized-And-Closed",
         "type": "boolean"
      },
      "winner-realized": {
         "title": "Winner-Realized",
         "type": "boolean"
      },
      "winner-realized-with-fees": {
         "title": "Winner-Realized-With-Fees",
         "type": "boolean"
      },
      "roll-count": {
         "title": "Roll-Count",
         "type": "integer"
      },
      "opened-at": {
         "format": "date-time",
         "title": "Opened-At",
         "type": "string"
      },
      "last-occurred-at": {
         "format": "date-time",
         "title": "Last-Occurred-At",
         "type": "string"
      },
      "started-at-days-to-expiration": {
         "title": "Started-At-Days-To-Expiration",
         "type": "integer"
      },
      "duration": {
         "title": "Duration",
         "type": "integer"
      },
      "total-opening-cost": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Total-Opening-Cost"
      },
      "total-closing-cost": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Total-Closing-Cost"
      },
      "total-cost": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Total-Cost"
      },
      "gcd-open-quantity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Gcd-Open-Quantity"
      },
      "fees-missing": {
         "title": "Fees-Missing",
         "type": "boolean"
      },
      "open-entries": {
         "items": {
            "$ref": "#/$defs/OrderChainEntry"
         },
         "title": "Open-Entries",
         "type": "array"
      },
      "total-cost-per-unit": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Total-Cost-Per-Unit"
      }
   },
   "$defs": {
      "InstrumentType": {
         "description": "This is an :class:`~enum.Enum` that contains the valid types of instruments\nand 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"
      },
      "OrderChainEntry": {
         "description": "Dataclass containing information about a single order in an order chain.",
         "properties": {
            "symbol": {
               "title": "Symbol",
               "type": "string"
            },
            "instrument-type": {
               "$ref": "#/$defs/InstrumentType"
            },
            "quantity": {
               "title": "Quantity",
               "type": "string"
            },
            "quantity-type": {
               "title": "Quantity-Type",
               "type": "string"
            },
            "quantity-numeric": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Quantity-Numeric"
            }
         },
         "required": [
            "symbol",
            "instrument-type",
            "quantity",
            "quantity-type",
            "quantity-numeric"
         ],
         "title": "OrderChainEntry",
         "type": "object"
      }
   },
   "required": [
      "open",
      "updated-at",
      "total-fees",
      "total-commissions",
      "realized-gain",
      "realized-gain-with-fees",
      "winner-realized-and-closed",
      "winner-realized",
      "winner-realized-with-fees",
      "roll-count",
      "opened-at",
      "last-occurred-at",
      "started-at-days-to-expiration",
      "duration",
      "total-opening-cost",
      "total-closing-cost",
      "total-cost",
      "gcd-open-quantity",
      "fees-missing",
      "open-entries"
   ]
}

Fields:¶

• duration (int)

• fees_missing (bool)

• gcd_open_quantity (decimal.Decimal)

• last_occurred_at (datetime.datetime)

• open (bool)

• open_entries (list[tastytrade.order.OrderChainEntry])

• opened_at (datetime.datetime)

• realized_gain (decimal.Decimal)

• realized_gain_with_fees (decimal.Decimal)

• roll_count (int)

• started_at_days_to_expiration (int)

• total_closing_cost (decimal.Decimal)

• total_commissions (decimal.Decimal)

• total_cost (decimal.Decimal)

• total_cost_per_unit (decimal.Decimal | None)

• total_fees (decimal.Decimal)

• total_opening_cost (decimal.Decimal)

• updated_at (datetime.datetime)

• winner_realized (bool)

• winner_realized_and_closed (bool)

• winner_realized_with_fees (bool)

Validators:¶

• validate_price_effects » all fields

pydantic model tastytrade.order.FeeCalculation(*, regulatory_fees: Decimal, clearing_fees: Decimal, commission: Decimal, proprietary_index_option_fees: Decimal, total_fees: Decimal)¶

Bases: TastytradeData

Dataclass containing information about the fees associated with a trade.

Show JSON schema

{
   "title": "FeeCalculation",
   "description": "Dataclass containing information about the fees associated with a trade.",
   "type": "object",
   "properties": {
      "regulatory-fees": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Regulatory-Fees"
      },
      "clearing-fees": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Clearing-Fees"
      },
      "commission": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Commission"
      },
      "proprietary-index-option-fees": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Proprietary-Index-Option-Fees"
      },
      "total-fees": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Total-Fees"
      }
   },
   "required": [
      "regulatory-fees",
      "clearing-fees",
      "commission",
      "proprietary-index-option-fees",
      "total-fees"
   ]
}

Fields:¶

• clearing_fees (decimal.Decimal)

• commission (decimal.Decimal)

• proprietary_index_option_fees (decimal.Decimal)

• regulatory_fees (decimal.Decimal)

• total_fees (decimal.Decimal)

Validators:¶

• validate_price_effects » all fields

pydantic model tastytrade.order.FillInfo(*, fill_id: str, quantity: Decimal, fill_price: Decimal, filled_at: datetime, destination_venue: str | None = None, ext_group_fill_id: str | None = None, ext_exec_id: str | None = None)¶

Bases: TastytradeData

Dataclass that contains information about an order fill.

Show JSON schema

{
   "title": "FillInfo",
   "description": "Dataclass that contains information about an order fill.",
   "type": "object",
   "properties": {
      "fill-id": {
         "title": "Fill-Id",
         "type": "string"
      },
      "quantity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Quantity"
      },
      "fill-price": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            }
         ],
         "title": "Fill-Price"
      },
      "filled-at": {
         "format": "date-time",
         "title": "Filled-At",
         "type": "string"
      },
      "destination-venue": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Destination-Venue"
      },
      "ext-group-fill-id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Ext-Group-Fill-Id"
      },
      "ext-exec-id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Ext-Exec-Id"
      }
   },
   "required": [
      "fill-id",
      "quantity",
      "fill-price",
      "filled-at"
   ]
}

Fields:¶

• destination_venue (str | None)

• ext_exec_id (str | None)

• ext_group_fill_id (str | None)

• fill_id (str)

• fill_price (decimal.Decimal)

• filled_at (datetime.datetime)

• quantity (decimal.Decimal)

enum tastytrade.order.InstrumentType(value)¶

Bases: str, Enum

This is an Enum that contains the valid types of instruments and their representation in the API.

Member Type:¶

str

Valid values are as follows:

BOND = <InstrumentType.BOND: 'Bond'>¶

CRYPTOCURRENCY = <InstrumentType.CRYPTOCURRENCY: 'Cryptocurrency'>¶

CURRENCY_PAIR = <InstrumentType.CURRENCY_PAIR: 'Currency Pair'>¶

EQUITY = <InstrumentType.EQUITY: 'Equity'>¶

EQUITY_OFFERING = <InstrumentType.EQUITY_OFFERING: 'Equity Offering'>¶

EQUITY_OPTION = <InstrumentType.EQUITY_OPTION: 'Equity Option'>¶

FIXED_INCOME = <InstrumentType.FIXED_INCOME: 'Fixed Income Security'>¶

FUTURE = <InstrumentType.FUTURE: 'Future'>¶

FUTURE_OPTION = <InstrumentType.FUTURE_OPTION: 'Future Option'>¶

INDEX = <InstrumentType.INDEX: 'Index'>¶

LIQUIDITY_POOL = <InstrumentType.LIQUIDITY_POOL: 'Liquidity Pool'>¶

UNKNOWN = <InstrumentType.UNKNOWN: 'Unknown'>¶

WARRANT = <InstrumentType.WARRANT: 'Warrant'>¶

pydantic model tastytrade.order.Leg(*, instrument_type: InstrumentType, symbol: str, action: OrderAction, quantity: Decimal | int | None = None, remaining_quantity: Decimal | None = None, fills: list[FillInfo] | None = None)¶

Bases: TastytradeData

Dataclass that represents an order leg.

Classes that inherit from TradeableTastytradeData can call build_leg() to build a leg from the dataclass.

Show JSON schema

{
   "title": "Leg",
   "description": "Dataclass that represents an order leg.\n\nClasses that inherit from :class:`TradeableTastytradeData` can\ncall :meth:`build_leg` to build a leg from the dataclass.",
   "type": "object",
   "properties": {
      "instrument-type": {
         "$ref": "#/$defs/InstrumentType"
      },
      "symbol": {
         "title": "Symbol",
         "type": "string"
      },
      "action": {
         "$ref": "#/$defs/OrderAction"
      },
      "quantity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            },
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Quantity"
      },
      "remaining-quantity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Remaining-Quantity"
      },
      "fills": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/FillInfo"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Fills"
      }
   },
   "$defs": {
      "FillInfo": {
         "description": "Dataclass that contains information about an order fill.",
         "properties": {
            "fill-id": {
               "title": "Fill-Id",
               "type": "string"
            },
            "quantity": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Quantity"
            },
            "fill-price": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Fill-Price"
            },
            "filled-at": {
               "format": "date-time",
               "title": "Filled-At",
               "type": "string"
            },
            "destination-venue": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Destination-Venue"
            },
            "ext-group-fill-id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Ext-Group-Fill-Id"
            },
            "ext-exec-id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Ext-Exec-Id"
            }
         },
         "required": [
            "fill-id",
            "quantity",
            "fill-price",
            "filled-at"
         ],
         "title": "FillInfo",
         "type": "object"
      },
      "InstrumentType": {
         "description": "This is an :class:`~enum.Enum` that contains the valid types of instruments\nand 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"
      },
      "OrderAction": {
         "description": "This is an :class:`~enum.Enum` that contains the valid order actions.",
         "enum": [
            "Buy to Open",
            "Buy to Close",
            "Sell to Open",
            "Sell to Close",
            "Buy",
            "Sell"
         ],
         "title": "OrderAction",
         "type": "string"
      }
   },
   "required": [
      "instrument-type",
      "symbol",
      "action"
   ]
}

Fields:¶

• action (tastytrade.order.OrderAction)

• fills (list[tastytrade.order.FillInfo] | None)

• instrument_type (tastytrade.order.InstrumentType)

• quantity (decimal.Decimal | int | None)

• remaining_quantity (decimal.Decimal | None)

• symbol (str)

pydantic model tastytrade.order.Message(*, code: str, message: str, preflight_id: str | None = None)¶

Bases: TastytradeData

Dataclass that represents a message from the Tastytrade API, usually a warning or an error.

Show JSON schema

{
   "title": "Message",
   "description": "Dataclass that represents a message from the Tastytrade API, usually\na warning or an error.",
   "type": "object",
   "properties": {
      "code": {
         "title": "Code",
         "type": "string"
      },
      "message": {
         "title": "Message",
         "type": "string"
      },
      "preflight-id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Preflight-Id"
      }
   },
   "required": [
      "code",
      "message"
   ]
}

Fields:¶

• code (str)

• message (str)

• preflight_id (str | None)

pydantic model tastytrade.order.NewComplexOrder(*, orders: list[NewOrder], source: str = 'tastyware/tastytrade:v11.0.5', trigger_order: NewOrder | None = None, type: ComplexOrderType = ComplexOrderType.OCO)¶

Bases: TastytradeData

Dataclass containing information about a new OTOCO order. Also used for modifying existing orders.

Show JSON schema

{
   "title": "NewComplexOrder",
   "description": "Dataclass containing information about a new OTOCO order.\nAlso used for modifying existing orders.",
   "type": "object",
   "properties": {
      "orders": {
         "items": {
            "$ref": "#/$defs/NewOrder"
         },
         "title": "Orders",
         "type": "array"
      },
      "source": {
         "default": "tastyware/tastytrade:v11.0.5",
         "title": "Source",
         "type": "string"
      },
      "trigger-order": {
         "anyOf": [
            {
               "$ref": "#/$defs/NewOrder"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "type": {
         "$ref": "#/$defs/ComplexOrderType",
         "default": "OCO"
      }
   },
   "$defs": {
      "AdvancedInstructions": {
         "description": "Dataclass containing advanced order rules.",
         "properties": {
            "strict-position-effect-validation": {
               "default": false,
               "title": "Strict-Position-Effect-Validation",
               "type": "boolean"
            }
         },
         "title": "AdvancedInstructions",
         "type": "object"
      },
      "ComplexOrderType": {
         "description": "This is an :class:`~enum.Enum` that contains the valid complex order types.",
         "enum": [
            "OCO",
            "OTOCO"
         ],
         "title": "ComplexOrderType",
         "type": "string"
      },
      "FillInfo": {
         "description": "Dataclass that contains information about an order fill.",
         "properties": {
            "fill-id": {
               "title": "Fill-Id",
               "type": "string"
            },
            "quantity": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Quantity"
            },
            "fill-price": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Fill-Price"
            },
            "filled-at": {
               "format": "date-time",
               "title": "Filled-At",
               "type": "string"
            },
            "destination-venue": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Destination-Venue"
            },
            "ext-group-fill-id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Ext-Group-Fill-Id"
            },
            "ext-exec-id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Ext-Exec-Id"
            }
         },
         "required": [
            "fill-id",
            "quantity",
            "fill-price",
            "filled-at"
         ],
         "title": "FillInfo",
         "type": "object"
      },
      "InstrumentType": {
         "description": "This is an :class:`~enum.Enum` that contains the valid types of instruments\nand 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"
      },
      "Leg": {
         "description": "Dataclass that represents an order leg.\n\nClasses that inherit from :class:`TradeableTastytradeData` can\ncall :meth:`build_leg` to build a leg from the dataclass.",
         "properties": {
            "instrument-type": {
               "$ref": "#/$defs/InstrumentType"
            },
            "symbol": {
               "title": "Symbol",
               "type": "string"
            },
            "action": {
               "$ref": "#/$defs/OrderAction"
            },
            "quantity": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Quantity"
            },
            "remaining-quantity": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Remaining-Quantity"
            },
            "fills": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/FillInfo"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Fills"
            }
         },
         "required": [
            "instrument-type",
            "symbol",
            "action"
         ],
         "title": "Leg",
         "type": "object"
      },
      "NewOrder": {
         "description": "Dataclass containing information about a new order. Also used for\nmodifying existing orders.",
         "properties": {
            "time-in-force": {
               "$ref": "#/$defs/OrderTimeInForce"
            },
            "order-type": {
               "$ref": "#/$defs/OrderType"
            },
            "source": {
               "default": "tastyware/tastytrade:v11.0.5",
               "title": "Source",
               "type": "string"
            },
            "legs": {
               "items": {
                  "$ref": "#/$defs/Leg"
               },
               "title": "Legs",
               "type": "array"
            },
            "gtc-date": {
               "anyOf": [
                  {
                     "format": "date",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Gtc-Date"
            },
            "stop-trigger": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Stop-Trigger"
            },
            "price": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Price"
            },
            "value": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Value"
            },
            "partition-key": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Partition-Key"
            },
            "preflight-id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Preflight-Id"
            },
            "rules": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OrderRule"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "advanced-instructions": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AdvancedInstructions"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "external-identifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "External-Identifier"
            }
         },
         "required": [
            "time-in-force",
            "order-type",
            "legs"
         ],
         "title": "NewOrder",
         "type": "object"
      },
      "OrderAction": {
         "description": "This is an :class:`~enum.Enum` that contains the valid order actions.",
         "enum": [
            "Buy to Open",
            "Buy to Close",
            "Sell to Open",
            "Sell to Close",
            "Buy",
            "Sell"
         ],
         "title": "OrderAction",
         "type": "string"
      },
      "OrderCondition": {
         "description": "Dataclass that represents an order condition for an order rule.",
         "properties": {
            "id": {
               "title": "Id",
               "type": "string"
            },
            "action": {
               "title": "Action",
               "type": "string"
            },
            "symbol": {
               "title": "Symbol",
               "type": "string"
            },
            "instrument-type": {
               "$ref": "#/$defs/InstrumentType"
            },
            "indicator": {
               "title": "Indicator",
               "type": "string"
            },
            "comparator": {
               "title": "Comparator",
               "type": "string"
            },
            "threshold": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Threshold"
            },
            "is-threshold-based-on-notional": {
               "title": "Is-Threshold-Based-On-Notional",
               "type": "boolean"
            },
            "triggered-at": {
               "format": "date-time",
               "title": "Triggered-At",
               "type": "string"
            },
            "triggered-value": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Triggered-Value"
            },
            "price-components": {
               "items": {
                  "$ref": "#/$defs/OrderConditionPriceComponent"
               },
               "title": "Price-Components",
               "type": "array"
            }
         },
         "required": [
            "id",
            "action",
            "symbol",
            "instrument-type",
            "indicator",
            "comparator",
            "threshold",
            "is-threshold-based-on-notional",
            "triggered-at",
            "triggered-value",
            "price-components"
         ],
         "title": "OrderCondition",
         "type": "object"
      },
      "OrderConditionPriceComponent": {
         "description": "Dataclass that represents a price component of an order condition.",
         "properties": {
            "symbol": {
               "title": "Symbol",
               "type": "string"
            },
            "instrument-type": {
               "$ref": "#/$defs/InstrumentType"
            },
            "quantity": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Quantity"
            },
            "quantity-direction": {
               "title": "Quantity-Direction",
               "type": "string"
            }
         },
         "required": [
            "symbol",
            "instrument-type",
            "quantity",
            "quantity-direction"
         ],
         "title": "OrderConditionPriceComponent",
         "type": "object"
      },
      "OrderRule": {
         "description": "Dataclass that represents an order rule for a complex order.",
         "properties": {
            "route-after": {
               "format": "date-time",
               "title": "Route-After",
               "type": "string"
            },
            "routed-at": {
               "format": "date-time",
               "title": "Routed-At",
               "type": "string"
            },
            "cancel-at": {
               "format": "date-time",
               "title": "Cancel-At",
               "type": "string"
            },
            "cancelled-at": {
               "format": "date-time",
               "title": "Cancelled-At",
               "type": "string"
            },
            "order-conditions": {
               "items": {
                  "$ref": "#/$defs/OrderCondition"
               },
               "title": "Order-Conditions",
               "type": "array"
            }
         },
         "required": [
            "route-after",
            "routed-at",
            "cancel-at",
            "cancelled-at",
            "order-conditions"
         ],
         "title": "OrderRule",
         "type": "object"
      },
      "OrderTimeInForce": {
         "description": "This is an :class:`~enum.Enum` that contains the valid TIFs for orders.",
         "enum": [
            "Day",
            "GTC",
            "GTD",
            "Ext",
            "GTC Ext",
            "IOC"
         ],
         "title": "OrderTimeInForce",
         "type": "string"
      },
      "OrderType": {
         "description": "This is an :class:`~enum.Enum` that contains the valid types of orders.",
         "enum": [
            "Limit",
            "Market",
            "Marketable Limit",
            "Stop",
            "Stop Limit",
            "Notional Market"
         ],
         "title": "OrderType",
         "type": "string"
      }
   },
   "required": [
      "orders"
   ]
}

Fields:¶

• orders (list[tastytrade.order.NewOrder])

• source (str)

• trigger_order (tastytrade.order.NewOrder | None)

• type (tastytrade.order.ComplexOrderType)

pydantic model tastytrade.order.NewOrder(*, time_in_force: OrderTimeInForce, order_type: OrderType, source: str = 'tastyware/tastytrade:v11.0.5', legs: list[Leg], gtc_date: date | None = None, stop_trigger: Decimal | None = None, price: Decimal | None = None, value: Decimal | None = None, partition_key: str | None = None, preflight_id: str | None = None, rules: OrderRule | None = None, advanced_instructions: AdvancedInstructions | None = None, external_identifier: str | None = None)¶

Bases: TastytradeData

Dataclass containing information about a new order. Also used for modifying existing orders.

Show JSON schema

{
   "title": "NewOrder",
   "description": "Dataclass containing information about a new order. Also used for\nmodifying existing orders.",
   "type": "object",
   "properties": {
      "time-in-force": {
         "$ref": "#/$defs/OrderTimeInForce"
      },
      "order-type": {
         "$ref": "#/$defs/OrderType"
      },
      "source": {
         "default": "tastyware/tastytrade:v11.0.5",
         "title": "Source",
         "type": "string"
      },
      "legs": {
         "items": {
            "$ref": "#/$defs/Leg"
         },
         "title": "Legs",
         "type": "array"
      },
      "gtc-date": {
         "anyOf": [
            {
               "format": "date",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Gtc-Date"
      },
      "stop-trigger": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Stop-Trigger"
      },
      "price": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Price"
      },
      "value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Value"
      },
      "partition-key": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Partition-Key"
      },
      "preflight-id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Preflight-Id"
      },
      "rules": {
         "anyOf": [
            {
               "$ref": "#/$defs/OrderRule"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "advanced-instructions": {
         "anyOf": [
            {
               "$ref": "#/$defs/AdvancedInstructions"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "external-identifier": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "External-Identifier"
      }
   },
   "$defs": {
      "AdvancedInstructions": {
         "description": "Dataclass containing advanced order rules.",
         "properties": {
            "strict-position-effect-validation": {
               "default": false,
               "title": "Strict-Position-Effect-Validation",
               "type": "boolean"
            }
         },
         "title": "AdvancedInstructions",
         "type": "object"
      },
      "FillInfo": {
         "description": "Dataclass that contains information about an order fill.",
         "properties": {
            "fill-id": {
               "title": "Fill-Id",
               "type": "string"
            },
            "quantity": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Quantity"
            },
            "fill-price": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Fill-Price"
            },
            "filled-at": {
               "format": "date-time",
               "title": "Filled-At",
               "type": "string"
            },
            "destination-venue": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Destination-Venue"
            },
            "ext-group-fill-id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Ext-Group-Fill-Id"
            },
            "ext-exec-id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Ext-Exec-Id"
            }
         },
         "required": [
            "fill-id",
            "quantity",
            "fill-price",
            "filled-at"
         ],
         "title": "FillInfo",
         "type": "object"
      },
      "InstrumentType": {
         "description": "This is an :class:`~enum.Enum` that contains the valid types of instruments\nand 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"
      },
      "Leg": {
         "description": "Dataclass that represents an order leg.\n\nClasses that inherit from :class:`TradeableTastytradeData` can\ncall :meth:`build_leg` to build a leg from the dataclass.",
         "properties": {
            "instrument-type": {
               "$ref": "#/$defs/InstrumentType"
            },
            "symbol": {
               "title": "Symbol",
               "type": "string"
            },
            "action": {
               "$ref": "#/$defs/OrderAction"
            },
            "quantity": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Quantity"
            },
            "remaining-quantity": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Remaining-Quantity"
            },
            "fills": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/FillInfo"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Fills"
            }
         },
         "required": [
            "instrument-type",
            "symbol",
            "action"
         ],
         "title": "Leg",
         "type": "object"
      },
      "OrderAction": {
         "description": "This is an :class:`~enum.Enum` that contains the valid order actions.",
         "enum": [
            "Buy to Open",
            "Buy to Close",
            "Sell to Open",
            "Sell to Close",
            "Buy",
            "Sell"
         ],
         "title": "OrderAction",
         "type": "string"
      },
      "OrderCondition": {
         "description": "Dataclass that represents an order condition for an order rule.",
         "properties": {
            "id": {
               "title": "Id",
               "type": "string"
            },
            "action": {
               "title": "Action",
               "type": "string"
            },
            "symbol": {
               "title": "Symbol",
               "type": "string"
            },
            "instrument-type": {
               "$ref": "#/$defs/InstrumentType"
            },
            "indicator": {
               "title": "Indicator",
               "type": "string"
            },
            "comparator": {
               "title": "Comparator",
               "type": "string"
            },
            "threshold": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Threshold"
            },
            "is-threshold-based-on-notional": {
               "title": "Is-Threshold-Based-On-Notional",
               "type": "boolean"
            },
            "triggered-at": {
               "format": "date-time",
               "title": "Triggered-At",
               "type": "string"
            },
            "triggered-value": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Triggered-Value"
            },
            "price-components": {
               "items": {
                  "$ref": "#/$defs/OrderConditionPriceComponent"
               },
               "title": "Price-Components",
               "type": "array"
            }
         },
         "required": [
            "id",
            "action",
            "symbol",
            "instrument-type",
            "indicator",
            "comparator",
            "threshold",
            "is-threshold-based-on-notional",
            "triggered-at",
            "triggered-value",
            "price-components"
         ],
         "title": "OrderCondition",
         "type": "object"
      },
      "OrderConditionPriceComponent": {
         "description": "Dataclass that represents a price component of an order condition.",
         "properties": {
            "symbol": {
               "title": "Symbol",
               "type": "string"
            },
            "instrument-type": {
               "$ref": "#/$defs/InstrumentType"
            },
            "quantity": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Quantity"
            },
            "quantity-direction": {
               "title": "Quantity-Direction",
               "type": "string"
            }
         },
         "required": [
            "symbol",
            "instrument-type",
            "quantity",
            "quantity-direction"
         ],
         "title": "OrderConditionPriceComponent",
         "type": "object"
      },
      "OrderRule": {
         "description": "Dataclass that represents an order rule for a complex order.",
         "properties": {
            "route-after": {
               "format": "date-time",
               "title": "Route-After",
               "type": "string"
            },
            "routed-at": {
               "format": "date-time",
               "title": "Routed-At",
               "type": "string"
            },
            "cancel-at": {
               "format": "date-time",
               "title": "Cancel-At",
               "type": "string"
            },
            "cancelled-at": {
               "format": "date-time",
               "title": "Cancelled-At",
               "type": "string"
            },
            "order-conditions": {
               "items": {
                  "$ref": "#/$defs/OrderCondition"
               },
               "title": "Order-Conditions",
               "type": "array"
            }
         },
         "required": [
            "route-after",
            "routed-at",
            "cancel-at",
            "cancelled-at",
            "order-conditions"
         ],
         "title": "OrderRule",
         "type": "object"
      },
      "OrderTimeInForce": {
         "description": "This is an :class:`~enum.Enum` that contains the valid TIFs for orders.",
         "enum": [
            "Day",
            "GTC",
            "GTD",
            "Ext",
            "GTC Ext",
            "IOC"
         ],
         "title": "OrderTimeInForce",
         "type": "string"
      },
      "OrderType": {
         "description": "This is an :class:`~enum.Enum` that contains the valid types of orders.",
         "enum": [
            "Limit",
            "Market",
            "Marketable Limit",
            "Stop",
            "Stop Limit",
            "Notional Market"
         ],
         "title": "OrderType",
         "type": "string"
      }
   },
   "required": [
      "time-in-force",
      "order-type",
      "legs"
   ]
}

Fields:¶

• advanced_instructions (tastytrade.order.AdvancedInstructions | None)

• external_identifier (str | None)

• gtc_date (datetime.date | None)

• legs (list[tastytrade.order.Leg])

• order_type (tastytrade.order.OrderType)

• partition_key (str | None)

• preflight_id (str | None)

• price (decimal.Decimal | None)

• rules (tastytrade.order.OrderRule | None)

• source (str)

• stop_trigger (decimal.Decimal | None)

• time_in_force (tastytrade.order.OrderTimeInForce)

• value (decimal.Decimal | None)

field external_identifier : str | None = None (alias 'external-identifier')¶

External identifier for the order, used to track orders across systems

field price : Decimal | None = None¶

The price of the order; negative = debit, positive = credit

field stop_trigger : Decimal | None = None (alias 'stop-trigger')¶

For a stop/stop limit order. If the latter, use price for the limit price

field value : Decimal | None = None¶

The actual notional value of the order. Only for notional market orders!