Pagination

See the pagination guide for usage patterns.

Bases: BasePage[T]

One page of results from the sync client.

next_page

next_page() -> SyncCursorPage[T] | None

Fetch the next page, or return None on the last page.

The original filter/sort parameters are re-sent alongside the cursor, as required by the API (the cursor does not encode them).

iter_pages

iter_pages() -> Iterator[SyncCursorPage[T]]

Iterate page by page, starting with this one.

__iter__

__iter__() -> Iterator[T]

Iterate over the items of every page (auto-pagination).

Bases: BasePage[T]

One page of results from the async client.

next_page async

next_page() -> AsyncCursorPage[T] | None

Fetch the next page, or return None on the last page.

iter_pages async

iter_pages() -> AsyncIterator[AsyncCursorPage[T]]

Iterate page by page, starting with this one.

__aiter__

__aiter__() -> AsyncIterator[T]

Iterate over the items of every page (auto-pagination).

Bases: BaseNumberedPage[T]

One page of results from a page-number paginated endpoint (sync).

next_page

next_page() -> SyncNumberedPage[T] | None

Fetch the next page, or return None on the last page.

iter_pages

iter_pages() -> Iterator[SyncNumberedPage[T]]

Iterate page by page, starting with this one.

__iter__

__iter__() -> Iterator[T]

Iterate over the items of every page (auto-pagination).

Bases: BaseNumberedPage[T]

One page of results from a page-number paginated endpoint (async).

next_page async

next_page() -> AsyncNumberedPage[T] | None

Fetch the next page, or return None on the last page.

iter_pages async

iter_pages() -> AsyncIterator[AsyncNumberedPage[T]]

Iterate page by page, starting with this one.

__aiter__

__aiter__() -> AsyncIterator[T]

Iterate over the items of every page (auto-pagination).