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.
noFee,hasOpenHouse, andhas3dTouraccepttrueor nothing at all. Borough leaves those fieldsnulluntil a listing has been detail-scraped, so it cannot tell “confirmed absent” from “not yet checked”, andfalseis rejected. Omit the parameter to search every listing regardless of that field.- Broadband filters use Borough’s FCC-backed provider enrichment. Coverage may be exact-building or Census-block level depending on the imported area.
minTransitScore,fiberOnly,minDownloadMbps, and building-level amenities match only listings Borough has linked to their building, which happens when it loads a listing’s full detail. Listings without that link never match these filters, even when their building qualifies, so results undercount while detail coverage is incomplete.
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. Everysearch_rentals parameter applies here except noFee, which is a rentals-only filter. Sale search adds:
Tier: Free
Notes:
noFeeis not accepted here. A broker fee is something you pay to rent, so sale listings carry no broker-fee flag, and passingnoFeeto sale search is refused with that reason rather than silently ignored. Usesearch_rentalswhen you want no-fee listings.hasOpenHouseandhas3dTourtaketrueor nothing here as well.
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
costSummary:noFeeplus monthly maintenance, common charges, and property tax
Freshness. On Business,
get_property, get_property_by_url, and get_building fetch stale data live before responding, and paid tiers queue a background refresh for stale data. Live fetches and refreshes draw on a shared live-fetch budget. When that budget is held for Borough’s scheduled updates, or live fetching is paused, these tools return cached data instead: check meta.source (cached or stale rather than live) and meta.dataAge.get_property_by_url
Look up a listing by its URL path. Tier: Starter ($19/mo)
Returns the same compact projection as
get_property, with the same freshness behavior.
Building Tools
get_building
Get detailed building information. Tier: Starter ($19/mo)
Returns the building’s name, address, type, year built, floor and unit counts, area ID, up to 8 amenities plus
amenityCount, policies, management company, and tax abatement status. Building scores are not included; get_property returns them for a listing in the building. Freshness behaves as described under get_property above.
get_building_listings
Get the listings Borough has linked to a specific building, cheapest first. Listings are linked when Borough loads their full detail, so units seen only in search results may be missing. 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
Recent price trends for a neighborhood: up to 365 rows, one per date and event type, most recent first. Because each day can carry several event types, the rows typically cover the last few months rather than a full year. Tier: Free (authenticated)compare_neighborhoods
Side-by-side comparison of 1-5 neighborhoods. Tier: Free (authenticated)
Use either
areas or locations, not both.