REST API reference
Partner keys use JSON over HTTPS under /v1/public/*. See also OpenAPI, the Candle Script API, and Webhooks.
Developer REST API access requires Essential or higher. Daily quotas follow the API key owner's current plan, including after upgrades or downgrades.
Market data (API key)
GET/v1/public/symbolsscope: symbols:read
Search and resolve symbols.
| Parameter | Description |
|---|---|
query | Free-text search, for example AAPL or bitcoin. |
GET/v1/public/quotesscope: quotes:read
Latest quote snapshot for one or more symbols.
| Parameter | Description |
|---|---|
symbols | Comma-separated symbol identifiers, for example NASDAQ:AAPL,CRYPTO:BTCUSD. |
GET/v1/public/historyscope: history:read
Historical OHLCV bars.
| Parameter | Description |
|---|---|
symbol | Symbol identifier. |
resolution | Supported resolution such as 1m, 5m, 15m, 1h, 1D, or 1W. |
from | Optional ISO start timestamp. |
to | Optional ISO end timestamp. |
GET/v1/public/screenersscope: screeners:read
Filter, sort, and paginate the screener universe.
| Parameter | Description |
|---|---|
assetClass | Asset class: stocks, crypto, or forex. |
pageSize | Rows per page. |
Example: latest daily bar
curl -s "https://candlescript.io/api/v1/public/history?symbol=NASDAQ:AAPL&resolution=1D" \
-H "Authorization: Bearer $CHARTING_API_KEY" | jq '.bars[-1]'Widgets
POST/v1/widgetsscope: session
Create a saved widget configuration and return its embed URL.
GET/widgets/mini-chartscope: public
Render a query-parameter mini-chart without a key.
GET/widgets/{id}scope: public
Render saved widget embed HTML.
Errors
| Status | Meaning |
|---|---|
401 | Missing or invalid API key. |
403 | The key lacks the required scope or entitlement. |
429 | Rate limit exceeded; check Retry-After. |