watchlists

Get Watchlist

Get a single watchlist by ID.

Returns the full watchlist object including all symbols. Raises 404 if the watchlist does not exist.

curl example:

curl https://api.halalterminal.com/api/watchlists/wl_abc123 \
  -H "X-API-Key: sk_live_abc123def456"

Python example:

import requests

resp = requests.get(
    "https://api.halalterminal.com/api/watchlists/wl_abc123",
    headers={"X-API-Key": "sk_live_abc123def456"},
)
watchlist = resp.json()
get/api/watchlists/{watchlist_id}

Request

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

Path parameters

watchlist_idstring required

Watchlist ID.

Response

The requested 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.