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.
Get assets
GET /v2/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 |
attributes |
string | Optional |
Comma separated values to query for more than one attribute. |
Response
An array of Asset objectGet an asset by id or symbol
GET /v2/assets/{symbol_or_asset_id}
Get the asset model for a given symbol
or asset_id
. The symbol
or asset_id
should be passed in as a path parameter.
Note: For crypto, the symbol has to follow old symbology, e.g. BTCUSD
.
Note: For coin pairs, the symbol should be separated by spare symbol (/
), e.g. BTC/USDT
. Since spare is a special character in HTTP, use the URL encoded version instead, e.g. /v2/assets/BTC%2FUSDT
Parameters
Path Parameters
Attribute | Type | Requirement | Description |
---|---|---|---|
symbol or asset id |
string | Required |
symbol or asset_id |
Response
An Asset objectErrors
Asset Entity #
Currently, two classes of assets exist: us_equity
and crypto
.
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,
"attributes": ["ptp_no_exception"],
}
Properties #
Attribute | Type | Description |
---|---|---|
id |
string<uuid> | Asset ID. |
class |
string | “us_equity” |
exchange |
string | AMEX , ARCA , BATS , NYSE , NASDAQ or NYSEARCA |
symbol |
string | |
name |
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. |
maintenance_margin_requirement |
string | Shows the % margin requirement for the asset (equities only). |
attributes |
array | One of ptp_no_exception or ptp_with_exception . We will include unique characteristics of the asset here. |
Crypto Example #
{
"id": "276e2673-764b-4ab6-a611-caf665ca6340",
"class": "crypto",
"exchange": "FTXU",
"symbol": "BTC/USD",
"name": "Bitcoin / US Dollar",
"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<uuid> | Asset ID. |
class |
string | crypto |
exchange |
string | FTXU |
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). |
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. |