How pagination works on the Rated API v1.
limit
and offset
.
limit
and offset
parameters. Both parameters accept an existing object ID value (see below) and return objects in chronological order. The limit
parameter specifies how many records to fetch per page. The offset
parameter indicates where to start fetching data or how many records to skip, defining the initial position within the list.
See details on the parameters below:
Parameters | Description |
---|---|
limit | Limit specifies how many records to fetch per page. Default value is 10. |
offset | Offset indicates where to start fetching data or how many records to skip, defining the initial position within the list. Default value is 0. |
pages
which signifies how many pages of data we have for the requested information.
For example, if you call https://api.rated.network/v1/eth/entities/Lido/effectiveness?entityType=pool&sortOrder=desc
you will get about 120 pages of data which signifies about 1,200 days worth of data.
Example of a paginated response
previous
and next
URLs. Just use the URL in next
to continue fetching the rest of the data. You will also get a url in previous
as you navigate throught pages 2,3,4… and so on. When there’s no more data left, the Rated API will stop giving you the link and show next: null
.
sortBy
and sortOrder
to retrieve the response in chronological or reverse chronological order.
See details on the parameters below:
Parameters | Description |
---|---|
sortBy | sortBy specifies what parameter you’d like to order your response by. Default value is day for Ethereum. |
sortOrder | sortOrder indicates how the sorting will be order. Can be desc or asc and defaults to asc . |
fromDate
and toDate
or fromDay
and toDay
query parameters. To see how time works, head here for Ethereum.
See details on the parameters below:
Parameters | Description |
---|---|
fromDate | The inclusive start date for the query in the format YYYY-MM-DD . Cannot be after toDate . |
toDate | The inclusive end date for the query in the format YYYY-MM-DD . Cannot be before fromDate . |
fromDay | The inclusive start day for the query. Cannot be after toDay . |
toDay | The inclusive end day for the query. Cannot be before fromDay . |
granularity
, the response will contain a list of items with startDate
, endDate
, fromDay
and EndDay
that collectively correspond to the filter you applied over a particular granularity.
See details on the parameters below:
Parameters | Description |
---|---|
startDate | The inclusive start date for the item in a list in the format YYYY-MM-DD . |
endDate | The inclusive end date for the item in a list in the format YYYY-MM-DD . |
startDay | The inclusive start day for the item in a list. |
endDay | The inclusive end day for the item in a list. |
https://api.rated.network/v1/eth/entities/Lido/effectiveness?fromDate=2024-03-01&toDate=2024-03-31&granularity=week&entityType=pool&limit=2
you will get a paginated list of two items per page, with weekly aggregates of effectiveness for Lido (pool) from 1st March 2024 to 31st March 2024 with weekly start date/day and end date/day.
Example of a filtered response