Skip to content

Tools Reference

Search active rental listings across all five NYC boroughs.

Tier: Free

ParameterTypeDescription
areasstring or arrayArea IDs as either a comma-separated string or an array
locationstringSingle borough or neighborhood name such as Chelsea or Astoria
locationsstring or arrayMultiple borough or neighborhood names
minPricenumberMinimum monthly rent in USD
maxPricenumberMaximum monthly rent in USD
minBedsnumberMinimum bedrooms (0 = studio)
maxBedsnumberMaximum bedrooms
minBathsnumberMinimum full bathrooms
maxBathsnumberMaximum full bathrooms
minSqftnumberMinimum interior square footage
maxSqftnumberMaximum interior square footage
petsAllowedbooleanFilter for pet-friendly listings
amenitiesstring or arrayAmenity enums such as DISHWASHER, WASHER_DRYER, ELEVATOR, DOORMAN, LAUNDRY, GYM, POOL, PARKING
buildingTypestringComma-separated: RENTAL, CONDO, CO_OP, HOUSE, MULTI_FAMILY, TOWNHOUSE
noFeebooleanFilter for no-fee listings only
sortstringPRICE, LISTED_AT, or RECOMMENDED
sortDirstringASC or DESC
hasOpenHousebooleanFilter for listings with open houses
has3dTourbooleanFilter for listings with 3D tours
maxMonthlyCostnumberMax total monthly cost (rent + fees)
minTransitScorenumberMinimum transit score (0-100)
fiberOnlybooleanRequire a building-level FCC broadband provider match with fiber technology
minDownloadMbpsnumberRequire a building-level FCC broadband provider with at least this advertised download speed
pagenumberPage number (default 1)
perPagenumberResults per page (default 3, max 5)

Notes:

  • Use either areas, location, or locations, not more than one of them in the same call.
  • Exact borough and neighborhood names can be passed directly with location, but list_areas is 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 DISHWASHER and WASHER_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. fiberOnly and minDownloadMbps remain provisional pending contract validation and may change before further rollout.

Response highlights:

  • price and displayPrice for numeric and human-friendly price display
  • geoPoint for map plotting
  • leadPhotoUrl for proxied listing images
  • renderHints for card-friendly address, price, map label, and image URL values

Borough IDs: Manhattan=100, Bronx=200, Brooklyn=300, Queens=400, Staten Island=500


Search active for-sale listings. Same parameters as search_rentals plus:

Tier: Free

ParameterTypeDescription
saleTypestringRESALE, SPONSOR_UNIT, or FORECLOSURE

Response highlights match search_rentals, including price, displayPrice, geoPoint, leadPhotoUrl, and renderHints.


Get full details for a specific listing by ID. Returns 50+ fields.

Tier: Starter ($19/mo)

ParameterTypeRequiredDescription
idstringYesListing 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

Look up a listing by its URL path.

Tier: Starter ($19/mo)

ParameterTypeRequiredDescription
urlstringYesURL path (e.g. “apartment-for-rent/1234567/manhattan/nyc”)

Get detailed building information.

Tier: Starter ($19/mo)

ParameterTypeRequiredDescription
idstringYesBuilding ID

Get all listings within a specific building.

Tier: Starter ($19/mo)

ParameterTypeRequiredDescription
idstringYesBuilding ID
statusstringNoACTIVE, IN_CONTRACT, or OFF_MARKET
listingTypestringNorental or sale
pagenumberNoPage number
perPagenumberNoResults per page

Returns the same compact, render-friendly listing summary fields as the search tools, including price, displayPrice, geoPoint, leadPhotoUrl, and renderHints.


List all 349 NYC neighborhoods, boroughs, and sub-areas.

Tier: Free

ParameterTypeDescription
levelnumber0=borough, 1=neighborhood
parentIdnumberParent area ID (e.g. 200 for Bronx neighborhoods)
qstringName lookup for boroughs or neighborhoods such as Chelsea
pagenumberPage number
perPagenumberResults per page

Use this when you want the safest, most explicit area-ID resolution before calling a search or market tool.


Current market statistics for a neighborhood.

Tier: Free (authenticated)

ParameterTypeRequiredDescription
areaIdnumberNoArea ID
locationstringNoBorough or neighborhood name
bedroomsnumberNoFilter by bedroom count (0-4)
listingTypestringNorental or sale (default: rental)

Historical price trends for a neighborhood (up to 365 days).

Tier: Free (authenticated)

ParameterTypeRequiredDescription
areaIdnumberNoArea ID
locationstringNoBorough or neighborhood name
listingTypestringNorental or sale (default: rental)

Side-by-side comparison of 1-5 neighborhoods.

Tier: Free (authenticated)

ParameterTypeRequiredDescription
areasstring or arrayNoArea IDs as a comma-separated string or an array (1-5 total)
locationsstring or arrayNoBorough or neighborhood names (1-5 total)
bedroomsnumberNoFilter by bedroom count (0-4)
listingTypestringNorental or sale (default: rental)

Use either areas or locations, not both.