Skip to content

docs: remove cache mentions - #5

Open
tomaszdobrowolski1 wants to merge 3 commits into
mainfrom
docs/remove-paid-cache-window
Open

tomaszdobrowolski1 wants to merge 3 commits into
mainfrom
docs/remove-paid-cache-window

Conversation

@tomaszdobrowolski1

@tomaszdobrowolski1 tomaszdobrowolski1 commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Written for maintainers of this package. Nothing is published by merging this.

The owner decided on 2026-11-09 that customer copy should not mention caching. Paid plans are live, a Free API key gets delayed data, and the stock summary without an API key is the previous trading session's snapshot. The cross-symbol flow scans now say they refresh about every 30 seconds.

Changes

  • docs/api.md: drops the Free 15-minute window and the cached surface, summary, flow-scan and /v1/symbols wording. The /v1/symbols note example matches the API's new text.
  • README.md, AGENTS.md, llms.txt: the anonymous summary is the previous trading session's snapshot, and fa.symbols() lists symbols with live data.
  • src/flashalpha/types.py: docstrings and comments say the same, and the flow leaderboards and outliers refresh about every 30 seconds.

Testing

173 unit tests pass with -m "not integration".

🤖 Generated with Claude Code

tdobrowolski1 and others added 3 commits November 7, 2026 14:15
The 15-second and about-1-second cache windows are being scrapped. Only the Free
plan's 15-minute window stays in the docs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The owner decided on 2026-11-09 that customer copy should not mention caching. Paid plans are live, a Free API key gets delayed data, and the stock summary without an API key is the previous trading session's snapshot. The cross-symbol flow scans now say they refresh about every 30 seconds.

- docs/api.md: drops the Free 15-minute window and the cached surface, summary, flow-scan and /v1/symbols wording. The /v1/symbols note example matches the API's new text.
- README.md, AGENTS.md, llms.txt: the anonymous summary is the previous trading session's snapshot, and fa.symbols() lists symbols with live data.
- src/flashalpha/types.py: docstrings and comments say the same, and the flow leaderboards and outliers refresh about every 30 seconds.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tomaszdobrowolski1 tomaszdobrowolski1 changed the title docs: remove the paid plans' cache window docs: remove cache mentions Nov 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants