Skip to main content
Platform API
The data behind our charts

Request historical candles, volume footprint and TPO profiles and the security catalog over REST, and subscribe to live candles, footprint profiles and order books over WebSocket. One key in one header works for both.

​
What you can request

Candles

Historical candles for any supported timeframe, plus the list of timeframes. Over WebSocket, the latest candle and then live updates of the forming one.

Volume footprint

Buy and sell volume per price row, with the row size scale a settings UI can offer. Live profiles arrive as complete replacements.

TPO profiles

Market Profile data for day, week and month timeframes, with point of control, initial balance and time blocks.

Order book

One snapshot of the top levels per side, then incremental updates. Available over WebSocket.

Securities

Search by name, ticker or ISIN, list exchanges and their securities, and read a security specification with tick size and precision.

One key for both

A personal API token from your TakeProfit settings, sent in the x-api-key header on every request and on the WebSocket handshake.

​
Two ways in

REST API

https://public-api.takeprofit.com/api/v1/marketdataHistory and reference data. Every endpoint answers GET only, and unknown query parameters are rejected.

WebSocket API

wss://public-api.takeprofit.com/api/v1/marketdataLive streams. Subscription parameters go in the query string; the client sends nothing after the handshake.
Both sections open with an overview of the shared parameters, and their endpoint pages are generated from our OpenAPI and AsyncAPI specifications, so every parameter and response field matches the running API. The three streams are candles, volume footprint and order book.

​
From key to live data

  1. Step 1 of 4
    Create an API key

    In Settings, create a personal API token on a paid plan and copy it once: the full key is shown a single time.

  2. Step 2 of 4
    Find the security

    Search by name, ticker or ISIN and take the exchange and symbol pair from the hit. Every other endpoint speaks that pair.

  3. Step 3 of 4
    Load history

    Ask for candles, footprint or TPO profiles over a range. Prices and volumes come as decimal strings, so nothing is rounded on the way.

  4. Step 4 of 4
    Go live

    Open a WebSocket connection with the same key in the handshake header and keep the picture up to date as the market moves.

​
Good to know

  • One header, both protocols. x-api-key authenticates REST requests and the WebSocket upgrade alike. Exactly one value is accepted.
  • Securities are identified by exchange and symbol. Take them from the Securities endpoints; ISINs work in search only.
  • Unknown query parameters are rejected with 400, so a typo fails loudly instead of being ignored.
  • Requests draw credits from your key’s quota. Heavier requests cost more, a stream is charged once per subscription rather than per frame, and an exhausted quota answers 429.
Questions and suggestions go to support@takeprofit.com. The Platform API is separate from the Partner API, which has its own credentials and endpoints.