Skip to content
ChartDeck Developer API docs Account Get an API key

GET /v1/pictures/strata/{widget}.png

#GET /v1/pictures/strata/{widget}.pnggetStrataPicture

A Strata widget as a PNG picture, drawn by the Strata page itself

Answers the image, not the JSON envelope (errors stay JSON). The widget is drawn by the Strata page's own code from the same data, in a headless browser, and photographed (each widget takes the controls the page offers it: 400 not_applicable for others). layout=frame (the default since 1.3.10 for the widgets that have a frame: levels, heatmap, netpos, replay, hl, realized, screener, calibration, blocks, oi, terrain, whales, funding, fundclock, context, divergence and the cross-coin widgets) is a picture made for posting: a fixed 16:9 frame (the table-like widgets: as tall as their content), 1600 x 900 CSS px at scale 2 (3200 x 1800 pixels) by default, with no buttons or small print, in two looks: style=flat (default: a flat black frame, the chart edge to edge in crisp rows with a color scale bar, the key numbers as text lines above it) or style=glass (a title line and the key numbers in glass blocks inside the chart). Both name the widget, coin, venue, window and the draw time in UTC. layout=page is the card exactly as a member sees it on the page. A widget with nothing to draw for the request (an unknown coin, no data for the venue or window) answers 404 no_data, never a picture of an empty card. The sources of the data it shows are in X-Attribution (show them yourself: Terms Section 9); attribution=strip also prints them in the picture (the default is header, a clean picture, since 1.3.10). One render per parameter set and data version per 45 s, shared by every caller: Cache-Control: private, max-age=<seconds left>; a cached picture costs the same. Pictures per key per minute: Starter 20, Developer 60, Business 120 (429 picture_rate_limited); since 1.3.10 a picture counts toward the monthly units only, not against the units-per-minute limit. Under load or while the renderer is down: 503 with Retry-After, never a wrong picture. PNG = lossless, the exact pixels.

Scopecharts:read
Lowest tiersandbox
Weight (units)20 at any size and scale; +5 for window=30d
SDKPython client.pictures.strata · JavaScript cd.pictures.strata

Parameters

ParameterInTypeDescription
widget requiredpath"levels" | "heatmap" | "replay" | "hl" | "realized" | "netpos" | "whales" | "funding" | "screener" | "context" | "calibration" | "blocks" | "oi" | "series" | "expertgrid" | "terrain" | "fundclock" | "rankmap" | "quadrant" | "correlation" | "paircorr" | "spaghetti" | "distribution" | "profiles" | "coinmatrix" | "stacker" | "timegrid" | "coinpulse" | "divergence"The Strata widget, as the card is named on the page.
coinquerystringdefault "BTC"Base coin of the USDT perpetual (BTC, ETH, 1000PEPE); symbol=BTCUSDT is read the same. Widgets: levels, heatmap, replay, hl, realized, netpos, funding, context, calibration, series, terrain, fundclock, rankmap, quadrant, correlation, paircorr, spaghetti, distribution, profiles, coinmatrix, stacker, timegrid, coinpulse, divergence.
venuequery"all" | "binance" | "bybit" | "okx" | "bitget" | "blofin" | "hyperliquid" | "mexc" | "gate" | "kucoin" | "krakenfutures" | "dydx" | "woox" | "backpack" | "coinbase" | "bingx" | "aster"default "all"All venues (guarded) or one venue: the page’s Venue select. Widgets: levels, heatmap, replay, realized, netpos, calibration, terrain.
windowquery"7d" | "30d"default "7d"History: 7D, or 30D where the tier has it. Widgets: levels, heatmap, replay, realized, netpos, funding, calibration, series, terrain.
half_lifequeryintegerdefault 48Half-life in hours (the Half-life slider). Widgets: levels, heatmap, replay, terrain. Whole number 6 to 168 in steps of 6.
thresholdqueryintegerdefault 0Hide cells below this % of the peak (the Threshold slider). Widgets: levels, heatmap, replay, terrain. Whole number 0 to 60 in steps of 2.
sidequery"both" | "long" | "short"default "both"Which side of the book (the Side buttons). Widgets: levels, heatmap, replay, realized, terrain.
themequery"dark" | "light"default "dark"The page’s dark or light theme.
langquery"en" | "es" | "pt-BR" | "fr" | "de" | "it" | "tr" | "ru" | "uk" | "zh-CN" | "zh-TW" | "ja" | "ko" | "hi" | "ar" | "id" | "vi"default "en"Language of the card’s words (the page’s 17 languages).
layoutquery"frame" | "page"default "frame"frame (default since 1.3.10) = the share picture: a fixed frame with a title line, the stat blocks inside the chart and no controls or small print; page = the card exactly as the Strata page draws it. A widget that has no frame picture yet is drawn as page.
stylequery"flat" | "glass"default "flat"layout=frame only (a page card reads it and changes nothing; a widget that has only the flat look answers flat for either value): flat (default) = a flat black frame, the chart edge to edge with crisp rows, a color scale bar at the left and the key numbers as text lines above the chart; glass = a title line and the key numbers in glass blocks inside the chart.
widthqueryintegerPicture width in CSS pixels. layout=frame: the frame’s width (default 1600; the same composition at any width, only larger or smaller). layout=page: the card’s width on the page (default 1200; the browser window is 32 px wider) and the height follows the card. Whole number 360 to 2400.
heightqueryintegerlayout=frame only: the frame’s height in CSS pixels (default: 16:9 of the width, 900 at 1600). The width must be 1 to 3 times the height. Refused by the table-like widgets (realized, screener, calibration, blocks, oi, context, expertgrid), whose picture is as tall as its content. Whole number 240 to 2400.
scalequery"1" | "2"Device pixel ratio: 2 doubles every pixel dimension (sharper text), at the same price. Default: 2 for layout=frame (3200 x 1800 pixels at the default size), 1 for layout=page.
attributionquery"strip" | "header"default "header"Sources only in the X-Attribution header (header, default since 1.3.10: you show them yourself, Terms Section 9) or also printed under the card (strip).
spanquery"wide" | "half"layout=page only (a frame picture reads it and changes nothing): the card’s width class on the page (Edit layout): wide = a full row, half = half a row (smaller charts). Default = the widget’s own default.
bandsquery"6" | "10" | "16"default "10"Bands drawn. Widget: stacker.
barsquery"12" | "24" | "36"default "24"Rolling window in bars. Widget: paircorr.
colorquery"distance" | "cohort"default "distance"Level colors: distance from price, or leverage cohort (where the venues export it). Default: distance; cohort in a style=flat frame picture. Widget: levels.
estimatequerybooleandefault falseScale sizes by the sweep coverage estimate. Widget: hl.
fieldquery"net" | "long" | "short" | "chg"default "net"Net, longs, shorts or change. Widget: whales.
hoursquerystringA widget's own control; its values and default depend on the widget (see the widget table). Widgets: rankmap, quadrant, correlation, paircorr, spaghetti, distribution, profiles, coinmatrix, stacker, timegrid, coinpulse, divergence.
indicatorquerystringA widget's own control; its values and default depend on the widget (see the widget table). Widgets: rankmap, correlation, paircorr, spaghetti, distribution, profiles, stacker.
metricquerystringA widget's own control; its values and default depend on the widget (see the widget table). Widgets: netpos, divergence.
modequerystringA widget's own control; its values and default depend on the widget (see the widget table). Widgets: realized, rankmap, quadrant, distribution, coinmatrix, timegrid.
modelquerybooleandefault trueShow the model overlay. Widget: hl.
orderquerystringA widget's own control; its values and default depend on the widget (see the widget table). Widgets: rankmap, correlation.
pairquerystringThe second coin (default: the biggest other book). 1.2.9: named pair, not with (a keyword in Python). Widget: paircorr.
periodquery"0" | "12" | "24"default "0"Last 12 h, 24 h, or everything in the window (0). Widget: realized.
rampquery"heat" | "viridis"default "heat"Color ramp: the heatmap’s, or Viridis. Widget: terrain.
rangequery"full" | "25" | "10"default "full"Price range: full book, ±25 %, ±10 %. Widget: hl.
rowsquery"24" | "40" | "60"default "40"Price rows (capped by the data). Widget: profiles.
scopequery"sym" | "all"default "all"This coin, or all tracked coins. Widget: realized.
showquerystringA widget's own control; its values and default depend on the widget (see the widget table). Widgets: spaghetti, stacker.
sortquery"oi" | "oi24h" | "px24h" | "fund" | "lsr" | "liq"Sort column (default: the page’s, open interest). Widget: screener.
splitquery"auto" | "zero" | "median"A widget's own control; its values and default depend on the widget (see the widget table). Widgets: quadrant, coinmatrix.
stepqueryintegerdefault -1Replay column (0 = oldest, -1 = now). Widget: replay. Whole number -1 to 10000.
third_asquery"size" | "color" | "both"default "both"The third reading as dot size, color or both. Widget: coinmatrix.
unitquery"apr" | "8h" | "raw"default "apr"APR, per 8 h, or the venue’s raw rate. Widget: funding.
value_areaquery"60" | "70" | "80"default "70"Value area, % of the mass. Widget: profiles.
viewquery"rate" | "cum"default "rate"Rate, or the accrual over the window. Widget: funding.
xquerystringA widget's own control; its values and default depend on the widget (see the widget table). Widgets: quadrant, coinmatrix.
yquerystringA widget's own control; its values and default depend on the widget (see the widget table). Widgets: quadrant, coinmatrix.
zquerystringdefault "oi"Third (in the dots): any of the 34 indicators, optionally @1h (flows, and the levels open interest, price, L/S ratios, OI share, funding, taker buy ratio, basis, premium, sentiment gap, whale dominance, net L/S, net OI) / @4h / @1d / @1w / @1M anchored. Widget: coinmatrix.

Errors

  • 400 invalid_param, unknown_param, not_applicable
  • 401 unauthorized: missing, unknown, revoked or expired key
  • 403 insufficient_scope, tier_required
  • 404 unknown_widget, no_data (nothing to draw for this coin, venue or window), pictures_unavailable, not_in_sandbox
  • 422 window_too_large
  • 429 picture_rate_limited (pictures per key per minute) or quota_exhausted (month); see Retry-After
  • 503 api_disabled, overloaded, render_busy, render_timeout, renderer_unavailable, upstream_unavailable (502 picture_failed)

Example

Shell
curl "https://api.chartdeck.trade/v1/pictures/strata/levels.png" \
  -H "Authorization: Bearer $CHARTDECK_API_KEY"
Python
from chartdeck import Client

client = Client()  # reads CHARTDECK_API_KEY
r = client.pictures.strata("<widget>")
print(r.data, r.meta["attribution"])
JavaScript
import { ChartDeck } from '@chartdeck/api';

const cd = new ChartDeck();  // reads CHARTDECK_API_KEY
const r = await cd.pictures.strata("<widget>");
console.log(r.data, r.meta.attribution);

The Developer API documentation is in English.