Skip to main content
GET
/
search
/
sales
Search sale listings
curl --request GET \
  --url https://borough.qwady.app/v1/search/sales \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "address": {
        "street": "157 West 57th Street",
        "unit": "#48B",
        "city": "NEW YORK",
        "state": "NY",
        "zipCode": "10019"
      },
      "price": 123,
      "netEffective": 123,
      "monthsFree": 123,
      "leaseTermMonths": 123,
      "bedroomCount": 123,
      "fullBathroomCount": 123,
      "halfBathroomCount": 123,
      "buildingType": "CONDO",
      "areaName": "<string>",
      "areaId": 123,
      "status": "ACTIVE",
      "geoPoint": {
        "latitude": 40.7654,
        "longitude": -73.9791
      },
      "leadPhotoKey": "<string>",
      "sourceGroupLabel": "<string>",
      "urlPath": "<string>",
      "listingType": "rental"
    }
  ],
  "meta": {
    "dataAge": "2023-11-07T05:31:56Z",
    "source": "cached",
    "freshnessThreshold": 123,
    "refreshTriggered": true,
    "total": 123,
    "page": 123,
    "perPage": 123,
    "links": {
      "self": "<string>",
      "first": "<string>",
      "last": "<string>",
      "prev": "<string>",
      "next": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
areas
string

Comma-separated area IDs (e.g., 120,115). See /areas for the full list.

​
minPrice
integer
​
maxPrice
integer
​
minBeds
integer
​
maxBeds
integer
​
minBaths
integer
​
maxBaths
integer
​
buildingType
string

Comma-separated building types

​
saleType
enum<string>

Filter by sale type

Available options:
RESALE,
SPONSOR_UNIT,
FORECLOSURE
​
minDaysOnMarket
integer

Minimum days on market

Required range: x >= 0
​
maxDaysOnMarket
integer

Maximum days on market

Required range: x >= 0
​
listedAfter
string<date-time>

Only listings created after this date (ISO 8601)

​
listedBefore
string<date-time>

Only listings created before this date (ISO 8601)

​
hasOpenHouse
boolean

Filter to listings with a scheduled open house

​
has3dTour
boolean

Filter to listings with a 3D virtual tour

​
minSqft
integer

Minimum square footage

Required range: x >= 1
​
maxSqft
integer

Maximum square footage

Required range: x >= 1
​
petsAllowed
boolean

Filter to listings that explicitly allow pets

​
amenities
string

Comma-separated amenity codes. Listings must match all requested amenities across listing- and building-level data.

​
maxMonthlyCost
integer

Maximum total monthly cost (price + maintenance + common charges + property tax). Useful for sales.

Required range: x >= 0
​
minTransitScore
integer

Minimum transit score (0-100) based on proximity to subway/bus stops

Required range: 0 <= x <= 100
​
fiberOnly
boolean

Require a building-level FCC broadband provider record with fiber technology. Provisional while Borough validates the underlying FCC and CostQuest contract path for further rollout.

​
minDownloadMbps
integer

Require a building-level FCC broadband provider record with at least this advertised download speed in Mbps. Provisional while Borough validates the underlying FCC and CostQuest contract path for further rollout.

Required range: x >= 0
​
sort
enum<string>
default:PRICE

Sort attribute

Available options:
RECOMMENDED,
PRICE,
LISTED_AT
​
sortDir
enum<string>
default:DESC

Sort direction

Available options:
ASC,
DESC
​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
perPage
integer
default:50

Results per page. Maximum depends on tier: Free=10, Starter=50, Pro/Business=500.

Required range: 1 <= x <= 500

Response

Paginated list of sale listings

​
data
object[]
​
meta
object