API Reference

Get Building Scores

Composite 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

building

{id}

scores

Get building quality scores

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

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

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

	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}/scores")

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": {
    "buildingId": "<string>",
    "healthScore": 50,
    "noiseScore": 50,
    "safetyScore": 50,
    "transitScore": 50,
    "violationsOpen": 123,
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "dataAge": "2023-11-07T05:31:56Z",
    "freshnessThreshold": 123,
    "refreshTriggered": true,
    "detailScraped": true
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Building ID

Response

Building quality scores

data

object

Show child attributes

meta

object

Show child attributes

Get Building ViolationsHPD (Housing Preservation & Development) violations for a building, ordered by date descending. Includes violation class (A/B/C), status, and description. Only available for buildings with a known BBL (Borough-Block-Lot). **Tier:** Starter+

Get building quality scores

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

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

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

	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}/scores")

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": {
    "buildingId": "<string>",
    "healthScore": 50,
    "noiseScore": 50,
    "safetyScore": 50,
    "transitScore": 50,
    "violationsOpen": 123,
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "dataAge": "2023-11-07T05:31:56Z",
    "freshnessThreshold": 123,
    "refreshTriggered": true,
    "detailScraped": true
  }
}

Getting Started

Guides

Reference

API Reference

MCP Server

SDK

Get Building Scores

Authorizations

Path Parameters

Response