The watchlist API provides CRUD operation for the account’s watchlist. An account can have multiple watchlists and each is uniquely identified by id but can also be addressed by user-defined name. Each watchlist is an ordered list of assets.
Sample Watchlist
{
"account_id": "1d5493c9-ea39-4377-aa94-340734c368ae",
"assets": [
{
"class": "us_equity",
"easy_to_borrow": true,
"exchange": "ARCA",
"id": "b28f4066-5c6d-479b-a2af-85dc1a8f16fb",
"marginable": true,
"shortable": true,
"status": "active",
"symbol": "SPY",
"tradable": true
},
{
"class": "us_equity",
"easy_to_borrow": false,
"exchange": "NASDAQ",
"id": "f801f835-bfe6-4a9d-a6b1-ccbb84bfd75f",
"marginable": true,
"shortable": false,
"status": "active",
"symbol": "AMZN",
"tradable": true
}
],
"created_at": "2019-10-30T07:54:42.981322Z",
"id": "fb306e55-16d3-4118-8c3d-c1615fcd4c03",
"name": "Monday List",
"updated_at": "2019-10-30T07:54:42.981322Z"
}
Properties
| Attribute | Type | Description |
|---|---|---|
| id | string | The watchlist id |
| created_at | string | Timestamp for when the watchlist was created |
| updated_at | string | Timestamp for when the watchlist was updated |
| name | string | The name of the watchlist |
| account_id | string | The account_id to which the watchlist belongs |
| assets | Array of asset objects | The content of this watchlist, in the order as registered by the client |
Alternative/Valid Endpoint
You can also call GET, PUT, POST and DELETE with watchlist name with another endpoint /v2/watchlists:by_name and query parameter name=<watchlist_name>, instead of /v2/watchlists/{watchlist_id} endpoints.