Skip to main content
GET
/
market
/
compare
Compare market snapshots across areas
curl --request GET \
  --url https://borough.qwady.com/v1/market/compare \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "areaId": 123,
      "snapshots": [
        {
          "bedrooms": 123,
          "inventory": 123,
          "medianRent": 123,
          "avgDaysOnMarket": 123,
          "concessionRate": 123,
          "computedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "meta": {
    "dataAge": "2023-11-07T05:31:56Z",
    "source": "cached",
    "freshnessThreshold": 123,
    "refreshTriggered": true
  }
}

Authorizations

Authorization
string
header
required

Polar.sh license key. Format: BOROUGH_<uuid>

Query Parameters

areas
string
required

Comma-separated area IDs (1-5)

bedrooms
integer

Filter by bedroom count (0=studio, 1-4)

Required range: 0 <= x <= 4
listingType
enum<string>
default:rental

Listing type

Available options:
rental,
sale

Response

Market comparison across areas

data
object[]
meta
object