Skip to main content
GET

alpaca_list_assets

Options
  • include / exclude: filter which tools are exposed (use full names like alpaca_list_assets).
  • 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

symbol
string
required

Ticker symbol or asset symbol.

provider
string | null

Trading provider identifier. Omitted when minimal=True.

id
string | null

Provider asset id when available.

name
string | null

Human-readable asset name when available.

exchange
string | null

Exchange code when available (provider dependent).

asset_class
string | null

Canonical asset class when available. Some providers use different naming (e.g. Alpaca uses 'class').

status
string | null

Provider status when available (e.g. 'active', 'inactive').

tradable
boolean | null

Whether the asset is tradable on the provider, if known.

marginable
boolean | null

Whether the asset is marginable on the provider, if known.

shortable
boolean | null

Whether the asset is shortable on the provider, if known.

easy_to_borrow
boolean | null

Whether the asset is easy-to-borrow on the provider, if known.

fractionable
boolean | null

Whether fractional trading is supported on the provider, if known.

provider_fields
object

Additional provider-specific fields. Omitted when minimal=True