API Documentation

Everything you need to integrate StockAlert.pro into your applications

Watchlist API

Create and manage your watchlist programmatically. The API supports listing items with enriched stock data, creating and updating items, deleting items, and intention swaps (buy/sell) which trigger a fresh AI analysis.

Authentication & Scopes

Authentication: Session (cookie) or Bearer JWT, and API Key. API Keys require scopes:watchlist:read for reads andwatchlist:write for mutations.

List Watchlist Items

GET/api/v1/watchlist

Returns your watchlist items including stock data and active alert counts.

curl -X GET https://stockalert.pro/api/v1/watchlist   -H "X-API-Key: sk_your_api_key"

Create Watchlist Item

POST/api/v1/watchlist

Add a symbol to your watchlist.

Field	Type	Required	Description
`stock_symbol`	string	Yes	Ticker symbol (e.g., "AAPL")
`stock_name`	string	No	Optional display name (used when creating new stocks)
`intention`	string	Yes	One of `buy` or `sell`
`target_price`	number	No	Optional target price
`notes`	string	No	Optional strategy notes

Update & Delete

PATCH/api/v1/watchlist/{id}Update fields (target_price, notes, is_active, auto_alerts_enabled)

DELETE/api/v1/watchlist/{id}Remove item from watchlist

Swap Intention

PUT/api/v1/watchlist/order

Switch between buy and sell for a given item. Deletes AI‑generated alerts for that item and queues a new analysis.

Field	Type	Required	Description
`item_id`	string (uuid)	Yes	Watchlist item id
`new_intention`	string	Yes	One of `buy` or `sell`
`stock_symbol`	string	Yes	Ticker symbol of the item

Rate Limits & Envelope

All responses include X‑RateLimit‑* headers and a meta.rate_limit object with limit, remaining, and reset (epoch ms).