Skip to content

Watchlist:InsertIntoWatchlist

Adds Members to a Watchlist by inserting them at an offset.

Controller: Watchlist
Topic: InsertIntoWatchlist Action: Publish
Permissions: Zenith/Market

NameTypeExpectDescription
WatchlistIDStringAlwaysA unique identifier of the existing Watchlist to update.
MembersArrayAlwaysAn array of strings representing the new Members of the Watchlist.
OffsetNumberAlwaysAn zero-based index to insert the new Members.

No Response Body.

Send:

{"Controller":"Watchlist","Topic":"InsertIntoWatchlist","TransactionID":1,"Data":{"WatchlistID":"123ABC","Members":["TLS.ASX"],"At":0}}

Receive:

{
"Controller":"Watchlist",
"Topic":"InsertIntoWatchlist",
"TransactionID":1
}

If subscribed to the modified Watchlist, you will also receive an update:

{
"Controller":"Watchlist",
"Topic":"Watchlist!123ABC",
"Data":
[
{"Operation":"Insert","At":0,"Members":["TLS.ASX"]}
]
}