Compare Markets - Qwady Docs

GET

market

compare

Compare market snapshots across areas

curl --request GET \
  --url https://borough.qwady.app/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",
    "freshnessThreshold": 123,
    "refreshTriggered": true
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

areas

string

required

Comma-separated area IDs (1-5)

bedrooms

integer

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

Required range: 0 <= x <= 6

listingType

enum<string>

default:rental

Listing type

Available options:

rental,

sale

Response

Market comparison across areas

data

object[]

Show child attributes

meta

object

Show child attributes

List AreasReturns all 349 NYC areas including boroughs, sub-boroughs, and neighborhoods. Optionally filter by level or parent area. **Tier:** Free+

Compare market snapshots across areas

curl --request GET \
  --url https://borough.qwady.app/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",
    "freshnessThreshold": 123,
    "refreshTriggered": true
  }
}