Skip to content

Commit 2b23a58

Browse files
committed
docs: document the data_as_of response envelope
Every FlashAlpha API response carries data_as_of, reporting when each upstream feed last delivered to the node that answered, plus endpoint_version identifying the deployment. Nine feeds are reported separately - equity and index spot, their option chains, futures and futures options, the classified trade tape, settled open interest, and the macro series - because they arrive over different pipes and fail independently. An index chain can be current while the index level behind it is not, and one timestamp cannot express that. The section covers how to read it, not just what it is: each feed against its OWN cadence rather than against as_of. Settled open interest dated to the previous session's close is correct, because it is published once per session - on a Monday the newest figure that exists is Friday's. An options feed an hour behind during the regular session is not. A null means that node has not seen that feed, not that it is broken. The limit is stated alongside the claim: the field evidences that a feed delivered recently, not that every contract in a chain is equally current. Documentation only. No code changes.
1 parent 5cb6b2b commit 2b23a58

2 files changed

Lines changed: 50 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,44 @@ Five more end-to-end recipes — pair-by-ticker with equity bars, 0DTE pin-risk
147147

148148
---
149149

150+
## Data provenance: `data_as_of`
151+
152+
Every FlashAlpha API response carries `data_as_of`, reporting when each upstream feed last
153+
delivered to the node that answered, plus `endpoint_version` identifying the deployment
154+
that produced it.
155+
156+
```json
157+
"endpoint_version": "2026.08.25",
158+
"data_as_of": {
159+
"node": "fa2",
160+
"equity_feed": "2026-08-25T18:48:58.204Z",
161+
"equity_options_feed": "2026-08-25T18:48:57.900Z",
162+
"index_feed": null,
163+
"index_options_feed": null,
164+
"futures_feed": null,
165+
"futures_options_feed": null,
166+
"flow_feed": "2026-08-25T18:48:55.100Z",
167+
"oi_feed": "2026-08-22T20:00:00.000Z",
168+
"macro_feed": "2026-08-25T18:45:00.000Z"
169+
}
170+
```
171+
172+
Spot and options are reported separately because they arrive over different pipes and fail
173+
independently - an index chain can be current while the index level behind it is not, and
174+
one timestamp cannot express that.
175+
176+
Read each feed against its **own cadence**, not against `as_of`. `oi_feed` at the previous
177+
session's close is correct: settled open interest is published once per session, so on a
178+
Monday the newest figure that exists is Friday's. An options feed an hour behind during
179+
the regular session is not correct. A `null` means that node has not seen that feed, not
180+
that it is broken.
181+
182+
The field evidences that a feed delivered recently. It does not assert that every contract
183+
in a chain is equally current: an illiquid strike may not have quoted for hours while its
184+
feed is healthy.
185+
186+
Full reference: <https://flashalpha.com/docs/lab-api-overview#response-envelope>
187+
150188
## Data catalog
151189

152190
Every bar lives at `https://historical.flashalpha.com/docs/<endpoint>`. Full field tables and side-by-side `OnData` samples are in [docs/data-types.md](docs/data-types.md).

llms.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

33
> FlashAlpha options-flow and dealer-positioning data as native QuantConnect LEAN custom-data bars. Seventeen endpoint families — GEX/DEX/VEX/CHEX, exposure summary/levels, vol surface, 0DTE, max pain, volatility, advanced vol (SVI), VRP, narrative, stock summary/quote, option quote, tickers — exposed as `BaseData` subclasses in C# and `PythonData` subclasses in Python. Works in QC Cloud and self-hosted LEAN. Versioned to the underlying `flashalpha-historical` SDK so schema drift breaks at compile time.
44

5+
## Data provenance
6+
7+
Every FlashAlpha API response carries `data_as_of`: when each upstream feed last delivered
8+
to the node that answered - equity and index spot, their option chains, futures and futures
9+
options, the classified trade tape, settled open interest, and the macro series, each
10+
reported separately because they arrive over different pipes and fail independently. `null`
11+
means that node has not seen that feed, not that it is broken. Read each feed against its
12+
own cadence: settled open interest dated to the previous session's close is correct, while
13+
an options feed an hour behind during the regular session is not. `endpoint_version`
14+
identifies the deployment. Full reference:
15+
https://flashalpha.com/docs/lab-api-overview#response-envelope
16+
517
## Docs
618

719
- [README](README.md): elevator pitch, install, first algorithm, full data catalog, FAQ

0 commit comments

Comments
 (0)