Property search, comparison, investment analysis and watchlists with change alerts
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Gross rental yield, gross annual rent, price-to-rent and price per sq ft for a sale listing, from the user's monthly_rent, an active rental listing for the same property, or a RentCast rent estimate (labelled). With assumptions (down payment, rate, taxes, insurance, vacancy, repairs, management, capex) also cash flow, cap rate and cash-on-cash, plus a sensitivity table. Gross yield is not a return; always relay the disclaimer.
The user's own rent assumption; used instead of an estimate.
Use a RentCast rent estimate when no monthly_rent is given (may use a live refresh).
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Gross rental yield, gross annual rent, price-to-rent and price per sq ft for a sale listing, from the user's monthly_rent, an active rental listing for the same property, or a RentCast rent estimate (labelled). With assumptions (down payment, rate, taxes, insurance, vacancy, repairs, management, capex) also cash flow, cap rate and cash-on-cash, plus a sensitivity table. Gross yield is not a return; always relay the disclaimer.
| Argument | Type | Description |
|---|---|---|
| listing_id | string | |
| assumptions | object | |
| property_id | string | |
| monthly_rent | number | The user's own rent assumption; used instead of an estimate. |
| use_rent_estimate | boolean | Use a RentCast rent estimate when no monthly_rent is given (may use a live refresh). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"listing_id": {
"type": "string",
"pattern": "^rrl_[a-f0-9]{24}$"
},
"assumptions": {
"type": "object",
"properties": {
"capex_pct": {
"type": "number",
"maximum": 100,
"minimum": 0
},
"loan_years": {
"type": "integer",
"maximum": 40,
"minimum": 1
},
"hoa_monthly": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"repairs_pct": {
"type": "number",
"maximum": 100,
"minimum": 0
},
"vacancy_pct": {
"type": "number",
"maximum": 100,
"minimum": 0
},
"management_pct": {
"type": "number",
"maximum": 100,
"minimum": 0
},
"down_payment_pct": {
"type": "number",
"maximum": 100,
"minimum": 0
},
"insurance_annual": {
"type": "number",
"maximum": 10000000,
"minimum": 0
},
"mortgage_rate_pct": {
"type": "number",
"maximum": 30,
"minimum": 0
},
"property_tax_annual": {
"type": "number",
"maximum": 10000000,
"minimum": 0
}
},
"additionalProperties": false
},
"property_id": {
"type": "string",
"pattern": "^rrp_[a-f0-9]{24}$"
},
"monthly_rent": {
"type": "number",
"maximum": 1000000,
"description": "The user's own rent assumption; used instead of an estimate.",
"exclusiveMinimum": 0
},
"use_rent_estimate": {
"type": "boolean",
"default": true,
"description": "Use a RentCast rent estimate when no monthly_rent is given (may use a live refresh)."
}
},
"additionalProperties": false
}Side-by-side comparison of 2-5 properties (property_id) on price, price per sq ft, size, age, HOA, time observed, price changes and stated features (unknown where the listing is silent); optional match scores against a saved watchlist.
| Argument | Type | Description |
|---|---|---|
| watchlist | string | Score each against this saved search. |
| property_ids* | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"property_ids"
],
"properties": {
"watchlist": {
"type": "string",
"maxLength": 60,
"description": "Score each against this saved search."
},
"property_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^rrp_[a-f0-9]{24}$"
},
"maxItems": 5,
"minItems": 2
}
},
"additionalProperties": false
}New alerts from monitoring: NEW_MATCHING_PROPERTY, NEW_STRONG_STYLE_MATCH, PRICE_DROP, RENT_DROP, PRICE_THRESHOLD_REACHED, RENT_THRESHOLD_REACHED, PROPERTY_BACK_ON_MARKET, LISTING_STATUS_CHANGED, SAVED_PROPERTY_UPDATED, INVESTMENT_CRITERIA_MATCHED. Filter by types (e.g. price changes only) or watchlist. Each alert has the property, source, previous and current values, detection time, freshness and why it matched. Returned alerts are marked retrieved. Relay the message wording; do not upgrade it (a price drop is not a bargain, a removed listing is not a sale).
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| types | array | Filter, e.g. ['PRICE_DROP','RENT_DROP'] for price changes or ['NEW_MATCHING_PROPERTY','NEW_STRONG_STYLE_MATCH'] for new matches. |
| watchlist | string | |
| include_already_retrieved | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1
},
"types": {
"type": "array",
"items": {
"enum": [
"NEW_MATCHING_PROPERTY",
"NEW_LISTING_OBSERVED",
"PRICE_DROP",
"PRICE_INCREASE",
"PRICE_THRESHOLD_REACHED",
"RENT_DROP",
"RENT_THRESHOLD_REACHED",
"PROPERTY_BACK_ON_MARKET",
"LISTING_STATUS_CHANGED",
"PROPERTY_PENDING",
"PROPERTY_SOLD",
"SAVED_PROPERTY_UPDATED",
"NEW_STRONG_STYLE_MATCH",
"INVESTMENT_CRITERIA_MATCHED"
],
"type": "string"
},
"maxItems": 14,
"description": "Filter, e.g. ['PRICE_DROP','RENT_DROP'] for price changes or ['NEW_MATCHING_PROPERTY','NEW_STRONG_STYLE_MATCH'] for new matches."
},
"watchlist": {
"type": "string",
"maxLength": 60
},
"include_already_retrieved": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}Everything Realty.Bingo holds on one property (property_id) or listing (listing_id): attributes, current and other listings, listing contact as published, features with evidence, identity-resolution confidence, recent changes and any stored rent/value estimates (labelled as estimates). refresh: true fetches the latest record if the stored one is over a day old.
| Argument | Type | Description |
|---|---|---|
| refresh | boolean | Fetch the latest listing record from its source if the stored one is over 24 hours old (uses a live refresh). |
| listing_id | string | |
| property_id | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"refresh": {
"type": "boolean",
"default": false,
"description": "Fetch the latest listing record from its source if the stored one is over 24 hours old (uses a live refresh)."
},
"listing_id": {
"type": "string",
"pattern": "^rrl_[a-f0-9]{24}$"
},
"property_id": {
"type": "string",
"pattern": "^rrp_[a-f0-9]{24}$"
}
},
"additionalProperties": false
}Price and status history for a property: what Realty.Bingo observed (with dates), detected changes, and the listing source's own reported history, kept separate and labelled. Includes cumulative change since first observed. Never infers an earlier price.
| Argument | Type | Description |
|---|---|---|
| listing_id | string | |
| property_id | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"listing_id": {
"type": "string",
"pattern": "^rrl_[a-f0-9]{24}$"
},
"property_id": {
"type": "string",
"pattern": "^rrp_[a-f0-9]{24}$"
}
},
"additionalProperties": false
}A personalized digest: pending alert counts and the top few, each watchlist's best current matches and data age, tracked properties and their changes this week, learned-preference suggestions and questions worth asking. Does not mark alerts retrieved.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"additionalProperties": false
}list, get, pause, resume or delete (confirm: true) the user's watchlists by name, or 'matches' to see the best-scoring current listings for one. Also shows plan limits.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| action* | string | |
| confirm | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"action"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"action": {
"enum": [
"list",
"get",
"pause",
"resume",
"delete",
"matches"
],
"type": "string"
},
"confirm": {
"type": "boolean"
}
},
"additionalProperties": false
}view the account, plan, usage and every stored preference with its provenance; confirm, reject or delete a learned preference; clear personalization or delete the account (both need confirm: true and an explicit request); set or remove a signed webhook for alerts (paid plans).
| Argument | Type | Description |
|---|---|---|
| key | string | |
| action* | string | |
| confirm | boolean | |
| webhook_url | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"action"
],
"properties": {
"key": {
"type": "string",
"maxLength": 120
},
"action": {
"enum": [
"view",
"confirm_preference",
"reject_preference",
"delete_preference",
"clear_personalization",
"set_webhook",
"remove_webhook",
"delete_account"
],
"type": "string"
},
"confirm": {
"type": "boolean"
},
"webhook_url": {
"type": "string",
"maxLength": 500
}
},
"additionalProperties": false
}Record the user's reaction to a property: like, save (also tracks it), dislike, dismiss (never shown again), hide, contacted_agent, toured, with optional reasons (price, hoa, location, size, condition, style, layout, lot, noise, other). Only when the user says so. Returns learned preference suggestions and clarifying questions to ask.
| Argument | Type | Description |
|---|---|---|
| reasons | array | |
| feedback* | string | |
| listing_id | string | |
| property_id | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"feedback"
],
"properties": {
"reasons": {
"type": "array",
"items": {
"enum": [
"price",
"hoa",
"location",
"size",
"condition",
"style",
"layout",
"lot",
"noise",
"other"
],
"type": "string"
},
"maxItems": 5
},
"feedback": {
"enum": [
"like",
"save",
"dislike",
"dismiss",
"hide",
"contacted_agent",
"toured"
],
"type": "string"
},
"listing_id": {
"type": "string",
"pattern": "^rrl_[a-f0-9]{24}$"
},
"property_id": {
"type": "string",
"pattern": "^rrp_[a-f0-9]{24}$"
}
},
"additionalProperties": false
}Save the user's search criteria once as a named, persistent watchlist (same criteria as search_properties) with alert preferences (min_score, new listings, price drops with optional minimum percent or amount, back on market). Realty.Bingo then monitors the area on a schedule, independent of any conversation, and records new matching listings, price reductions and relistings as alerts. Saving again with the same name replaces it. Returns how the criteria were interpreted (hard vs soft vs excluded) and a preview from stored data. Preferences about the people in a neighbourhood are refused (fair housing).
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| criteria* | object | |
| priority | string | |
| monitoring | string | |
| alert_prefs | object |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"criteria"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"criteria": {
"type": "object",
"required": [
"listing_type",
"location"
],
"properties": {
"avoid": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 2
},
"maxItems": 15,
"description": "Features that exclude a listing when the listing states them, e.g. fixer-upper, pool."
},
"notes": {
"type": "string",
"maxLength": 500,
"description": "The user's own words, kept for reference; terms in it that match the feature list become soft preferences."
},
"styles": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 2
},
"maxItems": 10,
"description": "Architectural styles, e.g. Craftsman, Victorian, mid-century modern."
},
"location": {
"type": "object",
"properties": {
"city": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"state": {
"type": "string",
"pattern": "^[A-Za-z]{2}$"
},
"center": {
"type": "object",
"required": [
"latitude",
"longitude"
],
"properties": {
"latitude": {
"type": "number",
"maximum": 90,
"minimum": -90
},
"longitude": {
"type": "number",
"maximum": 180,
"minimum": -180
}
},
"additionalProperties": false
},
"polygon": {
"type": "array",
"items": {
"type": "array",
"items": false,
"maxItems": 2,
"minItems": 2,
"prefixItems": [
{
"type": "number",
"maximum": 90,
"minimum": -90
},
{
"type": "number",
"maximum": 180,
"minimum": -180
}
]
},
"maxItems": 100,
"minItems": 3
},
"zip_codes": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d{5}$"
},
"maxItems": 10,
"minItems": 1
},
"radius_miles": {
"type": "number",
"maximum": 50,
"exclusiveMinimum": 0
},
"preferred_zip_codes": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d{5}$"
},
"maxItems": 20
}
},
"additionalProperties": false
},
"max_price": {
"type": "number",
"maximum": 1000000000,
"description": "Hard ceiling: listings above it are excluded.",
"exclusiveMinimum": 0
},
"min_price": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"must_have": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 2
},
"maxItems": 15,
"description": "Mandatory features, e.g. garage, fireplace. Unmentioned = unverified, not excluded (unless strict_unknowns)."
},
"investment": {
"type": "object",
"properties": {
"max_price_per_sqft": {
"type": "number",
"maximum": 100000,
"exclusiveMinimum": 0
},
"min_gross_yield_pct": {
"type": "number",
"maximum": 100,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"max_hoa_fee": {
"type": "number",
"maximum": 100000,
"minimum": 0
},
"listing_type": {
"enum": [
"sale",
"rental"
],
"type": "string"
},
"max_distance": {
"type": "object",
"required": [
"place",
"miles"
],
"properties": {
"label": {
"type": "string",
"maxLength": 60
},
"miles": {
"type": "number",
"maximum": 100,
"exclusiveMinimum": 0
},
"place": {
"type": "object",
"required": [
"latitude",
"longitude"
],
"properties": {
"latitude": {
"type": "number",
"maximum": 90,
"minimum": -90
},
"longitude": {
"type": "number",
"maximum": 180,
"minimum": -180
}
},
"additionalProperties": false
}
},
"description": "Straight-line distance from a place the user names (e.g. work). Not driving time.",
"additionalProperties": false
},
"min_bedrooms": {
"type": "integer",
"maximum": 20,
"minimum": 0
},
"min_lot_area": {
"type": "integer",
"maximum": 100000000,
"exclusiveMinimum": 0
},
"nice_to_have": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 2
},
"maxItems": 25,
"description": "Soft features that improve ranking."
},
"min_bathrooms": {
"type": "number",
"maximum": 20,
"minimum": 0
},
"min_year_built": {
"type": "integer",
"maximum": 2100,
"minimum": 1600
},
"property_types": {
"type": "array",
"items": {
"enum": [
"single_family",
"condo",
"townhouse",
"multi_family",
"apartment",
"manufactured",
"land"
],
"type": "string"
},
"maxItems": 7
},
"ideal_max_price": {
"type": "number",
"maximum": 1000000000,
"description": "Soft target: listings above it rank lower but stay in.",
"exclusiveMinimum": 0
},
"min_living_area": {
"type": "integer",
"maximum": 100000,
"exclusiveMinimum": 0
},
"strict_unknowns": {
"type": "boolean",
"description": "Exclude listings that do not state a must_have feature (default false: keep and flag)."
},
"bedrooms_exception": {
"type": "object",
"required": [
"min_bedrooms",
"requires"
],
"properties": {
"requires": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 2
},
"maxItems": 5,
"minItems": 1
},
"min_bedrooms": {
"type": "integer",
"maximum": 20,
"minimum": 0
}
},
"description": "e.g. 'three bedrooms, but two is fine with an office': min_bedrooms 3 plus {min_bedrooms: 2, requires: ['home office']}",
"additionalProperties": false
},
"preferred_bedrooms": {
"type": "integer",
"maximum": 20,
"minimum": 0
},
"exclude_property_types": {
"type": "array",
"items": {
"enum": [
"single_family",
"condo",
"townhouse",
"multi_family",
"apartment",
"manufactured",
"land"
],
"type": "string"
},
"maxItems": 7
}
},
"additionalProperties": false
},
"priority": {
"enum": [
"normal",
"high"
],
"type": "string",
"default": "normal"
},
"monitoring": {
"enum": [
"active",
"paused"
],
"type": "string",
"default": "active"
},
"alert_prefs": {
"type": "object",
"properties": {
"min_score": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"price_drops": {
"type": "boolean"
},
"min_drop_pct": {
"type": "number",
"maximum": 90,
"exclusiveMinimum": 0
},
"new_listings": {
"type": "boolean"
},
"back_on_market": {
"type": "boolean"
},
"status_changes": {
"type": "boolean"
},
"min_drop_amount": {
"type": "number",
"maximum": 100000000,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Find active U.S. homes for sale or rent in a city+state, ZIP codes, a radius around a point, or a polygon. Hard requirements (max_price, min_bedrooms, min_bathrooms, property_types, must_have) filter; soft preferences (ideal_max_price, preferred_bedrooms, nice_to_have, styles) rank; avoid and exclude_property_types exclude. Each result has a 0-100 match score with reasons and uncertainties, the features the listing states (with evidence class), source details and when it was last confirmed active. Features a listing does not mention are UNKNOWN, never assumed. Reuses data fetched in the last 12 hours; otherwise makes a live request if the daily allowance permits. Source: Realtor.com (via RapidAPI) with RentCast as fallback; each result names its source. Never present results beyond what is returned.
| Argument | Type | Description |
|---|---|---|
| sort | string | |
| avoid | array | Features that exclude a listing when the listing states them, e.g. fixer-upper, pool. |
| limit | integer | |
| notes | string | The user's own words, kept for reference; terms in it that match the feature list become soft preferences. |
| offset | integer | |
| styles | array | Architectural styles, e.g. Craftsman, Victorian, mid-century modern. |
| location* | object |
Follow one property (track), stop (untrack) or list tracked ones. Optional price_below threshold and min_drop_pct. Tracked properties produce alerts on every verified price or status change.
| Argument | Type | Description |
|---|---|---|
| note | string | |
| action* | string | |
| listing_id | string | |
| price_below | number | Alert when the asking price (or rent) drops below this. |
| property_id | string | |
| min_drop_pct | number | Only alert on reductions at least this large (percent). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"action"
],
"properties": {
"note": {
"type": "string",
"maxLength": 200
},
"action": {
"enum": [
"track",
"untrack",
"list"
],
"type": "string"
},
"listing_id": {
"type": "string",
"pattern": "^rrl_[a-f0-9]{24}$"
},
"price_below": {
"type": "number",
"maximum": 1000000000,
"description": "Alert when the asking price (or rent) drops below this.",
"exclusiveMinimum": 0
},
"property_id": {
"type": "string",
"pattern": "^rrp_[a-f0-9]{24}$"
},
"min_drop_pct": {
"type": "number",
"maximum": 90,
"description": "Only alert on reductions at least this large (percent).",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
}| max_price | number | Hard ceiling: listings above it are excluded. |
| min_price | number |
| must_have | array | Mandatory features, e.g. garage, fireplace. Unmentioned = unverified, not excluded (unless strict_unknowns). |
| investment | object |
| max_hoa_fee | number |
| listing_type* | string |
| max_distance | object | Straight-line distance from a place the user names (e.g. work). Not driving time. |
| min_bedrooms | integer |
| min_lot_area | integer |
| nice_to_have | array | Soft features that improve ranking. |
| min_bathrooms | number |
| min_year_built | integer |
| property_types | array |
| ideal_max_price | number | Soft target: listings above it rank lower but stay in. |
| min_living_area | integer |
| strict_unknowns | boolean | Exclude listings that do not state a must_have feature (default false: keep and flag). |
| allow_live_request | boolean | false = stored data only (no provider request). |
| bedrooms_exception | object | e.g. 'three bedrooms, but two is fine with an office': min_bedrooms 3 plus {min_bedrooms: 2, requires: ['home office']} |
| preferred_bedrooms | integer |
| include_non_matching | boolean | true = also return listings that fail a hard requirement, with the reason. |
| exclude_property_types | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"listing_type",
"location"
],
"properties": {
"sort": {
"enum": [
"match",
"price_low",
"price_high",
"newest"
],
"type": "string",
"default": "match"
},
"avoid": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 2
},
"maxItems": 15,
"description": "Features that exclude a listing when the listing states them, e.g. fixer-upper, pool."
},
"limit": {
"type": "integer",
"default": 10,
"maximum": 25,
"minimum": 1
},
"notes": {
"type": "string",
"maxLength": 500,
"description": "The user's own words, kept for reference; terms in it that match the feature list become soft preferences."
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 500,
"minimum": 0
},
"styles": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 2
},
"maxItems": 10,
"description": "Architectural styles, e.g. Craftsman, Victorian, mid-century modern."
},
"location": {
"type": "object",
"properties": {
"city": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"state": {
"type": "string",
"pattern": "^[A-Za-z]{2}$"
},
"center": {
"type": "object",
"required": [
"latitude",
"longitude"
],
"properties": {
"latitude": {
"type": "number",
"maximum": 90,
"minimum": -90
},
"longitude": {
"type": "number",
"maximum": 180,
"minimum": -180
}
},
"additionalProperties": false
},
"polygon": {
"type": "array",
"items": {
"type": "array",
"items": false,
"maxItems": 2,
"minItems": 2,
"prefixItems": [
{
"type": "number",
"maximum": 90,
"minimum": -90
},
{
"type": "number",
"maximum": 180,
"minimum": -180
}
]
},
"maxItems": 100,
"minItems": 3
},
"zip_codes": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d{5}$"
},
"maxItems": 10,
"minItems": 1
},
"radius_miles": {
"type": "number",
"maximum": 50,
"exclusiveMinimum": 0
},
"preferred_zip_codes": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d{5}$"
},
"maxItems": 20
}
},
"additionalProperties": false
},
"max_price": {
"type": "number",
"maximum": 1000000000,
"description": "Hard ceiling: listings above it are excluded.",
"exclusiveMinimum": 0
},
"min_price": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"must_have": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 2
},
"maxItems": 15,
"description": "Mandatory features, e.g. garage, fireplace. Unmentioned = unverified, not excluded (unless strict_unknowns)."
},
"investment": {
"type": "object",
"properties": {
"max_price_per_sqft": {
"type": "number",
"maximum": 100000,
"exclusiveMinimum": 0
},
"min_gross_yield_pct": {
"type": "number",
"maximum": 100,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"max_hoa_fee": {
"type": "number",
"maximum": 100000,
"minimum": 0
},
"listing_type": {
"enum": [
"sale",
"rental"
],
"type": "string"
},
"max_distance": {
"type": "object",
"required": [
"place",
"miles"
],
"properties": {
"label": {
"type": "string",
"maxLength": 60
},
"miles": {
"type": "number",
"maximum": 100,
"exclusiveMinimum": 0
},
"place": {
"type": "object",
"required": [
"latitude",
"longitude"
],
"properties": {
"latitude": {
"type": "number",
"maximum": 90,
"minimum": -90
},
"longitude": {
"type": "number",
"maximum": 180,
"minimum": -180
}
},
"additionalProperties": false
}
},
"description": "Straight-line distance from a place the user names (e.g. work). Not driving time.",
"additionalProperties": false
},
"min_bedrooms": {
"type": "integer",
"maximum": 20,
"minimum": 0
},
"min_lot_area": {
"type": "integer",
"maximum": 100000000,
"exclusiveMinimum": 0
},
"nice_to_have": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 2
},
"maxItems": 25,
"description": "Soft features that improve ranking."
},
"min_bathrooms": {
"type": "number",
"maximum": 20,
"minimum": 0
},
"min_year_built": {
"type": "integer",
"maximum": 2100,
"minimum": 1600
},
"property_types": {
"type": "array",
"items": {
"enum": [
"single_family",
"condo",
"townhouse",
"multi_family",
"apartment",
"manufactured",
"land"
],
"type": "string"
},
"maxItems": 7
},
"ideal_max_price": {
"type": "number",
"maximum": 1000000000,
"description": "Soft target: listings above it rank lower but stay in.",
"exclusiveMinimum": 0
},
"min_living_area": {
"type": "integer",
"maximum": 100000,
"exclusiveMinimum": 0
},
"strict_unknowns": {
"type": "boolean",
"description": "Exclude listings that do not state a must_have feature (default false: keep and flag)."
},
"allow_live_request": {
"type": "boolean",
"default": true,
"description": "false = stored data only (no provider request)."
},
"bedrooms_exception": {
"type": "object",
"required": [
"min_bedrooms",
"requires"
],
"properties": {
"requires": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 2
},
"maxItems": 5,
"minItems": 1
},
"min_bedrooms": {
"type": "integer",
"maximum": 20,
"minimum": 0
}
},
"description": "e.g. 'three bedrooms, but two is fine with an office': min_bedrooms 3 plus {min_bedrooms: 2, requires: ['home office']}",
"additionalProperties": false
},
"preferred_bedrooms": {
"type": "integer",
"maximum": 20,
"minimum": 0
},
"include_non_matching": {
"type": "boolean",
"default": false,
"description": "true = also return listings that fail a hard requirement, with the reason."
},
"exclude_property_types": {
"type": "array",
"items": {
"enum": [
"single_family",
"condo",
"townhouse",
"multi_family",
"apartment",
"manufactured",
"land"
],
"type": "string"
},
"maxItems": 7
}
},
"additionalProperties": false
}