Quickstart

1. Make your first request

Search, areas, market, and photo endpoints work without an API key, so you can try Borough right now. Keyless requests are limited per IP to 100 requests/month and 10 requests/minute, with up to 10 results per page. This finds 1+ bedroom rentals under $4,000 on the Upper East Side:

curl "https://borough.qwady.app/v1/search/rentals?areas=140&maxPrice=4000&minBeds=1"

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

// No key needed for the free tier.
const borough = new BoroughClient();

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

for (const listing of results.data) {
  console.log(`${listing.address.street} (${listing.areaName}) - $${listing.price}/mo`);
}

import requests

params = {"areas": "140", "maxPrice": 4000, "minBeds": 1}

response = requests.get(
    "https://borough.qwady.app/v1/search/rentals",
    params=params,
)
data = response.json()

for listing in data["data"]:
    print(f"{listing['address']['street']} ({listing['areaName']}) - ${listing['price']}/mo")

140 is the Upper East Side. An area that contains other areas covers all of them, so this search also returns Yorkville, Lenox Hill, and Carnegie Hill listings. Find the ID for any neighborhood with List Areas, for example /v1/areas?q=williamsburg.

2. Understand the response

Every response follows this envelope (values below are illustrative):

{
  "data": [
    {
      "id": "1234567",
      "address": { "street": "123 East 86th Street", "unit": "5B" },
      "price": 3450,
      "bedroomCount": 1,
      "fullBathroomCount": 1,
      "areaName": "Yorkville",
      "areaId": 142,
      "listedAt": "2026-09-20",
      "daysOnMarket": 3,
      "buildingScores": {
        "healthScore": 82,
        "noiseScore": 64,
        "safetyScore": 71,
        "transitScore": 88,
        "violationsOpen": 2,
        "updatedAt": "2026-09-20T03:10:00.000Z"
      }
    }
  ],
  "meta": {
    "total": 87,
    "page": 1,
    "perPage": 10,
    "dataAge": "2026-09-23T12:40:39.711Z",
    "source": "cached",
    "links": {
      "self": "https://borough.qwady.app/v1/search/rentals?areas=140&maxPrice=4000&minBeds=1&page=1&perPage=10",
      "first": "https://borough.qwady.app/v1/search/rentals?areas=140&maxPrice=4000&minBeds=1&page=1&perPage=10",
      "last": "https://borough.qwady.app/v1/search/rentals?areas=140&maxPrice=4000&minBeds=1&page=9&perPage=10",
      "prev": null,
      "next": "https://borough.qwady.app/v1/search/rentals?areas=140&maxPrice=4000&minBeds=1&page=2&perPage=10"
    }
  }
}

Key fields:

data: The response payload (array for lists, object for single resources)
data[].buildingScores: Health, noise, safety, and transit scores plus the open violation count for the listing’s building, or null when the building has not been scored yet. See Enrichment
meta.dataAge: When the data was last refreshed (ISO 8601)
meta.source: How data was served: cached, stale, or live. Search is always cached or stale. live appears only on Business live-first detail and is not guaranteed: while live fetching is held back or paused, detail responses return cached or stale instead
meta.links: Pagination navigation URLs
meta.warnings: Present when a filter relies on partially populated data (for example noFee, minSqft, amenities, or fiberOnly) and may shrink results. Check it when a search returns fewer results than expected

Responses also carry X-Quota-Limit, X-Quota-Used, and X-Quota-Remaining headers so you can track your monthly allowance. X-Quota-Used is the count before the current request. If a listing includes a leadPhotoKey, you can fetch a first-party image URL through Borough at /v1/photos/{key}. Each photo request counts as one request against your quota, so cache images you have already fetched. See Photo URLs for supported sizes.

3. Get an API key when you need more

Paid plans add property and building detail (price history, fees, open houses, comparables, and HPD violations), higher monthly limits, and larger pages. Pro adds live listing streams (the live update is best-effort); Business adds live-first detail, webhooks, and watchers. See Tiers & Pricing. Keys are provisioned automatically when you subscribe and use the format BOROUGH-<uuid>. Send yours as a Bearer token:

curl -H "Authorization: Bearer $BOROUGH_API_KEY" \
  "https://borough.qwady.app/v1/search/rentals?areas=140&maxPrice=4000&minBeds=1"

// With no argument the client reads BOROUGH_API_KEY from the environment.
const borough = new BoroughClient(process.env.BOROUGH_API_KEY);

import os

headers = {"Authorization": f"Bearer {os.environ['BOROUGH_API_KEY']}"}

Next steps

Search Filters: All available filter parameters
SDK Guide: Install and use the TypeScript SDK
MCP Server: Connect Claude or another AI agent (the free tier works there too)
Authentication: API key formats and OAuth

Getting Started

Guides

Reference

API Reference

MCP Server

SDK

1. Make your first request

2. Understand the response

3. Get an API key when you need more

Next steps

​1. Make your first request

​2. Understand the response

​3. Get an API key when you need more

​Next steps

1. Make your first request

2. Understand the response

3. Get an API key when you need more

Next steps