Accounts

Manage trading accounts, balances, and portfolio history.

Get Accounts

$ clst v1:accounts get-accounts

GET/v1/accounts

Get Account By ID

$ clst v1:accounts get-account-by-id

GET/v1/accounts/{account_id}

Patch Account By ID

$ clst v1:accounts patch-account-by-id

PATCH/v1/accounts/{account_id}

Get Account Balances

$ clst v1:accounts get-account-balances

GET/v1/accounts/{account_id}/balances

Get Portfolio History

$ clst v1:accounts get-portfolio-history

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

ModelsExpand Collapse

account: object { id, account_holder_entity_id, account_holder_entity_kind, 8 more }

Represents a trading account

id: number

The unique identifier for the account

account_holder_entity_id: number

The account holder entity identifier

account_holder_entity_kind: "NATURAL_PERSON" or "LEGAL_ENTITY" or "OTHER"

Whether the account holder is a natural person or a legal entity.

"NATURAL_PERSON"

"LEGAL_ENTITY"

"OTHER"

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 When a null/undefined value is observed, it indicates it does not apply.

account_balances: object { account_id, buying_power, currency, 18 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: base buying power plus the open order adjustment, where base buying power is maintenance margin excess times the multiplier for intraday and initial margin excess times the multiplier for overnight.

currency: string

Currency identifier for all monetary values.

daily_change: string

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

daily_pnl: string

Total profit or loss since start of day.

daily_realized_pnl: string

Realized 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: cash plus long market value plus short market value, where short market value is negative.

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

Buying power correction from open orders, computed as projected buying power minus actual buying power. A negative value means open orders are consuming buying power.

settled_cash: string

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

sod: object { buying_power, equity, long_market_value, 5 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. When a null/undefined value is observed, it indicates that there is no available data.

maintenance_margin_excess: optional string

Start-of-day maintenance margin excess: the difference between equity and the maintenance margin requirement. When a null/undefined value is observed, it indicates it does not apply.

maintenance_margin_requirement: optional string

Start-of-day maintenance margin requirement: the amount of equity required to maintain current positions. When a null/undefined value is observed, it indicates it does not apply.

trade_cash: optional string

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

trade_cash: string

Trade-date effective cash.

unrealized_pnl: string

Total unrealized profit or loss across all open positions.

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 { initial_margin_excess, initial_margin_requirement, intraday_details, 5 more }

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

initial_margin_excess: string

The difference between equity and the initial margin requirement.

initial_margin_requirement: string

The amount of equity required to open new positions.

intraday_details: object { buying_power, multiplier }

Intraday session margin calculation details.

buying_power: string

Maximum buying power available in the account during the session: base buying power plus the open order adjustment, where base buying power is maintenance margin excess times the multiplier for intraday and initial margin excess times the multiplier for overnight.

multiplier: optional string

Margin multiplier for the session: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session.

maintenance_margin_excess: string

The difference between equity and the maintenance margin requirement.

maintenance_margin_requirement: string

The amount of equity required to maintain current positions.

overnight_details: object { buying_power, multiplier }

Overnight session margin calculation details.

buying_power: string

multiplier: optional string

Margin multiplier for the session: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session.

top_contributors: optional array of MarginTopContributor { initial_margin_requirement, maintenance_margin_requirement, market_value, underlying_instrument_id }

Optional top margin contributors, returned only when explicitly requested.

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. When a null/undefined value is observed, it indicates that there is no available data.

total: string

The total margin available in the current model.

used: string

The amount of margin that is currently being utilized.

multiplier: optional string

Margin multiplier: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session. When a null/undefined value is observed, it indicates it does not apply.

short_market_value: optional string

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.

account_balances_sod: object { buying_power, equity, long_market_value, 5 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. When a null/undefined value is observed, it indicates that there is no available data.

maintenance_margin_excess: optional string

Start-of-day maintenance margin excess: the difference between equity and the maintenance margin requirement. When a null/undefined value is observed, it indicates it does not apply.

maintenance_margin_requirement: optional string

Start-of-day maintenance margin requirement: the amount of equity required to maintain current positions. When a null/undefined value is observed, it indicates it does not apply.

trade_cash: optional string

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

account_holder_entity_kind: "NATURAL_PERSON" or "LEGAL_ENTITY" or "OTHER"

Whether an account holder is a natural person or a legal entity.

"NATURAL_PERSON"

"LEGAL_ENTITY"

"OTHER"

account_list: array of Account { id, account_holder_entity_id, account_holder_entity_kind, 8 more }

id: number

The unique identifier for the account

account_holder_entity_id: number

The account holder entity identifier

account_holder_entity_kind: "NATURAL_PERSON" or "LEGAL_ENTITY" or "OTHER"

Whether the account holder is a natural person or a legal entity.

"NATURAL_PERSON"

"LEGAL_ENTITY"

"OTHER"

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 When a null/undefined value is observed, it indicates it does not apply.

account_settings: object { risk }

risk: optional object { max_notional }

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

max_notional: optional string

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

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"

account_with_personal_details: object { id, account_holder_entity_id, account_holder_entity_kind, 12 more }

Represents a trading account

id: number

The unique identifier for the account

account_holder_entity_id: number

The account holder entity identifier

account_holder_entity_kind: "NATURAL_PERSON" or "LEGAL_ENTITY" or "OTHER"

Whether the account holder is a natural person or a legal entity.

"NATURAL_PERSON"

"LEGAL_ENTITY"

"OTHER"

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 When a null/undefined value is observed, it indicates it does not apply.

country_of_tax_residency: optional string

The country of tax residency of the account-holder entity. null when not on file or entity reference data is unavailable. When a null/undefined value is observed, it indicates that there is no available data.

date_of_birth: optional string

The date of birth of the account holder’s primary contact. null when not on file or entity reference data is unavailable. When a null/undefined value is observed, it indicates that there is no available data.

mailing_address: optional object { city, country, line1, 3 more }

The mailing address of the account-holder entity. null when no mailing address is on file or entity reference data is unavailable. When a null/undefined value is observed, it indicates that there is no available data.

city: string

City

country: string

Country

line1: string

First street address line

postal_code: string

Postal code

line2: optional string

Second street address line When a null/undefined value is observed, it indicates it does not apply.

state: optional string

State or province When a null/undefined value is observed, it indicates it does not apply.

phone_number: optional string

The phone number of the account holder’s primary contact. null when not on file or entity reference data is unavailable. When a null/undefined value is observed, it indicates that there is no available data.

address: object { city, country, line1, 3 more }

A postal address.

city: string

City

country: string

Country

line1: string

First street address line

postal_code: string

Postal code

line2: optional string

Second street address line When a null/undefined value is observed, it indicates it does not apply.

state: optional string

State or province When a null/undefined value is observed, it indicates it does not apply.

margin_details: object { initial_margin_excess, initial_margin_requirement, intraday_details, 5 more }

initial_margin_excess: string

The difference between equity and the initial margin requirement.

initial_margin_requirement: string

The amount of equity required to open new positions.

intraday_details: object { buying_power, multiplier }

Intraday session margin calculation details.

buying_power: string

multiplier: optional string

Margin multiplier for the session: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session.

maintenance_margin_excess: string

The difference between equity and the maintenance margin requirement.

maintenance_margin_requirement: string

The amount of equity required to maintain current positions.

overnight_details: object { buying_power, multiplier }

Overnight session margin calculation details.

buying_power: string

multiplier: optional string

Margin multiplier for the session: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session.

top_contributors: optional array of MarginTopContributor { initial_margin_requirement, maintenance_margin_requirement, market_value, underlying_instrument_id }

Optional top margin contributors, returned only when explicitly requested.

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. When a null/undefined value is observed, it indicates that there is no available data.

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_session_details: object { buying_power, multiplier }

buying_power: string

multiplier: optional string

Margin multiplier for the session: 4 during intraday sessions (pre-market, regular, and after-hours) and 2 during the overnight session.

margin_top_contributor: object { initial_margin_requirement, maintenance_margin_requirement, market_value, underlying_instrument_id }

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 When a null/undefined value is observed, it indicates that there is no available data.