Skip to content
Start Trading

Trading Account Metrics

Learn about account metrics like balance, positions, and portfolio history.

Balances endpoint gives you a real-time view of your account’s financial state. There is an optional query parameter called top_margin_contributors_limit which provides the top margin contributors for your account.

Data Fields

FieldTypeDescription
account_idintegerAccount identifier.
buying_powerdecimal stringProjected buying power available after current positions and risk-increasing open orders.
currencystringCurrency for monetary values, USD.
daily_realized_pnldecimal stringRealized daily P&L, calculated as daily_total_pnl - daily_unrealized_pnl.
daily_total_pnldecimal stringTotal daily P&L, calculated as current equity minus start-of-day equity.
daily_unrealized_pnldecimal stringTotal unrealized P&L across positions versus prior close.
equitydecimal stringCurrent trade-date account equity based on cash and positions. trade_cash + long_market_value - short_market_value
long_market_valuedecimal stringCurrent market value of long positions, excluding cash.
margin_typestringAccount margin model, such as NONE, REG_T, or PORTFOLIO_MARGIN.
open_order_adjustmentdecimal stringBuying-power adjustment from open orders.Negative means open orders are consuming buying power.
settled_cashdecimal stringSettle-date cash balance.
sodobjectStart-of-day balance snapshot.
trade_cashdecimal stringTrade-date cash balance.
unsettled_creditsdecimal stringTrade-date unsettled cash credits.
unsettled_debitsdecimal stringTrade-date unsettled cash debits.
withdrawable_cashstringThe amount of cash currently available to withdraw.
margin_detailsobject, optionalReg T margin-specific details. Omitted for non-Reg T accounts.
multiplierdecimal string, optionalEffective margin multiplier. Present for Reg T accounts.
short_market_valuedecimal stringCurrent market value of short positions, excluding cash.
FieldTypeDescription
buying_powerdecimal stringStart-of-day buying power. For cash accounts, this maps to SOD cash.
equitydecimal stringStart-of-day account equity.
long_market_valuedecimal stringStart-of-day long market value.
short_market_valuedecimal stringStart-of-day short market value.
asofdate, optionalDate of the start-of-day snapshot.
day_trade_buying_powerdecimal string, optionalDeprecated legacy field indicating start-of-day day-trade buying power. Reg T/PDT only.
maintenance_margin_excessdecimal string, optionalStart-of-day maintenance margin excess. Reg T only.
maintenance_margin_requirementdecimal string, optionalStart-of-day maintenance margin requirement. Reg T only.
trade_cashdecimal string, optionalStart-of-day trade cash. Reg T only.

Margin Details Fields

FieldTypeDescription
day_trade_countintegerDeprecated legacy field indicating number of day trades over the five most recent trading days.
initial_margin_excessdecimal stringCurrent equity above initial margin requirement.
initial_margin_requirementdecimal stringCurrent initial margin requirement.
maintenance_margin_excessdecimal stringCurrent maintenance margin excess.
maintenance_margin_requirementdecimal stringCurrent maintenance margin requirement.
pattern_day_traderbooleanDeprecated legacy field indicating whether the account is currently flagged as a Pattern Day Trader.
day_trade_buying_power_usagedecimal string, optionalDeprecated legacy field indicating day-trade buying power used today.
top_contributorsarray, optionalTop per-underlying margin contributors. Returned only when requested with top_margin_contributors_limit.
usageobject, optionalCurrent margin usage totals.

Margin Details Usage Fields

FieldTypeDescription
totaldecimal stringTotal available capacity, calculated as used plus excess.
useddecimal stringAmount of margin or day-trade buying power currently being used.

Margin Details Top Contributors

FieldTypeDescription
day_trade_buying_power_usagestringDeprecated legacy field indicating day-trade buying power consumed by fills against this underlying on the current trade date. Populated only for pattern day trader accounts.
initial_margin_requirementdecimal stringInitial margin requirement attributable to this underlying.
maintenance_margin_requirementdecimal stringMaintenance margin requirement attributable to this underlying.
market_valuedecimal stringNet market value attributable to this underlying.
underlying_instrument_idUUID stringUnderlying instrument contributing to margin requirement.

The Positions API lets clients retrieve current account holdings. It also supports close-position workflows that submit market DAY orders to flatten one or all non-cash positions, with trade permission required for those actions.

NameMethodPathDescription
List PositionsGET/v1/accounts/{account_id}/positionsReturns current positions for the account, with optional filtering, sorting, and pagination. Requires view permission.
Close PositionDELETE/v1/accounts/{account_id}/positions/{instrument_id}Submits a market DAY order to flatten one non-cash position for the specified instrument. Optionally cancels related open orders first. Important to note that if there are open orders close positon will reject unless open orders are canceled.
Close PositionsDELETE/v1/accounts/{account_id}/positionsSubmits market DAY orders to flatten all non-cash positions in the account. Optionally cancels related open orders first. Important to note that if there are open orders close positons will reject unless open orders are canceled.

The list positions endpoint returns your current holdings, including real-time P&L calculations.

List Positions Query Parameters

ParameterTypeRequiredDescription
instrument_idsstringNoComma-separated instrument UUIDs
page_sizeintegerNoNumber of positions to return. Defaults to 1000; maximum 1000.
page_tokenstringNoPagination token from metadata.next_page_token or metadata.previous_page_token.
sort_byenumNoOne of SYMBOL, INSTRUMENT_TYPE, QUANTITY, MARKET_VALUE, POSITION_TYPE, UNREALIZED_PNL, or DAILY_UNREALIZED_PNL. Defaults to SYMBOL.
sort_directionenumNoASC or DESC. Defaults to ASC.

List Positions Response

FieldDescription
account_idAccount that owns the position.
available_quantityQuantity currently available to act on. May differ from quantity due to open orders or other constraints.
instrument_idUUID for an instrument
instrument_typeInstrument type, such as COMMON_STOCK, OPTION, or CASH.
market_valueCurrent market value.
position_typePosition direction, such as LONG or SHORT.
quantitySigned position quantity. Positive is long; negative is short.
symbolDisplay symbol. For cash positions, this is usually the currency, such as USD.
avg_priceAverage position price, when available.
closing_pricePrevious close price used for valuation, when available.
closing_price_dateThe market date associated with closing_price
cost_basisTotal cost basis, when available.
daily_unrealized_pnlCurrent-day unrealized P&L, when available.
daily_unrealized_pnl_pctCurrent-day unrealized P&L percentage, when available.
instrument_priceCurrent market price, of the instrument.
underlying_instrument_idUnderlying instrument ID for options, when available.
unrealized_pnlTotal unrealized P&L, when available.
unrealized_pnl_pctTotal unrealized P&L percentage, when available.

Closes an open position positions.

Close One Path Parameters

ParameterTypeRequiredDescription
account_idintegerYesClear Street account identifier.
instrument_idstringYesUUID for an instrument

Behavior

  • For a long position, a market DAY sell order is sent for the net quantity.
  • For a short position, a market DAY buy order for the absolute net quantity.
  • Cash positions and already-flat positions are skipped. If no order is needed, the endpoint returns an empty data array.

Close Position Response

Returns order status for generated order.

Closes all positions

Behavior

Evaluates every current non-cash position in the account and submits market DAY orders to flatten them. Long positions generate sell orders. Short positions generate buy orders. Cash positions and already-flat positions are skipped.

Get portfolio history endpoint returns daily snapshots of your account equity, letting you track performance over time. Each snapshot includes the opening equity, closing equity, and daily P&L for that trading day.

ParameterTypeRequiredDescription
start_datedateYesInclusive start date in YYYY-MM-DD format.
end_datedateNoInclusive end date in YYYY-MM-DD format. Must be on or before the current UTC date.

Note start_date must be on or before end_date.

When end_date is the current UTC date, the response includes an intraday segment computed from current balances. Some fields for that segment may be null because finalized order-flow, adjustment, dividend, accrual, income, or expense data may not yet be available.

The response may contain fewer segments than calendar days in the requested range. Non-trading days or dates with no available account history may be omitted.

FieldDescription
dateDate for the segment.
eod_equityEquity at the end of the trading day, or current intraday equity for the current-day segment.
realized_pnlP&L realized from position-closing activity.
sod_equityEquity at the start of the trading day.
unrealized_pnlP&L from market changes.
bought_notionalMark-to-market amount bought, when available.
day_pnlP&L from intraday trading activity, when available.
net_pnlNet P&L after realized P&L, unrealized P&L, adjustments, dividends, accrual changes, income, and expenses, when available.
position_pnlP&L attributable to start-of-day carried positions, when available.
sold_notionalMark-to-market amount sold, when available.

Monetary values are returned as decimal strings. Nullable fields are returned as null when unavailable.