GET /v1/footprint/stacks

#`GET /v1/footprint/stacks`getFootprintStacks

Stacked imbalance zones (the Footprint chart's rule)

Scope	analytics:read
Lowest tier	sandbox
Weight (units)	10; 20 over 120 bars or all=1
History each tier may read	Sandbox: 2 days; Starter: 7 days; Elite (included): 7 days; Developer: 30 days; Business: 90 days
SDK	Python client.footprint.stacks · JavaScript cd.footprint.stacks

Parameters

Parameter	In	Type	Description
`venue` required	query	`string`	Venue id (see /v1/venues), lower case.
`symbol` required	query	`string`	The venue's symbol (BTCUSDT; see /v1/markets).
`res` required	query	`string`	Resolution: minutes (1 ... 720), 1D, 1W, 1M; seconds (1S ... 45S) and ticks (10T ...) from Developer.
`from`	query	`string`	Start, inclusive: unix seconds or RFC 3339.
`to`	query	`string`	End, exclusive: unix seconds or RFC 3339. Default now.
`all`	query	`boolean`	Every zone, not only the open ones.
`ratio`	query	`number`	Imbalance ratio.
`rows`	query	`integer`	Stacked rows needed.
`gaps`	query	`integer`	Gaps allowed.
`side`	query	`"buy" \| "sell" \| "both"`	Side.
`min_k`	query	`number`	Smallest level (thousands).
`min_usd`	query	`number`	Smallest level in USD.
`min_qty`	query	`number`	Smallest level in coins.
`end`	query	`string`	Zone end rule.

Errors

400 invalid_param, invalid_cursor
401 unauthorized: missing, unknown, revoked or expired key
403 insufficient_scope, tier_required
404 not_found, not_available, not_in_sandbox
422 window_too_large
429 rate_limited (per minute) or quota_exhausted (month; X-Quota-* headers, Retry-After = seconds to the next month); see Retry-After
503 api_disabled, overloaded

Example

Shell

curl "https://api.chartdeck.trade/v1/footprint/stacks?venue=binance&symbol=BTCUSDT&res=60" \
  -H "Authorization: Bearer $CHARTDECK_API_KEY"

Python

from chartdeck import Client

client = Client()  # reads CHARTDECK_API_KEY
r = client.footprint.stacks(venue="binance", symbol="BTCUSDT", res="60")
print(r.data, r.meta["attribution"])

JavaScript

import { ChartDeck } from '@chartdeck/api';

const cd = new ChartDeck();  // reads CHARTDECK_API_KEY
const r = await cd.footprint.stacks({ venue: "binance", symbol: "BTCUSDT", res: "60" });
console.log(r.data, r.meta.attribution);

GET /v1/footprint/stacks

#GET /v1/footprint/stacksgetFootprintStacks

#`GET /v1/footprint/stacks`getFootprintStacks