Skip to main content
POST
Add a symbol to a watchlist

Authorizations

x-api-key
string
header
required

Raw API key shown once when created in the Allocait app (Settings > API keys). Send it verbatim in this header; the server stores and compares only its SHA-256 hash. Allocait generates every key: alc_ followed by 64 lowercase hex characters. Keys issued before 2026-10-10 are 64 hex characters with no prefix and keep working. A key may carry an expiry (90 days or 1 year, or never). A malformed, unknown, revoked or expired key gets 401 with no further detail, and a malformed one is refused before any lookup. Keys cannot be created through this API.

Path Parameters

id
string<uuid>
required

watchlist_id

Body

application/json
symbol
string
required
Example:

"BRAV"

asset_class_id
string<uuid>

Must belong to the caller, or be a system asset class. Leave the key out to have the catalog's class filled in; null adds the symbol with no class.

Response

The item was added

success
boolean
item
object

The full item record, as returned by add-item (distinct field names from the WatchlistItem list-view above; id/asset_class_name/sort_order rather than item_id/asset_class).