Last updated

Pagination Guide

To efficiently handle large datasets, the Bermuda Commercial Bank Open Banking API uses cursor-based pagination with support for pageStart, pageSize, and pageToken.


🔢 Parameters

ParameterTypeDescription
pageStartintegerStarting page number (default: 1)
pageSizeintegerNumber of records per page (max: 1000)
pageTokenstringToken for retrieving the next page of results

It's recommended to use pageToken from the previous response to retrieve subsequent pages for consistent data access.


🧭 Example Workflow

  1. Call the endpoint with pageStart=1&pageSize=100
  2. Store the pageToken from the response
  3. Use that token to request the next page:
    .../transactions?pageToken=abc123&pageStart=2

📦 Sample Response

{
  "meta": {
    "pagination": {
      "page_start": 2,
      "page_token": "abc123",
      "total_size": 955,
      "page_size": 100
    }
  },
  "data": [ ... ]
}

Use the page_token value in subsequent requests to paginate efficiently.