tickers

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 My watchlist on the site. The agent tools add_tickers and remove_tickers call this.

patch/tickers

Request

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

Request body

addstring[]

Exchange symbols to start tracking, upper case (BRK.B). Each must be a ticker TradingPal knows; already tracked ones are ignored.

removestring[]

Exchange symbols to stop tracking; names not on the list are ignored.

Example request

{
  "add": [
    "NVDA"
  ],
  "remove": [
    "AAPL"
  ]
}

Response

The tracked set as it stands

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 tracked tickers.

capinteger

Maximum number of tickers the account may track.

Example response

{
  "api_version": "v1",
  "tickers": [
    {
      "symbol": "NVDA",
      "covered": true
    }
  ],
  "count": 1,
  "cap": 200,
  "account": {
    "email": "you@example.com"
  }
}

Changes

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