Watchlists: broker API endpoints compared
15 documented calls from 3 of the 12 APIs with endpoint records here, each with the page it was read on.
Risk warning: CFDs and spread bets are complex instruments and come with a high risk of losing money rapidly due to leverage. You can lose money on these products, and each provider publishes its own loss figure under FCA rules. You should consider whether you understand how they work and whether you can afford to take the high risk of losing your money. Automated and API trading can amplify losses through bugs, connectivity failures and runaway orders.
What this task is
A watchlist is a saved list of instruments on your account, the same lists you see in the provider's own platform. Reading one through the API is a simple way to give a program the set of markets you follow.
Watchlists hold no money and place no trades, which makes these calls a low stakes way to test that your login and your requests work.
The documented endpoint, API by API
Ordered by the name of the broker or platform API, then by path. The order is not a ranking. Open a row for the parameters, the response and a sample request.
| Broker | Endpoint | What the record says it does | Source |
|---|---|---|---|
| Capital.com | POST/api/v1/watchlists | Create a watchlist with a name and, if you wish, a first set of markets. | open-api.capital.comchecked |
| Capital.com | GET/api/v1/watchlists | Every watchlist on your account. Open one with GET /api/v1/watchlists/{watchlistId}. | open-api.capital.comchecked |
| Capital.com | DELETE/api/v1/watchlists/{watchlistId} | Delete a watchlist. The list itself is removed, not the markets or any position in them. | open-api.capital.comchecked |
| Capital.com | PUT/api/v1/watchlists/{watchlistId} | Add one market to an existing watchlist, by its epic. | open-api.capital.comchecked |
| Capital.com | GET/api/v1/watchlists/{watchlistId} | The markets in one watchlist, each with its epic, name, status and current bid and offer. | open-api.capital.comchecked |
| Capital.com | DELETE/api/v1/watchlists/{watchlistId}/{epic} | Take one market out of a watchlist. The watchlist and its other markets stay as they are. | open-api.capital.comchecked |
| eToro | POST/api/v1/watchlists | Creates a new watchlist with the name you give. The name and type go in the query string, not the body. | api-portal.etoro.comchecked |
| eToro | GET/api/v1/watchlists | Returns all of your watchlists and their items, with optional paging of items and related assets. | api-portal.etoro.comchecked |
| eToro | POST/api/v1/watchlists/{watchlistId}/items | Adds instruments or people to an existing watchlist. The body is a JSON array of items. | api-portal.etoro.comchecked |
| IG | POST/watchlists | Create a watchlist with a name and, if you wish, a first set of markets. The reply says whether every market was added. | labs.ig.comchecked |
| IG | GET/watchlists | All watchlists on the account, including the built in ones. | labs.ig.comchecked |
| IG | DELETE/watchlists/{watchlistId} | Delete a watchlist. The list itself is removed, not the markets or any position in them. | labs.ig.comchecked |
| IG | PUT/watchlists/{watchlistId} | Add one market to an existing watchlist, by its epic. | labs.ig.comchecked |
| IG | GET/watchlists/{watchlistId} | The markets in one watchlist, each with its epic, name, status and current bid and offer. | labs.ig.comchecked |
| IG | DELETE/watchlists/{watchlistId}/{epic} | Take one market out of a watchlist. The watchlist and its other markets stay as they are. | labs.ig.comchecked |
None documented here yet
These APIs have endpoint records on this site, but none is assigned to this task. That describes this dataset. It is not a statement that the API lacks such a call.
- Deriv: none documented here yet
- Interactive Brokers: none documented here yet
- OANDA: none documented here yet
- Saxo OpenAPI: none documented here yet
- Trading 212: none documented here yet
- DXtrade APIs: none documented here yet
- Match-Trader Platform API: none documented here yet
- MetaApi: none documented here yet
- TradeLocker API: none documented here yet
Brokers and platforms with no endpoint records at all are not listed above. The broker directory shows what is recorded for each.