Get Watchlist by Name
GET {{baseUrl}}/v2/watchlists:by_name?name=
You can also call GET, PUT, POST and DELETE with watchlist name with another endpoint /v2/watchlists:byname and query parameter name=<watchlistname>, instead of /v2/watchlists/{watchlist_id} endpoints
Returns a watchlist by name
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
name | null | (Required) name of the watchlist |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
Apca-Api-Key-Id | string | ||
Apca-Api-Secret-Key | string |
RESPONSES
status: OK
{"id":"3d4933d1-12d3-4777-af29-40c4f3c50a3d","account_id":"75b4e7d9-3e50-4df9-a8bb-5b6dc5fa7e59","created_at":"2024-03-27T01:58:39.253016Z","updated_at":"2024-03-27T20:46:35.273027Z","name":"us_equity","assets":[{"id":"bea0f181-afd8-4bd2-9486-85d3fc2f10d7","class":"us_equity","exchange":"NYSE","symbol":"UBER","name":"Uber Technologies, Inc.","status":"active","tradable":true,"marginable":true,"maintenance_margin_requirement":0,"shortable":true,"easy_to_borrow":true,"fractionable":true,"attributes":null},{"id":"b0b6dd9d-8b9b-48a9-ba46-b9d54906e415","class":"us_equity","exchange":"NASDAQ","symbol":"AAPL","name":"Apple Inc. Common Stock","status":"active","tradable":true,"marginable":true,"maintenance_margin_requirement":0,"shortable":true,"easy_to_borrow":true,"fractionable":true,"attributes":null}]}