Skip to main content
GET
/
api
/
v1
/
watchlists
Get user watchlists
curl --request GET \
  --url https://public-api.etoro.com/api/v1/watchlists \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-request-id: <x-request-id>' \
  --header 'x-user-key: <x-user-key>'
{
  "watchlists": [
    {
      "WatchlistId": "12345",
      "Name": "Tech Watchlist",
      "Gcid": 12345,
      "WatchlistType": "Static",
      "TotalItems": 100,
      "IsDefault": true,
      "IsUserSelectedDefault": true,
      "WatchlistRank": 1,
      "DynamicUrl": "<string>",
      "Items": [
        {
          "ItemId": 12345,
          "ItemType": "Instrument",
          "ItemRank": 1
        }
      ],
      "RelatedAssets": [
        12345,
        67890
      ]
    }
  ],
  "metadata": {
    "totalCount": 100,
    "maxItemsInWatchlist": 1000,
    "maxWatchlistPerUser": 10
  }
}

Headers

​
x-request-id
string<uuid>
required

A unique request identifier.

Example:

"babc63cc-cd60-43bf-8f4e-b4416107f9d0"

​
x-api-key
string<password>
required

API key for authentication.

Example:

"lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663"

​
x-user-key
string<password>
required

User-specific authentication key.

Example:

"eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_"

Query Parameters

​
itemsPerPageForSingle
integer<int32>
default:100

Number of items to include per watchlist for pagination

Required range: 1 <= x <= 1000
Example:

100

​
ensureBuiltinWatchlists
boolean
default:true

Whether to ensure built-in watchlists are included

Example:

true

​
addRelatedAssets
boolean
default:false

Whether to include related assets in the response

Example:

false

Response

200 - application/json

Successfully retrieved user watchlists

Response containing multiple watchlists with metadata

​
watchlists
object[]

List of user watchlists

​
metadata
object

Response metadata including pagination info