Reference

Indicator catalog

Order flow indicators, computed live from the trades. Each page covers the parameters, the data you receive and example messages.

Each parameter has a generic default, and a ticker can have its own; ticker defaults are regularly updated, ticker by ticker, and each indicator page lists them. A subscription with all parameters at its instrument’s defaults is not a custom configuration. Only explicit parameters keep a computation identical over time: pass them to keep the same results.

Summary

The objects of each indicator, the period its snapshot covers, when it starts over, the format of its ids and its default timeframe, in seconds, for the tickers without their own. In the id formats, weekSunday is the date of the Sunday reopen of the week, and session the date of the session.

IndicatorAPI idObjects and id formatsSnapshot periodStarts overDefault timeframe
Fathom Tradesbig-tradesgroup: <startNs>:<ordinal>SessionNever: each group stands on its own—
Fathom Footprintfootprintbar: <barStartNs>SessionNever: each bar stands on its own15
Fathom Zoneseffort-zonesbar: bar:<weekSunday>:<index>
ema: ema:<weekSunday>:<index>

zone: zone:<weekSunday>:<startIndex>
Trading weekEvery week—
Fathom Wallsliquidity-wallssignal: <barStartNs>Trading weekEvery week60
Fathom Flowflow-trackerdrawing: <kind>:<weekSunday>:<ordinal>Trading weekEvery week60
Fathom Imbalancesimbalanceszone: <weekSunday>:<ordinal>Trading weekEvery week, or every session with resetSession300
Fathom VWAPvwap-bandspoint: <barStartNs>Trading weekEvery session (daily, the default), or every week with bars300
Fathom Levelskey-levelslevel: <period>:<key>:<label>UTC dayNever: rolling windows300
Fathom Profilesession-profilevalues: <barStartNs>Trading weekEvery session300
Fathom Openingopening-rangerange: range:<session>
zone: zone:<session>:<ordinal>

projection: proj:<session>:<protection|ext-1|ext-2>

statistics: statistics:<session>
Trading weekEvery session300

Indicator names

On the site, each indicator goes by its Fathom name, also the name of its catalog entry (GET /v1/indicators). The API only knows its id: that is what you send in indicator. The SDKs name the generated types after the id (big-trades → BigTradesParams, BigTradesData) and only use the name in their comments.

NameAPI id
Fathom Tradesbig-trades
Fathom Footprintfootprint
Fathom Zoneseffort-zones
Fathom Wallsliquidity-walls
Fathom Flowflow-tracker
Fathom Imbalancesimbalances
Fathom VWAPvwap-bands
Fathom Levelskey-levels
Fathom Profilesession-profile
Fathom Openingopening-range

The catalog is also available from the API, with the JSON schemas of each indicator: GET /v1/indicators.

Catalog format

GET /v1/indicators answers version (the format version, 1), engineFingerprint (the engine version, the engine of subscribed messages) and indicators, one entry per indicator with these fields:

FieldMeaning
idThe id you send in indicator.
nameThe indicator’s Fathom name, as on the site (Fathom Trades): not used in requests, and only in the comments of generated types.
summaryOne-line summary.
descriptionThree blocks separated by a blank line: what the indicator shows, how to read and draw it, when it updates. The indicator page shows the last two.
originWhere the computation starts over history: one of the values listed below this table. The estimate gives the resulting coveredFrom.
inputsData the indicator reads: trades.
computeUnitsPerTradeCompute units per trade read over history.
paramsParameters by name: type (integer, number with at most two decimals, choice, boolean), category (calc changes the result, view only changes what you receive, such as which objects or the published price), default (the default of the tickers without their own), minimum and maximum or options, unit, description.
productDefaultsDefaults of the tickers that have their own, by ticker root (ES) then parameter name: only the parameters whose default differs from default. Empty when every ticker uses default.
objectsKinds of objects received: kind, idPattern (the id format), provisional (true: sent in progress; it may end with a final version or a remove; false: sent once, final), description and fields (the data fields, with type, unit, enum and optional when the field can be absent).
paramsSchemaJSON Schema (draft 2020-12) of params.
dataSchemaJSON Schema of data.
exampleparams and messages of the examples shown on the indicator page.

The values of origin:

  • none: each object stands on its own. The computation starts at 00:00 UTC of the day before the last trade before your range, to complete the objects in progress.
  • week: the start of the trading week, Saturday 00:00 UTC.
  • periods: as many sessions, weeks or months back as the parameters ask (key-levels).