API Reference
Comparables
Active listings comparable to the reference listing: same listing type and neighborhood, matching bedroom count, within ±25% of its price, ranked by price proximity. Cached data only, billed as one request.
Tier: Starter+
GET
/
property
/
{id}
/
comparables
Get comparable listings
curl --request GET \
--url https://borough.qwady.app/v1/property/{id}/comparables \
--header 'Authorization: Bearer <token>'import requests
url = "https://borough.qwady.app/v1/property/{id}/comparables"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://borough.qwady.app/v1/property/{id}/comparables', 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/property/{id}/comparables",
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/property/{id}/comparables"
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))
}HttpResponse<String> response = Unirest.get("https://borough.qwady.app/v1/property/{id}/comparables")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://borough.qwady.app/v1/property/{id}/comparables")
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,
"buildingType": "CONDO",
"areaName": "<string>",
"areaId": 123,
"status": "ACTIVE",
"geoPoint": {
"latitude": 40.7654,
"longitude": -73.9791
},
"leadPhotoKey": "<string>",
"sourceGroupLabel": "<string>",
"urlPath": "<string>",
"listingType": "rental",
"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": {
"total": 123,
"reference": {},
"dataAge": "2023-11-07T05:31:56Z",
"source": "cached"
}
}Authorizations
Polar.sh license key. Format: BOROUGH-<uuid>
Path Parameters
Reference listing ID
Query Parameters
Max comparables to return (default 12, capped at your tier's perPage)
Required range:
x >= 1⌘I
Get comparable listings
curl --request GET \
--url https://borough.qwady.app/v1/property/{id}/comparables \
--header 'Authorization: Bearer <token>'import requests
url = "https://borough.qwady.app/v1/property/{id}/comparables"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://borough.qwady.app/v1/property/{id}/comparables', 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/property/{id}/comparables",
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/property/{id}/comparables"
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))
}HttpResponse<String> response = Unirest.get("https://borough.qwady.app/v1/property/{id}/comparables")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://borough.qwady.app/v1/property/{id}/comparables")
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,
"buildingType": "CONDO",
"areaName": "<string>",
"areaId": 123,
"status": "ACTIVE",
"geoPoint": {
"latitude": 40.7654,
"longitude": -73.9791
},
"leadPhotoKey": "<string>",
"sourceGroupLabel": "<string>",
"urlPath": "<string>",
"listingType": "rental",
"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": {
"total": 123,
"reference": {},
"dataAge": "2023-11-07T05:31:56Z",
"source": "cached"
}
}