Watchlists

Get Watchlist Details

Returns watchlist details along with a paginated list of its companies, ordered alphabetically by company name. Hidden and unverified companies are excluded. Requires the read:watchlist scope.

get/api/v1/watchlists/{id}

Request

Path parameters

idstring required

Watchlist ID (e.g. a1b2c3d4e5f6).

Query parameters

limitinteger

Number of companies to return per page (default 25, max 100).

cursorstring

Opaque pagination cursor returned as pagination.next_cursor from a previous response.

Headers

If-None-Matchstring

ETag value from a previous response. Returns 304 Not Modified if data has not changed.

If-Modified-Sincestring

HTTP date from a previous Last-Modified header. Returns 304 Not Modified if nothing has changed since.

Response

Watchlist retrieved successfully

Example response

{
  "watchlist": {
    "id": "a1b2c3d4e5f6",
    "name": "Tech Stocks",
    "company_count": 12,
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-03-01T14:00:00Z"
  },
  "companies": [
    {
      "id": "w55fcw3pbg3p",
      "name": "Volvo Car AB",
      "slug": "VOLCAR-B",
      "ticker": "VOLCAR-B",
      "former_tickers": [
        "VOLV"
      ],
      "is_active": true,
      "market_segment": "large_cap",
      "also_listed_on": []
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.