singer_sdk.pagination.SimpleHeaderPaginator

class singer_sdk.pagination.SimpleHeaderPaginator

Paginator class for APIs returning a pagination token in the response headers.

__init__(key: str, *args: Any, **kwargs: Any) → None

Create a new paginator.

Parameters

  • key – Header key that contains the next page token.

  • args – Paginator positional arguments for base class.

  • kwargs – Paginator keyword arguments for base class.

get_next(response: Response) → str | None

Get the next page token.

Parameters

response – API response object.

Returns

The next page token.