Skip to content

HELD until the API returns next_cursor on order flow: page order flow with --cursor - #6

Closed
0xFantomMenace wants to merge 1 commit into
masterfrom
docs/order-flow-paging
Closed

0xFantomMenace wants to merge 1 commit into
masterfrom
docs/order-flow-paging

Conversation

@0xFantomMenace

@0xFantomMenace 0xFantomMenace commented Sep 27, 2026 •

Copy link
Copy Markdown
Member

Held. Do not merge until the API returns next_cursor on order flow. The API already buckets order flow at 1m, 5m, 15m and 1h and reads a sent cursor, but it does not return next_cursor on 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.

#5, which keeps --cursor and drops the paging help and output, is merged, and this PR now targets master. Its diff is only the paging help and output.

Changes

  • oxa orders flow and oxa hip4 orders flow: --cursor help says it is the previous response's cursor, sent with the same --start, --end and --interval; --limit counts buckets per page (default 1000, max 10000).
  • With --out, the summary reports has_more and nextCursor, and pretty output shows "Has more" and says when more data is available, as oxa orders history does. (Before the API switch these would always read "no more", which is why they are held.)
  • README: the --cursor row and how to page.
  • CHANGELOG: the Unreleased entry describes order-flow paging.

Before merging

  1. The API returns next_cursor on order flow: a full day at 1m on BTC gives 1000 buckets plus a cursor, then the other 440.
  2. Accept --interval 1m on aggregated history, and page order flow with --cursor #5 is merged and this PR targets master (both done).

Test plan

  • tsc --noEmit: clean.
  • vitest run: 73 passed (5 files).

Restores the order-flow paging help and output for when the API returns
next_cursor on order flow. Hold until then.

- `--cursor` help: the previous response's cursor, sent with the same
  --start, --end and --interval. `--limit` counts buckets per page.
- With --out, the summary reports has_more and nextCursor, and pretty
  output says when more data is available, as order history does.
- README: how to page with --cursor.
- CHANGELOG: order flow pages with nextCursor.
@0xFantomMenace

Copy link
Copy Markdown
Member Author

Included in #9 (order flow paging help and README).

@0xFantomMenace
0xFantomMenace deleted the docs/order-flow-paging branch September 29, 2026 04:38
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