Skip to content

Amenities

Pass amenity values to the amenities parameter as a comma-separated string. Listings are filtered to include only those matching all specified amenities.

Terminal window
curl "https://borough.qwady.app/v1/search/rentals?amenities=DOORMAN,ELEVATOR,GYM&areas=100"
const results = await borough.rentals.search({
amenities: "DOORMAN,ELEVATOR,GYM",
areas: "100",
});
ValueDescription
WASHER_DRYERIn-unit washer/dryer
DISHWASHERIn-unit dishwasher
CENTRAL_ACCentral air conditioning
FURNISHEDFully furnished unit
FIREPLACEWorking or decorative fireplace
LOFTLoft-style layout with high ceilings
PRIVATE_OUTDOOR_SPACEPrivate balcony, terrace, or patio
ValueDescription
ELEVATORBuilding has elevator service
DOORMANDoorman or concierge service
LAUNDRYShared laundry room in building
GYMFitness center in building
POOLSwimming pool
PARKINGParking available (garage or lot)
SHARED_OUTDOOR_SPACEShared roof deck, courtyard, or garden
CHILDRENS_PLAYROOMChildren’s playroom in building
STORAGE_SPACEStorage units available
ValueDescription
PIED_A_TERRE_ALLOWEDBuilding allows pied-a-terre (non-primary residence)
SMOKE_FREENo-smoking building
GUARANTORS_ACCEPTEDBuilding accepts guarantors for lease applications

The following categories are intentionally out of scope for the current API filter surface and should not be treated as supported search values:

  • view-style enums such as CITY_VIEW, WATER_VIEW, or PARK_VIEW
  • transit-line matching
  • prewar-only filtering

The building detail endpoint (GET /v1/building/{id}) returns richer amenity data in the amenities object:

{
"amenities": {
"list": ["ELEVATOR", "DOORMAN", "GYM", "LAUNDRY", "PARKING"],
"doormanTypes": ["FULL_TIME"],
"parkingTypes": ["GARAGE"],
"storageTypes": ["BASEMENT"],
"sharedOutdoorTypes": ["ROOF_DECK", "COURTYARD"]
}
}
FieldTypeDescription
liststring[]Array of amenity enum values present in the building
doormanTypesstring[]Doorman service types (e.g., FULL_TIME, PART_TIME, VIRTUAL)
parkingTypesstring[]Parking types (e.g., GARAGE, LOT, VALET)
storageTypesstring[]Storage options (e.g., BASEMENT, UNIT, BIKE_ROOM)
sharedOutdoorTypesstring[]Outdoor space types (e.g., ROOF_DECK, COURTYARD, GARDEN)