List historical TPO (Market Profile) data
Provide exchange, symbol, and timeframe. Nothing else is required: the
window defaults to the 40 timeframe periods before now.
- With
fromthe window starts there and runs forward, ending attoor afterperiodseconds (40 timeframe periods by default). - Without
fromthe window ends atto(now by default) and runs backwards overperiodseconds or the 40 timeframe periods before it. - The default is measured in wall-clock time, so it holds fewer than 40 periods on an exchange with non-trading days (about 28 for a 1d frame on a weekday-only market).
periodcannot be added to an explicitfrom+towindow.- Supported timeframes are day, week, and month based (1d..31d, 1w..4w, 1M).
- If
fromis not aligned to a timeframe period boundary, the beginning of the next period is used. - The requested range is limited to at most 400 profiles (with
mergeSessions=GROUP_BY_TYPEevery session type of a period counts as a profile).
Cost: 25 credits per returned timeframe period (distinct openTradingDay), at least
1000 credits per request. With mergeSessions=GROUP_BY_TYPE one profile per session
type is built for every period at no additional cost.
Authorizations
Query Parameters
TakeProfit exchange code as returned by /api/v1/marketdata/exchanges.
"BATS"
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).
"AAPL"
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.
"1h"
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.
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.
Range duration in seconds, counted forward from from or backwards from to.
x >= 1Duration of each profile time block. Defaults to 30m. Duration of each TPO time block.
30m, 1h, 2h, 4h Price row height in tick size. 0 (or omitted) enables automatic row size detection.
0 <= x <= 1000000Optional session filter. Repeat this parameter or pass comma-separated values.
MAINSESSION, PRE_MARKET, POST_MARKET How sessions are merged into profiles. Defaults to MERGE_ALL. MERGE_ALL merges all sessions into one profile per period. GROUP_BY_TYPE builds one profile per session type per period.
MERGE_ALL, GROUP_BY_TYPE