Alpha AnalystDocs
API Portal

Update Watchlist API

Platform-linked

Platform-linked: the key’s login needs an API plan and a website plan with watchlists; ApiKey only. How this works.

Update watchlist membership—add or remove up to 20 company ids per call on one list; remove runs before add. Same ids as Entity Reference.

curl -X POST "https://example.com/v2/watchlists/update" \  -H "Content-Type: application/json" \  -d '{    "watchlist_id": "string"  }'
{  "watchlist_id": "string",  "added": [    {      "id": "string",      "entity": {        "name": "string",        "name_short": "string",        "full_ticker": "string",        "normalized_ticker": "string",        "exchange_code": "string",        "composite_code": "string",        "backlink_url": "string",        "category": "string",        "cik": "string",        "edinet_code": "string",        "lei": "string",        "crd_number": "string",        "series_id": "string",        "internal_id": "string",        "figi": "string",        "composite_figi": "string",        "share_class_figi": "string",        "entity_is_public": 0,        "is_person": 0,        "is_actively_trading": 0,        "sec_type": "string",        "sec_type2": "string",        "market_sector": "string",        "generic_sic_code": "string",        "score": 0,        "resolved": true,        "filer_type": "string",        "fy": "string",        "q": "string"      }    }  ],  "removed": [    {      "id": "string",      "entity": {        "name": "string",        "name_short": "string",        "full_ticker": "string",        "normalized_ticker": "string",        "exchange_code": "string",        "composite_code": "string",        "backlink_url": "string",        "category": "string",        "cik": "string",        "edinet_code": "string",        "lei": "string",        "crd_number": "string",        "series_id": "string",        "internal_id": "string",        "figi": "string",        "composite_figi": "string",        "share_class_figi": "string",        "entity_is_public": 0,        "is_person": 0,        "is_actively_trading": 0,        "sec_type": "string",        "sec_type2": "string",        "market_sector": "string",        "generic_sic_code": "string",        "score": 0,        "resolved": true,        "filer_type": "string",        "fy": "string",        "q": "string"      }    }  ],  "unresolved": [    "string"  ]}
POST
/v2/watchlists/update

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

watchlist_id*string

Watchlist id from Watchlists.

Length1 <= length <= 20
add?array<Entity Id>

Catalog ids to add. Same ids as Entity Reference. At most 20. Optional when remove is set.

Items1 <= items <= 20
remove?array<Entity Id>

Catalog ids to remove. Same ids as Entity Reference, or the id returned by Watchlist Entities. At most 20. Optional when add is set.

Items1 <= items <= 20

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json