API reference

Add or remove tickers

PATCH/tickersKey required

Add or remove tracked tickers

Adds the symbols in add to the tracked set and removes the ones in remove, leaving the rest alone; removals apply first. Every added symbol must be a ticker TradingPal knows and the result must fit the cap, otherwise nothing changes and the error names the offending symbols; names in remove that are not tracked are ignored. Send either list or both. Symbols are upper-cased and duplicates dropped. This also changes the user's Main watchlist on the site. The agent tools add_tickers and remove_tickers call this.

Authentication

Needs a key: send Authorization: Bearer tp_live_… (see Authentication). Counted against the key's limits of 60 requests a minute and 10,000 a day.

Parameters

NameInTypeRequiredDescription
X-TradingPal-ClientheaderstringnoOptional 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.

Request body

The tickers to add and the tickers to remove.

FieldTypeDescription
addarray of stringExchange symbols to start tracking, upper case (BRK.B). Each must be a ticker TradingPal knows; already tracked ones are ignored.
removearray of stringExchange symbols to stop tracking; names not on the list are ignored.
Body
{
  "add": [
    "NVDA"
  ],
  "remove": [
    "AAPL"
  ]
}

Request

curl -X PATCH "https://api.tradingpal.io/api/v1/tickers" \
  -H "Authorization: Bearer $TRADINGPAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"add":["NVDA"],"remove":["AAPL"]}'

Response

JSON. The fields this route adds are below; every response also carries the envelope fields (api_version, as_of_session, data_version, source, disclaimer).

FieldTypeDescription
tickersarray of objectThe tracked tickers, in the order the user keeps them.
tickers[].symbolstringExchange symbol, upper case.
tickers[].coveredbooleanTrue when the active nightly manifest covers the symbol, so the pattern and history routes can answer for it. False means it is tracked but the nightly has no data for it.
countintegerNumber of tracked tickers.
capintegerMaximum number of tickers the account may track.

Example response

Response
{
  "api_version": "v1",
  "tickers": [
    {
      "symbol": "NVDA",
      "covered": true
    }
  ],
  "count": 1,
  "cap": 200
}

Errors

Errors are JSON with the Error shape; the fix field says what to do.

StatusCodeMeaningFix
401missing_api_keyThe request had no Authorization: Bearer tp_live_… header and the route needs one.Send the header on every keyed call. Only the demo, families and universe routes answer without it.
401invalid_api_keyThe key is not one we know, or it has been revoked.Create a new key on the API Keys page and replace it wherever the old one was stored.
403forbiddenThe account behind the key is not on Premium+. API and MCP access requires Premium+ subscription at $30/month; Premium alone does not unlock the API.Get Premium+ ($30/month, all of the benefits in Premium plus API and MCP access) from the Quickstart, or switch an existing Premium subscription to it there, then retry with the same key.
429rate_limitedThe key passed 60 requests in a minute or 10,000 in a day, or a keyless caller passed 30 a minute from one IP.Wait details.retry_after_seconds, then retry. Cache the nightly answers; they do not change until the next session.
400bad_requestA query parameter is malformed: limit or offset is not an integer, outcome is not all, resolved or open, a scan filter (family, direction, status, max_distance_pct) is not one of its allowed values, or filters is not a valid predicate list (the message names the predicate).The message names the parameter. Correct it and retry.
400invalid_symbolA symbol in a PATCH /tickers or PUT /tickers body is not a valid ticker symbol (letters, digits and a dot, as in BRK.B).Use the exchange symbol in upper case. details lists the rejected values.
400unknown_symbolA symbol in a PATCH /tickers or PUT /tickers body is well formed but not a ticker TradingPal knows.Check the spelling against GET /universe. details lists the unknown values.
400ticker_cap_exceededThe PUT /tickers body has more symbols than the account’s cap, or the PATCH /tickers additions would go over it. Nothing was changed.Send at most cap symbols, or remove some first (GET /tickers returns the cap). The cap is 200 on Premium+.