> ## Documentation Index > Fetch the complete documentation index at: https://qwady.wiki/llms.txt > Use this file to discover all available pages before exploring further. # Tools Reference > Complete reference for all Borough MCP tools ## Search Tools ### 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 (integer 0–50; 0 = studio) | | `maxBeds` | number | Maximum bedrooms (integer 0–50) | | `minBaths` | number | Minimum full bathrooms (integer 1–4) | | `maxBaths` | number | Maximum full bathrooms (integer 1–4) | | `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, CONDOP, HOUSE, SINGLEFAMILY, TOWNHOUSE, TWOFAMILY, THREEFAMILY, FOURFAMILY, MULTI\_FAMILY, MIXED\_USE, HYBRID, COMMERCIAL, UNKNOWN | | `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 an FCC public-data provider match with fiber technology | | `minDownloadMbps` | number | Require an FCC public-data 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`, 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. * Broadband filters use Borough's FCC-backed provider enrichment. Coverage may be exact-building or Census-block level depending on the imported area. 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\_sales Search active for-sale listings. Same parameters as `search_rentals` plus: **Tier:** Free | Parameter | Type | Description | | ---------- | ------ | -------------------------------------------------------------------------- | | `saleType` | string | RESALE, SPONSOR\_UNIT, FORECLOSURE, RESTRICTED, AUCTION, SHORT, or UNKNOWN | 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) | 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 Look up a listing by its URL path. **Tier:** Starter (\$19/mo) | Parameter | Type | Required | Description | | --------- | ------ | -------- | ------------------------------------------------------------------------------------------- | | `url` | string | Yes | URL path such as `/sale/`, `/building//`, or `/building//rental/` | *** ## Building Tools ### get\_building Get detailed building information. **Tier:** Starter (\$19/mo) | Parameter | Type | Required | Description | | --------- | ------ | -------- | ----------- | | `id` | string | Yes | Building ID | *** ### 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 ### 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 | Parameter | Type | Description | | ---------- | ------ | --------------------------------------------------------------------------------------- | | `level` | number | 0=NYC container, 1=borough, 2-3=neighborhoods (see the Areas & Neighborhoods reference) | | `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 ### 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-6) | | `listingType` | string | No | rental or sale (default: rental) | *** ### 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 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-6) | | `listingType` | string | No | rental or sale (default: rental) | Use either `areas` or `locations`, not both.