Assets #

The assets API serves as the master list of assets available for trade and data consumption from Alpaca. Assets are sorted by asset class, exchange and symbol. Some assets are only available for data consumption via Polygon, and are not tradable with Alpaca. These assets will be marked with the flag tradable=false.

Get assets

GET /v2/assets

Get a list of assets

Parameters

Query Parameters

Attribute	Type	Requirement	Description
`status`	string	Optional	e.g. “active”. By default, all statuses are included.
`asset_class`	string	Optional	Defaults to `us_equity`.
`exchange`	string	Optional	`AMEX`, `ARCA`, `BATS`, `NYSE`, `NASDAQ`, `NYSEARCA` or `OTC`

Response

An array of Asset object

Get assets/:id

GET /v2/assets/:id

Assets returned from this endpoint will have the same new fields marginable, shortable, and easy_to_borrow as the /assets endpoint.

Response

Get an asset

GET /v2/assets/{symbol}

Get an asset for the given symbol.

Parameters

Path Parameters

Attribute	Type	Requirement	Description
`symbol`	string	Optional	symbol or asset_id

Response

An Asset object

Errors

404 Not found

Asset is not found.

Asset Entity #

Example #

{
  "id": "904837e3-3b76-47ec-b432-046db621571b",
  "class": "us_equity",
  "exchange": "NASDAQ",
  "symbol": "AAPL",
  "status": "active",
  "tradable": true,
  "marginable": true,
  "shortable": true,
  "easy_to_borrow": true,
  "fractionable": true
}

Properties #

Attribute	Type	Description
`id`	string<uuid>	Asset ID.
`class`	string	“us_equity”
`exchange`	string	`AMEX`, `ARCA`, `BATS`, `NYSE`, `NASDAQ` or `NYSEARCA`
`symbol`	string
`status`	string	`active` or `inactive`
`tradable`	boolean	Asset is tradable on Alpaca or not.
`marginable`	boolean	Asset is marginable or not.
`shortable`	boolean	Asset is shortable or not.
`easy_to_borrow`	boolean	Asset is easy-to-borrow or not (filtering for easy_to_borrow = True is the best way to check whether the name is currently available to short at Alpaca).
`fractionable`	boolean	Asset is fractionable or not.