Holding
A position in a brokerage account. Get holdings returns an array of holdings.
Note
Enrichment fields like market_price can be absent or null when a brokerage does not supply them. warning says why.
Fields
Stable identifier for the position: the normalized symbol, or the compact OCC symbol for options.
Normalized ticker, crypto pair, or OCC option symbol.
Symbol to show users.
Shares, coins, or contracts held. Negative for a short position.
Brokerage-specific legacy value. Use average_unit_cost.
Average cost per share, coin, or option share, before multiplier. Null when the brokerage does not report it.
Name of the security, such as Cloudflare, Inc.
Asset type: 2 for stocks and options, 4 for crypto.
0248Whether the position is long or short.
longshortWhether the position is an equity, crypto, or option.
equitycryptooptionThe option's OCC symbol as the brokerage reports it.
Shares each unit controls: 100 for standard options, 1 otherwise.
quantity × average_unit_cost × multiplier.
Current price per share, coin, or option share. Null when no price is available.
quantity × market_price × multiplier.
market_value minus total_cost.
unrealized_pnl as a percent of total_cost, such as 12.5 for 12.5%.
Where market_price came from. midpoint is the option bid/ask midpoint.
last_trademinute_closemidpointbrokerageunavailableWhen market_price was observed.
Whether market_price is delayed.
The option's underlying ticker.
Why a value is missing, such as Current price unavailable.
Balance
Money fields are Balance objects.
Amount in currency.
ISO 4217 currency code, such as USD.