Skip to main content
Most list endpoints page with limit and offset. Transactions and streets use a cursor. Lookups by ID and nearest-match searches return a single page.

Offset pagination

limit is the page size and offset is the number of records to skip. Send them in the query string on GET endpoints and in the JSON body on POST endpoints. A page looks like this:
Increase offset by the number of records you received and stop when has_more is false. Where the table below gives an offset maximum, stop there even if has_more is true. total_count is the number of matches across all pages, except where the table below says otherwise.
Over HTTP, send X-API-Version: 2 when you page property or listings endpoints. Without it they return { "success": true, "result": [...], "totalSize": 1250, "size": 25 }, which has no has_more. The SDK always sends the header. See Versions.

Limits by endpoint

“None” means the API sets no maximum.

Cursor pagination

Transactions

POST /v1/transactions/query and GET /v1/transactions/by-uprn/{uprn} take limit (default 25, maximum 100) and cursor. Each page has has_more and next_cursor. Send next_cursor back as cursor, with the same sort, to get the next page; it is null on the last page. A cursor that cannot be read, or was made under a different sort, is ignored, and you get the first page again. These responses have no total_count.

Streets

POST /v1/location/street/query returns up to identifier.limit streets (default 10, maximum 50) for name, coordinate and postcode lookups. To get the next page, send starting_after with the id of the last street on the page, such as gb-usrn:21701338. SDK 6.8.0 does not have starting_after, so page streets over HTTP.

Endpoints that return one page

These do not page. Ask for what you need in one request, or split the IDs across several.