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)

async a_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 a_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 classmethod a_get(session: Session, *, include_closed: bool = False) → list[Self]¶

async classmethod a_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 a_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 a_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 a_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 a_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 a_get_effective_margin_requirements(session: Session, symbol: str) → MarginRequirement¶

Get the effective margin requirements for a given symbol.

Parameters:¶

session: Session¶

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

symbol: str¶

the symbol to get margin requirements for.

async a_get_history(session: Session, per_page: int = 250, page_offset: int | None = 0, sort: 'Asc' | 'Desc' = 'Desc', type: str | None = None, types: list[str] | None = None, sub_types: list[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: list[str] | None = None¶

a list of transaction types to filter by.

sub_types: list[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 a_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 a_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 a_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 a_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 a_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 a_get_order_chains(session: Session, symbol: str, start_time: datetime, end_time: datetime) → list[OrderChain]¶

Get a list of order chains (open + rolls + close) for given symbol over the given time frame, with total P/L, commissions, etc.

Not supported for OAuth sessions–write Tasty to get this added!

Parameters:¶

session: Session¶

the session to use for the request.

symbol: str¶

the underlying symbol for the chains.

start_time: datetime¶

the beginning time of the query.

end_time: datetime¶

the ending time of the query.

async a_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: list[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: list[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 a_get_position_limit(session: Session) → PositionLimit¶

Get the maximum order size information for the account.

Parameters:¶

session: Session¶

the session to use for the request.

async a_get_positions(session: Session, underlying_symbols: list[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: list[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: list[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: list[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 a_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 a_get_trading_status(session: Session) → TradingStatus¶

Get the trading status of the account.

Parameters:¶

session: Session¶

the session to use for the request.

async a_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 a_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 a_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 a_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.

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.

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.

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

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

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).

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

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.

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

get_effective_margin_requirements(session: Session, symbol: str) → MarginRequirement¶

Get the effective margin requirements for a given symbol.

Parameters:¶

session: Session¶

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

symbol: str¶

the symbol to get margin requirements for.

get_history(session: Session, per_page: int = 250, page_offset: int | None = 0, sort: 'Asc' | 'Desc' = 'Desc', type: str | None = None, types: list[str] | None = None, sub_types: list[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: list[str] | None = None¶

a list of transaction types to filter by.

sub_types: list[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.

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.

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

Get orders placed today for the account.

Parameters:¶

session: Session¶

the session to use for the request.

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.

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.

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.

get_order_chains(session: Session, symbol: str, start_time: datetime, end_time: datetime) → list[OrderChain]¶

Get a list of order chains (open + rolls + close) for given symbol over the given time frame, with total P/L, commissions, etc.

Not supported for OAuth sessions–write Tasty to get this added!

Parameters:¶

session: Session¶

the session to use for the request.

symbol: str¶

the underlying symbol for the chains.

start_time: datetime¶

the beginning time of the query.

end_time: datetime¶

the ending time of the query.

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: list[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: list[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.

get_position_limit(session: Session) → PositionLimit¶

Get the maximum order size information for the account.

Parameters:¶

session: Session¶

the session to use for the request.

get_positions(session: Session, underlying_symbols: list[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: list[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: list[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: list[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).

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.

get_trading_status(session: Session) → TradingStatus¶

Get the trading status of the account.

Parameters:¶

session: Session¶

the session to use for the request.

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.

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.

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.

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.