Get alerts for a search
create_alert_linkCreate a link that opens this search on Buzzedin, where the user can save it as an alert and get an email or push notification when a new matching listing appears. Pass the same filters used for search_listings. Use it when the user wants to be notified, or accepts the offer of an alert.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| beds | No | Number of bedrooms. "1br"=1, "2bed"=2, "studio"="studio" | |
| baths | No | Minimum number of bathrooms | |
| hasAc | No | AC/air conditioning required | |
| noFee | No | No broker fee required | |
| sortBy | No | Sort order | |
| borough | No | Borough name if mentioned: Manhattan, Brooklyn, Queens, Bronx, Staten Island | |
| maxSqft | No | Maximum square footage. Extract from phrases like "under X sqft", "less than X sq ft", "max X square feet" | |
| minSqft | No | Minimum square footage. Extract from phrases like "at least X sqft", "X+ sqft", "over X sq ft", "minimum X square feet" | |
| isPrewar | No | Pre-war building | |
| maxPrice | No | Maximum monthly rent in dollars. Extract from phrases like "under $X", "under X", "less than $X", "max $X", "$Xk", "Xk" where k=1000. Examples: "5k"=5000, "$4k"=4000, "under 3500"=3500 | |
| minPrice | No | Minimum monthly rent in dollars | |
| moveInBy | No | Latest acceptable move-in date as YYYYMMDD (for example, 20260701 for July 1, 2026). Only set this when the user gives a move-in deadline. | |
| spacious | No | Apartment feels above-average in size for its bedroom count. Match spacious or very spacious listings. | |
| viewType | No | View type. "park views"="park", "water view"="water", "city views"="city_skyline" | |
| floorLevel | No | Floor level. "high floor"="high", "penthouse"="penthouse" | |
| hasBathtub | No | Has bathtub (not just shower) | |
| hasDoorman | No | Doorman building required | |
| hasParking | No | Parking available | |
| noiseLevel | No | Street noise level. "quiet"="quiet", "peaceful"="quiet" | |
| roomLayout | No | Room layout type. "open layout"="open", "flex"="flex", "railroad"="railroad" | |
| catsAllowed | No | Cats allowed | |
| dogsAllowed | No | Dogs allowed | |
| hasElevator | No | Elevator building required | |
| isFurnished | No | Furnished apartment required | |
| kitchenType | No | Kitchen type. "open kitchen"="open", "eat-in kitchen"="eat_in" | |
| moveInAfter | No | Earliest acceptable move-in date as YYYYMMDD (for example, 20260801 for August 1, 2026). Only set this when the user wants listings available on or after a specific date — for example "not until August" or "earliest move-in August 1". | |
| petsAllowed | No | Pets allowed (any pets) | |
| buildingType | No | Building type. "high rise"="high_rise", "walkup"="walk_up" | |
| flooringType | No | Flooring type. "hardwood floors"="hardwood" | |
| hasFireplace | No | Has fireplace (decorative or working) | |
| naturalLight | No | Natural light level. "sunny"/"bright"="abundant" | |
| commuteFilter | No | Filter by commute time to a SPECIFIC location | |
| hasDishwasher | No | Has dishwasher | |
| hasHomeOffice | No | Has dedicated home office space | |
| hasRoofAccess | No | Building has roof access/deck | |
| inUnitLaundry | No | In-unit washer/dryer required | |
| neighborhoods | No | Extract specific NYC neighborhood names. Map abbreviations to full names: "LES"="Lower East Side", "UES"="Upper East Side", "UWS"="Upper West Side", "FiDi"="Financial District", "BedStuy"="Bedford-Stuyvesant", "LIC"="Long Island City", "DUMBO"="DUMBO". Map general areas to specific neighborhoods: "Lower Manhattan" -> ["Financial District", "Tribeca", "Battery Park City", "Chinatown", "Civic Center"]. Use exact neighborhood names. | |
| facesQuietSide | No | Unit faces quiet side (courtyard, back) | |
| hasBikeStorage | No | Building has bike storage | |
| hasLiveInSuper | No | Building has live-in super | |
| hasNotableView | No | Has notable/great view | |
| hasStorageUnit | No | Storage unit available in building | |
| hasExposedBrick | No | Has exposed brick | |
| hasHighCeilings | No | Has high ceilings (9ft+) | |
| hasOutdoorSpace | No | Private outdoor space required (balcony, patio, backyard, terrace, roof) | |
| hasWalkInCloset | No | Has walk-in closet | |
| isLeaseTakeover | No | Looking for lease takeover | |
| hasGymInBuilding | No | Gym in building required | |
| renovationStatus | No | Renovation status. "renovated"="newly_renovated" | |
| buildingCondition | No | Building condition/maintenance level | |
| exposureDirection | No | Unit exposure/facing direction. "south facing"="south" | |
| poiCommuteFilters | No | ONLY for generic POI types like "a grocery store". For specific brands (Whole Foods, Equinox), use commuteFilter instead | |
| utilitiesIncluded | No | Heat/utilities included in rent | |
| hasLaundryInBuilding | No | Laundry in building required | |
| rentControlledClaimed | No | The listing itself says the unit is rent-stabilized. Much rarer; use only when the user wants the listing to state it. | |
| rentControlledVerified | No | Building is on the NYC (DHCR) list of buildings with rent-stabilized units. Use this when the user asks for rent-stabilized apartments. |