Search Sales

GET

sales

Search sale listings

curl --request GET \
  --url https://borough.qwady.app/v1/search/sales \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://borough.qwady.app/v1/search/sales', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://borough.qwady.app/v1/search/sales",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://borough.qwady.app/v1/search/sales"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://borough.qwady.app/v1/search/sales")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "address": {
        "street": "157 West 57th Street",
        "unit": "#48B"
      },
      "price": 123,
      "netEffective": 123,
      "monthsFree": 123,
      "leaseTermMonths": 123,
      "bedroomCount": 123,
      "fullBathroomCount": 123,
      "halfBathroomCount": 123,
      "sqft": 123,
      "pricePerSqft": 123,
      "areaName": "<string>",
      "areaId": 123,
      "geoPoint": {
        "latitude": 40.7654,
        "longitude": -73.9791
      },
      "leadPhotoKey": "<string>",
      "sourceGroupLabel": "<string>",
      "urlPath": "<string>",
      "listedAt": "2023-12-25",
      "listedAtIsApproximate": true,
      "availableAt": "2023-12-25",
      "daysOnMarket": 123,
      "buildingId": "<string>",
      "buildingScores": {
        "healthScore": 123,
        "noiseScore": 123,
        "safetyScore": 123,
        "transitScore": 123,
        "violationsOpen": 123,
        "updatedAt": "<string>"
      },
      "noFee": true,
      "detailScraped": true,
      "priceDelta": 123
    }
  ],
  "meta": {
    "dataAge": "2023-11-07T05:31:56Z",
    "freshnessThreshold": 123,
    "refreshTriggered": true,
    "detailScraped": true,
    "total": 123,
    "page": 123,
    "perPage": 123,
    "links": {
      "self": "<string>",
      "first": "<string>",
      "last": "<string>",
      "prev": "<string>",
      "next": "<string>"
    },
    "warnings": [
      "<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.

excludeAreas

string

Comma-separated area IDs to exclude from results. Unlike areas, borough-level IDs are matched exactly (no expansion to their child neighborhoods), and unknown IDs are ignored rather than returning a 422.

minPrice

integer

maxPrice

integer

minBeds

integer

maxBeds

integer

minBaths

integer

maxBaths

integer

buildingType

string

Comma-separated building types. Valid values: RENTAL, CONDO, CO_OP, CONDOP, HOUSE, SINGLEFAMILY, TOWNHOUSE, TWOFAMILY, THREEFAMILY, FOURFAMILY, MULTI_FAMILY, MIXED_USE, HYBRID, COMMERCIAL, UNKNOWN. MULTIFAMILY (no underscore) is accepted as an input alias for MULTI_FAMILY; responses always return the canonical spelling.

excludeBuildingType

string

Comma-separated building types to exclude. Same valid values as buildingType: RENTAL, CONDO, CO_OP, CONDOP, HOUSE, SINGLEFAMILY, TOWNHOUSE, TWOFAMILY, THREEFAMILY, FOURFAMILY, MULTI_FAMILY, MIXED_USE, HYBRID, COMMERCIAL, UNKNOWN.

saleType

enum<string>

Filter by sale type

Available options:

RESALE,

SPONSOR_UNIT,

FORECLOSURE,

RESTRICTED,

AUCTION,

SHORT,

UNKNOWN

minDaysOnMarket

integer

Minimum days on market. Computed from listedAt, which is a feed-first-seen estimate until a listing is detail-scraped; see meta.warnings in the response and listedAtIsApproximate on individual listings.

Required range: x >= 0

maxDaysOnMarket

integer

Maximum days on market. Same listedAt estimate caveat as minDaysOnMarket; see meta.warnings in the response.

Required range: x >= 0

listedAfter

string<date>

Only listings listed on or after this date (YYYY-MM-DD). Datetimes are accepted but normalized to the UTC calendar day; any time component is ignored. listedAt is a feed-first-seen estimate until a listing is detail-scraped; see meta.warnings in the response.

listedBefore

string<date>

Only listings listed on or before this date (YYYY-MM-DD). Datetimes are accepted but normalized to the UTC calendar day; any time component is ignored. Same listedAt estimate caveat as listedAfter; see meta.warnings in the response.

updatedSince

string<date>

Delta sync: only listings last confirmed in the active feed at or after this date (ISO 8601). Returns rows whose last_seen_at is on or after the value, useful for incrementally pulling what changed since your last crawl. Includes newly listed rows. Matching is by calendar day; any time component is ignored.

hasOpenHouse

boolean

Filter to listings with a scheduled open house. This is a detail-only signal and may undercount while listing-detail backfills complete; see meta.warnings in the response. hasOpenHouse=false returns 400 INVALID_PARAMS for the same reason as noFee=false: Borough cannot yet distinguish "confirmed no open house" from "not yet detail-scraped." Omit the parameter to return listings regardless of open-house status.

has3dTour

boolean

Filter to listings with a 3D virtual tour. has3dTour=true matches only confirmed 3D-tour listings and may undercount while listing-detail backfills complete; see meta.warnings in the response. has3dTour=false returns 400 INVALID_PARAMS for the same reason as noFee=false. Omit the parameter to return listings regardless of 3D-tour status.

minSqft

integer

Minimum square footage. sqft is a detail-only field: this drops every listing whose square footage hasn't been measured yet (not yet detail-scraped), not just listings outside the range; see meta.warnings in the response.

Required range: x >= 1

maxSqft

integer

Maximum square footage. Same detail-only coverage caveat as minSqft; see meta.warnings in the response.

Required range: x >= 1

petsAllowed

boolean

Filter by listing-level pet flag or building-level pet policy

amenities

string

Comma-separated amenity codes. Listings must match all requested amenities across listing- and building-level data. Listing-level amenities are detail-only and regex-derived from the listing description, so an amenity the description never mentions reads as absent, not merely unconfirmed; matches may undercount while listing-detail backfills complete. See meta.warnings in the response.

maxMonthlyCost

integer

Maximum total monthly cost where maintenance, common charges, and property tax fields are populated. Falls back to price when those fields are unknown.

Required range: x >= 0

minTransitScore

integer

Minimum transit score (0-100) based on proximity and stop density within 400 meters. Scores are strict; 80+ means exceptional transit clusters, not ordinary good subway access.

Required range: 0 <= x <= 100

fiberOnly

boolean

Require an FCC public-data provider match with fiber technology. Coverage may be exact-building or Census-block level depending on imported area.

minDownloadMbps

integer

Require an FCC public-data provider match with at least this advertised download speed in Mbps. Coverage may be exact-building or Census-block level depending on imported area.

Required range: x >= 0

sort

enum<string>

default:RECOMMENDED

Sort attribute. sort=LISTED_AT orders by listedAt, which is a feed-first-seen estimate until a listing is detail-scraped; this can interleave estimated and authoritative dates, ranking an undetailed listing as newer than it really is. See meta.warnings in the response.

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:10

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[]

Show child attributes

meta

object

Show child attributes

Get PropertyFull listing detail including pricing, availability, sale and rental flags, building linkage, and freshness metadata. Related fees, price history, and open houses are available via dedicated subresource endpoints. **Tier:** Starter+

Search sale listings

curl --request GET \
  --url https://borough.qwady.app/v1/search/sales \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://borough.qwady.app/v1/search/sales', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://borough.qwady.app/v1/search/sales",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://borough.qwady.app/v1/search/sales"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://borough.qwady.app/v1/search/sales")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "address": {
        "street": "157 West 57th Street",
        "unit": "#48B"
      },
      "price": 123,
      "netEffective": 123,
      "monthsFree": 123,
      "leaseTermMonths": 123,
      "bedroomCount": 123,
      "fullBathroomCount": 123,
      "halfBathroomCount": 123,
      "sqft": 123,
      "pricePerSqft": 123,
      "areaName": "<string>",
      "areaId": 123,
      "geoPoint": {
        "latitude": 40.7654,
        "longitude": -73.9791
      },
      "leadPhotoKey": "<string>",
      "sourceGroupLabel": "<string>",
      "urlPath": "<string>",
      "listedAt": "2023-12-25",
      "listedAtIsApproximate": true,
      "availableAt": "2023-12-25",
      "daysOnMarket": 123,
      "buildingId": "<string>",
      "buildingScores": {
        "healthScore": 123,
        "noiseScore": 123,
        "safetyScore": 123,
        "transitScore": 123,
        "violationsOpen": 123,
        "updatedAt": "<string>"
      },
      "noFee": true,
      "detailScraped": true,
      "priceDelta": 123
    }
  ],
  "meta": {
    "dataAge": "2023-11-07T05:31:56Z",
    "freshnessThreshold": 123,
    "refreshTriggered": true,
    "detailScraped": true,
    "total": 123,
    "page": 123,
    "perPage": 123,
    "links": {
      "self": "<string>",
      "first": "<string>",
      "last": "<string>",
      "prev": "<string>",
      "next": "<string>"
    },
    "warnings": [
      "<string>"
    ]
  }
}

Getting Started

Guides

Reference

API Reference

MCP Server

SDK

Authorizations

Query Parameters

Response