API Reference
Get Property
Full 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.
On Business and Internal keys, when the stored detail is more than 5
minutes old the request first fetches the listing live, waiting up to
about 8 seconds, and returns meta.source: "live". A live response can
report status: IN_CONTRACT, which is not stored, so a later cached read
shows the stored status again. If the live fetch times out or fails, or
the shared live-fetch budget is held for Borough’s scheduled updates, or
live fetching is paused, the stored record is returned instead
(meta.source cached or stale); see meta.refreshTriggered.
Tier: Starter+
GET
/
property
/
{id}
Get listing detail
curl --request GET \
--url https://borough.qwady.app/v1/property/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://borough.qwady.app/v1/property/{id}"
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}', 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}",
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}"
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}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://borough.qwady.app/v1/property/{id}")
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,
"saleType": "RESALE",
"petsAllowed": true,
"amenities": [
"<string>"
],
"furnished": true,
"floorPlanKey": "<string>",
"has3dTour": true,
"hasVideo": true,
"priceChangedAt": "2023-11-07T05:31:56Z",
"maintenance": 123,
"commonCharges": 123,
"propertyTax": 123,
"virtualTourUrl": "<string>",
"internetProviders": {
"status": "matched",
"source": "fcc_bdc",
"coverageLevel": "building",
"fccLocationId": 123,
"blockGeoid": "<string>",
"matchedAddress": "<string>",
"unitCount": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"providers": [
{
"providerId": 123,
"providerName": "<string>",
"holdingCompanyName": "<string>",
"technologyCode": 123,
"technologyLabel": "<string>",
"maxDownloadMbps": 123,
"maxUploadMbps": 123,
"lowLatency": true
}
],
"disclaimer": "<string>"
},
"photos": [
"<string>"
]
},
"meta": {
"dataAge": "2023-11-07T05:31:56Z",
"source": "cached",
"freshnessThreshold": 123,
"refreshTriggered": true,
"detailScraped": true
}
}Listing detail responses include the building-linked
internetProviders block when Borough has FCC broadband availability data for the underlying building or Census block.
This product uses FCC APIs and/or Data but is not endorsed or certified by the FCC.
⌘I
Get listing detail
curl --request GET \
--url https://borough.qwady.app/v1/property/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://borough.qwady.app/v1/property/{id}"
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}', 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}",
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}"
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}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://borough.qwady.app/v1/property/{id}")
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,
"saleType": "RESALE",
"petsAllowed": true,
"amenities": [
"<string>"
],
"furnished": true,
"floorPlanKey": "<string>",
"has3dTour": true,
"hasVideo": true,
"priceChangedAt": "2023-11-07T05:31:56Z",
"maintenance": 123,
"commonCharges": 123,
"propertyTax": 123,
"virtualTourUrl": "<string>",
"internetProviders": {
"status": "matched",
"source": "fcc_bdc",
"coverageLevel": "building",
"fccLocationId": 123,
"blockGeoid": "<string>",
"matchedAddress": "<string>",
"unitCount": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"providers": [
{
"providerId": 123,
"providerName": "<string>",
"holdingCompanyName": "<string>",
"technologyCode": 123,
"technologyLabel": "<string>",
"maxDownloadMbps": 123,
"maxUploadMbps": 123,
"lowLatency": true
}
],
"disclaimer": "<string>"
},
"photos": [
"<string>"
]
},
"meta": {
"dataAge": "2023-11-07T05:31:56Z",
"source": "cached",
"freshnessThreshold": 123,
"refreshTriggered": true,
"detailScraped": true
}
}