Get Account Balances

$ clst v1:accounts get-account-balances

GET/v1/accounts/{account_id}/balances

Fetch account balance information

ParametersExpand Collapse

--account-id: number

Account identifier

--top-margin-contributors-limit: optional number

Limit the number of top margin contributors returned.

ReturnsExpand Collapse

V1AccountGetAccountBalancesResponse: BaseResponse { metadata, error }

data: 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.

Get Account Balances

clst v1:accounts get-account-balances \
  --api-key 'My API Key' \
  --account-id 0

{
  "data": {
    "account_id": 19816,
    "buying_power": "45000.00",
    "currency": "USD",
    "daily_change": "0.00",
    "daily_pnl": "1250.00",
    "daily_realized_pnl": "700.00",
    "daily_unrealized_pnl": "550.00",
    "equity": "100000.00",
    "long_market_value": "30000.00",
    "margin_type": "NONE",
    "open_order_adjustment": "-5000.00",
    "settled_cash": "60000.00",
    "sod": {
      "asof": "2023-09-27",
      "buying_power": "45000.00",
      "equity": "100000.00",
      "long_market_value": "30000.00",
      "short_market_value": "0.00"
    },
    "trade_cash": "60000.00",
    "unrealized_pnl": "1500.00",
    "unsettled_credits": "20000.00",
    "unsettled_debits": "10000.00",
    "withdrawable_cash": "55000.00"
  },
  "error": null,
  "metadata": {
    "request_id": "b7e2d3f4-a1b2-4c3d-8e4f-5a6b7c8d9e0f"
  }
}

{
  "data": {
    "account_id": 19816,
    "buying_power": "90000.00",
    "currency": "USD",
    "daily_change": "0.00",
    "daily_pnl": "1250.00",
    "daily_realized_pnl": "700.00",
    "daily_unrealized_pnl": "550.00",
    "equity": "100000.00",
    "long_market_value": "40000.00",
    "margin_details": {
      "initial_margin_excess": "50000.00",
      "initial_margin_requirement": "50000.00",
      "intraday_details": {
        "buying_power": "90000.00",
        "multiplier": "2"
      },
      "maintenance_margin_excess": "75000.00",
      "maintenance_margin_requirement": "25000.00",
      "overnight_details": {
        "buying_power": "90000.00",
        "multiplier": "2"
      },
      "top_contributors": [
        {
          "initial_margin_requirement": "25000.00",
          "maintenance_margin_requirement": "15000.00",
          "market_value": "50000.00",
          "underlying_instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8"
        }
      ],
      "usage": {
        "total": "100000.00",
        "used": "5000.00"
      }
    },
    "margin_type": "REG_T",
    "multiplier": "2",
    "open_order_adjustment": "-10000.00",
    "settled_cash": "99775.05",
    "short_market_value": "10000.00",
    "sod": {
      "asof": "2023-09-27",
      "buying_power": "90000.00",
      "equity": "100000.00",
      "long_market_value": "40000.00",
      "maintenance_margin_excess": "50000.00",
      "maintenance_margin_requirement": "50000.00",
      "short_market_value": "10000.00",
      "trade_cash": "70000.00"
    },
    "trade_cash": "70000.00",
    "unrealized_pnl": "1500.00",
    "unsettled_credits": "20000.00",
    "unsettled_debits": "10000.00",
    "withdrawable_cash": "75000.00"
  },
  "error": null,
  "metadata": {
    "request_id": "b7e2d3f4-a1b2-4c3d-8e4f-5a6b7c8d9e0f"
  }
}

{
  "error": {
    "code": 403,
    "message": "The caller does not have permission to execute the specified operation"
  },
  "metadata": {
    "request_id": "5518f0c6-58ff-4b4a-81a5-701556d41206"
  }
}

{
  "error": {
    "code": 404,
    "message": "Some requested entity was not found"
  },
  "metadata": {
    "request_id": "67e95eb4-93b9-4010-8c9b-7ada7c2be93f"
  }
}

Returns Examples

{
  "data": {
    "account_id": 19816,
    "buying_power": "45000.00",
    "currency": "USD",
    "daily_change": "0.00",
    "daily_pnl": "1250.00",
    "daily_realized_pnl": "700.00",
    "daily_unrealized_pnl": "550.00",
    "equity": "100000.00",
    "long_market_value": "30000.00",
    "margin_type": "NONE",
    "open_order_adjustment": "-5000.00",
    "settled_cash": "60000.00",
    "sod": {
      "asof": "2023-09-27",
      "buying_power": "45000.00",
      "equity": "100000.00",
      "long_market_value": "30000.00",
      "short_market_value": "0.00"
    },
    "trade_cash": "60000.00",
    "unrealized_pnl": "1500.00",
    "unsettled_credits": "20000.00",
    "unsettled_debits": "10000.00",
    "withdrawable_cash": "55000.00"
  },
  "error": null,
  "metadata": {
    "request_id": "b7e2d3f4-a1b2-4c3d-8e4f-5a6b7c8d9e0f"
  }
}

{
  "data": {
    "account_id": 19816,
    "buying_power": "90000.00",
    "currency": "USD",
    "daily_change": "0.00",
    "daily_pnl": "1250.00",
    "daily_realized_pnl": "700.00",
    "daily_unrealized_pnl": "550.00",
    "equity": "100000.00",
    "long_market_value": "40000.00",
    "margin_details": {
      "initial_margin_excess": "50000.00",
      "initial_margin_requirement": "50000.00",
      "intraday_details": {
        "buying_power": "90000.00",
        "multiplier": "2"
      },
      "maintenance_margin_excess": "75000.00",
      "maintenance_margin_requirement": "25000.00",
      "overnight_details": {
        "buying_power": "90000.00",
        "multiplier": "2"
      },
      "top_contributors": [
        {
          "initial_margin_requirement": "25000.00",
          "maintenance_margin_requirement": "15000.00",
          "market_value": "50000.00",
          "underlying_instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8"
        }
      ],
      "usage": {
        "total": "100000.00",
        "used": "5000.00"
      }
    },
    "margin_type": "REG_T",
    "multiplier": "2",
    "open_order_adjustment": "-10000.00",
    "settled_cash": "99775.05",
    "short_market_value": "10000.00",
    "sod": {
      "asof": "2023-09-27",
      "buying_power": "90000.00",
      "equity": "100000.00",
      "long_market_value": "40000.00",
      "maintenance_margin_excess": "50000.00",
      "maintenance_margin_requirement": "50000.00",
      "short_market_value": "10000.00",
      "trade_cash": "70000.00"
    },
    "trade_cash": "70000.00",
    "unrealized_pnl": "1500.00",
    "unsettled_credits": "20000.00",
    "unsettled_debits": "10000.00",
    "withdrawable_cash": "75000.00"
  },
  "error": null,
  "metadata": {
    "request_id": "b7e2d3f4-a1b2-4c3d-8e4f-5a6b7c8d9e0f"
  }
}

{
  "error": {
    "code": 403,
    "message": "The caller does not have permission to execute the specified operation"
  },
  "metadata": {
    "request_id": "5518f0c6-58ff-4b4a-81a5-701556d41206"
  }
}

{
  "error": {
    "code": 404,
    "message": "Some requested entity was not found"
  },
  "metadata": {
    "request_id": "67e95eb4-93b9-4010-8c9b-7ada7c2be93f"
  }
}