v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB

Watchlists

Update items in watchlist

Rate limit: 20 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:

DELETE /api/v1/watchlists/{watchlistId}
DELETE /api/v1/watchlists/{watchlistId}/items
POST /api/v1/watchlists
POST /api/v1/watchlists/default-watchlist/selected-items
POST /api/v1/watchlists/newasdefault-watchlist
POST /api/v1/watchlists/{watchlistId}/items
PUT /api/v1/watchlists/rank/{watchlistId}
PUT /api/v1/watchlists/setUserSelectedUserDefault/{watchlistId}
PUT /api/v1/watchlists/{watchlistId}

Updates existing items in a watchlist (rank, etc.).

put/api/v1/watchlists/{watchlistId}/items

Path parameters

watchlistIdstring required

Unique identifier of the watchlist

Headers

x-request-idstring uuid required

Example:4a3c2c64-7efd-42e1-98bc-1707b7e888c7

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.

Request body

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 request

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

Response

Items updated successfully