PagedDataFrame
Paginated DataFrame of search results
property
has_next: bool
Whether there is a next page of results available
property
page_number: int
The current page number (0-indexed)
property
size: int
The requested number of items per page. Not necessarily the same as the actual number of items on the page
property
data: DataFrame
The content of the current result page.
property
total_elements: int | None
The total number of elements across all pages
Not available for context items.
property
total_pages: int | None
The total number of pages
Not available for context items.
collect(max_pages: int | None = 10) -> DataFrame
Collects all pages of results into a single DataFrame
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
max_pages
|
int | None
|
Maximum number of pages to collect. Default is set to 10 to prevent accidental excessive API calls. Can be set to None to collect all pages regardless of number. Must be 1 (only the current page) or higher if set. |
10
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
A single DataFrame containing the concatenated results of all collected pages. |