families

Symbols the nightly covers

Returns every symbol the active nightly manifest covers, sorted. Use it to check a symbol before tracking it; the unknown_symbol error from PUT /tickers points here. The list is empty when no manifest is active. No key is needed; the answer is cached for an hour and keyless calls are limited per IP.

get/universe

Request

  • Base URL: https://api.tradingpal.io/api/v1
  • URL: https://api.tradingpal.io/api/v1/universe
  • 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.

countinteger

Number of symbols.

symbolsstring[]

Every symbol the active nightly manifest covers, sorted. Empty when no manifest is active.

Example response

{
  "api_version": "v1",
  "count": 2,
  "symbols": [
    "AAPL",
    "NVDA"
  ]
}

Changes

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