API Reference

Update Watcher

Update the poll interval or active status of a watcher. Setting active: false pauses the watcher without deleting it.

Resuming (active: true) starts a fresh baseline: changes that happened while the watcher was paused are not reported, and unread buffered changes are cleared. Resuming returns 400 when it would exceed an active-watcher cap (on Business, 50 per account and 5 listing watchers), or for a search watcher whose filters now match more than 500 active listings (filters cannot be changed here, so delete that watcher and create a narrower one). Resuming a listing watcher whose pollInterval is below the current minimum raises it to the minimum. A pollInterval below the minimum for the watcher’s type (Business: listing 3600, building and search 300) returns 400. A shorter interval applies at once; a longer one takes effect after the poll already scheduled.

Updates never count against your quota, so an exhausted account can still pause its watchers.

Tier: Business+ (a pause-only request, {"active": false}, works on any authenticated key)

PATCH

watchers

{id}

Update a watcher

curl --request PATCH \
  --url https://borough.qwady.app/v1/watchers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pollInterval": 123,
  "active": true
}
'

import requests

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

payload = {
    "pollInterval": 123,
    "active": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({pollInterval: 123, active: true})
};

fetch('https://borough.qwady.app/v1/watchers/{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/watchers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'pollInterval' => 123,
    'active' => true
  ]),
  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/{id}"

	payload := strings.NewReader("{\n  \"pollInterval\": 123,\n  \"active\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://borough.qwady.app/v1/watchers/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pollInterval\": 123,\n  \"active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pollInterval\": 123,\n  \"active\": true\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>

Path Parameters

string

required

Watcher ID (UUID)

Body

application/json

pollInterval

integer

Seconds between polls. Must meet the minimum for the watcher's type: on Business, 3600 for listing watchers and 300 for building and search watchers.

active

boolean

false pauses the watcher. true resumes it with a fresh baseline, subject to the active-watcher caps and, for search watchers, the 500-listing limit.

Response

Watcher updated

data

object

Show child attributes

meta

object

Show child attributes

Update a watcher

curl --request PATCH \
  --url https://borough.qwady.app/v1/watchers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pollInterval": 123,
  "active": true
}
'

import requests

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

payload = {
    "pollInterval": 123,
    "active": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({pollInterval: 123, active: true})
};

fetch('https://borough.qwady.app/v1/watchers/{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/watchers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'pollInterval' => 123,
    'active' => true
  ]),
  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/{id}"

	payload := strings.NewReader("{\n  \"pollInterval\": 123,\n  \"active\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://borough.qwady.app/v1/watchers/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pollInterval\": 123,\n  \"active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pollInterval\": 123,\n  \"active\": true\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