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.
The Asset Object
Equity Example
{
"id": "904837e3-3b76-47ec-b432-046db621571b",
"class": "us_equity",
"exchange": "NASDAQ",
"symbol": "AAPL",
"name": "Apple Inc. Common Stock",
"status": "active",
"tradable": true,
"marginable": true,
"shortable": true,
"easy_to_borrow": true,
"fractionable": true,
"maintenance_margin_requirement": 30,
}
Crypto Example
{
"id": "276e2673-764b-4ab6-a611-caf665ca6340",
"class": "crypto",
"exchange": "FTXU",
"symbol": "BTC/USD",
"name": "BTC/USD pair",
"status": "active",
"tradable": true,
"marginable": false,
"shortable": false,
"easy_to_borrow": false,
"fractionable": true,
"min_order_size": "0.0001",
"min_trade_increment": "0.0001",
"price_increment": "1"
}
Properties
Attribute | Type | Description |
---|---|---|
id | string | Asset ID |
class | string | Either us_equity or crypto |
exchange | string | The exchange in which the asset is traded (eg: NASDAQ, NYSE, CRXL, ...) |
symbol | string | Symbol of asset |
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). Field available for equities only. |
fractionable | boolean | Asset is fractionable or not. |
min_order_size | string | Minimum order size. Field available for crypto only. |
min_trade_increment | string | Amount a trade quantity can be incremented by. Field available for crypto only. |
price_increment | string | Amount the price can be incremented by. Field available for crypto only. |
maintenance_margin_requirement | int | Shows the % margin requirement for the asset. Field available for equities only. |
Retrieving All Assets
This API endpoint returns all assets available at Alpaca. We recommend caching the response, and querying regularly.
Request
Endpoint
GET /v2/assets
Response
Returns an array of asset objects.
Retrieving an Asset by ID or Symbol
Get the asset model for a given symbol
or asset_id
. The symbol
or asset_id
should be passed in as a path parameter.
Request
Endpoint
GET /v2/assets/{symbol_or_asset_id}
Path Parameter
Attribute | Type | Requirement | Description |
---|---|---|---|
symbol OR asset_id | string | Required | The symbol or asset_id being retrieved |
Response
Returns an asset object