watchlists

Create Watchlist

Create a new watchlist.

Creates a named watchlist with an optional initial set of symbols. Returns the full watchlist object including its generated ID.

curl example:

curl -X POST https://api.halalterminal.com/api/watchlists \
  -H "Content-Type: application/json" \
  -H "X-API-Key: sk_live_abc123def456" \
  -d '{"name": "Halal Tech", "symbols": ["AAPL", "MSFT", "GOOGL"]}'

Python example:

import requests

resp = requests.post(
    "https://api.halalterminal.com/api/watchlists",
    headers={"X-API-Key": "sk_live_abc123def456"},
    json={"name": "Halal Tech", "symbols": ["AAPL", "MSFT", "GOOGL"]},
)
watchlist = resp.json()
post/api/watchlists

Request

  • Base URL: https://api.halalterminal.com
  • URL: https://api.halalterminal.com/api/watchlists
  • Auth: API key in header X-API-Key

Request body

namestring required

Display name for the watchlist

symbolsstring[] nullable

Initial list of stock ticker symbols to include

Example request

{
  "name": "Halal Tech",
  "symbols": [
    "AAPL",
    "MSFT",
    "GOOGL"
  ]
}

Response

The newly created watchlist

idstring required

Unique watchlist identifier

namestring required

Display name of the watchlist

symbolsstring[] required

Ticker symbols in the watchlist

countinteger required

Number of symbols currently in the watchlist

created_atstring required

ISO-8601 timestamp when the watchlist was created

updated_atstring required

ISO-8601 timestamp of the last modification

Example response

{
  "count": 3,
  "created_at": "2025-06-01T12:00:00Z",
  "id": "wl_abc123",
  "name": "Halal Tech",
  "symbols": [
    "AAPL",
    "MSFT",
    "GOOGL"
  ],
  "updated_at": "2025-06-01T12:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.