singer_sdk.pagination.JSONPathPaginator

class singer_sdk.pagination.JSONPathPaginator

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

__init__(jsonpath: str, *args: Any, **kwargs: Any) None

Create a new paginator.

Parameters
  • jsonpath – A JSONPath expression.

  • 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.