Create default watchlist with selected items

Creates a default watchlist populated with the specified items.

POST /api/v1/watchlists/default-watchlist/selected-items

Create default watchlist with selected items

cURL

curl --request POST \
  --url https://public-api.etoro.com/api/v1/watchlists/default-watchlist/selected-items \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-request-id: <x-request-id>' \
  --header 'x-user-key: <x-user-key>' \
  --data '
[
  {
    "itemId": 12345,
    "itemType": "Instrument",
    "itemRank": 1,
    "itemAddedReason": "Manual",
    "itemAddedDate": "2023-11-07T05:31:56Z",
    "market": {
      "id": "<string>",
      "symbolName": "<string>",
      "displayName": "<string>",
      "assetTypeId": 123,
      "assetTypeSubCategoryId": 123,
      "exchangeId": 123,
      "hasExpirationDate": true,
      "avatar": {
        "small": "<string>",
        "medium": "<string>",
        "large": "<string>",
        "svg": {
          "url": "<string>",
          "backgroundColor": "<string>",
          "textColor": "<string>"
        }
      }
    }
  }
]
'

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:

"1f270bc8-8559-475b-89b4-1538f02483c3"

x-api-key · string<password> · required

API key for authentication.

Example:

"lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663"

x-user-key · string<password> · required

User-specific authentication key.

Example:

"eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_"

Body

application/json

Items to include in the default watchlist

itemId · integer<int32> · required

Unique identifier of the financial instrument

Example:

12345

itemType · string · required

Type of the financial instrument (e.g., 'Instrument', 'Person')

Example:

"Instrument"

itemRank · integer<int32> · default: 0

Ranking position of the item in the watchlist

Example:

1

itemAddedReason · string

Reason the item was added to the watchlist

Example:

"Manual"

itemAddedDate · string<date-time>

Date and time the item was added

market · object

Market metadata for the instrument when included

Show child attributes

Response

201 - application/json

Default 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