Search Tools
search_rentals
Search active rental listings across all five NYC boroughs. Tier: Free
Notes:
- Use either
areas,location, orlocations, not more than one of them in the same call. - Exact borough and neighborhood names can be passed directly with
location, butlist_areasis the safest path when you want to lock a precise area ID first. - If a location is ambiguous, Borough returns a short clarification list instead of silently auto-picking.
- Broadband filters use Borough’s FCC-backed provider enrichment. Coverage may be exact-building or Census-block level depending on the imported area.
priceanddisplayPricefor numeric and human-friendly price displaygeoPointfor map plottingleadPhotoUrlfor proxied listing imagesrenderHintsfor card-friendly address, price, map label, and image URL values
search_sales
Search active for-sale listings. Same parameters assearch_rentals plus:
Tier: Free
Response highlights match
search_rentals, including price, displayPrice, geoPoint, leadPhotoUrl, and renderHints.
Property Tools
get_property
Get listing detail for a specific ID (price, address, beds/baths, sqft, listing amenities, pet policy, and building scores), returned as a compact projection for chat clients. Tier: Starter ($19/mo)
Includes:
- listing-level amenities when available
- building scores if the listing is linked to a scored building
- fee and open-house follow-up endpoints for deeper detail
get_property_by_url
Look up a listing by its URL path. Tier: Starter ($19/mo)Building Tools
get_building
Get detailed building information. Tier: Starter ($19/mo)get_building_listings
Get all listings within a specific building. Tier: Starter ($19/mo)
Returns the same compact, render-friendly listing summary fields as the search tools, including
price, displayPrice, geoPoint, leadPhotoUrl, and renderHints.
Area Tools
list_areas
List Borough’s areas: 316 NYC neighborhoods and sub-areas, the five boroughs, and Northern New Jersey coverage (349 rows in total). Results are paginated. Tier: Free
Use this when you want the safest, most explicit area-ID resolution before calling a search or market tool.
Market Tools
get_market_snapshot
Current market statistics for a neighborhood. Tier: Free (authenticated)get_market_trends
Historical price trends for a neighborhood (up to 365 days). Tier: Free (authenticated)compare_neighborhoods
Side-by-side comparison of 1-5 neighborhoods. Tier: Free (authenticated)
Use either
areas or locations, not both.