API Reference

Create Watcher

Create a persistent watcher that monitors a listing, building, or search for changes. The watcher polls at the configured interval. Each poll counts as one API request against your active quota window, whether or not it finds a change.

How each type detects changes:

listing: fetches the live listing on every poll and reports status changes and price moves of more than $25. Live fetches draw on a shared live-fetch budget; while it is held for Borough’s scheduled updates, or live fetching is paused, polls are skipped and not counted.
building and search: compare against Borough’s own index, which refreshes about every 6h for rentals and 8h for sales, so polling faster than that mostly spends quota. A building watcher sees only the units linked to the building (see GET /building/{id}/listings).

Limits (Business):

At most 50 active watchers, of which at most 5 may be listing watchers. Creating one past either cap returns 429 QUOTA_EXCEEDED; paused watchers do not count.
pollInterval: listing watchers minimum and default 3600 seconds; building and search watchers minimum 300, default 900. A shorter interval returns 400.
A search watcher whose filters match more than 500 active listings is refused with 400 INVALID_PARAMS; narrow it with areas, minPrice/maxPrice, beds, listingType or buildingType. A running search watcher whose matches later grow past 500 is paused.

If the account drops below Business, all of its watchers and webhooks are paused; after re-subscribing, resume each with PATCH {"active": true}.

Tier: Business+

POST

watchers

Create a watcher

curl --request POST \
  --url https://borough.qwady.app/v1/watchers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "listingId": "<string>",
  "buildingId": "<string>",
  "searchFilters": {
    "areas": [
      100,
      105
    ],
    "minPrice": 2000,
    "maxPrice": 4500,
    "beds": 1,
    "listingType": "rental"
  },
  "pollInterval": 123
}
'

import requests

url = "https://borough.qwady.app/v1/watchers"

payload = {
    "listingId": "<string>",
    "buildingId": "<string>",
    "searchFilters": {
        "areas": [100, 105],
        "minPrice": 2000,
        "maxPrice": 4500,
        "beds": 1,
        "listingType": "rental"
    },
    "pollInterval": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    listingId: '<string>',
    buildingId: '<string>',
    searchFilters: {
      areas: [100, 105],
      minPrice: 2000,
      maxPrice: 4500,
      beds: 1,
      listingType: 'rental'
    },
    pollInterval: 123
  })
};

fetch('https://borough.qwady.app/v1/watchers', 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/watchers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'listingId' => '<string>',
    'buildingId' => '<string>',
    'searchFilters' => [
        'areas' => [
                100,
                105
        ],
        'minPrice' => 2000,
        'maxPrice' => 4500,
        'beds' => 1,
        'listingType' => 'rental'
    ],
    'pollInterval' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://borough.qwady.app/v1/watchers"

	payload := strings.NewReader("{\n  \"listingId\": \"<string>\",\n  \"buildingId\": \"<string>\",\n  \"searchFilters\": {\n    \"areas\": [\n      100,\n      105\n    ],\n    \"minPrice\": 2000,\n    \"maxPrice\": 4500,\n    \"beds\": 1,\n    \"listingType\": \"rental\"\n  },\n  \"pollInterval\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://borough.qwady.app/v1/watchers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"listingId\": \"<string>\",\n  \"buildingId\": \"<string>\",\n  \"searchFilters\": {\n    \"areas\": [\n      100,\n      105\n    ],\n    \"minPrice\": 2000,\n    \"maxPrice\": 4500,\n    \"beds\": 1,\n    \"listingType\": \"rental\"\n  },\n  \"pollInterval\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://borough.qwady.app/v1/watchers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"listingId\": \"<string>\",\n  \"buildingId\": \"<string>\",\n  \"searchFilters\": {\n    \"areas\": [\n      100,\n      105\n    ],\n    \"minPrice\": 2000,\n    \"maxPrice\": 4500,\n    \"beds\": 1,\n    \"listingType\": \"rental\"\n  },\n  \"pollInterval\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "watchType": "listing",
    "listingId": "<string>",
    "buildingId": "<string>",
    "searchFilters": {},
    "pollInterval": 123,
    "active": true,
    "lastPollAt": "2023-11-07T05:31:56Z",
    "lastChangeAt": "2023-11-07T05:31:56Z",
    "createdAt": "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>

Body

application/json

watchType

enum<string>

required

Available options:

listing,

building,

search

listingId

string

buildingId

string

searchFilters

object

Filters for a search watcher. Only the keys below are accepted; any other key is rejected with 400 INVALID_PARAMS at create time, rather than silently ignored — a watcher that quietly watches something broader than you asked for is worse than one that refuses to be created. Note beds is an exact match here, not the minBeds/maxBeds range the search endpoints take. The filters may match at most 500 active listings. Broader filters are refused with 400 INVALID_PARAMS at create and when a paused watcher is resumed; narrow them with areas, minPrice/maxPrice, beds, listingType or buildingType. A running watcher whose matches later grow past 500 is paused.

Show child attributes

Example:

{
  "areas": [100, 105],
  "minPrice": 2000,
  "maxPrice": 4500,
  "beds": 1,
  "listingType": "rental"
}

pollInterval

integer

Seconds between polls. Business: building and search watchers minimum 300, default 900; listing watchers minimum and default 3600. Internal: minimum 60.

Response

Watcher created

data

object

Show child attributes

meta

object

Show child attributes

Create a watcher

curl --request POST \
  --url https://borough.qwady.app/v1/watchers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "listingId": "<string>",
  "buildingId": "<string>",
  "searchFilters": {
    "areas": [
      100,
      105
    ],
    "minPrice": 2000,
    "maxPrice": 4500,
    "beds": 1,
    "listingType": "rental"
  },
  "pollInterval": 123
}
'

import requests

url = "https://borough.qwady.app/v1/watchers"

payload = {
    "listingId": "<string>",
    "buildingId": "<string>",
    "searchFilters": {
        "areas": [100, 105],
        "minPrice": 2000,
        "maxPrice": 4500,
        "beds": 1,
        "listingType": "rental"
    },
    "pollInterval": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    listingId: '<string>',
    buildingId: '<string>',
    searchFilters: {
      areas: [100, 105],
      minPrice: 2000,
      maxPrice: 4500,
      beds: 1,
      listingType: 'rental'
    },
    pollInterval: 123
  })
};

fetch('https://borough.qwady.app/v1/watchers', 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/watchers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'listingId' => '<string>',
    'buildingId' => '<string>',
    'searchFilters' => [
        'areas' => [
                100,
                105
        ],
        'minPrice' => 2000,
        'maxPrice' => 4500,
        'beds' => 1,
        'listingType' => 'rental'
    ],
    'pollInterval' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://borough.qwady.app/v1/watchers"

	payload := strings.NewReader("{\n  \"listingId\": \"<string>\",\n  \"buildingId\": \"<string>\",\n  \"searchFilters\": {\n    \"areas\": [\n      100,\n      105\n    ],\n    \"minPrice\": 2000,\n    \"maxPrice\": 4500,\n    \"beds\": 1,\n    \"listingType\": \"rental\"\n  },\n  \"pollInterval\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://borough.qwady.app/v1/watchers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"listingId\": \"<string>\",\n  \"buildingId\": \"<string>\",\n  \"searchFilters\": {\n    \"areas\": [\n      100,\n      105\n    ],\n    \"minPrice\": 2000,\n    \"maxPrice\": 4500,\n    \"beds\": 1,\n    \"listingType\": \"rental\"\n  },\n  \"pollInterval\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://borough.qwady.app/v1/watchers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"listingId\": \"<string>\",\n  \"buildingId\": \"<string>\",\n  \"searchFilters\": {\n    \"areas\": [\n      100,\n      105\n    ],\n    \"minPrice\": 2000,\n    \"maxPrice\": 4500,\n    \"beds\": 1,\n    \"listingType\": \"rental\"\n  },\n  \"pollInterval\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "watchType": "listing",
    "listingId": "<string>",
    "buildingId": "<string>",
    "searchFilters": {},
    "pollInterval": 123,
    "active": true,
    "lastPollAt": "2023-11-07T05:31:56Z",
    "lastChangeAt": "2023-11-07T05:31:56Z",
    "createdAt": "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

Create Watcher

Authorizations

Body

Response