tradestation
Account
- pydantic model tradestation.account.Account(*, AccountDetail: AccountDetail | None = None, AccountID: str, AccountType: str, Alias: str | None = None, AltID: str | None = None, Currency: str, Status: str)
Bases:
TradestationModelShow JSON schema
{ "title": "Account", "type": "object", "properties": { "AccountDetail": { "anyOf": [ { "$ref": "#/$defs/AccountDetail" }, { "type": "null" } ], "default": null }, "AccountID": { "title": "Accountid", "type": "string" }, "AccountType": { "title": "Accounttype", "type": "string" }, "Alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Alias" }, "AltID": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Altid" }, "Currency": { "title": "Currency", "type": "string" }, "Status": { "title": "Status", "type": "string" } }, "$defs": { "AccountDetail": { "properties": { "DayTradingQualified": { "title": "Daytradingqualified", "type": "boolean" }, "EnrolledInRegTProgram": { "title": "Enrolledinregtprogram", "type": "boolean" }, "IsStockLocateEligible": { "title": "Isstocklocateeligible", "type": "boolean" }, "OptionApprovalLevel": { "title": "Optionapprovallevel", "type": "integer" }, "PatternDayTrader": { "title": "Patterndaytrader", "type": "boolean" }, "RequiresBuyingPowerWarning": { "title": "Requiresbuyingpowerwarning", "type": "boolean" } }, "required": [ "DayTradingQualified", "EnrolledInRegTProgram", "IsStockLocateEligible", "OptionApprovalLevel", "PatternDayTrader", "RequiresBuyingPowerWarning" ], "title": "AccountDetail", "type": "object" } }, "required": [ "AccountID", "AccountType", "Currency", "Status" ] }
- Fields:
account_detail (tradestation.account.AccountDetail | None)account_id (str)account_type (str)alias (str | None)alt_id (str | None)currency (str)status (str)
- pydantic model tradestation.account.AccountBalance(*, AccountID: str, AccountType: str, CashBalance: Decimal, BuyingPower: Decimal, Equity: Decimal, MarketValue: Decimal, TodaysProfitLoss: Decimal, UnclearedDeposit: Decimal, BalanceDetail: AccountBalanceDetail, CurrencyDetails: list[AccountCurrencyDetail] | None = None, Commission: Decimal)
Bases:
TradestationModelShow JSON schema
{ "title": "AccountBalance", "type": "object", "properties": { "AccountID": { "title": "Accountid", "type": "string" }, "AccountType": { "title": "Accounttype", "type": "string" }, "CashBalance": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Cashbalance" }, "BuyingPower": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Buyingpower" }, "Equity": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Equity" }, "MarketValue": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Marketvalue" }, "TodaysProfitLoss": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Todaysprofitloss" }, "UnclearedDeposit": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Uncleareddeposit" }, "BalanceDetail": { "$ref": "#/$defs/AccountBalanceDetail" }, "CurrencyDetails": { "anyOf": [ { "items": { "$ref": "#/$defs/AccountCurrencyDetail" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Currencydetails" }, "Commission": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Commission" } }, "$defs": { "AccountBalanceDetail": { "properties": { "CostOfPositions": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Costofpositions" }, "DayTradeExcess": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Daytradeexcess" }, "DayTradeMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Daytrademargin" }, "DayTradeOpenOrderMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Daytradeopenordermargin" }, "DayTrades": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Daytrades" }, "InitialMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Initialmargin" }, "MaintenanceMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Maintenancemargin" }, "MaintenanceRate": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Maintenancerate" }, "MarginRequirement": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Marginrequirement" }, "OpenOrderMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Openordermargin" }, "OptionBuyingPower": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Optionbuyingpower" }, "OptionsMarketValue": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Optionsmarketvalue" }, "OvernightBuyingPower": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Overnightbuyingpower" }, "RequiredMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requiredmargin" }, "RealizedProfitLoss": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Realizedprofitloss" }, "SecurityOnDeposit": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Securityondeposit" }, "TodayRealTimeTradeEquity": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Todayrealtimetradeequity" }, "TradeEquity": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tradeequity" }, "UnrealizedProfitLoss": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Unrealizedprofitloss" }, "UnsettledFunds": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Unsettledfunds" } }, "required": [ "RealizedProfitLoss", "UnrealizedProfitLoss" ], "title": "AccountBalanceDetail", "type": "object" }, "AccountCurrencyDetail": { "properties": { "Currency": { "title": "Currency", "type": "string" }, "Commission": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Commission" }, "CashBalance": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Cashbalance" }, "RealizedProfitLoss": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Realizedprofitloss" }, "UnrealizedProfitLoss": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Unrealizedprofitloss" }, "InitialMargin": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Initialmargin" }, "MaintenanceMargin": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Maintenancemargin" }, "AccountConversionRate": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Accountconversionrate" }, "AccountMarginRequirement": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Accountmarginrequirement" } }, "required": [ "Currency", "Commission", "CashBalance", "RealizedProfitLoss", "UnrealizedProfitLoss", "InitialMargin", "MaintenanceMargin", "AccountConversionRate" ], "title": "AccountCurrencyDetail", "type": "object" } }, "required": [ "AccountID", "AccountType", "CashBalance", "BuyingPower", "Equity", "MarketValue", "TodaysProfitLoss", "UnclearedDeposit", "BalanceDetail", "Commission" ] }
- Fields:
account_id (str)account_type (str)balance_detail (tradestation.account.AccountBalanceDetail)buying_power (decimal.Decimal)cash_balance (decimal.Decimal)commission (decimal.Decimal)currency_details (list[tradestation.account.AccountCurrencyDetail] | None)equity (decimal.Decimal)market_value (decimal.Decimal)todays_profit_loss (decimal.Decimal)uncleared_deposit (decimal.Decimal)
- pydantic model tradestation.account.AccountBalanceDetail(*, CostOfPositions: Decimal | None = None, DayTradeExcess: Decimal | None = None, DayTradeMargin: Decimal | None = None, DayTradeOpenOrderMargin: Decimal | None = None, DayTrades: int | None = None, InitialMargin: Decimal | None = None, MaintenanceMargin: Decimal | None = None, MaintenanceRate: Decimal | None = None, MarginRequirement: Decimal | None = None, OpenOrderMargin: Decimal | None = None, OptionBuyingPower: Decimal | None = None, OptionsMarketValue: Decimal | None = None, OvernightBuyingPower: Decimal | None = None, RequiredMargin: Decimal | None = None, RealizedProfitLoss: Decimal, SecurityOnDeposit: Decimal | None = None, TodayRealTimeTradeEquity: Decimal | None = None, TradeEquity: Decimal | None = None, UnrealizedProfitLoss: Decimal, UnsettledFunds: Decimal | None = None)
Bases:
TradestationModelShow JSON schema
{ "title": "AccountBalanceDetail", "type": "object", "properties": { "CostOfPositions": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Costofpositions" }, "DayTradeExcess": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Daytradeexcess" }, "DayTradeMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Daytrademargin" }, "DayTradeOpenOrderMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Daytradeopenordermargin" }, "DayTrades": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Daytrades" }, "InitialMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Initialmargin" }, "MaintenanceMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Maintenancemargin" }, "MaintenanceRate": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Maintenancerate" }, "MarginRequirement": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Marginrequirement" }, "OpenOrderMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Openordermargin" }, "OptionBuyingPower": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Optionbuyingpower" }, "OptionsMarketValue": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Optionsmarketvalue" }, "OvernightBuyingPower": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Overnightbuyingpower" }, "RequiredMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requiredmargin" }, "RealizedProfitLoss": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Realizedprofitloss" }, "SecurityOnDeposit": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Securityondeposit" }, "TodayRealTimeTradeEquity": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Todayrealtimetradeequity" }, "TradeEquity": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tradeequity" }, "UnrealizedProfitLoss": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Unrealizedprofitloss" }, "UnsettledFunds": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Unsettledfunds" } }, "required": [ "RealizedProfitLoss", "UnrealizedProfitLoss" ] }
- Fields:
cost_of_positions (decimal.Decimal | None)day_trade_excess (decimal.Decimal | None)day_trade_margin (decimal.Decimal | None)day_trade_open_order_margin (decimal.Decimal | None)day_trades (int | None)initial_margin (decimal.Decimal | None)maintenance_margin (decimal.Decimal | None)maintenance_rate (decimal.Decimal | None)margin_requirement (decimal.Decimal | None)open_order_margin (decimal.Decimal | None)option_buying_power (decimal.Decimal | None)options_market_value (decimal.Decimal | None)overnight_buying_power (decimal.Decimal | None)realized_profit_loss (decimal.Decimal)required_margin (decimal.Decimal | None)security_on_deposit (decimal.Decimal | None)today_real_time_trade_equity (decimal.Decimal | None)trade_equity (decimal.Decimal | None)unrealized_profit_loss (decimal.Decimal)unsettled_funds (decimal.Decimal | None)
- pydantic model tradestation.account.AccountBalances(*, Balances: list[AccountBalance], Errors: list[AccountError])
Bases:
TradestationModelShow JSON schema
{ "title": "AccountBalances", "type": "object", "properties": { "Balances": { "items": { "$ref": "#/$defs/AccountBalance" }, "title": "Balances", "type": "array" }, "Errors": { "items": { "$ref": "#/$defs/AccountError" }, "title": "Errors", "type": "array" } }, "$defs": { "AccountBalance": { "properties": { "AccountID": { "title": "Accountid", "type": "string" }, "AccountType": { "title": "Accounttype", "type": "string" }, "CashBalance": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Cashbalance" }, "BuyingPower": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Buyingpower" }, "Equity": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Equity" }, "MarketValue": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Marketvalue" }, "TodaysProfitLoss": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Todaysprofitloss" }, "UnclearedDeposit": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Uncleareddeposit" }, "BalanceDetail": { "$ref": "#/$defs/AccountBalanceDetail" }, "CurrencyDetails": { "anyOf": [ { "items": { "$ref": "#/$defs/AccountCurrencyDetail" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Currencydetails" }, "Commission": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Commission" } }, "required": [ "AccountID", "AccountType", "CashBalance", "BuyingPower", "Equity", "MarketValue", "TodaysProfitLoss", "UnclearedDeposit", "BalanceDetail", "Commission" ], "title": "AccountBalance", "type": "object" }, "AccountBalanceDetail": { "properties": { "CostOfPositions": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Costofpositions" }, "DayTradeExcess": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Daytradeexcess" }, "DayTradeMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Daytrademargin" }, "DayTradeOpenOrderMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Daytradeopenordermargin" }, "DayTrades": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Daytrades" }, "InitialMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Initialmargin" }, "MaintenanceMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Maintenancemargin" }, "MaintenanceRate": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Maintenancerate" }, "MarginRequirement": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Marginrequirement" }, "OpenOrderMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Openordermargin" }, "OptionBuyingPower": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Optionbuyingpower" }, "OptionsMarketValue": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Optionsmarketvalue" }, "OvernightBuyingPower": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Overnightbuyingpower" }, "RequiredMargin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requiredmargin" }, "RealizedProfitLoss": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Realizedprofitloss" }, "SecurityOnDeposit": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Securityondeposit" }, "TodayRealTimeTradeEquity": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Todayrealtimetradeequity" }, "TradeEquity": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tradeequity" }, "UnrealizedProfitLoss": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Unrealizedprofitloss" }, "UnsettledFunds": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Unsettledfunds" } }, "required": [ "RealizedProfitLoss", "UnrealizedProfitLoss" ], "title": "AccountBalanceDetail", "type": "object" }, "AccountCurrencyDetail": { "properties": { "Currency": { "title": "Currency", "type": "string" }, "Commission": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Commission" }, "CashBalance": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Cashbalance" }, "RealizedProfitLoss": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Realizedprofitloss" }, "UnrealizedProfitLoss": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Unrealizedprofitloss" }, "InitialMargin": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Initialmargin" }, "MaintenanceMargin": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Maintenancemargin" }, "AccountConversionRate": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Accountconversionrate" }, "AccountMarginRequirement": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Accountmarginrequirement" } }, "required": [ "Currency", "Commission", "CashBalance", "RealizedProfitLoss", "UnrealizedProfitLoss", "InitialMargin", "MaintenanceMargin", "AccountConversionRate" ], "title": "AccountCurrencyDetail", "type": "object" }, "AccountError": { "properties": { "AccountID": { "title": "Accountid", "type": "string" }, "Error": { "title": "Error", "type": "string" }, "Message": { "title": "Message", "type": "string" } }, "required": [ "AccountID", "Error", "Message" ], "title": "AccountError", "type": "object" } }, "required": [ "Balances", "Errors" ] }
- Fields:
balances (list[tradestation.account.AccountBalance])errors (list[tradestation.account.AccountError])
- pydantic model tradestation.account.AccountCurrencyDetail(*, Currency: str, Commission: Decimal, CashBalance: Decimal, RealizedProfitLoss: Decimal, UnrealizedProfitLoss: Decimal, InitialMargin: Decimal, MaintenanceMargin: Decimal, AccountConversionRate: Decimal, AccountMarginRequirement: Decimal | None = None)
Bases:
TradestationModelShow JSON schema
{ "title": "AccountCurrencyDetail", "type": "object", "properties": { "Currency": { "title": "Currency", "type": "string" }, "Commission": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Commission" }, "CashBalance": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Cashbalance" }, "RealizedProfitLoss": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Realizedprofitloss" }, "UnrealizedProfitLoss": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Unrealizedprofitloss" }, "InitialMargin": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Initialmargin" }, "MaintenanceMargin": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Maintenancemargin" }, "AccountConversionRate": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Accountconversionrate" }, "AccountMarginRequirement": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Accountmarginrequirement" } }, "required": [ "Currency", "Commission", "CashBalance", "RealizedProfitLoss", "UnrealizedProfitLoss", "InitialMargin", "MaintenanceMargin", "AccountConversionRate" ] }
- Fields:
account_conversion_rate (decimal.Decimal)account_margin_requirement (decimal.Decimal | None)cash_balance (decimal.Decimal)commission (decimal.Decimal)currency (str)initial_margin (decimal.Decimal)maintenance_margin (decimal.Decimal)realized_profit_loss (decimal.Decimal)unrealized_profit_loss (decimal.Decimal)
- pydantic model tradestation.account.AccountDetail(*, DayTradingQualified: bool, EnrolledInRegTProgram: bool, IsStockLocateEligible: bool, OptionApprovalLevel: int, PatternDayTrader: bool, RequiresBuyingPowerWarning: bool)
Bases:
TradestationModelShow JSON schema
{ "title": "AccountDetail", "type": "object", "properties": { "DayTradingQualified": { "title": "Daytradingqualified", "type": "boolean" }, "EnrolledInRegTProgram": { "title": "Enrolledinregtprogram", "type": "boolean" }, "IsStockLocateEligible": { "title": "Isstocklocateeligible", "type": "boolean" }, "OptionApprovalLevel": { "title": "Optionapprovallevel", "type": "integer" }, "PatternDayTrader": { "title": "Patterndaytrader", "type": "boolean" }, "RequiresBuyingPowerWarning": { "title": "Requiresbuyingpowerwarning", "type": "boolean" } }, "required": [ "DayTradingQualified", "EnrolledInRegTProgram", "IsStockLocateEligible", "OptionApprovalLevel", "PatternDayTrader", "RequiresBuyingPowerWarning" ] }
- Fields:
day_trading_qualified (bool)enrolled_in_reg_t_program (bool)is_stock_locate_eligible (bool)option_approval_level (int)pattern_day_trader (bool)requires_buying_power_warning (bool)
- pydantic model tradestation.account.AccountError(*, AccountID: str, Error: str, Message: str)
Bases:
TradestationModelShow JSON schema
{ "title": "AccountError", "type": "object", "properties": { "AccountID": { "title": "Accountid", "type": "string" }, "Error": { "title": "Error", "type": "string" }, "Message": { "title": "Message", "type": "string" } }, "required": [ "AccountID", "Error", "Message" ] }
- Fields:
account_id (str)error (str)message (str)
Session
- class tradestation.session.AutoRefreshSession(api_key: str, secret_key: str, refresh_token: str, access_token: str | None = None, id_token: str | None = None, token_lifetime: int = 1200, is_test: bool = False, use_v2: bool = False)
Bases:
SessionA special session that automatically refreshes the access token before expiration. It should always be initialized as an async context manager, or by awaiting it, since the object cannot be fully instantiated without async.
Example usage:
from tradestation import AutoRefreshSession async with AutoRefreshSession(api_key, secret_key, refresh_token) as session: # ...
Or:
session = await AutoRefreshSession(api_key, secret_key, refresh_token) # ... await session.close()
- class tradestation.session.Session(api_key: str, secret_key: str, refresh_token: str, access_token: str | None = None, id_token: str | None = None, token_lifetime: int = 1200, is_test: bool = False, use_v2: bool = False)
Bases:
objectContains a local user login which can then be used to interact with the remote API.
- Parameters:
api_key – Tradestation API key (client ID)
secret_key – Tradestation secret key (client secret)
refresh_token – Tradestation refresh token used to obtain new access tokens; can be acquired initially by calling
tradestation.oauth.login()access_token – previously generated access token; if absent, refresh token will be used to generate a new one automatically
id_token – previously generated ID token; if absent, you won’t be able to access the user_info property until refreshing
is_test – whether to use the simulated API endpoints, default False
use_v2 – whether to use the older v2 endpoints instead of the v3 ones
- access_token
Access token for authenticating requests. By default, is valid for 20 minutes, and then needs to be replaced.
- api_key
Tradestation client ID
- async_client
httpx client for async requests
- classmethod deserialize(serialized: str) Self
Create a new Session object from a serialized string.
- id_token
ID token containing personal info like name, email
- is_test
Whether this is a simulated or real session
- refresh_token
Refresh token for generating new access tokens
- secret_key
Tradestation client secret
- serialize() str
Serializes the session to a string, useful for storing a session for later use. Could be used with pickle, Redis, etc.
- sync_client
httpx client for sync requests
- token_lifetime
Lifetime, in seconds, of access tokens before they expire Defaults to 20 minutes
Utils
- exception tradestation.utils.TradestationError
An internal error raised by the Tradestation SDK.
- with_traceback()
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- pydantic model tradestation.utils.TradestationModel
A pydantic dataclass that converts keys from snake case to Pascal case and performs type validation and coercion.
Show JSON schema
{ "title": "TradestationModel", "description": "A pydantic dataclass that converts keys from snake case to Pascal case\nand performs type validation and coercion.", "type": "object", "properties": {} }
- copy(*, include: AbstractSetIntStr | MappingIntStrAny | None = None, exclude: AbstractSetIntStr | MappingIntStrAny | None = None, update: Dict[str, Any] | None = None, deep: bool = False) Self
Returns a copy of the model.
- !!! warning “Deprecated”
This method is now deprecated; use model_copy instead.
If you need include or exclude, use:
`python {test="skip" lint="skip"} data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `- Args:
include: Optional set or mapping specifying which fields to include in the copied model. exclude: Optional set or mapping specifying which fields to exclude in the copied model. update: Optional dictionary of field-value pairs to override field values in the copied model. deep: If True, the values of fields that are Pydantic models will be deep-copied.
- Returns:
A copy of the model with included, excluded and updated fields as specified.
- classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self
Creates a new instance of the Model class with validated data.
Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.
- !!! note
model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.
- Args:
- _fields_set: A set of field names that were originally explicitly set during instantiation. If provided,
this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values: Trusted or pre-validated data dictionary.
- Returns:
A new instance of the Model class with validated data.
- model_copy(*, update: Mapping[str, Any] | None = None, deep: bool = False) Self
Usage docs: https://docs.pydantic.dev/2.10/concepts/serialization/#model_copy
Returns a copy of the model.
- Args:
- update: Values to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.
deep: Set to True to make a deep copy of the model.
- Returns:
New model instance.
- model_dump(*, mode: Literal['json', 'python'] | str = 'python', include: Set[int] | Set[str] | Mapping[int, Set[int] | Set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, Set[int] | Set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, exclude: Set[int] | Set[str] | Mapping[int, Set[int] | Set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, Set[int] | Set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, context: Any | None = None, by_alias: bool = False, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, round_trip: bool = False, warnings: bool | Literal['none', 'warn', 'error'] = True, serialize_as_any: bool = False) dict[str, Any]
Usage docs: https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- Args:
- mode: The mode in which to_python should run.
If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.
include: A set of fields to include in the output. exclude: A set of fields to exclude from the output. context: Additional context to pass to the serializer. by_alias: Whether to use the field’s alias in the dictionary key if defined. exclude_unset: Whether to exclude fields that have not been explicitly set. exclude_defaults: Whether to exclude fields that are set to their default value. exclude_none: Whether to exclude fields that have a value of None. round_trip: If True, dumped values should be valid as input for non-idempotent types such as Json[T]. warnings: How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any: Whether to serialize fields with duck-typing serialization behavior.
- Returns:
A dictionary representation of the model.
- model_dump_json(*, indent: int | None = None, include: Set[int] | Set[str] | Mapping[int, Set[int] | Set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, Set[int] | Set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, exclude: Set[int] | Set[str] | Mapping[int, Set[int] | Set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, Set[int] | Set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, context: Any | None = None, by_alias: bool = False, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, round_trip: bool = False, warnings: bool | Literal['none', 'warn', 'error'] = True, serialize_as_any: bool = False) str
Usage docs: https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump_json
Generates a JSON representation of the model using Pydantic’s to_json method.
- Args:
indent: Indentation to use in the JSON output. If None is passed, the output will be compact. include: Field(s) to include in the JSON output. exclude: Field(s) to exclude from the JSON output. context: Additional context to pass to the serializer. by_alias: Whether to serialize using field aliases. exclude_unset: Whether to exclude fields that have not been explicitly set. exclude_defaults: Whether to exclude fields that are set to their default value. exclude_none: Whether to exclude fields that have a value of None. round_trip: If True, dumped values should be valid as input for non-idempotent types such as Json[T]. warnings: How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any: Whether to serialize fields with duck-typing serialization behavior.
- Returns:
A JSON string representation of the model.
- classmethod model_json_schema(by_alias: bool = True, ref_template: str = '#/$defs/{model}', schema_generator: type[~pydantic.json_schema.GenerateJsonSchema] = <class 'pydantic.json_schema.GenerateJsonSchema'>, mode: ~typing.Literal['validation', 'serialization'] = 'validation') dict[str, Any]
Generates a JSON schema for a model class.
- Args:
by_alias: Whether to use attribute aliases or not. ref_template: The reference template. schema_generator: To override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications
mode: The mode in which to generate the schema.
- Returns:
The JSON schema for the given model class.
- classmethod model_parametrized_name(params: tuple[type[Any], ...]) str
Compute the class name for parametrizations of generic classes.
This method can be overridden to achieve a custom naming scheme for generic BaseModels.
- Args:
- params: Tuple of types of the class. Given a generic class
Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
- Returns:
String representing the new class where params are passed to cls as type variables.
- Raises:
TypeError: Raised when trying to generate concrete names for non-generic models.
- model_post_init(_BaseModel__context: Any) None
Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.
- classmethod model_rebuild(*, force: bool = False, raise_errors: bool = True, _parent_namespace_depth: int = 2, _types_namespace: MappingNamespace | None = None) bool | None
Try to rebuild the pydantic-core schema for the model.
This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.
- Args:
force: Whether to force the rebuilding of the model schema, defaults to False. raise_errors: Whether to raise errors, defaults to True. _parent_namespace_depth: The depth level of the parent namespace, defaults to 2. _types_namespace: The types namespace, defaults to None.
- Returns:
Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.
- classmethod model_validate(obj: Any, *, strict: bool | None = None, from_attributes: bool | None = None, context: Any | None = None) Self
Validate a pydantic model instance.
- Args:
obj: The object to validate. strict: Whether to enforce types strictly. from_attributes: Whether to extract data from object attributes. context: Additional context to pass to the validator.
- Raises:
ValidationError: If the object could not be validated.
- Returns:
The validated model instance.
- classmethod model_validate_json(json_data: str | bytes | bytearray, *, strict: bool | None = None, context: Any | None = None) Self
Usage docs: https://docs.pydantic.dev/2.10/concepts/json/#json-parsing
Validate the given JSON data against the Pydantic model.
- Args:
json_data: The JSON data to validate. strict: Whether to enforce types strictly. context: Extra variables to pass to the validator.
- Returns:
The validated Pydantic model.
- Raises:
ValidationError: If json_data is not a JSON string or the object could not be validated.
- classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None) Self
Validate the given object with string data against the Pydantic model.
- Args:
obj: The object containing string data to validate. strict: Whether to enforce types strictly. context: Extra variables to pass to the validator.
- Returns:
The validated Pydantic model.