Our approach to pagination is fairly simple. There are only two parameters:
Parameter | Description |
---|---|
page | Tells our API what page of results to return. Default value is 1 . There is no max value. |
page_size | Tells our API how many results to return per page. Default value is 10 . Max value is 100 . |
The response body for paginated endpoints looks something like this:
{
"results": ["i", "am", "an", "array", "of", "results"],
"page": 1,
"page_size": 10,
"total_count": 6
}
The easiest way to traverse results is to increment page
in each successive request until the results
array in the response body is empty.