KYBB utilizes offset-limit based pagination to support bulk fetches via our List API method. These list API methods share a common structure, taking at least two parameters: offset
and limit
. This enables paging through a large list by modifying the offset
field on query params.
Let's break down the the following URL as an example: https://api.kybb.dev.merklescience.com/api/v1/entity/?limit=10&offset=10
Base URL providing access to the collection of VASP entities: [<https://api.kybb.dev.merklescience.com/api/v1](<https://api.kybb.dev.merklescience.com/api/v1)
Pagination Parameters:
limit=25: This parameter indicates that each page of data should contain 25 entities. It specifies the maximum number of items to be returned in each page.
offset=25: This parameter indicates that the requested page starts at the 25th entity. It represents the starting point of the data to be retrieved in the current page.
All paginated responses contain the following fields to help with paging.
Field Name | Description |
---|---|
count | The number of items in this list |
next | URL of previous page |
previous | URL of next page |
results | Paged data |