Get Building Listings

GET

building

{id}

listings

Get listings in building

curl --request GET \
  --url https://borough.qwady.app/v1/building/{id}/listings \
  --header 'Authorization: Bearer <token>'

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

fetch('https://borough.qwady.app/v1/building/{id}/listings', 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/building/{id}/listings",
  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/building/{id}/listings"

	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/building/{id}/listings")

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

Polar.sh license key. Format: BOROUGH-<uuid>

Path Parameters

string

required

Building ID

Query Parameters

status

enum<string>

Filter by listing status

Available options:

ACTIVE,

IN_CONTRACT,

OFF_MARKET

listingType

enum<string>

Filter by listing type

Available options:

rental,

sale

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

Listings in building

data

object[]

Show child attributes

meta

object

Show child attributes

Get Building ScoresComposite quality scores (0-100) derived from NYC Open Data: - **health_score**: Based on HPD violation count and severity - **noise_score**: Based on 311 noise complaints within 200m - **safety_score**: Based on NYPD crime data within 400m - **transit_score**: Based on subway/bus stop proximity and density All four scores (health, noise, safety, transit) are recomputed weekly. Not all buildings have all scores; missing scores are returned as `null`. **Tier:** Starter+

Get listings in building

curl --request GET \
  --url https://borough.qwady.app/v1/building/{id}/listings \
  --header 'Authorization: Bearer <token>'

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

fetch('https://borough.qwady.app/v1/building/{id}/listings', 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/building/{id}/listings",
  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/building/{id}/listings"

	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/building/{id}/listings")

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

Get Building Listings

Authorizations

Path Parameters

Query Parameters

Response