v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB

Watchlists

Get curated lists

Rate limit: 60 requests per 60 seconds. This is a dedicated limit for this endpoint — it is not shared with (pooled across) any other endpoint, so the full rate is available to this endpoint alone.

Retrieves curated investment lists available to the authenticated user.

get/api/v1/curated-lists

Headers

x-request-idstring uuid required

Example:5f7e1d0e-3fc5-4589-ac2b-7d35da41e860

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 curated lists

Example response

{
  "curatedLists": [
    {
      "uuid": "12345",
      "name": "Tech Watchlist",
      "description": "A list of tech stocks",
      "listImageUrl": "https://example.com/tech-watchlist.jpg",
      "items": [
        {
          "instrumentId": 12345
        }
      ]
    }
  ]
}