Footprint

List historical volume footprint profiles

Provide exchange, symbol, and timeframe. Nothing else is required: the window defaults to the 100 timeframe periods before now.

With from the window starts there and runs forward, ending at to or after period seconds (100 timeframe periods by default).
Without from the window ends at to (now by default) and runs backwards over period seconds or the 100 timeframe periods before it.
The default is measured in wall-clock time, so on an exchange with trading sessions it holds fewer than 100 profiles, and none while the market has been closed for the whole window (a 1m frame outside trading hours); pass from or period to reach back further.
period cannot be added to an explicit from+to window.
The requested range is limited to at most 1000 profiles, and rowSize (price row height in ticks, 0 enables automatic detection) is bounded, so a single request cannot ask for an unbounded number of price levels.
Every profile in one response shares the same rowSize and every row price is a whole multiple of it. That grid is resolved from the requested range, so a different range can answer on a different grid; pass rowSizeValue to pin it.
History depth is limited per timeframe, counted back from the security’s newest candle (from now while it trades): by default 30 days for minute frames below 5m, rising with the timeframe to 3 years for 1w and above. A from older than that limit is trimmed to it rather than rejected, so the response may start later than from (the first profileStart is the effective start) and a range ending before the limit is empty.

Cost: 10 credits per returned profile, at least 1000 credits per request.

GET

api

marketdata

footprint

List historical volume footprint profiles

curl --request GET \
  --url https://public-api.takeprofit.com/api/v1/marketdata/footprint \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://public-api.takeprofit.com/api/v1/marketdata/footprint', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.takeprofit.com/api/v1/marketdata/footprint",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.takeprofit.com/api/v1/marketdata/footprint"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public-api.takeprofit.com/api/v1/marketdata/footprint")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "meta": {
    "exchange": "CXBNCE",
    "symbol": "BTC/USDT",
    "timeframe": "1h"
  },
  "profiles": [
    {
      "profileStart": "2026-09-21T10:00:00Z",
      "profileEnd": "2026-09-21T11:00:00Z",
      "sessionType": "MAINSESSION",
      "rowSize": "100",
      "rows": [
        [
          "84100",
          "66.32422",
          "63.42842",
          8305,
          6430
        ],
        [
          "84200",
          "185.50922",
          "151.98043",
          25221,
          22635
        ],
        [
          "84300",
          "103.05549",
          "75.71044",
          13722,
          12348
        ],
        [
          "84400",
          "67.85132",
          "72.35893",
          10385,
          10509
        ],
        [
          "84500",
          "349.05247",
          "260.16653",
          34101,
          27199
        ],
        [
          "84600",
          "108.17618",
          "98.62807",
          13821,
          13449
        ],
        [
          "84700",
          "55.2806",
          "34.94816",
          5132,
          4522
        ],
        [
          "84800",
          "1.75602",
          "2.40955",
          229,
          186
        ]
      ],
      "totalVolumeSell": "759.63053",
      "totalVolumeBuy": "937.00552",
      "totalTradesCountSell": 97278,
      "totalTradesCountBuy": 110916
    }
  ]
}

{
  "error": {
    "code": "invalid_argument",
    "message": "query parameter \"exchange\" is required"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "authentication failed"
  }
}

{
  "error": {
    "code": "permission_denied",
    "message": "permission denied"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "security not found"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "rate limit exceeded"
  }
}

Authorizations

x-api-key

string

header

required

Query Parameters

exchange

string

required

TakeProfit exchange code as returned by /api/v1/marketdata/exchanges.

Example:

"BATS"

symbol

string

required

Public security symbol returned by /api/v1/marketdata/exchanges/{exchange}/securities. TakeProfit security symbol as returned by /api/v1/marketdata/exchanges/{exchange}/securities. In a path segment a slash must be percent-encoded (BTC/USDT is requested as BTC%2FUSDT).

Example:

"AAPL"

timeframe

string

required

Minute (1m..59m), hour (1h..24h), day (1d..31d), week (1w..4w), or month (1M) timeframe id. Timeframe id returned by /api/v1/marketdata/timeframes. Canonical suffixes include M for months and Q for quarters.

Example:

"1h"

from

string

Range start as Unix seconds or RFC3339 timestamp. Without it the window is measured backwards from to. Unix seconds (for example 1790000000) or RFC3339 timestamp.

string

Range end as Unix seconds or RFC3339 timestamp, greater than from. Defaults to now when from is omitted. Unix seconds (for example 1790000000) or RFC3339 timestamp.

period

integer

Range duration in seconds, counted forward from from or backwards from to.

Required range: x >= 1

rowSize

integer

Price row height in tick size. 0 (or omitted) enables automatic row size detection. When rowSizeValue is set it takes precedence, but rowSize is still validated.

Required range: 0 <= x <= 1000000

rowSizeValue

string

Absolute price row height in quote currency units, echoed back from the rowSize a previous response returned. Takes precedence over rowSize and pins this request to the same price grid, so a chart that loads history and then opens the footprint websocket stream keeps one price axis. A resolved row size is not always a whole number of ticks, so rowSize cannot always reproduce it. The server may still coarsen the pinned value onto the stored price grid or to respect its row limit, so read the rowSize actually returned.

sessionType

enum<string>[]

Optional session filter. Repeat this parameter or pass comma-separated values.

Available options:

MAINSESSION,

PRE_MARKET,

POST_MARKET

Response

Volume footprint response.

meta

object

required

Show child attributes

profiles

object[]

required

Show child attributes

List historical volume footprint profiles

curl --request GET \
  --url https://public-api.takeprofit.com/api/v1/marketdata/footprint \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://public-api.takeprofit.com/api/v1/marketdata/footprint', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.takeprofit.com/api/v1/marketdata/footprint",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.takeprofit.com/api/v1/marketdata/footprint"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public-api.takeprofit.com/api/v1/marketdata/footprint")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "meta": {
    "exchange": "CXBNCE",
    "symbol": "BTC/USDT",
    "timeframe": "1h"
  },
  "profiles": [
    {
      "profileStart": "2026-09-21T10:00:00Z",
      "profileEnd": "2026-09-21T11:00:00Z",
      "sessionType": "MAINSESSION",
      "rowSize": "100",
      "rows": [
        [
          "84100",
          "66.32422",
          "63.42842",
          8305,
          6430
        ],
        [
          "84200",
          "185.50922",
          "151.98043",
          25221,
          22635
        ],
        [
          "84300",
          "103.05549",
          "75.71044",
          13722,
          12348
        ],
        [
          "84400",
          "67.85132",
          "72.35893",
          10385,
          10509
        ],
        [
          "84500",
          "349.05247",
          "260.16653",
          34101,
          27199
        ],
        [
          "84600",
          "108.17618",
          "98.62807",
          13821,
          13449
        ],
        [
          "84700",
          "55.2806",
          "34.94816",
          5132,
          4522
        ],
        [
          "84800",
          "1.75602",
          "2.40955",
          229,
          186
        ]
      ],
      "totalVolumeSell": "759.63053",
      "totalVolumeBuy": "937.00552",
      "totalTradesCountSell": 97278,
      "totalTradesCountBuy": 110916
    }
  ]
}

{
  "error": {
    "code": "invalid_argument",
    "message": "query parameter \"exchange\" is required"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "authentication failed"
  }
}

{
  "error": {
    "code": "permission_denied",
    "message": "permission denied"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "security not found"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "rate limit exceeded"
  }
}