Positions

The positions API provides information about an account’s current open positions. The response will include information such as cost basis, shares traded, and market value, which will be updated live as price information is updated. Once a position is closed, it will no longer be queryable through this API.

Sample Position Object

{
  "asset_id": "904837e3-3b76-47ec-b432-046db621571b",
  "symbol": "AAPL ",
  "exchange": "NASDAQ",
  "asset_class": "us_equity",
  "avg_entry_price": "100.0",
  "qty": "5",
  "qty_available": "4",
  "side": "long",
  "market_value": "600.0",
  "cost_basis": "500.0",
  "unrealized_pl": "100.0",
  "unrealized_plpc": "0.20",
  "unrealized_intraday_pl": "10.0",
  "unrealized_intraday_plpc": "0.0084",
  "current_price": "120.0",
  "lastday_price": "119.0",
  "change_today": "0.0084"
}

Properties

AttributeTypeDescription
asset_idstringThe ID of the asset
symbolstringThe symbol of the position
exchangestringThe exchange in which the position trades
asset_classstringThe asset_class of the position. Can either be us_equity or crypto.
avg_entry_pricestringAverage entry price of the position
qtystringThe number of shares
qty_availablestringTotal number of shares available minus open orders
sidestringEither long or short
market_valuestringTotal dollar amount of the position
cost_basisstringTotal cost basis in dollar
unrealized_plstringUnrealized profit/loss in dollars
unrealized_plpcstringUnrealized profit/loss percent (by a factor of 1)
unrealized_intraday_plstringUnrealized profit/loss in dollars for the day
unrealized_intraday_plpcstringUnrealized profit/loss percent (by a factor of 1)
current_pricestringCurrent asset price per share
lastday_pricestringLast day’s asset price per share based on the closing value of the last trading day
change_todaystringLast day’s asset price per share based on the closing value of the last trading day