This API endpoint enables you to retrieve information about a specific watchlist. If parameter includeSecurities is set to true, the watchlist’s securities will also be included in the response.
application/json
text/json
Last updated
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| HTTP Code | Description | Schema |
|---|---|---|
Header
Authorization required
This is the authorization token that you retrieved from the first endpoint (/token).
string
Path
userId required
This is the internal identifier of the user whose watchlist’s information needs to be retrieved.
integer (int32)
Path
version required
This is the version of the API. Unless you have multiple versions of AutoShares’s API deployed in your environment, leave it at 1.0.
string
"1"
Path
watchlistId required
This is the internal identifier of the watchlist whose information needs to be retrieved.
integer (int32)
Query
includeSecurities required
This boolean parameter indicates if the list of securities in the watchlist should be returned in the request response.
boolean
200
Successful request, JSON data containing the information about the new watchlist is returned (along with its securities if the resultIncludeSecurities parameter was set to true).
401
The access level of the provided authorization token is not sufficient to perform this operation.
No Content
403
The provided Et-App-Key is incorrect.
No Content
409
The watchlist does not exist.
No Content
422
A validation error occurred while processing the request.
No Content
500
Internal server error
No Content