Using Pagination

When gathering data, response may contain an amount of data that is too big to send at one time. Instead of sending all the data at once, a limited number may be returned at one time. This smaller subset of accounts is called a page.

More data can be viewed by loading the next page. Using these pages of data is referred to as pagination. The concept is further explained in the Collection Pagination documentation.

The response from the operation includes the URI for next page of resources in the nextPage_url field. For example, when listing accounts, the nextPage_url may be:

{
   "nextPage_url": "https://api.apiture.com/banking/accounts?start=641f62296ecbf1882c84?limit=100"
   "items": [ ...

The limit query parameter can be adjusted to a page size that is efficient for your application. The default limit is 100, but this number can be adjusted. However, the requested limit may be overridden by service maximums. For example, even if there are 5,000 resources in a collection and a limit of 500, a service may impose a maximum of 250 items per page. The remaining resources will be available on subsequent pages.

When the list of resources is exhausted, the nextPage_url is omitted from the response. There may not be enough resources left in the collection to meet the limit, so the operation returns a smaller number of results. For example, if the limit is 100, but there are only eight points of data, eight points of data are returned.

However, the omission of nextPage_url should always be used as an indicator that the list of resources has been exhausted. The number of results returned may be less than the limit, even when there are resources remaining in the collection. Sometimes, the number of accounts returned is fewer than requested due to time limitations, slow service or other issues.

Each page of data can be viewed in linear order. Pages cannot be skipped or navigated backwards. The start parameter should not be manually adjusted as it contains an automatically generated cursor.