Pagination

By default, most of the "List" endpoints return paginated results. Use the query parameters page and size to control the number of results displayed.

curl --request GET \
     --url 'https://api.sandbox.bvnk.com/ledger/v1/wallets? page=2&size=30&sort=currencyCode%2Cdesc&offset=1' \
     --header 'accept: application/json'

Parameter	Description
`page`	Page number. Starts from "0".
`size`	Number of records on the page returned in the response. Maximum number: 100. Example, `2`.
`sort`	Sorting criteria. Format: `property,<asc/desc>`. Default sort order is ascending.
`offset`	Starting point for pagination. Use instead of `page`, for example for cursor-based pagination.

In the response, the pageable object may be returned. The object provides detailed info on the pagination.

{
    "pageable": {
        "pageNumber": 0,
        "pageSize": 20,
        "sort": {
            "empty": true,
            "unsorted": true,
            "sorted": false
        },
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "last": true,
    "totalPages": 1,
    "totalElements": 2,
    "first": true,
    "size": 20,
    "number": 0,
    "sort": {
        "empty": true,
        "unsorted": true,
        "sorted": false
    },
    "numberOfElements": 2,
    "empty": false
}

Attribute	Description
`pageNumber`	Current page number, for example, `0` for the first page.
`pageSize`	Number of records per page, for example, `2`.
`sort.empty`	Indication whether the sort criteria is empty. `true` means no sorting.
`sort.sorted`	Indication whether the results are sorted. `false` means no sorting.
`sort.unsorted`	Indication whether the results are unsorted. `true` means no sorting.
`offset`	Offset of the first record, for example, `0`, which means no offset is applied.
`paged`	Indication whether the results are paginated. `true` for paginated.
`unpaged`	Indication whether the results are not paginated (false).
`last`	Indication whether this is the last page of results. `false` means there are more pages after the current one.
`totalPages`	Total number of pages, for example, `10`.
`totalElements`	Total number of elements across all pages, foe example, `20` elements.
`first`	Indication whether this is the first page. `true` for yes.
`size`	Number of elements per page, for example, `2`.
`number`	Current page number, foe example, `0` for the first page.
`sort.empty`	Indication whether the sort criteria is empty. `true` means no criteria.
`sort.sorted`	Indication whether the results are sorted. (false).
`sort.unsorted`	Indication whether the results are unsorted. `true` for unsorted.
`numberOfElements`	Number of elements on the current page, for example, `2` items.
`empty`	Indication whether the page is empty. `false` means the page contains elements.