Repository navigation
HELD until the API returns next_cursor on order flow: document order-flow paging - #14
Closed
0xFantomMenace wants to merge 1 commit into
Closed
0xFantomMenace wants to merge 1 commit into
0xFantomMenace wants to merge 1 commit into
Conversation
Restores the order-flow paging docs for when the API returns next_cursor on order flow. Hold until then. - `OrderFlowParams.cursor` JSDoc: the previous response's nextCursor, sent with the same start, end and interval; `limit` is buckets per page. - The `flow()` JSDoc says a page holds the oldest `limit` buckets and how to follow nextCursor. - The README order-flow example follows nextCursor. - CHANGELOG: order flow pages with nextCursor.
0xFantomMenace
force-pushed
the
docs/order-flow-paging
branch
from
September 29, 2026 00:17
f1f09fc to
9a63cb3
Compare
0xFantomMenace
force-pushed
the
master
branch
from
September 29, 2026 00:17
7d8fd18 to
3015676
Compare
Member
Author
|
Included in #19 (order flow paging docs and cursor forwarding). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Held. Do not merge until the API returns
next_cursoron order flow. The API already buckets order flow at1m,5m,15mand1hand reads a sentcursor, but it does not returnnext_cursoron order flow yet. That arrives with an API switch, which is turned on after SDK releases that forward the cursor are published. Merge this once the switch is on and verified.#13, which keeps
OrderFlowParams.cursorand drops the paging docs, is merged, and this PR now targetsmaster. Its diff is only the paging docs.Changes
OrderFlowParams.cursorJSDoc: the previous response'snextCursor, sent with the samestart,endandinterval.limitreads as buckets per page (default 1000, max 10000).flow()JSDoc: a page holds the oldestlimitbuckets of the window; whilenextCursoris set, pass it back ascursor, and stop when it is undefined.nextCursorwith the same window.No code change: the type and the request path are already in #13.
Before merging
next_cursoron order flow: a full day at1mon BTC gives 1000 buckets plus a cursor, then the other 440.master(both done).Test plan
vitest run: 73 passed.tsc --noEmit: clean.eslint src/: 0 errors (36 existing warnings).