Indicator catalog
Order flow indicators, computed live from the trades. Each page covers the parameters, the data you receive and example messages.
Fathom Trades
Size leaves a trace. Isolate aggressive orders above your threshold and see exactly where they hit the market.
Fathom Footprint
Look inside the candle. The raw detail, price by price: volume traded at the bid and the ask, to read the pressure on both sides.
Fathom Zones
See where the market pushed with conviction. Strong directional moves become buyer or seller effort zones that price comes back to test.
Fathom Walls
Some levels hold, again and again. Spot the ones buyers or sellers keep defending.
Fathom Flow
Is that volume burst actually moving price? Accelerations, exhaustions, slowdowns and absorption levels put every move in context.
Fathom Imbalances
Where the footprint shows every number, Imbalances keeps only the signal: when one side overwhelms the other on several levels in a row, the closed candle leaves a zone on the chart.
Fathom VWAP
Keep price in perspective. VWAP and its bands show where the market sits against everything traded this session.
Fathom Levels
Your reference levels, always in view. Open, extremes and VWAP frame your read of the session.
Fathom Profile
See where the session’s volume concentrates. Track the point of control, value area and VWAP as the session develops.
Fathom Opening
Set the frame from the open. Track the opening range bounds, then the projections published once price breaks out.
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.
| Indicator | API id | Objects and id formats | Snapshot period | Starts over | Default timeframe |
|---|---|---|---|---|---|
| Fathom Trades | big-trades | group: <startNs>:<ordinal> | Session | Never: each group stands on its own | — |
| Fathom Footprint | footprint | bar: <barStartNs> | Session | Never: each bar stands on its own | 15 |
| Fathom Zones | effort-zones | bar: bar:<weekSunday>:<index>ema: ema:<weekSunday>:<index>zone: zone:<weekSunday>:<startIndex> | Trading week | Every week | — |
| Fathom Walls | liquidity-walls | signal: <barStartNs> | Trading week | Every week | 60 |
| Fathom Flow | flow-tracker | drawing: <kind>:<weekSunday>:<ordinal> | Trading week | Every week | 60 |
| Fathom Imbalances | imbalances | zone: <weekSunday>:<ordinal> | Trading week | Every week, or every session with resetSession | 300 |
| Fathom VWAP | vwap-bands | point: <barStartNs> | Trading week | Every session (daily, the default), or every week with bars | 300 |
| Fathom Levels | key-levels | level: <period>:<key>:<label> | UTC day | Never: rolling windows | 300 |
| Fathom Profile | session-profile | values: <barStartNs> | Trading week | Every session | 300 |
| Fathom Opening | opening-range | range: range:<session>zone: zone:<session>:<ordinal>projection: proj:<session>:<protection|ext-1|ext-2>statistics: statistics:<session> | Trading week | Every session | 300 |
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.
| Name | API id |
|---|---|
| Fathom Trades | big-trades |
| Fathom Footprint | footprint |
| Fathom Zones | effort-zones |
| Fathom Walls | liquidity-walls |
| Fathom Flow | flow-tracker |
| Fathom Imbalances | imbalances |
| Fathom VWAP | vwap-bands |
| Fathom Levels | key-levels |
| Fathom Profile | session-profile |
| Fathom Opening | opening-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:
| Field | Meaning |
|---|---|
id | The id you send in indicator. |
name | The indicator’s Fathom name, as on the site (Fathom Trades): not used in requests, and only in the comments of generated types. |
summary | One-line summary. |
description | Three 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. |
origin | Where the computation starts over history: one of the values listed below this table. The estimate gives the resulting coveredFrom. |
inputs | Data the indicator reads: trades. |
computeUnitsPerTrade | Compute units per trade read over history. |
params | Parameters 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. |
productDefaults | Defaults 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. |
objects | Kinds 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). |
paramsSchema | JSON Schema (draft 2020-12) of params. |
dataSchema | JSON Schema of data. |
example | params 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).