API Reference

V1

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Accounts

Manage trading accounts, balances, and portfolio history.

Get Accounts

v1.accounts.get_accounts(AccountGetAccountsParams**kwargs) -> AccountGetAccountsResponse

GET/v1/accounts

Get Account By ID

v1.accounts.get_account_by_id(intaccount_id) -> AccountGetAccountByIDResponse

GET/v1/accounts/{account_id}

Patch Account By ID

v1.accounts.patch_account_by_id(intaccount_id, AccountPatchAccountByIDParams**kwargs) -> AccountPatchAccountByIDResponse

PATCH/v1/accounts/{account_id}

Get Account Balances

v1.accounts.get_account_balances(intaccount_id, AccountGetAccountBalancesParams**kwargs) -> AccountGetAccountBalancesResponse

GET/v1/accounts/{account_id}/balances

Get Portfolio History

v1.accounts.get_portfolio_history(intaccount_id, AccountGetPortfolioHistoryParams**kwargs) -> AccountGetPortfolioHistoryResponse

GET/v1/accounts/{account_id}/portfolio-history

ModelsExpand Collapse

class Account: …

Represents a trading account

id: int

The unique identifier for the account

formatint64

account_holder_entity_id: int

The account holder entity identifier

formatint64

full_name: str

The full legal name of the account

open_date: date

The date the account was opened

formatdate

options_level: int

The options level of the account

formatint64

short_name: str

The short name of the account

status: AccountStatus

The current status of the account

One of the following:

"ACTIVE"

"INACTIVE"

"CLOSED"

subtype: AccountSubtype

The sub-type of account

One of the following:

"CASH"

"MARGIN"

"OTHER"

type: AccountType

The type of account

One of the following:

"CUSTOMER"

"OTHER"

close_date: Optional[date]

The date the account was closed, if applicable When a null/undefined value is observed, it indicates it does not apply.

formatdate

class AccountBalances: …

Represents the balance details for a trading account

account_id: int

The unique identifier for the account

formatint64

buying_power: str

The total buying power available in the account.

currency: str

Currency identifier for all monetary values.

daily_change: str

Difference between current equity and start-of-day equity.

daily_pnl: str

Total profit or loss since start of day.

daily_realized_pnl: str

Realized profit or loss since start of day.

daily_total_pnl: str

Total profit or loss since start of day.

daily_unrealized_pnl: str

Total unrealized profit or loss across all positions relative to prior close.

equity: str

The total equity in the account.

long_market_value: str

The total market value of all long positions.

margin_type: MarginType

The applicable margin model for the account

One of the following:

"OTHER"

"NONE"

"PORTFOLIO_MARGIN"

"RISK_BASED_HAIRCUT_BROKER_DEALER"

"REG_T"

"RISK_BASED_HAIRCUT_MARKET_MAKER"

"CIRO"

"FUTURES_NLV"

"FUTURES_TOT_EQ"

open_order_adjustment: str

Signed buying-power correction from open orders.

settled_cash: str

The amount of cash that is settled and available for withdrawal or trading.

sod: AccountBalancesSod

Start-of-day snapshot balances.

buying_power: str

Start-of-day buying power.

equity: str

Start-of-day equity.

long_market_value: str

Start-of-day long market value.

short_market_value: str

Start-of-day short market value.

asof: Optional[date]

Timestamp for the start-of-day values. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

Deprecatedday_trade_buying_power: Optional[str]

Start-of-day day-trade buying power. When a null/undefined value is observed, it indicates it does not apply.

maintenance_margin_excess: Optional[str]

Start-of-day maintenance margin excess. When a null/undefined value is observed, it indicates it does not apply.

maintenance_margin_requirement: Optional[str]

Start-of-day maintenance margin requirement. When a null/undefined value is observed, it indicates it does not apply.

trade_cash: Optional[str]

Start-of-day trade cash. When a null/undefined value is observed, it indicates it does not apply.

trade_cash: str

Trade-date effective cash.

unrealized_pnl: str

Total unrealized profit or loss across all open positions.

unsettled_credits: str

Trade-date unsettled cash credits.

unsettled_debits: str

Trade-date unsettled cash debits.

withdrawable_cash: str

The amount of cash currently available to withdraw.

margin_details: Optional[MarginDetails]

Margin-account-only details. When a null/undefined value is observed, it indicates it does not apply.

Deprecatedday_trade_count: int

The number of day trades executed over the 5 most recent trading days.

formatint32

minimum0

initial_margin_excess: str

Initial margin excess for trade-date balances.

initial_margin_requirement: str

Initial margin requirement for trade-date balances.

intraday_details: MarginSessionDetails

Intraday session margin calculation details.

buying_power: str

Maximum buying power available in the account during the session.

multiplier: Optional[str]

Effective multiplier for margin calculations during the session.

maintenance_margin_excess: str

Maintenance margin excess for trade-date balances.

maintenance_margin_requirement: str

Maintenance margin requirement for trade-date balances.

overnight_details: MarginSessionDetails

Overnight session margin calculation details.

buying_power: str

Maximum buying power available in the account during the session.

multiplier: Optional[str]

Effective multiplier for margin calculations during the session.

Deprecatedpattern_day_trader: bool

true if the account is currently flagged as a PDT, otherwise false.

Deprecatedday_trade_buying_power_usage: Optional[str]

The amount of day-trade buying power used during the current trading day. When null/undefined, the value should be assumed to be zero. The field is omitted to simplify the response.

top_contributors: Optional[List[MarginTopContributor]]

Optional top margin contributors, returned only when explicitly requested.

Deprecatedday_trade_buying_power_usage: str

Day-trade buying power consumed by fills against this underlying on the current trade date. Populated only for pattern day trader accounts.

initial_margin_requirement: str

Initial margin requirement attributable to this underlying.

maintenance_margin_requirement: str

Maintenance margin requirement attributable to this underlying.

market_value: str

Net market value attributable to this underlying.

underlying_instrument_id: str

UUID of the underlying security contributing to margin requirement.

formatuuid

usage: Optional[MarginDetailsUsage]

Current usage totals. When a null/undefined value is observed, it indicates that there is no available data.

total: str

The total margin available in the current model.

used: str

The amount of margin that is currently being utilized.

multiplier: Optional[str]

Applied multiplier for margin calculations. When a null/undefined value is observed, it indicates it does not apply.

short_market_value: Optional[str]

The total market value of all short positions. When null/undefined, the value should be assumed to be zero. The field is omitted to simplify the response.

class AccountBalancesSod: …

buying_power: str

Start-of-day buying power.

equity: str

Start-of-day equity.

long_market_value: str

Start-of-day long market value.

short_market_value: str

Start-of-day short market value.

asof: Optional[date]

Timestamp for the start-of-day values. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

Deprecatedday_trade_buying_power: Optional[str]

Start-of-day day-trade buying power. When a null/undefined value is observed, it indicates it does not apply.

maintenance_margin_excess: Optional[str]

Start-of-day maintenance margin excess. When a null/undefined value is observed, it indicates it does not apply.

maintenance_margin_requirement: Optional[str]

Start-of-day maintenance margin requirement. When a null/undefined value is observed, it indicates it does not apply.

trade_cash: Optional[str]

Start-of-day trade cash. When a null/undefined value is observed, it indicates it does not apply.

List[Account]

id: int

The unique identifier for the account

formatint64

account_holder_entity_id: int

The account holder entity identifier

formatint64

full_name: str

The full legal name of the account

open_date: date

The date the account was opened

formatdate

options_level: int

The options level of the account

formatint64

short_name: str

The short name of the account

status: AccountStatus

The current status of the account

One of the following:

"ACTIVE"

"INACTIVE"

"CLOSED"

subtype: AccountSubtype

The sub-type of account

One of the following:

"CASH"

"MARGIN"

"OTHER"

type: AccountType

The type of account

One of the following:

"CUSTOMER"

"OTHER"

close_date: Optional[date]

The date the account was closed, if applicable When a null/undefined value is observed, it indicates it does not apply.

formatdate

class AccountSettings: …

risk: Optional[RiskSettings]

Risk settings for the account When a null/undefined value is observed, it indicates that there is no available data.

max_notional: Optional[str]

The maximum notional value available to the account When a null/undefined value is observed, it indicates that there is no available data.

Literal["ACTIVE", "INACTIVE", "CLOSED"]

Account status

One of the following:

"ACTIVE"

"INACTIVE"

"CLOSED"

Literal["CASH", "MARGIN", "OTHER"]

Account subtype classification providing more granular categorization

One of the following:

"CASH"

"MARGIN"

"OTHER"

Literal["CUSTOMER", "OTHER"]

Account type classification

One of the following:

"CUSTOMER"

"OTHER"

class MarginDetails: …

Deprecatedday_trade_count: int

The number of day trades executed over the 5 most recent trading days.

formatint32

minimum0

initial_margin_excess: str

Initial margin excess for trade-date balances.

initial_margin_requirement: str

Initial margin requirement for trade-date balances.

intraday_details: MarginSessionDetails

Intraday session margin calculation details.

buying_power: str

Maximum buying power available in the account during the session.

multiplier: Optional[str]

Effective multiplier for margin calculations during the session.

maintenance_margin_excess: str

Maintenance margin excess for trade-date balances.

maintenance_margin_requirement: str

Maintenance margin requirement for trade-date balances.

overnight_details: MarginSessionDetails

Overnight session margin calculation details.

buying_power: str

Maximum buying power available in the account during the session.

multiplier: Optional[str]

Effective multiplier for margin calculations during the session.

Deprecatedpattern_day_trader: bool

true if the account is currently flagged as a PDT, otherwise false.

Deprecatedday_trade_buying_power_usage: Optional[str]

The amount of day-trade buying power used during the current trading day. When null/undefined, the value should be assumed to be zero. The field is omitted to simplify the response.

top_contributors: Optional[List[MarginTopContributor]]

Optional top margin contributors, returned only when explicitly requested.

Deprecatedday_trade_buying_power_usage: str

Day-trade buying power consumed by fills against this underlying on the current trade date. Populated only for pattern day trader accounts.

initial_margin_requirement: str

Initial margin requirement attributable to this underlying.

maintenance_margin_requirement: str

Maintenance margin requirement attributable to this underlying.

market_value: str

Net market value attributable to this underlying.

underlying_instrument_id: str

UUID of the underlying security contributing to margin requirement.

formatuuid

usage: Optional[MarginDetailsUsage]

Current usage totals. When a null/undefined value is observed, it indicates that there is no available data.

total: str

The total margin available in the current model.

used: str

The amount of margin that is currently being utilized.

class MarginDetailsUsage: …

total: str

The total margin available in the current model.

used: str

The amount of margin that is currently being utilized.

class MarginSessionDetails: …

buying_power: str

Maximum buying power available in the account during the session.

multiplier: Optional[str]

Effective multiplier for margin calculations during the session.

class MarginTopContributor: …

Deprecatedday_trade_buying_power_usage: str

Day-trade buying power consumed by fills against this underlying on the current trade date. Populated only for pattern day trader accounts.

initial_margin_requirement: str

Initial margin requirement attributable to this underlying.

maintenance_margin_requirement: str

Maintenance margin requirement attributable to this underlying.

market_value: str

Net market value attributable to this underlying.

underlying_instrument_id: str

UUID of the underlying security contributing to margin requirement.

formatuuid

Literal["OTHER", "NONE", "PORTFOLIO_MARGIN", 6 more]

An account’s margin type

One of the following:

"OTHER"

"NONE"

"PORTFOLIO_MARGIN"

"RISK_BASED_HAIRCUT_BROKER_DEALER"

"REG_T"

"RISK_BASED_HAIRCUT_MARKET_MAKER"

"CIRO"

"FUTURES_NLV"

"FUTURES_TOT_EQ"

class PortfolioHistoryResponse: …

segments: List[PortfolioHistorySegment]

date: date

The date for this segment

formatdate

eod_equity: str

The equity at the end of the trading day.

realized_pnl: str

Sum of the profit and loss realized from position closing trading activity.

sod_equity: str

The equity at the start of the trading day.

unrealized_pnl: str

Sum of the profit and loss from market changes.

bought_notional: Optional[str]

Amount bought MTM

day_pnl: Optional[str]

Sum of the profit and loss from intraday trading activities for the trading day.

net_pnl: Optional[str]

P&L after netting all realized and unrealized P&L, adjustments, dividends, change in accruals, income and expenses

position_pnl: Optional[str]

P&L attributable to start-of-day (carried) positions from market movement during this trading day.

sold_notional: Optional[str]

Amount sold MTM

class PortfolioHistorySegment: …

date: date

The date for this segment

formatdate

eod_equity: str

The equity at the end of the trading day.

realized_pnl: str

Sum of the profit and loss realized from position closing trading activity.

sod_equity: str

The equity at the start of the trading day.

unrealized_pnl: str

Sum of the profit and loss from market changes.

bought_notional: Optional[str]

Amount bought MTM

day_pnl: Optional[str]

Sum of the profit and loss from intraday trading activities for the trading day.

net_pnl: Optional[str]

P&L after netting all realized and unrealized P&L, adjustments, dividends, change in accruals, income and expenses

position_pnl: Optional[str]

P&L attributable to start-of-day (carried) positions from market movement during this trading day.

sold_notional: Optional[str]

Amount sold MTM

class RiskSettings: …

Risk settings for an account

max_notional: Optional[str]

The maximum notional value available to the account When a null/undefined value is observed, it indicates that there is no available data.

class AccountGetAccountsResponse: …

data: AccountList

id: int

The unique identifier for the account

formatint64

account_holder_entity_id: int

The account holder entity identifier

formatint64

full_name: str

The full legal name of the account

open_date: date

The date the account was opened

formatdate

options_level: int

The options level of the account

formatint64

short_name: str

The short name of the account

status: AccountStatus

The current status of the account

One of the following:

"ACTIVE"

"INACTIVE"

"CLOSED"

subtype: AccountSubtype

The sub-type of account

One of the following:

"CASH"

"MARGIN"

"OTHER"

type: AccountType

The type of account

One of the following:

"CUSTOMER"

"OTHER"

close_date: Optional[date]

The date the account was closed, if applicable When a null/undefined value is observed, it indicates it does not apply.

formatdate

class AccountGetAccountByIDResponse: …

data: Account

Represents a trading account

id: int

The unique identifier for the account

formatint64

account_holder_entity_id: int

The account holder entity identifier

formatint64

full_name: str

The full legal name of the account

open_date: date

The date the account was opened

formatdate

options_level: int

The options level of the account

formatint64

short_name: str

The short name of the account

status: AccountStatus

The current status of the account

One of the following:

"ACTIVE"

"INACTIVE"

"CLOSED"

subtype: AccountSubtype

The sub-type of account

One of the following:

"CASH"

"MARGIN"

"OTHER"

type: AccountType

The type of account

One of the following:

"CUSTOMER"

"OTHER"

close_date: Optional[date]

The date the account was closed, if applicable When a null/undefined value is observed, it indicates it does not apply.

formatdate

class AccountPatchAccountByIDResponse: …

data: AccountSettings

risk: Optional[RiskSettings]

Risk settings for the account When a null/undefined value is observed, it indicates that there is no available data.

max_notional: Optional[str]

The maximum notional value available to the account When a null/undefined value is observed, it indicates that there is no available data.

class AccountGetAccountBalancesResponse: …

data: AccountBalances

Represents the balance details for a trading account

account_id: int

The unique identifier for the account

formatint64

buying_power: str

The total buying power available in the account.

currency: str

Currency identifier for all monetary values.

daily_change: str

Difference between current equity and start-of-day equity.

daily_pnl: str

Total profit or loss since start of day.

daily_realized_pnl: str

Realized profit or loss since start of day.

daily_total_pnl: str

Total profit or loss since start of day.

daily_unrealized_pnl: str

Total unrealized profit or loss across all positions relative to prior close.

equity: str

The total equity in the account.

long_market_value: str

The total market value of all long positions.

margin_type: MarginType

The applicable margin model for the account

One of the following:

"OTHER"

"NONE"

"PORTFOLIO_MARGIN"

"RISK_BASED_HAIRCUT_BROKER_DEALER"

"REG_T"

"RISK_BASED_HAIRCUT_MARKET_MAKER"

"CIRO"

"FUTURES_NLV"

"FUTURES_TOT_EQ"

open_order_adjustment: str

Signed buying-power correction from open orders.

settled_cash: str

The amount of cash that is settled and available for withdrawal or trading.

sod: AccountBalancesSod

Start-of-day snapshot balances.

buying_power: str

Start-of-day buying power.

equity: str

Start-of-day equity.

long_market_value: str

Start-of-day long market value.

short_market_value: str

Start-of-day short market value.

asof: Optional[date]

Timestamp for the start-of-day values. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

Deprecatedday_trade_buying_power: Optional[str]

Start-of-day day-trade buying power. When a null/undefined value is observed, it indicates it does not apply.

maintenance_margin_excess: Optional[str]

Start-of-day maintenance margin excess. When a null/undefined value is observed, it indicates it does not apply.

maintenance_margin_requirement: Optional[str]

Start-of-day maintenance margin requirement. When a null/undefined value is observed, it indicates it does not apply.

trade_cash: Optional[str]

Start-of-day trade cash. When a null/undefined value is observed, it indicates it does not apply.

trade_cash: str

Trade-date effective cash.

unrealized_pnl: str

Total unrealized profit or loss across all open positions.

unsettled_credits: str

Trade-date unsettled cash credits.

unsettled_debits: str

Trade-date unsettled cash debits.

withdrawable_cash: str

The amount of cash currently available to withdraw.

margin_details: Optional[MarginDetails]

Margin-account-only details. When a null/undefined value is observed, it indicates it does not apply.

Deprecatedday_trade_count: int

The number of day trades executed over the 5 most recent trading days.

formatint32

minimum0

initial_margin_excess: str

Initial margin excess for trade-date balances.

initial_margin_requirement: str

Initial margin requirement for trade-date balances.

intraday_details: MarginSessionDetails

Intraday session margin calculation details.

buying_power: str

Maximum buying power available in the account during the session.

multiplier: Optional[str]

Effective multiplier for margin calculations during the session.

maintenance_margin_excess: str

Maintenance margin excess for trade-date balances.

maintenance_margin_requirement: str

Maintenance margin requirement for trade-date balances.

overnight_details: MarginSessionDetails

Overnight session margin calculation details.

buying_power: str

Maximum buying power available in the account during the session.

multiplier: Optional[str]

Effective multiplier for margin calculations during the session.

Deprecatedpattern_day_trader: bool

true if the account is currently flagged as a PDT, otherwise false.

Deprecatedday_trade_buying_power_usage: Optional[str]

The amount of day-trade buying power used during the current trading day. When null/undefined, the value should be assumed to be zero. The field is omitted to simplify the response.

top_contributors: Optional[List[MarginTopContributor]]

Optional top margin contributors, returned only when explicitly requested.

Deprecatedday_trade_buying_power_usage: str

Day-trade buying power consumed by fills against this underlying on the current trade date. Populated only for pattern day trader accounts.

initial_margin_requirement: str

Initial margin requirement attributable to this underlying.

maintenance_margin_requirement: str

Maintenance margin requirement attributable to this underlying.

market_value: str

Net market value attributable to this underlying.

underlying_instrument_id: str

UUID of the underlying security contributing to margin requirement.

formatuuid

usage: Optional[MarginDetailsUsage]

Current usage totals. When a null/undefined value is observed, it indicates that there is no available data.

total: str

The total margin available in the current model.

used: str

The amount of margin that is currently being utilized.

multiplier: Optional[str]

Applied multiplier for margin calculations. When a null/undefined value is observed, it indicates it does not apply.

short_market_value: Optional[str]

The total market value of all short positions. When null/undefined, the value should be assumed to be zero. The field is omitted to simplify the response.

class AccountGetPortfolioHistoryResponse: …

data: PortfolioHistoryResponse

segments: List[PortfolioHistorySegment]

date: date

The date for this segment

formatdate

eod_equity: str

The equity at the end of the trading day.

realized_pnl: str

Sum of the profit and loss realized from position closing trading activity.

sod_equity: str

The equity at the start of the trading day.

unrealized_pnl: str

Sum of the profit and loss from market changes.

bought_notional: Optional[str]

Amount bought MTM

day_pnl: Optional[str]

Sum of the profit and loss from intraday trading activities for the trading day.

net_pnl: Optional[str]

P&L after netting all realized and unrealized P&L, adjustments, dividends, change in accruals, income and expenses

position_pnl: Optional[str]

P&L attributable to start-of-day (carried) positions from market movement during this trading day.

sold_notional: Optional[str]

Amount sold MTM