Sign in

v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB
Watchlists

Get user watchlists

Rate limit: 60 requests per 60 seconds. This is a shared quota — the same budget is consumed by a group of related endpoints, so calling any of them reduces what is left for the others (you cannot call each at the full rate independently). Endpoints sharing this quota:

  • GET /api/v1/watchlists/default-watchlists/items
  • GET /api/v1/watchlists/public/{userId}
  • GET /api/v1/watchlists/public/{userId}/{watchlistId}
  • GET /api/v1/watchlists/{watchlistId}

Retrieves all watchlists for the authenticated user with optional pagination and built-in watchlist management.

get/api/v1/watchlists

Query parameters

itemsPerPageForSingleinteger
Example:100

Number of items to include per watchlist for pagination

ensureBuiltinWatchlistsboolean
Example:true

Whether to ensure built-in watchlists are included

addRelatedAssetsboolean

Whether to include related assets in the response

Headers

x-request-idstring uuid required
Example:8bb09dba-f340-4e35-99ac-3be86e53d295

A unique request identifier.

x-api-keystring password required
Example:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

API key for authentication.

x-user-keystring password required
Example:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

User-specific authentication key.

Response

Successfully retrieved user watchlists

statusinteger

HTTP status code of the response

isSucceededboolean

Whether the request succeeded

Example response

{
  "status": 200,
  "watchlists": [
    {
      "watchlistId": "12345",
      "name": "Tech Watchlist",
      "Gcid": 12345,
      "watchlistType": "Static",
      "totalItems": 100,
      "isDefault": true,
      "isUserSelectedDefault": true,
      "watchlistRank": 1,
      "items": [
        {
          "itemId": 12345,
          "itemType": "Instrument",
          "itemRank": 1
        }
      ],
      "relatedAssets": [
        12345,
        67890
      ]
    }
  ],
  "meta": {
    "itemsPerPage": 100,
    "maxItemsInWatchlistLimit": 1000,
    "maxWatchlistsLimit": 10
  },
  "isSucceeded": true
}