Watchlists

Retrieves a watchlist or a list of watchlists.

Endpoints

GET/data/v1/watchlists/:id

GET/data/v1/watchlists

Retrieve a Watchlist Object

Parameters

api_key string required
Your authentication key needed to make requests.

format string default: json
Defines return format of response. Options are json or csv. Default is json.

Example Request

cURL
curl -X GET "https://sensaai.com/data/v1/watchlists/70?api_key=API_KEY"
Python
import requests

url = "https://sensaai.com/data/v1/watchlists/70"
params = {
 "api_key": "API_KEY"  # Replace 'API_KEY' with your actual API key
}

response = requests.get(url, params=params)

if response.status_code == 200:
 data = response.json()
 print(data)
else:
 print(f"Request failed with status code {response.status_code}")
JavaScript
const https = require('https');

const url = "https://sensaai.com/data/v1/watchlists/70/";
const params = {
api_key: "API_KEY", // Replace 'API_KEY' with your actual API key
};

const requestUrl = new URL(url);
requestUrl.search = new URLSearchParams(params);

https.get(requestUrl, (response) => {
let data = '';

response.on('data', (chunk) => {
  data += chunk;
});

response.on('end', () => {
  if (response.statusCode === 200) {
    console.log(data);
  } else {
    console.error(`Request failed with status code ${response.statusCode}`);
  }
});
});

Response

Returns a watchlist object if a valid watchlist ID was provided. Returns an error otherwise.

{
  "id": "70",
  "name": "My Selected Stocks",
  "description": "A list of selected stocks that I am following closely.",
  "private": true,
  "createdAt": "2023-10-20T14:00:14.189005+00:00",
  "stockCount": 17
}

Retrieve a List of Watchlist Objects

Parameters

api_key string required
Your authentication key needed to make requests.

format string default: json
Defines return format of response. Options are json or csv. Default is json.

Example Request

cURL
curl -X GET "https://sensaai.com/data/v1/watchlists/?api_key=API_KEY"
Python
import requests

url = "https://sensaai.com/data/v1/watchlists/"
params = {
 "api_key": "API_KEY"  # Replace 'API_KEY' with your actual API key
}

response = requests.get(url, params=params)

if response.status_code == 200:
 data = response.json()
 print(data)
else:
 print(f"Request failed with status code {response.status_code}")
JavaScript
const https = require('https');

const url = "https://sensaai.com/data/v1/watchlists/";
const params = {
api_key: "API_KEY", // Replace 'API_KEY' with your actual API key
};

const requestUrl = new URL(url);
requestUrl.search = new URLSearchParams(params);

https.get(requestUrl, (response) => {
let data = '';

response.on('data', (chunk) => {
  data += chunk;
});

response.on('end', () => {
  if (response.statusCode === 200) {
    console.log(data);
  } else {
    console.error(`Request failed with status code ${response.statusCode}`);
  }
});
});

Response

[
  {
    "id": "69",
    "name": "My Watchlist",
    "description": "My favourite stocks",
    "private": true,
    "createdAt": "2023-10-10T12:25:14.159058+00:00",
    "stockCount": 102
  },
  {
    "id": "70",
    "name": "My Selected Stocks",
    "description": "A list of selected stocks that I am following closely.",
    "private": true,
    "createdAt": "2023-10-20T14:00:14.189005+00:00",
    "stockCount": 3
  }
    ...more watchlists
]
Table of Contents