Endpoints that support pagination can be queried using the pagination options defined below.
Passing the pagination object in the request body is optional and defaults will be used instead.
The defaults for sort and order are specific per [endpoint](#Paginated endpoints).
Pagination parameters
(NOTE: Search endpoint only accepts the parameters page and limit in the pagination object)
| Name | Info |
|---|---|
| page | required start at 1 |
| limit | optional default 10 max 1000 |
| sort | optional see endpoint for default and sort options |
| order | optional default to ASC for text values and DESC for numeric values |
API Example: Stocks daily list
{
"listId": "top-winners",
"markets": [
"USA"
],
"pagination": {
"page": 1,
"limit": 10,
"sort": "name",
"order": "ASC"
}
}
The response will include the total number of available items as total.
{
"top-winners": [
// list content
],
"total": 12
}