Skip to main content

​
Overview

Listing responses include photo keys: 32-character hex hashes that identify images. Borough also exposes a public photo proxy at /v1/photos/{key} so clients can fetch supported image sizes through the Borough domain when they want a stable first-party URL.

​
Borough photo proxy

Supported sizes:
  • large_800_400 (default)
  • medium_500_250
The photo proxy returns the image bytes with long-lived cache headers. Invalid keys and unsupported size values return 400; missing images return 404; other error responses from the image host return 502 UPSTREAM_ERROR. Each photo request counts as one request against your monthly quota, so cache images on your side.

​
Available sizes

​
Example

Given a photo key ed2987594843debc8e828fef155dbb6d:

​
Where keys appear

  • ListingSummary.leadPhotoKey: Primary listing photo (search results and building listings)
  • ListingDetail.leadPhotoKey: Primary listing photo
  • ListingDetail.photos: Up to 6 listing photo keys
  • ListingDetail.floorPlanKey: Floor plan image (if available)
Building detail (GET /v1/building/{id}) does not include photo keys.