Skip to main content
GET
/
building
/
{id}
/
listings
Get listings in building
curl --request GET \
  --url https://borough.qwady.app/v1/building/{id}/listings \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "address": {
        "street": "157 West 57th Street",
        "unit": "#48B",
        "city": "NEW YORK",
        "state": "NY",
        "zipCode": "10019"
      },
      "price": 123,
      "netEffective": 123,
      "monthsFree": 123,
      "leaseTermMonths": 123,
      "bedroomCount": 123,
      "fullBathroomCount": 123,
      "halfBathroomCount": 123,
      "areaName": "<string>",
      "areaId": 123,
      "geoPoint": {
        "latitude": 40.7654,
        "longitude": -73.9791
      },
      "leadPhotoKey": "<string>",
      "sourceGroupLabel": "<string>",
      "urlPath": "<string>",
      "listedAt": "2023-12-25",
      "availableAt": "2023-12-25",
      "daysOnMarket": 123
    }
  ],
  "meta": {
    "dataAge": "2023-11-07T05:31:56Z",
    "freshnessThreshold": 123,
    "refreshTriggered": 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

​
id
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:50

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[]
​
meta
object