Create a watchlist
curl --request POST \
--url https://api.bigdata.com/v1/watchlists \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "MAMAA stocks",
"description": "Large-cap US technology companies",
"items": [
"0157B1",
"12E454",
"228D42",
"4A6F00",
"D8442A"
]
}
'import requests
url = "https://api.bigdata.com/v1/watchlists"
payload = {
"name": "MAMAA stocks",
"description": "Large-cap US technology companies",
"items": ["0157B1", "12E454", "228D42", "4A6F00", "D8442A"]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'MAMAA stocks',
description: 'Large-cap US technology companies',
items: ['0157B1', '12E454', '228D42', '4A6F00', 'D8442A']
})
};
fetch('https://api.bigdata.com/v1/watchlists', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bigdata.com/v1/watchlists",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'MAMAA stocks',
'description' => 'Large-cap US technology companies',
'items' => [
'0157B1',
'12E454',
'228D42',
'4A6F00',
'D8442A'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bigdata.com/v1/watchlists"
payload := strings.NewReader("{\n \"name\": \"MAMAA stocks\",\n \"description\": \"Large-cap US technology companies\",\n \"items\": [\n \"0157B1\",\n \"12E454\",\n \"228D42\",\n \"4A6F00\",\n \"D8442A\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bigdata.com/v1/watchlists")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"MAMAA stocks\",\n \"description\": \"Large-cap US technology companies\",\n \"items\": [\n \"0157B1\",\n \"12E454\",\n \"228D42\",\n \"4A6F00\",\n \"D8442A\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/watchlists")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"MAMAA stocks\",\n \"description\": \"Large-cap US technology companies\",\n \"items\": [\n \"0157B1\",\n \"12E454\",\n \"228D42\",\n \"4A6F00\",\n \"D8442A\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
},
"results": {
"id": "b548fc37-87d3-4bc7-b482-eeeeb7060f78",
"user_id": "A1B2C3D4E5",
"created_at": "2026-10-20T10:15:00.000000Z",
"updated_at": "2026-10-23T08:30:00.000000Z",
"interacted_at": null,
"name": "MAMAA stocks",
"description": "Large-cap US technology companies",
"items": [
"0157B1",
"12E454",
"228D42",
"4A6F00",
"D8442A"
]
}
}{
"errors": [
{
"message": "Invalid payload"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Forbidden"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Conflict"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Unprocessable Entity"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Internal Server Error"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}Manage
Create a watchlist
Create a watchlist from a name and a list of items.
name and items are required. Duplicate items are removed and the response returns the items sorted. You can own up to 300 watchlists.
POST
/
v1
/
watchlists
Create a watchlist
curl --request POST \
--url https://api.bigdata.com/v1/watchlists \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "MAMAA stocks",
"description": "Large-cap US technology companies",
"items": [
"0157B1",
"12E454",
"228D42",
"4A6F00",
"D8442A"
]
}
'import requests
url = "https://api.bigdata.com/v1/watchlists"
payload = {
"name": "MAMAA stocks",
"description": "Large-cap US technology companies",
"items": ["0157B1", "12E454", "228D42", "4A6F00", "D8442A"]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'MAMAA stocks',
description: 'Large-cap US technology companies',
items: ['0157B1', '12E454', '228D42', '4A6F00', 'D8442A']
})
};
fetch('https://api.bigdata.com/v1/watchlists', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bigdata.com/v1/watchlists",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'MAMAA stocks',
'description' => 'Large-cap US technology companies',
'items' => [
'0157B1',
'12E454',
'228D42',
'4A6F00',
'D8442A'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bigdata.com/v1/watchlists"
payload := strings.NewReader("{\n \"name\": \"MAMAA stocks\",\n \"description\": \"Large-cap US technology companies\",\n \"items\": [\n \"0157B1\",\n \"12E454\",\n \"228D42\",\n \"4A6F00\",\n \"D8442A\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bigdata.com/v1/watchlists")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"MAMAA stocks\",\n \"description\": \"Large-cap US technology companies\",\n \"items\": [\n \"0157B1\",\n \"12E454\",\n \"228D42\",\n \"4A6F00\",\n \"D8442A\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/watchlists")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"MAMAA stocks\",\n \"description\": \"Large-cap US technology companies\",\n \"items\": [\n \"0157B1\",\n \"12E454\",\n \"228D42\",\n \"4A6F00\",\n \"D8442A\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
},
"results": {
"id": "b548fc37-87d3-4bc7-b482-eeeeb7060f78",
"user_id": "A1B2C3D4E5",
"created_at": "2026-10-20T10:15:00.000000Z",
"updated_at": "2026-10-23T08:30:00.000000Z",
"interacted_at": null,
"name": "MAMAA stocks",
"description": "Large-cap US technology companies",
"items": [
"0157B1",
"12E454",
"228D42",
"4A6F00",
"D8442A"
]
}
}{
"errors": [
{
"message": "Invalid payload"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Forbidden"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Conflict"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Unprocessable Entity"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Internal Server Error"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}Authorizations
API key from the Bigdata Developer Platform.
Body
application/json
Name of the watchlist.
Required string length:
1 - 255Ids of the entities in the watchlist. Duplicates are removed. A watchlist holds at most 2000 items.
Maximum array length:
2000Example:
[ "0157B1", "12E454", "228D42", "4A6F00", "D8442A" ]
Free-text description.
Maximum string length:
4000Was this page helpful?