feat: add helpers to fetch all market pages #225
+83
−0
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.
Summary
This PR adds four convenience methods to
ClobClient:getAllMarketsgetAllSimplifiedMarketsgetAllSamplingMarketsgetAllSamplingSimplifiedMarketsEach helper iterates through the paginated CLOB API using
next_cursorandEND_CURSOR, aggregatingdatafrom all pages into a single array.Motivation
Currently,
getMarkets,getSimplifiedMarkets,getSamplingMarketsandgetSamplingSimplifiedMarketsonly return a single page of results. Clientcode has to implement pagination manually. These helpers provide an ergonomic
way to fetch all markets without changing the existing API surface.
Implementation details
INITIAL_CURSOR/END_CURSORconstants.next_cursor === END_CURSORand concatenatesresponse.data.Note
Adds four
ClobClienthelpers to iterate paginated markets and return aggregated results.src/client.ts):getAllMarkets(next_cursor?): loops vianext_cursoruntilEND_CURSOR, aggregatesresponse.data.getAllSimplifiedMarkets(next_cursor?): same for simplified markets.getAllSamplingMarkets(next_cursor?): same for sampling markets.getAllSamplingSimplifiedMarkets(next_cursor?): same for sampling simplified markets.INITIAL_CURSOR/END_CURSOR.Written by Cursor Bugbot for commit c151f64. This will update automatically on new commits. Configure here.