Sign in

v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB
Watchlists

Get default watchlist items

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

Retrieves items from user's default watchlists with optional pagination.

get/api/v1/watchlists/default-watchlists/items

Query parameters

itemsLimitinteger

Maximum number of items to return

itemsPerPageinteger

Number of items per page for pagination

Headers

x-request-idstring uuid required
Example:c0f9c02a-1ed3-4295-9770-df0ed58d1af1

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 default watchlist items

itemIdinteger required

Unique identifier of the financial instrument

itemTypestring required

Type of the financial instrument (e.g., 'Instrument', 'Person')

itemRankinteger

Ranking position of the item in the watchlist

itemAddedReasonstring

Reason the item was added to the watchlist

itemAddedDatestring date-time

Date and time the item was added

Example response

[
  {
    "itemId": 12345,
    "itemType": "Instrument",
    "itemRank": 1,
    "itemAddedReason": "Manual"
  }
]