Skip to main content
GET
Get single public watchlist

Authorizations

x-api-key
string
header
default:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
default:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"c3dd407d-8b8f-4bd5-b60b-e849bb93b250"

Path Parameters

userId
integer<int32>
required

User ID who owns the watchlist

watchlistId
string
required

Unique identifier of the watchlist

Query Parameters

pageNumber
integer<int32>
default:0

Page number for pagination

itemsPerPage
integer<int32>
default:100

Number of items per page

Response

Successfully retrieved public watchlist

Represents a watchlist with its metadata and items

watchlistId
string

Unique identifier of the watchlist

Example:

"12345"

name
string

Display name of the watchlist

Example:

"Tech Watchlist"

Gcid
integer<int32>

Global Customer ID of the watchlist owner

Example:

12345

watchlistType
enum<string>

Type of the watchlist

Available options:
Static,
Dynamic,
RecentlyInvested,
Default
Example:

"Static"

totalItems
integer<int32>

Total number of items in the watchlist

Example:

100

isDefault
boolean

Whether this is a default system watchlist

Example:

true

isUserSelectedDefault
boolean

Whether this is the user's selected default watchlist

Example:

true

watchlistRank
integer<int32>

Display order rank of the watchlist

Example:

1

dynamicUrl
string | null

URL for dynamic watchlist queries

items
object[]

Items contained in the watchlist

Example:

Related asset IDs

Example: