Create a new watchlist

Creates a new watchlist for the authenticated user with the specified name and type.

POST /api/v1/watchlists

Create a new watchlist

cURL

curl --request POST \
  --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>'

201

{
  "status": 200,
  "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
      ]
    }
  ],
  "exception": {
    "invalidItems": [
      "<string>"
    ],
    "reason": "<string>",
    "message": "<string>"
  },
  "meta": {
    "pageNumber": 0,
    "itemsPerPage": 100,
    "maxItemsInWatchlistLimit": 1000,
    "maxWatchlistsLimit": 10
  },
  "isSucceeded": true
}

Headers

x-request-id · string<uuid> · required

A unique request identifier.

Example:

"cb0cded4-0ba1-4158-819b-837b42ea43bf"

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

name · string · required

Name of the new watchlist

Maximum string length: 100

Example:

"Tech Watchlist"

type · enum<string> · default: Static

Type of watchlist to create

Available options: Static, Dynamic

Example:

"Static"

dynamicQuery · string

Dynamic query URL for dynamic watchlists

Response

201 - application/json

Watchlist created successfully

Response containing multiple watchlists with metadata

status · integer<int32>

HTTP status code of the response

Example:

200

watchlists · object[]

List of user watchlists

Show child attributes

exception · object

Exception details when the request partially failed

Show child attributes

meta · object

Response metadata including pagination info

Show child attributes

isSucceeded · boolean

Whether the request succeeded

Example:

true