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

{
  "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
  ]
}

Headers

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

A unique request identifier.

Example:

"926eb912-839a-442b-910f-e11cf97efd6c"

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

Represents a watchlist with its metadata and items

WatchlistId · string

Unique identifier of the watchlist

Example:

"12345"

Name · string

Display name of the watchlist

Example:

"Tech Watchlist"

Gcid · integer<int32>

Global Customer ID of the watchlist owner

Example:

12345

WatchlistType · enum<string>

Type of the watchlist

Available options: Static, Dynamic

Example:

"Static"

TotalItems · integer<int32>

Total number of items in the watchlist

Example:

100

IsDefault · boolean

Whether this is a default system watchlist

Example:

true

IsUserSelectedDefault · boolean

Whether this is the user's selected default watchlist

Example:

true

WatchlistRank · integer<int32>

Display order rank of the watchlist

Example:

1

DynamicUrl · string

URL for dynamic watchlist queries

Items · object[]

Items contained in the watchlist

Show child attributes

Example:

[
  {
    "ItemId": 12345,
    "ItemType": "Instrument",
    "ItemRank": 1
  }
]

RelatedAssets · integer<int32>[]

Related asset IDs

Example:

[12345, 67890]