Auto-Pagination

const results = await borough.rentals.search({
  areas: "120",
  minBeds: 1,
  maxPrice: 4000,
});

// Iterate through every page (up to maxAutoPages, default 100)
for await (const listing of results) {
  console.log(`${listing.address.street} — $${listing.price}`);
}

// Get all results
const allListings = await results.toArray();

// Get first 100 results (stops fetching after enough items)
const first100 = await results.toArray({ limit: 100 });

// No page cap
const all = await borough.rentals.search({ areas: "120" }, { maxAutoPages: Infinity });

// Stop quietly at the cap and check whether anything was left unread
const bounded = await borough.rentals.search(
  { areas: "120" },
  { maxAutoPages: 20, onMaxAutoPages: "stop" },
);
const items = await bounded.toArray();
if (bounded.truncated) console.log("stopped at 20 pages");

const results = await borough.rentals.search({ areas: "120" });

console.log(results.meta.total); // Total matching listings
console.log(results.meta.page); // Current page (1-indexed)
console.log(results.meta.perPage); // Items per page
console.log(results.data.length); // Items on this page

// Smaller pages (fewer items per request)
const results = await borough.rentals.search({
  areas: "120",
  perPage: 10,
});

// Larger pages (Starter: max 50, Pro/Business: max 500)
const results = await borough.rentals.search({
  areas: "120",
  perPage: 500,
});

import { BoroughClient } from "@borough/sdk";

const borough = new BoroughClient("BOROUGH-...");

// perPage 500 needs Pro or Business; Starter is lowered to 50 per page
const results = await borough.rentals.search(
  {
    areas: "300", // Brooklyn
    perPage: 500,
  },
  { maxAutoPages: Infinity }, // one request per page, all counted against quota
);

const listings = await results.toArray();
console.log(`Exported ${listings.length} Brooklyn rentals`);

// Write to CSV, database, etc.
for (const listing of listings) {
  // process each listing...
}