tastytrade.account¶

pydantic model tastytrade.account.Account(*, account_number: str, opened_at: datetime, nickname: str, account_type_name: str, is_closed: bool, day_trader_status: str | bool, is_firm_error: bool, is_firm_proprietary: bool, is_futures_approved: bool, is_test_drive: bool = False, margin_or_cash: str, is_foreign: bool, created_at: datetime, external_id: str | None = None, closed_at: str | None = None, funding_date: date | None = None, investment_objective: str | None = None, liquidity_needs: str | None = None, risk_tolerance: str | None = None, investment_time_horizon: str | None = None, futures_account_purpose: str | None = None, external_fdid: str | None = None, suitable_options_level: str | None = None, submitting_user_id: str | None = None)¶

Bases: TastytradeData

Dataclass that represents a Tastytrade account object, containing methods for retrieving information about the account, placing orders, and retrieving past transactions.

Show JSON schema

{
   "title": "Account",
   "description": "Dataclass that represents a Tastytrade account object, containing\nmethods for retrieving information about the account, placing orders,\nand retrieving past transactions.",
   "type": "object",
   "properties": {
      "account-number": {
         "title": "Account-Number",
         "type": "string"
      },
      "opened-at": {
         "format": "date-time",
         "title": "Opened-At",
         "type": "string"
      },
      "nickname": {
         "title": "Nickname",
         "type": "string"
      },
      "account-type-name": {
         "title": "Account-Type-Name",
         "type": "string"
      },
      "is-closed": {
         "title": "Is-Closed",
         "type": "boolean"
      },
      "day-trader-status": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "boolean"
            }
         ],
         "title": "Day-Trader-Status"
      },
      "is-firm-error": {
         "title": "Is-Firm-Error",
         "type": "boolean"
      },
      "is-firm-proprietary": {
         "title": "Is-Firm-Proprietary",
         "type": "boolean"
      },
      "is-futures-approved": {
         "title": "Is-Futures-Approved",
         "type": "boolean"
      },
      "is-test-drive": {
         "default": false,
         "title": "Is-Test-Drive",
         "type": "boolean"
      },
      "margin-or-cash": {
         "title": "Margin-Or-Cash",
         "type": "string"
      },
      "is-foreign": {
         "title": "Is-Foreign",
         "type": "boolean"
      },
      "created-at": {
         "format": "date-time",
         "title": "Created-At",
         "type": "string"
      },
      "external-id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "External-Id"
      },
      "closed-at": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Closed-At"
      },
      "funding-date": {
         "anyOf": [
            {
               "format": "date",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Funding-Date"
      },
      "investment-objective": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Investment-Objective"
      },
      "liquidity-needs": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Liquidity-Needs"
      },
      "risk-tolerance": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Risk-Tolerance"
      },
      "investment-time-horizon": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Investment-Time-Horizon"
      },
      "futures-account-purpose": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Futures-Account-Purpose"
      },
      "external-fdid": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "External-Fdid"
      },
      "suitable-options-level": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Suitable-Options-Level"
      },
      "submitting-user-id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Submitting-User-Id"
      }
   },
   "required": [
      "account-number",
      "opened-at",
      "nickname",
      "account-type-name",
      "is-closed",
      "day-trader-status",
      "is-firm-error",
      "is-firm-proprietary",
      "is-futures-approved",
      "margin-or-cash",
      "is-foreign",
      "created-at"
   ]
}

Fields:¶

• account_number (str)

• account_type_name (str)

• closed_at (str | None)

• created_at (datetime.datetime)

• day_trader_status (str | bool)

• external_fdid (str | None)

• external_id (str | None)

• funding_date (datetime.date | None)

• futures_account_purpose (str | None)

• investment_objective (str | None)

• investment_time_horizon (str | None)

• is_closed (bool)

• is_firm_error (bool)

• is_firm_proprietary (bool)

• is_foreign (bool)

• is_futures_approved (bool)

• is_test_drive (bool)

• liquidity_needs (str | None)

• margin_or_cash (str)

• nickname (str)

• opened_at (datetime.datetime)

• risk_tolerance (str | None)

• submitting_user_id (str | None)

• suitable_options_level (str | None)

field account_number : str [Required] (alias 'account-number')¶

field account_type_name : str [Required] (alias 'account-type-name')¶

field closed_at : str | None = None (alias 'closed-at')¶

field created_at : datetime [Required] (alias 'created-at')¶

field day_trader_status : str | bool [Required] (alias 'day-trader-status')¶

field external_fdid : str | None = None (alias 'external-fdid')¶

field external_id : str | None = None (alias 'external-id')¶

field funding_date : date | None = None (alias 'funding-date')¶

field futures_account_purpose : str | None = None (alias 'futures-account-purpose')¶

field investment_objective : str | None = None (alias 'investment-objective')¶

field investment_time_horizon : str | None = None (alias 'investment-time-horizon')¶

field is_closed : bool [Required] (alias 'is-closed')¶

field is_firm_error : bool [Required] (alias 'is-firm-error')¶

field is_firm_proprietary : bool [Required] (alias 'is-firm-proprietary')¶

field is_foreign : bool [Required] (alias 'is-foreign')¶

field is_futures_approved : bool [Required] (alias 'is-futures-approved')¶

field is_test_drive : bool = False (alias 'is-test-drive')¶

field liquidity_needs : str | None = None (alias 'liquidity-needs')¶

field margin_or_cash : str [Required] (alias 'margin-or-cash')¶

field nickname : str [Required]¶

field opened_at : datetime [Required] (alias 'opened-at')¶

field risk_tolerance : str | None = None (alias 'risk-tolerance')¶

field submitting_user_id : str | None = None (alias 'submitting-user-id')¶

field suitable_options_level : str | None = None (alias 'suitable-options-level')¶

async classmethod get(session: Session, *, include_closed: bool = False) → list[Self]¶

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

Gets all trading accounts associated with the Tastytrade user, or a specific one if given an account ID.

Parameters:¶

session: Session¶

the session to use for the request.

account_number: str

the account ID to get.

include_closed: bool = False¶

whether to include closed accounts in the results

async delete_complex_order(session: Session, order_id: int) → None¶

Delete a complex order by ID.

Parameters:¶

session: Session¶

the session to use for the request.

order_id: int¶

the ID of the order to delete.

async delete_order(session: Session, order_id: int) → None¶

Delete an order by ID.

Parameters:¶

session: Session¶

the session to use for the request.

order_id: int¶

the ID of the order to delete.

async get_balance_snapshots(session: Session, per_page: int = 250, page_offset: int | None = 0, currency: str = 'USD', end_date: date | None = None, start_date: date | None = None, snapshot_date: date | None = None, time_of_day: 'BOD' | 'EOD' = 'EOD') → list[AccountBalanceSnapshot]¶

Returns a list of balance snapshots. This list will just have a few snapshots if you don’t pass a start date; otherwise, it will be each day’s balances in the given range.

Parameters:¶

session: Session¶

the session to use for the request.

per_page: int = 250¶

the number of results to return per page.

page_offset: int | None = 0¶

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

currency: str = 'USD'¶

the currency to show balances in.

start_date: date | None = None¶

the starting date of the range.

end_date: date | None = None¶

the ending date of the range.

snapshot_date: date | None = None¶

the date of the snapshot to get.

time_of_day: 'BOD' | 'EOD' = 'EOD'¶

the time of day of the snapshots to get, either ‘EOD’ (End Of Day) or ‘BOD’ (Beginning Of Day).

async get_balances(session: Session, currency: str = 'USD') → AccountBalance¶

Get the current balances of the account.

Parameters:¶

session: Session¶

the session to use for the request

currency: str = 'USD'¶

the currency to state balances in

async get_complex_order(session: Session, order_id: int) → PlacedComplexOrder¶

Gets a complex order with the given ID.

Parameters:¶

session: Session¶

the session to use for the request.

order_id: int¶

the ID of the order to fetch.

async get_complex_order_history(session: Session, per_page: int = 50, page_offset: int | None = 0) → list[PlacedComplexOrder]¶

Get order history of the account.

Parameters:¶

session: Session¶

the session to use for the request.

per_page: int = 50¶

the number of results to return per page.

page_offset: int | None = 0¶

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

async get_history(session: Session, per_page: int = 250, page_offset: int | None = 0, sort: 'Asc' | 'Desc' = 'Desc', type: str | None = None, types: Iterable[str] | None = None, sub_types: Iterable[str] | None = None, start_date: date | None = None, end_date: date | None = None, instrument_type: InstrumentType | None = None, symbol: str | None = None, underlying_symbol: str | None = None, action: str | None = None, partition_key: str | None = None, futures_symbol: str | None = None, start_at: datetime | None = None, end_at: datetime | None = None) → list[Transaction]¶

Get transaction history of the account.

Parameters:¶

session: Session¶

the session to use for the request.

per_page: int = 250¶

the number of results to return per page.

page_offset: int | None = 0¶

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

sort: 'Asc' | 'Desc' = 'Desc'¶

the order to sort results in, either ‘Desc’ or ‘Asc’.

type: str | None = None¶

the type of transaction.

types: Iterable[str] | None = None¶

a list of transaction types to filter by.

sub_types: Iterable[str] | None = None¶

an array of transaction subtypes to filter by.

start_date: date | None = None¶

the start date of transactions to query.

end_date: date | None = None¶

the end date of transactions to query.

instrument_type: InstrumentType | None = None¶

the type of instrument.

symbol: str | None = None¶

a single symbol.

underlying_symbol: str | None = None¶

the underlying symbol.

action: str | None = None¶

the action of the transaction: ‘Sell to Open’, ‘Sell to Close’, ‘Buy to Open’, ‘Buy to Close’, ‘Sell’ or ‘Buy’.

partition_key: str | None = None¶

account partition key.

futures_symbol: str | None = None¶

the full TW Future Symbol, e.g. /ESZ9, /NGZ19.

start_at: datetime | None = None¶

datetime start range for filtering transactions in full date-time.

end_at: datetime | None = None¶

datetime end range for filtering transactions in full date-time.

async get_live_complex_orders(session: Session) → list[PlacedComplexOrder]¶

Get complex orders placed today for the account.

Parameters:¶

session: Session¶

the session to use for the request.

async get_live_orders(session: Session) → list[PlacedOrder]¶

Get orders placed today for the account.

Parameters:¶

session: Session¶

the session to use for the request.

async get_margin_requirements(session: Session) → MarginReport¶

Get the margin report for the account, with total margin requirements as well as a breakdown per symbol/instrument.

Parameters:¶

session: Session¶

the session to use for the request.

async get_net_liquidating_value_history(session: Session, time_back: str | None = None, start_time: datetime | None = None) → list[NetLiqOhlc]¶

Returns a list of account net liquidating value snapshots over the specified time period.

Parameters:¶

session: Session¶

the session to use for the request, can’t be certification.

time_back: str | None = None¶

the time period to get net liquidating value snapshots for. This param is required if start_time is not given. Possible values are: ‘1d’, ‘1m’, ‘3m’, ‘6m’, ‘1y’, ‘all’.

start_time: datetime | None = None¶

the start point for the query. This param is required is time-back is not given. If given, will take precedence over time-back.

async get_order(session: Session, order_id: int) → PlacedOrder¶

Gets an order with the given ID.

Parameters:¶

session: Session¶

the session to use for the request.

order_id: int¶

the ID of the order to fetch.

async get_order_buying_power_effect(session: Session, order: NewOrder) → BuyingPowerEffect¶

Calculate the buying power effect for the given order.

Parameters:¶

session: Session¶

the session to use for the request.

order: NewOrder¶

the order to calculate usage for.

async get_order_history(session: Session, per_page: int = 50, page_offset: int | None = 0, start_date: date | None = None, end_date: date | None = None, underlying_symbol: str | None = None, statuses: Iterable[OrderStatus] | None = None, futures_symbol: str | None = None, underlying_instrument_type: InstrumentType | None = None, sort: 'Asc' | 'Desc' | None = None, start_at: datetime | None = None, end_at: datetime | None = None) → list[PlacedOrder]¶

Get order history of the account.

Parameters:¶

session: Session¶

the session to use for the request.

per_page: int = 50¶

the number of results to return per page.

page_offset: int | None = 0¶

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

start_date: date | None = None¶

the start date of orders to query.

end_date: date | None = None¶

the end date of orders to query.

underlying_symbol: str | None = None¶

underlying symbol to filter by.

statuses: Iterable[OrderStatus] | None = None¶

a list of statuses to filter by.

futures_symbol: str | None = None¶

Tastytrade future symbol for futures and future options.

underlying_instrument_type: InstrumentType | None = None¶

the type of instrument to filter by

sort: 'Asc' | 'Desc' | None = None¶

the order to sort results in, either ‘Desc’ or ‘Asc’.

start_at: datetime | None = None¶

datetime start range for filtering transactions in full date-time.

end_at: datetime | None = None¶

datetime end range for filtering transactions in full date-time.

async get_positions(session: Session, underlying_symbols: Iterable[str] | None = None, symbol: str | None = None, instrument_type: InstrumentType | None = None, include_closed: bool | None = None, underlying_product_code: str | None = None, partition_keys: Iterable[str] | None = None, net_positions: bool | None = None, include_marks: bool | None = None) → list[CurrentPosition]¶

Get the current positions of the account.

Parameters:¶

session: Session¶

the session to use for the request.

underlying_symbols: Iterable[str] | None = None¶

an array of underlying symbols for positions.

symbol: str | None = None¶

a single symbol.

instrument_type: InstrumentType | None = None¶

the type of instrument.

include_closed: bool | None = None¶

if closed positions should be included in the query.

underlying_product_code: str | None = None¶

the underlying future’s product code.

partition_keys: Iterable[str] | None = None¶

account partition keys.

net_positions: bool | None = None¶

returns net positions grouped by instrument type and symbol.

include_marks: bool | None = None¶

include current quote mark (note: can decrease performance).

async get_total_fees(session: Session, day: date | None = None) → FeesInfo¶

Get the total fees for a given date.

Parameters:¶

session: Session¶

the session to use for the request.

day: date | None = None¶

the date to get fees for.

async get_trading_status(session: Session) → TradingStatus¶

Get the trading status of the account.

Parameters:¶

session: Session¶

the session to use for the request.

async get_transaction(session: Session, id: int) → Transaction¶

Get a single transaction by ID.

Parameters:¶

session: Session¶

the session to use for the request.

id: int¶

the ID of the transaction to fetch.

async place_complex_order(session: Session, order: NewComplexOrder, dry_run: bool = True) → PlacedComplexOrderResponse¶

Place the given order.

Parameters:¶

session: Session¶

the session to use for the request.

order: NewComplexOrder¶

the order to place.

dry_run: bool = True¶

whether this is a test order or not.

async place_order(session: Session, order: NewOrder, dry_run: bool = True) → PlacedOrderResponse¶

Place the given order.

Parameters:¶

session: Session¶

the session to use for the request.

order: NewOrder¶

the order to place.

dry_run: bool = True¶

whether this is a test order or not.

async replace_order(session: Session, old_order_id: int, new_order: NewOrder) → PlacedOrder¶

Replace an order with a new order with different characteristics (but same legs).

Parameters:¶

session: Session¶

the session to use for the request.

old_order_id: int¶

the ID of the order to replace.

new_order: NewOrder¶

the new order to replace the old order with.

pydantic model tastytrade.account.AccountBalance(*, account_number: str, cash_balance: Decimal, long_equity_value: Decimal, short_equity_value: Decimal, long_derivative_value: Decimal, short_derivative_value: Decimal, long_futures_value: Decimal, short_futures_value: Decimal, long_futures_derivative_value: Decimal, short_futures_derivative_value: Decimal, long_margineable_value: Decimal, short_margineable_value: Decimal, margin_equity: Decimal, equity_buying_power: Decimal, derivative_buying_power: Decimal, day_trading_buying_power: Decimal, futures_margin_requirement: Decimal, available_trading_funds: Decimal, maintenance_requirement: Decimal, maintenance_call_value: Decimal, reg_t_call_value: Decimal, day_trading_call_value: Decimal, day_equity_call_value: Decimal, net_liquidating_value: Decimal, cash_available_to_withdraw: Decimal, day_trade_excess: Decimal, pending_cash: Decimal, long_cryptocurrency_value: Decimal, short_cryptocurrency_value: Decimal, cryptocurrency_margin_requirement: Decimal, unsettled_cryptocurrency_fiat_amount: Decimal, closed_loop_available_balance: Decimal, equity_offering_margin_requirement: Decimal, long_bond_value: Decimal, bond_margin_requirement: Decimal, used_derivative_buying_power: Decimal, snapshot_date: date, reg_t_margin_requirement: Decimal, futures_overnight_margin_requirement: Decimal, futures_intraday_margin_requirement: Decimal, maintenance_excess: Decimal, pending_margin_interest: Decimal, effective_cryptocurrency_buying_power: Decimal, updated_at: datetime, apex_starting_day_margin_equity: Decimal | None = None, buying_power_adjustment: Decimal | None = None, time_of_day: str | None = None)¶

Bases: TastytradeData

Dataclass containing account balance information.

Show JSON schema

{
   "title": "AccountBalance",
   "description": "Dataclass containing account balance information.",
   "type": "object",
   "properties": {
      "account-number": {
         "title": "Account-Number",
         "type": "string"
      },
      "cash-balance": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Cash-Balance"
      },
      "long-equity-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Long-Equity-Value"
      },
      "short-equity-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Short-Equity-Value"
      },
      "long-derivative-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Long-Derivative-Value"
      },
      "short-derivative-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Short-Derivative-Value"
      },
      "long-futures-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Long-Futures-Value"
      },
      "short-futures-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Short-Futures-Value"
      },
      "long-futures-derivative-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Long-Futures-Derivative-Value"
      },
      "short-futures-derivative-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Short-Futures-Derivative-Value"
      },
      "long-margineable-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Long-Margineable-Value"
      },
      "short-margineable-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Short-Margineable-Value"
      },
      "margin-equity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Margin-Equity"
      },
      "equity-buying-power": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Equity-Buying-Power"
      },
      "derivative-buying-power": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Derivative-Buying-Power"
      },
      "day-trading-buying-power": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Day-Trading-Buying-Power"
      },
      "futures-margin-requirement": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Futures-Margin-Requirement"
      },
      "available-trading-funds": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Available-Trading-Funds"
      },
      "maintenance-requirement": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Maintenance-Requirement"
      },
      "maintenance-call-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Maintenance-Call-Value"
      },
      "reg-t-call-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Reg-T-Call-Value"
      },
      "day-trading-call-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Day-Trading-Call-Value"
      },
      "day-equity-call-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Day-Equity-Call-Value"
      },
      "net-liquidating-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Net-Liquidating-Value"
      },
      "cash-available-to-withdraw": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Cash-Available-To-Withdraw"
      },
      "day-trade-excess": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Day-Trade-Excess"
      },
      "pending-cash": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Pending-Cash"
      },
      "long-cryptocurrency-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Long-Cryptocurrency-Value"
      },
      "short-cryptocurrency-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Short-Cryptocurrency-Value"
      },
      "cryptocurrency-margin-requirement": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Cryptocurrency-Margin-Requirement"
      },
      "unsettled-cryptocurrency-fiat-amount": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Unsettled-Cryptocurrency-Fiat-Amount"
      },
      "closed-loop-available-balance": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Closed-Loop-Available-Balance"
      },
      "equity-offering-margin-requirement": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Equity-Offering-Margin-Requirement"
      },
      "long-bond-value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Long-Bond-Value"
      },
      "bond-margin-requirement": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Bond-Margin-Requirement"
      },
      "used-derivative-buying-power": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Used-Derivative-Buying-Power"
      },
      "snapshot-date": {
         "format": "date",
         "title": "Snapshot-Date",
         "type": "string"
      },
      "reg-t-margin-requirement": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Reg-T-Margin-Requirement"
      },
      "futures-overnight-margin-requirement": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Futures-Overnight-Margin-Requirement"
      },
      "futures-intraday-margin-requirement": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Futures-Intraday-Margin-Requirement"
      },
      "maintenance-excess": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Maintenance-Excess"
      },
      "pending-margin-interest": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Pending-Margin-Interest"
      },
      "effective-cryptocurrency-buying-power": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            }
         ],
         "title": "Effective-Cryptocurrency-Buying-Power"
      },
      "updated-at": {
         "format": "date-time",
         "title": "Updated-At",
         "type": "string"
      },
      "apex-starting-day-margin-equity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Apex-Starting-Day-Margin-Equity"
      },
      "buying-power-adjustment": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Buying-Power-Adjustment"
      },
      "time-of-day": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Time-Of-Day"
      }
   },
   "required": [
      "account-number",
      "cash-balance",
      "long-equity-value",
      "short-equity-value",
      "long-derivative-value",
      "short-derivative-value",
      "long-futures-value",
      "short-futures-value",
      "long-futures-derivative-value",
      "short-futures-derivative-value",
      "long-margineable-value",
      "short-margineable-value",
      "margin-equity",
      "equity-buying-power",
      "derivative-buying-power",
      "day-trading-buying-power",
      "futures-margin-requirement",
      "available-trading-funds",
      "maintenance-requirement",
      "maintenance-call-value",
      "reg-t-call-value",
      "day-trading-call-value",
      "day-equity-call-value",
      "net-liquidating-value",
      "cash-available-to-withdraw",
      "day-trade-excess",
      "pending-cash",
      "long-cryptocurrency-value",
      "short-cryptocurrency-value",
      "cryptocurrency-margin-requirement",
      "unsettled-cryptocurrency-fiat-amount",
      "closed-loop-available-balance",
      "equity-offering-margin-requirement",
      "long-bond-value",
      "bond-margin-requirement",
      "used-derivative-buying-power",
      "snapshot-date",
      "reg-t-margin-requirement",
      "futures-overnight-margin-requirement",
      "futures-intraday-margin-requirement",
      "maintenance-excess",
      "pending-margin-interest",
      "effective-cryptocurrency-buying-power",
      "updated-at"
   ]
}

Fields:¶

• account_number (str)

• apex_starting_day_margin_equity (decimal.Decimal | None)

• available_trading_funds (decimal.Decimal)

• bond_margin_requirement (decimal.Decimal)

• buying_power_adjustment (decimal.Decimal | None)

• cash_available_to_withdraw (decimal.Decimal)

• cash_balance (decimal.Decimal)

• closed_loop_available_balance (decimal.Decimal)

• cryptocurrency_margin_requirement (decimal.Decimal)

• day_equity_call_value (decimal.Decimal)

• day_trade_excess (decimal.Decimal)

• day_trading_buying_power (decimal.Decimal)

• day_trading_call_value (decimal.Decimal)

• derivative_buying_power (decimal.Decimal)

• effective_cryptocurrency_buying_power (decimal.Decimal)

• equity_buying_power (decimal.Decimal)

• equity_offering_margin_requirement (decimal.Decimal)

• futures_intraday_margin_requirement (decimal.Decimal)

• futures_margin_requirement (decimal.Decimal)

• futures_overnight_margin_requirement (decimal.Decimal)

• long_bond_value (decimal.Decimal)

• long_cryptocurrency_value (decimal.Decimal)

• long_derivative_value (decimal.Decimal)

• long_equity_value (decimal.Decimal)

• long_futures_derivative_value (decimal.Decimal)

• long_futures_value (decimal.Decimal)

• long_margineable_value (decimal.Decimal)

• maintenance_call_value (decimal.Decimal)

• maintenance_excess (decimal.Decimal)

• maintenance_requirement (decimal.Decimal)

• margin_equity (decimal.Decimal)

• net_liquidating_value (decimal.Decimal)

• pending_cash (decimal.Decimal)

• pending_margin_interest (decimal.Decimal)

• reg_t_call_value (decimal.Decimal)

• reg_t_margin_requirement (decimal.Decimal)

• short_cryptocurrency_value (decimal.Decimal)

• short_derivative_value (decimal.Decimal)

• short_equity_value (decimal.Decimal)

• short_futures_derivative_value (decimal.Decimal)

• short_futures_value (decimal.Decimal)

• short_margineable_value (decimal.Decimal)

• snapshot_date (datetime.date)

• time_of_day (str | None)

• unsettled_cryptocurrency_fiat_amount (decimal.Decimal)

• updated_at (datetime.datetime)

• used_derivative_buying_power (decimal.Decimal)

Validators:¶

• validate_price_effects » all fields

field account_number : str [Required] (alias 'account-number')¶

Validated by:¶

• validate_price_effects

field apex_starting_day_margin_equity : Decimal | None = None (alias 'apex-starting-day-margin-equity')¶

Validated by:¶

• validate_price_effects

field available_trading_funds : Decimal [Required] (alias 'available-trading-funds')¶

Validated by:¶

• validate_price_effects

field bond_margin_requirement : Decimal [Required] (alias 'bond-margin-requirement')¶

Validated by:¶

• validate_price_effects

field buying_power_adjustment : Decimal | None = None (alias 'buying-power-adjustment')¶

Validated by:¶

• validate_price_effects

field cash_available_to_withdraw : Decimal [Required] (alias 'cash-available-to-withdraw')¶

Validated by:¶

• validate_price_effects

field cash_balance : Decimal [Required] (alias 'cash-balance')¶

Validated by:¶

• validate_price_effects

field closed_loop_available_balance : Decimal [Required] (alias 'closed-loop-available-balance')¶

Validated by:¶

• validate_price_effects

field cryptocurrency_margin_requirement : Decimal [Required] (alias 'cryptocurrency-margin-requirement')¶

Validated by:¶

• validate_price_effects

field day_equity_call_value : Decimal [Required] (alias 'day-equity-call-value')¶

Validated by:¶

• validate_price_effects

field day_trade_excess : Decimal [Required] (alias 'day-trade-excess')¶

Validated by:¶

• validate_price_effects

field day_trading_buying_power : Decimal [Required] (alias 'day-trading-buying-power')¶

Validated by:¶

• validate_price_effects

field day_trading_call_value : Decimal [Required] (alias 'day-trading-call-value')¶

Validated by:¶

• validate_price_effects

field derivative_buying_power : Decimal [Required] (alias 'derivative-buying-power')¶

Validated by:¶

• validate_price_effects

field effective_cryptocurrency_buying_power : Decimal [Required] (alias 'effective-cryptocurrency-buying-power')¶

Validated by:¶

• validate_price_effects

field equity_buying_power : Decimal [Required] (alias 'equity-buying-power')¶

Validated by:¶

• validate_price_effects

field equity_offering_margin_requirement : Decimal [Required] (alias 'equity-offering-margin-requirement')¶

Validated by:¶

• validate_price_effects

field futures_intraday_margin_requirement : Decimal [Required] (alias 'futures-intraday-margin-requirement')¶

Validated by:¶

• validate_price_effects

field futures_margin_requirement : Decimal [Required] (alias 'futures-margin-requirement')¶

Validated by:¶

• validate_price_effects

field futures_overnight_margin_requirement : Decimal [Required] (alias 'futures-overnight-margin-requirement')¶

Validated by:¶

• validate_price_effects

field long_bond_value : Decimal [Required] (alias 'long-bond-value')¶

Validated by:¶

• validate_price_effects

field long_cryptocurrency_value : Decimal [Required] (alias 'long-cryptocurrency-value')¶

Validated by:¶

• validate_price_effects

field long_derivative_value : Decimal [Required] (alias 'long-derivative-value')¶

Validated by:¶

• validate_price_effects

field long_equity_value : Decimal [Required] (alias 'long-equity-value')¶

Validated by:¶

• validate_price_effects

field long_futures_derivative_value : Decimal [Required] (alias 'long-futures-derivative-value')¶

Validated by:¶

• validate_price_effects

field long_futures_value : Decimal [Required] (alias 'long-futures-value')¶

Validated by:¶

• validate_price_effects

field long_margineable_value : Decimal [Required] (alias 'long-margineable-value')¶

Validated by:¶

• validate_price_effects

field maintenance_call_value : Decimal [Required] (alias 'maintenance-call-value')¶

Validated by:¶

• validate_price_effects

field maintenance_excess : Decimal [Required] (alias 'maintenance-excess')¶

Validated by:¶

• validate_price_effects

field maintenance_requirement : Decimal [Required] (alias 'maintenance-requirement')¶

Validated by:¶

• validate_price_effects

field margin_equity : Decimal [Required] (alias 'margin-equity')¶

Validated by:¶

• validate_price_effects

field net_liquidating_value : Decimal [Required] (alias 'net-liquidating-value')¶

Validated by:¶

• validate_price_effects

field pending_cash : Decimal [Required] (alias 'pending-cash')¶

Validated by:¶

• validate_price_effects

field pending_margin_interest : Decimal [Required] (alias 'pending-margin-interest')¶

Validated by:¶

• validate_price_effects

field reg_t_call_value : Decimal [Required] (alias 'reg-t-call-value')¶

Validated by:¶

• validate_price_effects

field reg_t_margin_requirement : Decimal [Required] (alias 'reg-t-margin-requirement')¶

Validated by:¶

• validate_price_effects

field short_cryptocurrency_value : Decimal [Required] (alias 'short-cryptocurrency-value')¶

Validated by:¶

• validate_price_effects

field short_derivative_value : Decimal [Required] (alias 'short-derivative-value')¶

Validated by:¶

• validate_price_effects

field short_equity_value : Decimal [Required] (alias 'short-equity-value')¶

Validated by:¶

• validate_price_effects

field short_futures_derivative_value : Decimal [Required] (alias 'short-futures-derivative-value')¶

Validated by:¶

• validate_price_effects

field short_futures_value : Decimal [Required] (alias 'short-futures-value')¶

Validated by:¶

• validate_price_effects

field short_margineable_value : Decimal [Required] (alias 'short-margineable-value')¶

Validated by:¶

• validate_price_effects

field snapshot_date : date [Required] (alias 'snapshot-date')¶

Validated by:¶

• validate_price_effects

field time_of_day : str | None = None (alias 'time-of-day')¶

Validated by:¶

• validate_price_effects

field unsettled_cryptocurrency_fiat_amount : Decimal [Required] (alias 'unsettled-cryptocurrency-fiat-amount')¶

Validated by:¶

• validate_price_effects

field updated_at : datetime [Required] (alias 'updated-at')¶

Validated by:¶

• validate_price_effects

field used_derivative_buying_power : Decimal [Required] (alias 'used-derivative-buying-power')¶

Validated by:¶

• validate_price_effects

validator validate_price_effects  »  all fields¶