Skip to content

Free plan: today's data needs Build after an account's first 30 days - #32

Open
0xFantomMenace wants to merge 1 commit into
masterfrom
docs/free-plan-today-needs-build
Open

0xFantomMenace wants to merge 1 commit into
masterfrom
docs/free-plan-today-needs-build

Conversation

@0xFantomMenace

Copy link
Copy Markdown
Member

Merge on 2026-11-23 when the change takes effect.

From November 23, 2026, after an account's first 30 days (counted from sign-up), Free data runs through yesterday (UTC): today's data and live streams need Build, and replays of past days stay on Free. Free keeps 50,000 credits a month, its rolling 30-day history window, the 30-day span per request or replay, and every route. Build and above are unaffected.

A Free REST request whose window reaches into today (an end, or timestamp on a point-in-time route, at or after 00:00 UTC today, a range without end, or any current, recent or summary route) is refused before it is metered with HTTP 403 forbidden. The body names the plans that serve today, so the SDK already raises it as PlanRequiredError: datatype is None, required_plans is ["build", "pro", "scale", "enterprise"], upgrade_url is set, and details carries reason ("today_needs_build") and data_ends_on (the last day served). No SDK code change is needed.

Changes

  • README
    • New Free Plan section: what is refused on REST and WebSocket, the refusal body, and what is never refused (instrument and pair lists, HIP-4 outcomes and questions, freshness).
    • Quick Start: a note that its calls read today's data; the "every plan reads the most recent 30 days" comment is removed.
    • REST reference: the shared now windows no longer claim every plan can reach them, with the line to use on Free.
    • Data Coverage, the plan paragraph in Web3 Authentication, live Lighter, mempool and the WebSocket intro no longer say live data is on every plan. The plan paragraph also lists the Build-and-above datasets among the exceptions, which it had left out.
    • Error Handling: how to recognise the new refusal, with an example.
  • Docstrings: ErrorCode, PlanRequiredError and WsError.
  • Tests: one test pins how the refusal body is surfaced (PlanRequiredError, datatype is None, details["reason"], details["data_ends_on"]).

Checks

  • pytest: 600 passed, 17 skipped.
  • ruff check on the changed files: no new findings.

From November 23, 2026, after an account's first 30 days, Free data runs
through yesterday (UTC). A Free REST request whose window reaches into
today is refused before it is metered with HTTP 403 forbidden, which the
SDK raises as PlanRequiredError with details["reason"] ==
"today_needs_build" and details["data_ends_on"]. Live subscribes, and
replays that reach into today, are answered with forbidden; replays of
past days stay on Free.

- README: a Free Plan section, the Quick Start and REST reference
  windows, the Web3 plan paragraph, live Lighter and mempool notes, the
  WebSocket intro, and Error Handling no longer say that every plan reads
  today's data or streams live.
- Docstrings for ErrorCode, PlanRequiredError and WsError describe the
  new refusal.
- A test pins how the refusal body is surfaced.
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.

1 participant