Skip to main content

Overview

Borough uses page-based pagination. Pages are 1-indexed (first page is page=1).

Parameters

Pass an explicit perPage (up to your tier max) for larger pages.

Response metadata

  • total: Total number of matching results across all pages
  • page: Current page number
  • perPage: Results per page
  • links: Navigation URLs for self, first, last, prev (null on first page), and next (null on last page)

Max perPage by tier

SDK auto-pagination

The TypeScript SDK supports automatic pagination via async iterators: