Footprint

Get the volume footprint row size scale

The row size scale a settings UI can offer for one security and timeframe, in absolute quote-currency units - the units rowSizeValue and every profile’s rowSize speak, so scale values can be echoed back directly: the step every achievable row size is a multiple of, and the bounds it stays within.

Measured over the most recent profile periods (a server-configured count, by default 100), ending at the security’s newest stored candle - the window a chart opens on.
A rowSizeValue that is a whole multiple of the step within [minRowSize, maxRowSize] is answered verbatim by requests over that recent window. History deeper than it can be stored more coarsely, so a request reaching far back may resolve a coarser grid, which the response and stream report and the echoed rowSizeValue follows.
The step follows how coarsely the stored data of the timeframe is packed, so it differs between timeframes and securities and can grow over time - re-read it with the chart rather than caching it.
404 (exchange not found) when the exchange is not served; 404 with the generic requested resource was not found when the security is not served or the window holds no stored data - unlike the profile endpoints, this one cannot tell the two apart.

Cost: 1000 credits per request (flat).

GET

api

marketdata

footprint

row-size-scale

Get the volume footprint row size scale

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

import requests

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

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://public-api.takeprofit.com/api/v1/marketdata/footprint/row-size-scale', 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/row-size-scale",
  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/row-size-scale"

	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/row-size-scale")

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"
  },
  "rowSizeStep": "100",
  "minRowSize": "100",
  "maxRowSize": "2600"
}

{
  "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": "requested resource was 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"

sessionType

enum<string>[]

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

Available options:

MAINSESSION,

PRE_MARKET,

POST_MARKET

Response

Volume footprint row size scale response.

meta

object

required

Show child attributes

rowSizeStep

string

required

The quantum of the scale, in quote currency units. A rowSizeValue that is a whole multiple of this within [minRowSize, maxRowSize] comes back verbatim. The least common grid of the security's tick size and the coarsest stored price grid of the measured window; divided by the tick size it is always a whole number of ticks.

minRowSize

string

required

The smallest row size a request is answered with; anything below comes back as this. Equal to rowSizeStep unless the per-profile row limit binds on the widest profile period of the window.

maxRowSize

string

required

Advisory upper end of the scale: the widest profile period's price range on the step grid. Larger values are served but render every profile as a single row.

Get the volume footprint row size scale

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

import requests

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

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://public-api.takeprofit.com/api/v1/marketdata/footprint/row-size-scale', 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/row-size-scale",
  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/row-size-scale"

	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/row-size-scale")

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"
  },
  "rowSizeStep": "100",
  "minRowSize": "100",
  "maxRowSize": "2600"
}

{
  "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": "requested resource was not found"
  }
}

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