singer_sdk.pagination.BaseOffsetPaginator

class singer_sdk.pagination.BaseOffsetPaginator[source]

Paginator class for APIs that use page offset.

__init__(start_value, page_size, *args, **kwargs)[source]

Create a new paginator.

Parameters:

  • start_value (int) – Initial value.

  • page_size (int) – Constant page size.

  • args (Any) – Paginator positional arguments.

  • kwargs (Any) – Paginator keyword arguments.

Return type:

None

get_next(response)[source]

Get the next page offset.

Parameters:

response (requests.Response) – API response object.

Returns:

The next page offset.

Return type:

int | None