Portal
SandboxAPI v1Not signed inExternal user: —

Pagination

foodapi.pagination.iterator.PageIterator ¶ PageIterator( fetch_page: Callable[ [int, int], tuple[list[T], PaginationMeta] ], *, limit: int = 50, start_offset:…

foodapi.pagination.iterator.PageIterator

PageIterator(
    fetch_page: Callable[
        [int, int], tuple[list[T], PaginationMeta]
    ],
    *,
    limit: int = 50,
    start_offset: int = 0
)

Bases: Generic[T]

Yield all items across paginated API pages.

__iter__

__iter__() -> Iterator[T]

foodapi.models.common.PaginationMeta

Bases: SDKBaseModel

from foodapi import FoodAPI
from foodapi.pagination import PageIterator

client = FoodAPI(api_key="foodapi_xxx")

def fetch(limit: int, offset: int):
    page = client.recipes.list(limit=limit, offset=offset)
    return page.items, page.pagination

for recipe in PageIterator(fetch, limit=50):
    print(recipe.title)

REST list endpoints return items + pagination metadata (total, limit, offset).