API Reference

Compare Markets

Side-by-side market snapshots for up to 5 areas. Returns snapshot data grouped by area ID, with each area containing snapshots broken down by bedroom count.

Container areas (boroughs and other areas with children) roll up their subtree as listed in /areas, so Marble Hill (226) counts toward Manhattan (100) here although search returns it for the Bronx (200). Without a bedrooms filter there is one bucket per exact bedroom count, which can exceed 6. An unknown area ID comes back with an empty snapshots array rather than an error.

Tier: Free+

GET

market

compare

Compare market snapshots across areas

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

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

fetch('https://borough.qwady.app/v1/market/compare', 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/market/compare",
  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/market/compare"

	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/market/compare")

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": [
    {
      "areaId": 123,
      "snapshots": [
        {
          "bedrooms": 123,
          "inventory": 123,
          "medianRent": 123,
          "medianPrice": 123,
          "avgDaysOnMarket": 123,
          "concessionRate": 123,
          "computedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "meta": {
    "dataAge": "2023-11-07T05:31:56Z",
    "source": "cached",
    "freshnessThreshold": 123,
    "refreshTriggered": true,
    "detailScraped": true
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

areas

string

required

Comma-separated area IDs (1-5)

bedrooms

integer

Filter by bedroom count (0=studio, 1-6). Buckets above 6 appear only in unfiltered responses and cannot be selected here.

Required range: 0 <= x <= 6

listingType

enum<string>

default:rental

Listing type

Available options:

rental,

sale

Response

Market comparison across areas

data

object[]

Show child attributes

meta

object

Show child attributes

Compare market snapshots across areas

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

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

fetch('https://borough.qwady.app/v1/market/compare', 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/market/compare",
  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/market/compare"

	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/market/compare")

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": [
    {
      "areaId": 123,
      "snapshots": [
        {
          "bedrooms": 123,
          "inventory": 123,
          "medianRent": 123,
          "medianPrice": 123,
          "avgDaysOnMarket": 123,
          "concessionRate": 123,
          "computedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "meta": {
    "dataAge": "2023-11-07T05:31:56Z",
    "source": "cached",
    "freshnessThreshold": 123,
    "refreshTriggered": true,
    "detailScraped": true
  }
}

Getting Started

Guides

Reference

API Reference

MCP Server

SDK

Compare Markets

Authorizations

Query Parameters

Response