Skip to main content
GET

alpaca_list_positions

Options
  • include / exclude: filter which tools are exposed (use full names like alpaca_list_positions).
  • minimal: omit provider and provider_fields when True.
  • paper: use Alpaca paper trading instead of live trading.

Body

application/json

This is a request to obtain information. Your API keys are required.

Response

Positions (OpenTools trading schema).

provider
string | null

Trading provider identifier. Omitted when minimal=True.

symbol
string

Instrument symbol (e.g. "AAPL", "BTCUSD").

qty
string | null

Position size.

avg_entry_price
string | null

Average entry price.

current_price
string | null

Latest price used for valuation.

market_value
string | null

Current position market value.

unrealized_pl
string | null

Unrealized profit/loss.

unrealized_plpc
string | null

Unrealized profit/loss percent (factor of 1, not 100).

side
enum<string> | null

Position direction.

Available options:
long,
short
provider_fields
object

Extra provider-specific fields (omitted when minimal=True).