docs

Where everything is

Returns a JSON map of where everything is: the human docs, llms.txt, skill.md, this OpenAPI document, the MCP server with install commands, the demo symbols, the auth header and the rate limits. Call it first when landing on the base URL with nothing else to go on. No key is needed.

get/

Request

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

Links to the docs, the OpenAPI document, llms.txt, the skill, the MCP server and the demo.

namestring

The API's name.

api_versionstring

The contract version, v1.

descriptionstring

One sentence on what the API serves.

docs_urlstring uri

The developer docs, where keys are created.

llms_txtstring uri

URL of the agent reference (llms.txt).

openapistring uri

URL of this OpenAPI document.

skillstring uri

URL of the installable SKILL.md.

disclaimerstring

The educational-use disclaimer.

Example response

{
  "name": "TradingPal pattern API",
  "api_version": "v1",
  "description": "Breakout patterns TradingPal found on stocks & crypto in the last nightly scan, with the historical win rate, the lines to draw and a suggested entry, stop and target for each one.",
  "docs_url": "https://tradingpal.io/developers",
  "llms_txt": "https://api.tradingpal.io/api/v1/llms.txt",
  "openapi": "https://api.tradingpal.io/api/v1/openapi.json",
  "skill": "https://api.tradingpal.io/api/v1/skill.md",
  "auth": {
    "header": "Authorization: Bearer tp_live_…",
    "keys_url": "https://tradingpal.io/developers",
    "client_header": "X-TradingPal-Client: <agent or script name> (optional)"
  },
  "mcp": {
    "url": "https://api.tradingpal.io/mcp",
    "transport": "streamable-http",
    "auth": "same Authorization header; connects without one for the demo tools",
    "install": {
      "claude_code": "claude mcp add --transport http tradingpal https://api.tradingpal.io/mcp --header \"Authorization: Bearer tp_live_…\"",
      "codex": "codex mcp add tradingpal --url https://api.tradingpal.io/mcp"
    }
  },
  "demo": {
    "symbols": [
      "AAPL",
      "NVDA"
    ],
    "patterns_url": "https://api.tradingpal.io/api/v1/demo/AAPL",
    "families_url": "https://api.tradingpal.io/api/v1/families"
  },
  "limits": {
    "requests_per_minute": 60,
    "requests_per_day": 10000,
    "keyless_per_minute_per_ip": 30
  },
  "disclaimer": "Educational breakout-pattern analysis from TradingPal, not investment advice. Past results do not guarantee future outcomes."
}

Changes

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