Skip to content

Paginator

Paginator for object lists and raw JSON.

Parameters:

Name Type Description Default
url str

Query URL

required
node_name str

Name of the relevant node

required
payload Union[str, None]

POST request payload

None
limit Union[int, None]

The max number of items per page.

None
offset Union[int, None]

The starting position of the paginator.

None
get_level int

Level to recursively get nested nodes.

1

count()

Get the total number of objects.

json()

Get the raw JSON.

next_page()

Flip to the next page.

objects()

Use the current raw JSON to generate a list of objects.

previous_page()

Flip to the previous page.