Pagination
Some API calls that return a large number of results will be broken up into multiple pages. You might need to make multiple API calls with slightly varied paging parameters to iteratively collect all the data you are trying to gather.
Parameters
Use the following query parameters to paginate through results:
Name | Description | Default |
---|---|---|
skip | number of items to skip from the full results set | 0 |
limit | The number of items you want included on each page of results | 100 |
Requests without these parameters will use the default values.
Iterate Through Results
To iterate through all results, you will need to begin with a skip=0
and a limit=numberOfRequestedResults
. To get the next page, set skip=numberOfRequestedResults
and keep limit=numberOfRequestedResults
. Following pages will have the skip
parameter set to 2*numberOfRequestedResults
, 3*numberOfRequestedResults
, 4*numberOfRequestedResults
until you reach the end of the dataset.
When you have reached the end of the dataset your response will contains fewer elements than you defined in numberOfRequestedResults
or you get an empty array of results.
Updated 5 months ago