Tools Reference
Search Tools
Section titled “Search Tools”search_rentals
Section titled “search_rentals”Search active rental listings across all five NYC boroughs.
Tier: Free
| Parameter | Type | Description |
|---|---|---|
areas | string or array | Area IDs as either a comma-separated string or an array |
location | string | Single borough or neighborhood name such as Chelsea or Astoria |
locations | string or array | Multiple borough or neighborhood names |
minPrice | number | Minimum monthly rent in USD |
maxPrice | number | Maximum monthly rent in USD |
minBeds | number | Minimum bedrooms (0 = studio) |
maxBeds | number | Maximum bedrooms |
minBaths | number | Minimum full bathrooms |
maxBaths | number | Maximum full bathrooms |
minSqft | number | Minimum interior square footage |
maxSqft | number | Maximum interior square footage |
petsAllowed | boolean | Filter for pet-friendly listings |
amenities | string or array | Amenity enums such as DISHWASHER, WASHER_DRYER, ELEVATOR, DOORMAN, LAUNDRY, GYM, POOL, PARKING |
buildingType | string | Comma-separated: RENTAL, CONDO, CO_OP, HOUSE, MULTI_FAMILY, TOWNHOUSE |
noFee | boolean | Filter for no-fee listings only |
sort | string | PRICE, LISTED_AT, or RECOMMENDED |
sortDir | string | ASC or DESC |
hasOpenHouse | boolean | Filter for listings with open houses |
has3dTour | boolean | Filter for listings with 3D tours |
maxMonthlyCost | number | Max total monthly cost (rent + fees) |
minTransitScore | number | Minimum transit score (0-100) |
fiberOnly | boolean | Require a building-level FCC broadband provider match with fiber technology |
minDownloadMbps | number | Require a building-level FCC broadband provider with at least this advertised download speed |
page | number | Page number (default 1) |
perPage | number | Results per page (default 3, max 5) |
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.
- For listing-level amenities such as
DISHWASHERandWASHER_DRYER, Borough may do a small follow-up detail refinement pass so the MCP result stays honest. - Broadband filters use Borough’s FCC-backed building-level provider enrichment, so unmatched buildings will not satisfy them.
- Contract validation status as of March 2-3, 2026: Borough observed live Broadband Map browser calls to
broadbandmap.fcc.gov/nbm/map/api/fabric/...with CostQuest Fabric license language restricting unauthorized scripted or programmatic access.fiberOnlyandminDownloadMbpsremain provisional pending contract validation and may change before further rollout.
Response highlights:
priceanddisplayPricefor numeric and human-friendly price displaygeoPointfor map plottingleadPhotoUrlfor proxied listing imagesrenderHintsfor card-friendly address, price, map label, and image URL values
Borough IDs: Manhattan=100, Bronx=200, Brooklyn=300, Queens=400, Staten Island=500
search_sales
Section titled “search_sales”Search active for-sale listings. Same parameters as search_rentals plus:
Tier: Free
| Parameter | Type | Description |
|---|---|---|
saleType | string | RESALE, SPONSOR_UNIT, or FORECLOSURE |
Response highlights match search_rentals, including price, displayPrice, geoPoint, leadPhotoUrl, and renderHints.
Property Tools
Section titled “Property Tools”get_property
Section titled “get_property”Get full details for a specific listing by ID. Returns 50+ fields.
Tier: Starter ($19/mo)
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Listing ID |
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
Section titled “get_property_by_url”Look up a listing by its URL path.
Tier: Starter ($19/mo)
| Parameter | Type | Required | Description |
|---|---|---|---|
url | string | Yes | URL path (e.g. “apartment-for-rent/1234567/manhattan/nyc”) |
Building Tools
Section titled “Building Tools”get_building
Section titled “get_building”Get detailed building information.
Tier: Starter ($19/mo)
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Building ID |
get_building_listings
Section titled “get_building_listings”Get all listings within a specific building.
Tier: Starter ($19/mo)
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Building ID |
status | string | No | ACTIVE, IN_CONTRACT, or OFF_MARKET |
listingType | string | No | rental or sale |
page | number | No | Page number |
perPage | number | No | Results per page |
Returns the same compact, render-friendly listing summary fields as the search tools, including price, displayPrice, geoPoint, leadPhotoUrl, and renderHints.
Area Tools
Section titled “Area Tools”list_areas
Section titled “list_areas”List all 349 NYC neighborhoods, boroughs, and sub-areas.
Tier: Free
| Parameter | Type | Description |
|---|---|---|
level | number | 0=borough, 1=neighborhood |
parentId | number | Parent area ID (e.g. 200 for Bronx neighborhoods) |
q | string | Name lookup for boroughs or neighborhoods such as Chelsea |
page | number | Page number |
perPage | number | Results per page |
Use this when you want the safest, most explicit area-ID resolution before calling a search or market tool.
Market Tools
Section titled “Market Tools”get_market_snapshot
Section titled “get_market_snapshot”Current market statistics for a neighborhood.
Tier: Free (authenticated)
| Parameter | Type | Required | Description |
|---|---|---|---|
areaId | number | No | Area ID |
location | string | No | Borough or neighborhood name |
bedrooms | number | No | Filter by bedroom count (0-4) |
listingType | string | No | rental or sale (default: rental) |
get_market_trends
Section titled “get_market_trends”Historical price trends for a neighborhood (up to 365 days).
Tier: Free (authenticated)
| Parameter | Type | Required | Description |
|---|---|---|---|
areaId | number | No | Area ID |
location | string | No | Borough or neighborhood name |
listingType | string | No | rental or sale (default: rental) |
compare_neighborhoods
Section titled “compare_neighborhoods”Side-by-side comparison of 1-5 neighborhoods.
Tier: Free (authenticated)
| Parameter | Type | Required | Description |
|---|---|---|---|
areas | string or array | No | Area IDs as a comma-separated string or an array (1-5 total) |
locations | string or array | No | Borough or neighborhood names (1-5 total) |
bedrooms | number | No | Filter by bedroom count (0-4) |
listingType | string | No | rental or sale (default: rental) |
Use either areas or locations, not both.