ETetoro
Watchlists

Get single watchlist

Rate limit: 60 requests per 60 seconds. This is a shared quota — the same budget is consumed by a group of related endpoints, so calling any of them reduces what is left for the others (you cannot call each at the full rate independently). Endpoints sharing this quota:

  • GET /api/v1/watchlists
  • GET /api/v1/watchlists/default-watchlists/items
  • GET /api/v1/watchlists/public/{userId}
  • GET /api/v1/watchlists/public/{userId}/{watchlistId}

Retrieves a specific watchlist with its items using pagination.

get/api/v1/watchlists/{watchlistId}

Request

  • Base URL
    https://public-api.etoro.com
  • Auth
    • OAuth 2
      Authorization code
      Scopesetoro-public:demo:read
    • or OAuth 2
      Authorization code
      Scopesetoro-public:demo:write
    • or OAuth 2
      Authorization code
      Scopesetoro-public:real:read
    • or OAuth 2
      Authorization code
      Scopesetoro-public:real:write
    • or OAuth 2
      Authorization code
      Scopesetoro-public:watchlist:read
    • or OAuth 2
      Authorization code
      Scopesetoro-public:watchlist:write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

watchlistIdstring required

Unique identifier of the watchlist

Query parameters

pageNumberinteger

Page number for pagination

itemsPerPageinteger

Number of items per page

Headers

x-request-idstring uuid required
Example:f0613e5b-b2ff-4aef-b4e8-067a7d06b72a

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 watchlist

statusinteger

HTTP status code of the response

isSucceededboolean

Whether the request succeeded

Example response

{
  "status": 200,
  "watchlists": [
    {
      "watchlistId": "12345",
      "name": "Tech Watchlist",
      "Gcid": 12345,
      "watchlistType": "Static",
      "totalItems": 100,
      "isDefault": true,
      "isUserSelectedDefault": true,
      "watchlistRank": 1,
      "items": [
        {
          "itemId": 12345,
          "itemType": "Instrument",
          "itemRank": 1
        }
      ],
      "relatedAssets": [
        12345,
        67890
      ]
    }
  ],
  "meta": {
    "itemsPerPage": 100,
    "maxItemsInWatchlistLimit": 1000,
    "maxWatchlistsLimit": 10
  },
  "isSucceeded": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.