Skip to main content

1. Get an API key

Subscribe to a plan on our pricing page to receive your API key. Keys use the format BOROUGH-<uuid>. Free-tier search, areas, market, health, and photo endpoints work without authentication (IP-based rate limiting applies).

2. Make your first request

3. Understand the response

Every response follows this envelope:
Key fields:
  • data: The response payload (array for lists, object for single resources)
  • meta.dataAge: When the data was last refreshed (ISO 8601)
  • meta.source: How data was served: cached, stale, or live
  • meta.links: Pagination navigation URLs
If the response includes a leadPhotoKey, you can fetch a first-party image URL through Borough at /v1/photos/{key}. See Photo URLs for supported sizes.

Next steps