---
title: "Where everything is"
method: GET
path: "/"
tags: ["docs"]
---

# Where everything is

`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`)

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.

## Response `200`

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

- Index: Where everything is, for an agent that lands on the base URL.
  - `name` string: The API's name.
  - `api_version` string: The contract version, v1.
  - `description` string: One sentence on what the API serves.
  - `docs_url` string, uri: The developer docs, where keys are created.
  - `llms_txt` string, uri: URL of the agent reference (llms.txt).
  - `openapi` string, uri: URL of this OpenAPI document.
  - `skill` string, uri: URL of the installable SKILL.md.
  - `auth` object: How to authenticate.
    - `header` string: The Authorization header to send with a key.
    - `keys_url` string, uri: Where to create a key.
    - `client_header` string: The optional X-TradingPal-Client header, which names the calling agent or script in the usage log.
  - `mcp` object: The MCP server and how to connect to it.
    - `url` string, uri: The MCP endpoint.
    - `transport` string: The MCP transport; streamable-http.
    - `auth` string: How the MCP server authenticates: the same Authorization header, optional for the demo tools.
    - `install` object: Copy-and-paste install commands per client.
      - `claude_code` string: The claude mcp add command.
      - `codex` string: The codex mcp add command.
  - `demo` object: The keyless demo.
    - `symbols` string[]: The demo symbols.
    - `patterns_url` string, uri: The demo patterns route for the first demo symbol.
    - `families_url` string, uri: The keyless families route.
  - `limits` object: Rate limits.
    - `requests_per_minute` integer: Per-key burst limit, requests per minute (60).
    - `requests_per_day` integer: Per-key daily limit, requests per day (10,000).
    - `keyless_per_minute_per_ip` integer: Limit for calls without a key, requests per minute per IP address (30).
  - `disclaimer` string: The educational-use disclaimer.

## Other responses

- `429`: rate_limited; wait details.retry_after_seconds

---

[API](https://skmtc.dev/tradingpal/apis/tradingpal-pattern-api.md) · [All operations](https://skmtc.dev/tradingpal/apis/tradingpal-pattern-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tradingpal/apis/tradingpal-pattern-api/revisions/e96e1f20c1ce?raw)