Skip to content

HELD until the API returns next_cursor on order flow: document order-flow paging - #14

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.

#13, which keeps the cursor parameter and drops the paging docs, is merged, and this PR now targets master. Its diff is only the paging docs.

Changes

  • orders.flow() docstring: a page holds the oldest limit buckets of the window; while next_cursor is set, pass it back as cursor with the same start, end and interval; stop when it is None. limit reads as buckets per page.
  • README: the order-flow example pages a full day at 1m until next_cursor is None.
  • CHANGELOG: the Unreleased entry describes order-flow paging.

No code change: flow() and aflow() already send cursor (added in #13).

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 1-minute breadth buckets, and page order flow with a cursor #13 is merged and this PR targets master (both done).

Test plan

  • pytest: 97 passed.
  • ruff check oxarchive/resources/orders.py: clean.

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

- The `flow()` docstring says a page holds the oldest `limit` buckets
  and how to follow next_cursor with the same start, end and interval.
- The README order-flow example pages a full day at 1m.
- CHANGELOG: order flow pages with next_cursor.
@0xFantomMenace

Copy link
Copy Markdown
Member Author

Included in #18 (order flow paging docs and cursor forwarding).

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