Accounts

Manage trading accounts, balances, and portfolio history.

Get Accounts

$ clear-street v1:accounts get-accounts

GET/v1/accounts

Get Account By ID

$ clear-street v1:accounts get-account-by-id

GET/v1/accounts/{account_id}

Patch Account By ID

$ clear-street v1:accounts patch-account-by-id

PATCH/v1/accounts/{account_id}

Get Account Balances

$ clear-street v1:accounts get-account-balances

GET/v1/accounts/{account_id}/balances

Get Portfolio History

$ clear-street v1:accounts get-portfolio-history

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

ModelsExpand Collapse

account: object { id, account_holder_entity_id, full_name, 7 more }

Represents a trading account

id: number

The unique identifier for the account

account_holder_entity_id: number

The account holder entity identifier

full_name: string

The full legal name of the account

open_date: string

The date the account was opened

options_level: number

The options level of the account

short_name: string

The short name of the account

status: "ACTIVE" or "INACTIVE" or "CLOSED"

The current status of the account

"ACTIVE"

"INACTIVE"

"CLOSED"

subtype: "CASH" or "MARGIN" or "OTHER"

The sub-type of account

"CASH"

"MARGIN"

"OTHER"

type: "CUSTOMER" or "OTHER"

The type of account

"CUSTOMER"

"OTHER"

close_date: optional string

The date the account was closed, if applicable

account_balances: object { account_id, buying_power, currency, 16 more }

Represents the balance details for a trading account

account_id: number

The unique identifier for the account

buying_power: string

The total buying power available in the account.

currency: string

Currency identifier for all monetary values.

daily_realized_pnl: string

Realized profit or loss since start of day.

daily_total_pnl: string

Total profit or loss since start of day.

daily_unrealized_pnl: string

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

equity: string

The total equity in the account.

long_market_value: string

The total market value of all long positions.

margin_type: "OTHER" or "NONE" or "PORTFOLIO_MARGIN" or 6 more

The applicable margin model for the account

"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: string

Signed buying-power correction from open orders.

settled_cash: string

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

sod: object { buying_power, equity, long_market_value, 6 more }

Start-of-day snapshot balances.

buying_power: string

Start-of-day buying power.

equity: string

Start-of-day equity.

long_market_value: string

Start-of-day long market value.

short_market_value: string

Start-of-day short market value.

asof: optional string

Timestamp for the start-of-day values.

day_trade_buying_power: optional string

Start-of-day day-trade buying power.

maintenance_margin_excess: optional string

Start-of-day maintenance margin excess.

maintenance_margin_requirement: optional string

Start-of-day maintenance margin requirement.

trade_cash: optional string

Start-of-day trade cash.

trade_cash: string

Trade-date effective cash.

unsettled_credits: string

Trade-date unsettled cash credits.

unsettled_debits: string

Trade-date unsettled cash debits.

withdrawable_cash: string

The amount of cash currently available to withdraw.

margin_details: optional object { day_trade_count, initial_margin_excess, initial_margin_requirement, 6 more }

Margin-account-only details.

day_trade_count: number

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

initial_margin_excess: string

Initial margin excess for trade-date balances.

initial_margin_requirement: string

Initial margin requirement for trade-date balances.

maintenance_margin_excess: string

Maintenance margin excess for trade-date balances.

maintenance_margin_requirement: string

Maintenance margin requirement for trade-date balances.

pattern_day_trader: boolean

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

day_trade_buying_power_usage: optional string

The amount of day-trade buying power used during the current trading day.

top_contributors: optional array of MarginTopContributor { day_trade_buying_power_usage, initial_margin_requirement, maintenance_margin_requirement, 2 more }

Optional top margin contributors, returned only when explicitly requested.

day_trade_buying_power_usage: string

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: string

Initial margin requirement attributable to this underlying.

maintenance_margin_requirement: string

Maintenance margin requirement attributable to this underlying.

market_value: string

Net market value attributable to this underlying.

underlying_instrument_id: string

UUID of the underlying security contributing to margin requirement.

usage: optional object { total, used }

Current usage totals.

total: string

The total margin available in the current model.

used: string

The amount of margin that is currently being utilized.

multiplier: optional string

Applied multiplier for margin calculations.

short_market_value: optional string

The total market value of all short positions.

account_balances_sod: object { buying_power, equity, long_market_value, 6 more }

buying_power: string

Start-of-day buying power.

equity: string

Start-of-day equity.

long_market_value: string

Start-of-day long market value.

short_market_value: string

Start-of-day short market value.

asof: optional string

Timestamp for the start-of-day values.

day_trade_buying_power: optional string

Start-of-day day-trade buying power.

maintenance_margin_excess: optional string

Start-of-day maintenance margin excess.

maintenance_margin_requirement: optional string

Start-of-day maintenance margin requirement.

trade_cash: optional string

Start-of-day trade cash.

account_list: array of Account { id, account_holder_entity_id, full_name, 7 more }

id: number

The unique identifier for the account

account_holder_entity_id: number

The account holder entity identifier

full_name: string

The full legal name of the account

open_date: string

The date the account was opened

options_level: number

The options level of the account

short_name: string

The short name of the account

status: "ACTIVE" or "INACTIVE" or "CLOSED"

The current status of the account

"ACTIVE"

"INACTIVE"

"CLOSED"

subtype: "CASH" or "MARGIN" or "OTHER"

The sub-type of account

"CASH"

"MARGIN"

"OTHER"

type: "CUSTOMER" or "OTHER"

The type of account

"CUSTOMER"

"OTHER"

close_date: optional string

The date the account was closed, if applicable

account_settings: object { risk }

risk: optional object { max_notional }

Risk settings for the account

max_notional: optional string

The maximum notional value available to the account

account_status: "ACTIVE" or "INACTIVE" or "CLOSED"

Account status

"ACTIVE"

"INACTIVE"

"CLOSED"

account_subtype: "CASH" or "MARGIN" or "OTHER"

Account subtype classification providing more granular categorization

"CASH"

"MARGIN"

"OTHER"

account_type: "CUSTOMER" or "OTHER"

Account type classification

"CUSTOMER"

"OTHER"

margin_details: object { day_trade_count, initial_margin_excess, initial_margin_requirement, 6 more }

day_trade_count: number

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

initial_margin_excess: string

Initial margin excess for trade-date balances.

initial_margin_requirement: string

Initial margin requirement for trade-date balances.

maintenance_margin_excess: string

Maintenance margin excess for trade-date balances.

maintenance_margin_requirement: string

Maintenance margin requirement for trade-date balances.

pattern_day_trader: boolean

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

day_trade_buying_power_usage: optional string

The amount of day-trade buying power used during the current trading day.

top_contributors: optional array of MarginTopContributor { day_trade_buying_power_usage, initial_margin_requirement, maintenance_margin_requirement, 2 more }

Optional top margin contributors, returned only when explicitly requested.

day_trade_buying_power_usage: string

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: string

Initial margin requirement attributable to this underlying.

maintenance_margin_requirement: string

Maintenance margin requirement attributable to this underlying.

market_value: string

Net market value attributable to this underlying.

underlying_instrument_id: string

UUID of the underlying security contributing to margin requirement.

usage: optional object { total, used }

Current usage totals.

total: string

The total margin available in the current model.

used: string

The amount of margin that is currently being utilized.

margin_details_usage: object { total, used }

total: string

The total margin available in the current model.

used: string

The amount of margin that is currently being utilized.

margin_top_contributor: object { day_trade_buying_power_usage, initial_margin_requirement, maintenance_margin_requirement, 2 more }

day_trade_buying_power_usage: string

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: string

Initial margin requirement attributable to this underlying.

maintenance_margin_requirement: string

Maintenance margin requirement attributable to this underlying.

market_value: string

Net market value attributable to this underlying.

underlying_instrument_id: string

UUID of the underlying security contributing to margin requirement.

margin_type: "OTHER" or "NONE" or "PORTFOLIO_MARGIN" or 6 more

An account’s margin type

"OTHER"

"NONE"

"PORTFOLIO_MARGIN"

"RISK_BASED_HAIRCUT_BROKER_DEALER"

"REG_T"

"RISK_BASED_HAIRCUT_MARKET_MAKER"

"CIRO"

"FUTURES_NLV"

"FUTURES_TOT_EQ"

portfolio_history_response: object { segments }

segments: array of PortfolioHistorySegment { date, eod_equity, realized_pnl, 7 more }

date: string

The date for this segment

eod_equity: string

The equity at the end of the trading day.

realized_pnl: string

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

sod_equity: string

The equity at the start of the trading day.

unrealized_pnl: string

Sum of the profit and loss from market changes.

bought_notional: optional string

Amount bought MTM

day_pnl: optional string

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

net_pnl: optional string

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

position_pnl: optional string

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

sold_notional: optional string

Amount sold MTM

portfolio_history_segment: object { date, eod_equity, realized_pnl, 7 more }

date: string

The date for this segment

eod_equity: string

The equity at the end of the trading day.

realized_pnl: string

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

sod_equity: string

The equity at the start of the trading day.

unrealized_pnl: string

Sum of the profit and loss from market changes.

bought_notional: optional string

Amount bought MTM

day_pnl: optional string

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

net_pnl: optional string

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

position_pnl: optional string

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

sold_notional: optional string

Amount sold MTM

risk_settings: object { max_notional }

Risk settings for an account

max_notional: optional string

The maximum notional value available to the account