Documentation Index
Fetch the complete documentation index at: https://qwady.wiki/llms.txt
Use this file to discover all available pages before exploring further.
Search filter amenities
Pass amenity values to the amenities parameter as a comma-separated string. Listings are filtered to include only those matching all specified amenities.
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",
});
Available amenity values
In-unit features
| Value | Description |
|---|
WASHER_DRYER | In-unit washer/dryer |
DISHWASHER | In-unit dishwasher |
CENTRAL_AC | Central air conditioning |
FURNISHED | Fully furnished unit |
FIREPLACE | Working or decorative fireplace |
LOFT | Loft-style layout with high ceilings |
PRIVATE_OUTDOOR_SPACE | Private balcony, terrace, or patio |
Building amenities
| Value | Description |
|---|
ELEVATOR | Building has elevator service |
DOORMAN | Doorman or concierge service |
LAUNDRY | Shared laundry room in building |
GYM | Fitness center in building |
POOL | Swimming pool |
PARKING | Parking available (garage or lot) |
SHARED_OUTDOOR_SPACE | Shared roof deck, courtyard, or garden |
CHILDRENS_PLAYROOM | Children’s playroom in building |
STORAGE_SPACE | Storage units available |
Policies
| Value | Description |
|---|
PIED_A_TERRE_ALLOWED | Building allows pied-a-terre (non-primary residence) |
SMOKE_FREE | No-smoking building |
GUARANTORS_ACCEPTED | Building accepts guarantors for lease applications |
Not currently supported as search filters
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
Building-level amenity details
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"]
}
}
| Field | Type | Description |
|---|
list | string[] | Array of amenity enum values present in the building |
doormanTypes | string[] | Doorman service types (e.g., FULL_TIME, PART_TIME, VIRTUAL) |
parkingTypes | string[] | Parking types (e.g., GARAGE, LOT, VALET) |
storageTypes | string[] | Storage options (e.g., BASEMENT, UNIT, BIKE_ROOM) |
sharedOutdoorTypes | string[] | Outdoor space types (e.g., ROOF_DECK, COURTYARD, GARDEN) |
