account

The key, plan, limits and tracked-ticker count

Returns the calling key (prefix, name, creation time), the plan, the account's limits (the tracked-ticker cap, requests per minute and per day) and how many tickers the account tracks. Call it to confirm a key works and to size a tracking list before PUT /tickers. Needs a key on an account with Premium+.

get/me

Request

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

Headers

X-TradingPal-Clientstring

Optional name of the agent or script making the call. It is recorded in the account's usage log so the user can see which client made which calls; the User-Agent is recorded when it is absent.

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.

plan'api' | 'staff'

The account's plan: api (Premium+, which includes Premium) or staff. No other account passes the gate.

tracked_ticker_countinteger

How many tickers the account tracks now.

docs_urlstring uri

The developer docs, where keys are managed.

mcp_urlstring uri

The MCP server endpoint (Streamable HTTP), which takes the same key.

Example response

{
  "api_version": "v1",
  "plan": "api",
  "tracked_ticker_count": 3
}

Changes

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