Skip to main content

Documentation Index

Fetch the complete documentation index at: https://qwady.wiki/llms.txt

Use this file to discover all available pages before exploring further.

​
BuildingType

Used in search filters (buildingType parameter) and returned in listing/building responses.
ValueDescription
CONDOCondominium — individually owned units in a shared building
CO_OPCo-operative — residents own shares in a corporation that owns the building
RENTALRental building — units available for lease only
TOWNHOUSETownhouse — multi-story attached or semi-attached home
MULTI_FAMILYMulti-family house — 2-4 unit residential building
HOUSESingle-family house
Pass one or more values as a comma-separated string: 
# Search for condos and co-ops
curl "https://borough.qwady.app/v1/search/rentals?buildingType=CONDO,CO_OP"

# Search only townhouses
curl "https://borough.qwady.app/v1/search/sales?buildingType=TOWNHOUSE"

const results = await borough.rentals.search({
  buildingType: "CONDO,CO_OP",
});

​
ListingStatus

Returned in the status field of listing responses.
ValueDescription
ACTIVECurrently available on the market
IN_CONTRACTUnder contract — offer accepted, sale pending
OFF_MARKETNo longer available
Search endpoints return ACTIVE listings by default. The property detail endpoint (/v1/property/{id}) may return listings in any status.

​
SaleType

Used as a filter on /v1/search/sales only (not applicable to rentals).
ValueDescription
RESALEStandard resale — existing owner selling
SPONSOR_UNITNew development or sponsor sale — first sale from developer
FORECLOSUREForeclosure — bank-owned or distressed sale

​
Usage in search

# Search for new development condos in Manhattan
curl "https://borough.qwady.app/v1/search/sales?saleType=SPONSOR_UNIT&buildingType=CONDO&areas=100"

const results = await borough.sales.search({
  saleType: "SPONSOR_UNIT",
  buildingType: "CONDO",
  areas: "100",
});