Sign in

v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB
Watchlists

Get single public watchlist

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
  • GET /api/v1/watchlists/default-watchlists/items
  • GET /api/v1/watchlists/public/{userId}
  • GET /api/v1/watchlists/{watchlistId}

Retrieves a specific public watchlist from a user.

get/api/v1/watchlists/public/{userId}/{watchlistId}

Path parameters

userIdinteger required

User ID who owns the watchlist

watchlistIdstring required

Unique identifier of the watchlist

Query parameters

pageNumberinteger

Page number for pagination

itemsPerPageinteger

Number of items per page

Headers

x-request-idstring uuid required
Example:c33925a4-3b72-4da3-8d99-2e810cf6051b

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 public watchlist

watchlistIdstring

Unique identifier of the watchlist

namestring

Display name of the watchlist

Gcidinteger

Global Customer ID of the watchlist owner

watchlistType'Static' | 'Dynamic' | 'RecentlyInvested' | 'Default'

Type of the watchlist

totalItemsinteger

Total number of items in the watchlist

isDefaultboolean

Whether this is a default system watchlist

isUserSelectedDefaultboolean

Whether this is the user's selected default watchlist

watchlistRankinteger

Display order rank of the watchlist

dynamicUrlstring nullable

URL for dynamic watchlist queries

relatedAssetsinteger[] nullable

Related asset IDs

Example response

{
  "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
  ]
}