demo

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.

get/demo

Request

  • Base URL: https://api.tradingpal.io/api/v1
  • URL: https://api.tradingpal.io/api/v1/demo
  • Auth: one of:
    • none
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.tradingpal.io/oauth/authorize, token URL https://api.tradingpal.io/oauth/token, scopes: patterns)

Response

OK

api_version'v1' required

The contract version, always v1. Field names in v1 do not change, and v1 stays available at least 12 months after a v2 ships.

as_of_sessionstring date nullable required

The last trading session the data describes, as an ISO date. Setups change nightly, so say it when presenting data and do not cache setups across days. Null on routes that do not read a dated artifact (account, tickers, history, families, universe and the demo index).

data_versionstring nullable

Identifier of the stored artifact the answer came from: the candidate-book generation for patterns, the sealed manifest for family records. Null when the route reads no versioned artifact.

disclaimer'Educational breakout-pattern analysis from TradingPal, not investment advice. Past results do not guarantee future outcomes.' required

The educational-use disclaimer, constant on every response. Repeat it when presenting a setup as something the user might act on.

demoboolean

Always true.

symbolsstring[]

The demo symbols, the only ones the demo routes answer for.

patterns_urlstring

URL template of the demo patterns route, with {symbol} to fill in.

chart_urlstring

URL template of the demo chart route, with {symbol} and the setup_id query value to fill in.

nextstring

A sentence on where to create a key to track other tickers.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.