API reference

Demo index

GET/demoNo key needed

The keyless demo symbols

Returns the demo symbols and URL templates for the demo patterns and chart routes. The demo exists so an agent can show TradingPal working before its user has a key. No key is needed; keyless calls are limited to 30 a minute per IP.

Authentication

No key needed. Without one the call is limited to 30 requests a minute per IP; with a key it counts against the key's limits instead.

Request

curl "https://api.tradingpal.io/api/v1/demo"

Response

JSON. The fields this route adds are below; every response also carries the envelope fields (api_version, as_of_session, data_version, source, disclaimer).

Field	Type	Description
`demo`	boolean	Always true.
`symbols`	array of string	The demo symbols, the only ones the demo routes answer for.
`patterns_url`	string	URL template of the demo patterns route, with {symbol} to fill in.
`chart_url`	string	URL template of the demo chart route, with {symbol} and the setup_id query value to fill in.
`next`	string	A sentence on where to create a key to track other tickers.

Example response

Response

{
  "api_version": "v1",
  "demo": true,
  "symbols": [
    "AAPL",
    "NVDA"
  ]
}

Errors

Errors are JSON with the Error shape; the fix field says what to do.

Status	Code	Meaning	Fix
429	`rate_limited`	The key passed 60 requests in a minute or 10,000 in a day, or a keyless caller passed 30 a minute from one IP.	Wait `details.retry_after_seconds`, then retry. Cache the nightly answers; they do not change until the next session.