Houski Property Data is an MCP server published by io.github.Houski, hosted at www.houski.ca. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 12 tools, including aggregate_endpoint, auth_endpoint, avm_endpoint, field_detail, field_list.
Property data for 220M+ homes in North America, Europe and South Korea: search, stats and values.
Nothing else in the archive shares these values.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
Get statistical aggregations for market analysis. Billed per aggregation returned. Aggregations: count, sum, mean, median, mode, min, max, quantile-10, quantile-25, quantile-40, quantile-60, quantile-75, quantile-80, quantile-85, quantile-90, quantile-95, quantile-99. Text and boolean fields only support count and mode, and only fields field_detail marks aggregatable are accepted. count counts the properties that hold a value for the field, so a count per country measures how well a field is covered there. Ask for several statistics in one call with the aggregations array instead of one call each. Every statistic must name exactly one country, with country_abbreviation, or something narrower inside one country, on the call or on its own entry, and different entries may name different countries. A bounding box or a polygon alone is not enough, and a call with a statistic that names no place, or more than one country, is refused with a 400.
| Parameter | Type | Description |
|---|---|---|
| city | ["string","null"] | City name. Requires country_abbreviation and province_abbreviation, and the request is refused with a 400 error if either is missing. |
| field | ["string","null"] | Field to aggregate for a single statistic. Use field_list to discover available fields. Leave this out when using aggregations. |
None yet. Changes appear after a server's second daily check.
| api_key * | string | API key for authentication |
| exclude | ["string","null"] | Source classes to leave out of the aggregation, comma separated: "inferred" leaves out every value Houski worked out, and "inferred,observed" keeps only values from a linked public record. Applies to a field with a source column, and the answer's values_used counts the values each statistic used. In… |
| filters | ["array","null"] | Filters array. Format: "field_operator=value", with the value as plain text and not URL encoded. Use search_api_documentation for reference. |
| polygon | ["string","null"] | Polygon coordinates "lat_lng,lat_lng,lat_lng", latitude and longitude joined by an underscore. Maximum 100 points, simplify a shape that has more. |
| community | ["string","null"] | Community/neighborhood name. Requires country_abbreviation, province_abbreviation and city. |
| aggregation | ["string","null"] | Aggregation type for the single-statistic form: count, sum, mean, median, mode, min, max, quantile-10, quantile-25, quantile-40, quantile-60, quantile-75, quantile-80, quantile-85, quantile-90, quantile-95 or quantile-99. Those quantiles are the only ones that exist. |
| bbox_ne_lat | ["number","null"] | Bounding box northeast latitude. All four bbox values are required together. |
| bbox_ne_lng | ["number","null"] | Bounding box northeast longitude. All four bbox values are required together. |
| bbox_sw_lat | ["number","null"] | Bounding box southwest latitude. All four bbox values are required together. |
| bbox_sw_lng | ["number","null"] | Bounding box southwest longitude. All four bbox values are required together. |
| price_quote | ["boolean","null"] | Return the cost of this request without billing it or returning data |
| aggregations | ["array","null"] | Several statistics in one request, instead of one call each. Each entry gets its own field and aggregation, and inherits this call's location and filters unless it sets its own. Do not also set field. |
| country_abbreviation | ["string","null"] | Country abbreviation as location_endpoint returns it (for example "CA"). Any letter case is accepted. Every statistic needs a place, so pass it here or on each entry of aggregations. |
| province_abbreviation | ["string","null"] | Province, state or region abbreviation as location_endpoint returns it (for example "AB"). Requires country_abbreviation. |
{
"name": "aggregate_endpoint",
"description": "Get statistical aggregations for market analysis. Billed per aggregation returned. Aggregations: count, sum, mean, median, mode, min, max, quantile-10, quantile-25, quantile-40, quantile-60, quantile-75, quantile-80, quantile-85, quantile-90, quantile-95, quantile-99. Text and boolean fields only support count and mode, and only fields field_detail marks aggregatable are accepted. count counts the properties that hold a value for the field, so a count per country measures how well a field is covered there. Ask for several statistics in one call with the aggregations array instead of one call each. Every statistic must name exactly one country, with country_abbreviation, or something narrower inside one country, on the call or on its own entry, and different entries may name different countries. A bounding box or a polygon alone is not enough, and a call with a statistic that names no place, or more than one country, is refused with a 400.",
"inputSchema": {
"type": "object",
"$defs": {
"AggregateRequest": {
"type": "object",
"required": [
"field",
"aggregation"
],
"properties": {
"city": {
"type": [
"string",
"null"
],
"description": "City for this statistic only, which is how you compare two cities in one request. Defaults to the call's city."
},
"field": {
"type": "string",
"description": "Field to aggregate. Use field_list to discover available fields."
},
"exclude": {
"type": [
"string",
"null"
],
"description": "Source classes to leave out of this statistic only, such as \"inferred\". Defaults to the call's exclude."
},
"filters": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Extra filters for this statistic only. These are applied on top of the call's filters."
},
"community": {
"type": [
"string",
"null"
],
"description": "Community for this statistic only. Defaults to the call's community."
},
"aggregation": {
"type": "string",
"description": "Aggregation type: count, sum, mean, median, mode, min, max, or quantile-10 through quantile-99 from the fixed list. Text and boolean fields only support count and mode."
},
"country_abbreviation": {
"type": [
"string",
"null"
],
"description": "Country abbreviation for this statistic only. Defaults to the call's country_abbreviation."
},
"province_abbreviation": {
"type": [
"string",
"null"
],
"description": "Province/state abbreviation for this statistic only. Defaults to the call's province_abbreviation."
}
},
"description": "One statistic inside an aggregate_endpoint batch."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"api_key"
],
"properties": {
"city": {
"type": [
"string",
"null"
],
"description": "City name. Requires country_abbreviation and province_abbreviation, and the request is refused with a 400 error if either is missing."
},
"field": {
"type": [
"string",
"null"
],
"description": "Field to aggregate for a single statistic. Use field_list to discover available fields. Leave this out when using aggregations."
},
"api_key": {
"type": "string",
"description": "API key for authentication"
},
"exclude": {
"type": [
"string",
"null"
],
"description": "Source classes to leave out of the aggregation, comma separated: \"inferred\" leaves out every value Houski worked out, and \"inferred,observed\" keeps only values from a linked public record. Applies to a field with a source column, and the answer's values_used counts the values each statistic used. In the aggregations form every entry inherits it unless it sets its own."
},
"filters": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Filters array. Format: \"field_operator=value\", with the value as plain text and not URL encoded. Use search_api_documentation for reference."
},
"polygon": {
"type": [
"string",
"null"
],
"description": "Polygon coordinates \"lat_lng,lat_lng,lat_lng\", latitude and longitude joined by an underscore. Maximum 100 points, simplify a shape that has more."
},
"community": {
"type": [
"string",
"null"
],
"description": "Community/neighborhood name. Requires country_abbreviation, province_abbreviation and city."
},
"aggregation": {
"type": [
"string",
"null"
],
"description": "Aggregation type for the single-statistic form: count, sum, mean, median, mode, min, max, quantile-10, quantile-25, quantile-40, quantile-60, quantile-75, quantile-80, quantile-85, quantile-90, quantile-95 or quantile-99. Those quantiles are the only ones that exist."
},
"bbox_ne_lat": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Bounding box northeast latitude. All four bbox values are required together."
},
"bbox_ne_lng": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Bounding box northeast longitude. All four bbox values are required together."
},
"bbox_sw_lat": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Bounding box southwest latitude. All four bbox values are required together."
},
"bbox_sw_lng": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Bounding box southwest longitude. All four bbox values are required together."
},
"price_quote": {
"type": [
"boolean",
"null"
],
"description": "Return the cost of this request without billing it or returning data"
},
"aggregations": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AggregateRequest"
},
"description": "Several statistics in one request, instead of one call each. Each entry gets its own field and aggregation, and inherits this call's location and filters unless it sets its own. Do not also set field."
},
"country_abbreviation": {
"type": [
"string",
"null"
],
"description": "Country abbreviation as location_endpoint returns it (for example \"CA\"). Any letter case is accepted. Every statistic needs a place, so pass it here or on each entry of aggregations."
},
"province_abbreviation": {
"type": [
"string",
"null"
],
"description": "Province, state or region abbreviation as location_endpoint returns it (for example \"AB\"). Requires country_abbreviation."
}
}
}
}Check that an API key exists and is enabled. Does not bill per call. Returns api_key_authorized boolean. It does not check the key's maximum monthly spend or the unlimited plan's daily allowance, so another tool can still refuse a key that passes here.
| Parameter | Type | Description |
|---|---|---|
| api_key * | string | API key to validate |
{
"name": "auth_endpoint",
"description": "Check that an API key exists and is enabled. Does not bill per call. Returns api_key_authorized boolean. It does not check the key's maximum monthly spend or the unlimited plan's daily allowance, so another tool can still refuse a key that passes here.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"api_key"
],
"properties": {
"api_key": {
"type": "string",
"description": "API key to validate"
}
}
}
}No description.
| Parameter | Type | Description |
|---|---|---|
| api_key * | string | API key for authentication |
| overrides | any | What-if changes to the property before valuing it, for scenario testing (a finished basement, an extra bathroom). Anything left out keeps the property's real value. |
| price_quote | ["boolean","null"] | Return the cost of this request without billing it or returning data |
| property_id * | string | Property ID, one per call. Every call is billed at the price in this tool's description. |
{
"name": "avm_endpoint",
"inputSchema": {
"type": "object",
"$defs": {
"ScenarioOverrides": {
"type": "object",
"properties": {
"den": {
"type": [
"integer",
"null"
],
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"description": "Den count"
},
"bedroom": {
"type": [
"integer",
"null"
],
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"description": "Bedroom count"
},
"bathroom_full": {
"type": [
"integer",
"null"
],
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"description": "Full bathroom count"
},
"bathroom_half": {
"type": [
"integer",
"null"
],
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"description": "Half bathroom count"
},
"interior_sq_m": {
"type": [
"number",
"null"
],
"format": "float",
"description": "Interior size in square metres"
},
"property_type": {
"type": [
"string",
"null"
],
"description": "Property type. Use field_detail on property_type for accepted values."
},
"maintenance_fee": {
"type": [
"number",
"null"
],
"format": "float",
"description": "Monthly maintenance or condo fee"
},
"construction_year": {
"type": [
"integer",
"null"
],
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"description": "Year the property was built"
},
"garage_type_first": {
"type": [
"string",
"null"
],
"description": "Garage type. Use field_detail on garage_type_first for accepted values."
}
},
"description": "What-if property changes accepted by both /avm and /predict."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"api_key",
"property_id"
],
"properties": {
"api_key": {
"type": "string",
"description": "API key for authentication"
},
"overrides": {
"anyOf": [
{
"$ref": "#/$defs/ScenarioOverrides"
},
{
"type": "null"
}
],
"description": "What-if changes to the property before valuing it, for scenario testing (a finished basement, an extra bathroom). Anything left out keeps the property's real value."
},
"price_quote": {
"type": [
"boolean",
"null"
],
"description": "Return the cost of this request without billing it or returning data"
},
"property_id": {
"type": "string",
"description": "Property ID, one per call. Every call is billed at the price in this tool's description."
}
}
}
}Describe fields by name: type, accepted filter values, its source column if it has one, filtered, aggregated or predicted, which expand set it belongs to, its price per home returned, and its full description. Does not bill per call. Coverage differs by country, and the server instructions say how to check it cheaply with location_endpoint.
| Parameter | Type | Description |
|---|---|---|
| fields * | string | Comma-separated list of field names to get details for |
{
"name": "field_detail",
"description": "Describe fields by name: type, accepted filter values, its source column if it has one, filtered, aggregated or predicted, which expand set it belongs to, its price per home returned, and its full description. Does not bill per call. Coverage differs by country, and the server instructions say how to check it cheaply with location_endpoint.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"fields"
],
"properties": {
"fields": {
"type": "string",
"description": "Comma-separated list of field names to get details for"
}
}
}
}List the name of every public property data field, one per line. Does not bill per call. Pass filter to list only the names that contain a piece of text, for example score_, demographic_, assessment, permit or expand_listing. Follow with field_detail for each field's type, accepted filter values, aggregation support, expand set and price per value returned.
| Parameter | Type | Description |
|---|---|---|
| filter | ["string","null"] | Optional text to match inside field names, for example "score_", "demographic_", "assessment", "permit" or "expand_listing". Leave it out to list every field. |
{
"name": "field_list",
"description": "List the name of every public property data field, one per line. Does not bill per call. Pass filter to list only the names that contain a piece of text, for example score_, demographic_, assessment, permit or expand_listing. Follow with field_detail for each field's type, accepted filter values, aggregation support, expand set and price per value returned.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"filter": {
"type": [
"string",
"null"
],
"description": "Optional text to match inside field names, for example \"score_\", \"demographic_\", \"assessment\", \"permit\" or \"expand_listing\". Leave it out to list every field."
}
}
}
}Find properties near coordinates (reverse geocoding). Billed per field, per home returned. Required: latitude, longitude. Optional: radius (km), shape (circle/square). This endpoint has no country, province, city, community or address parameters. To narrow by place, put filters such as country_abbreviation_eq=CA or city_eq=Calgary in filters, spelled exactly as location_endpoint returns them, letter case included. With no such filter the point and radius may cover no more homes than one country holds, and a filter that names more than one country is refused with a 400. For active or marketable properties, add has_expand_listings_eq=true to filters, which is far cheaper than expanding listings just to filter on their presence.
| Parameter | Type | Description |
|---|---|---|
| page | ["integer","null"] | Page number for pagination |
| shape | ["string","null"] | Search shape: "circle" (default) or "square" |
| expand | ["string","null"] | Comma-separated. Values: "listings", "listings_rent", "permits", "assessments". Each attached record is a flat charge. To filter to properties that HAVE a set, use the has_expand_* boolean filters instead. |
| radius | ["number","null"] | Search radius in kilometers |
| select | ["string","null"] | Comma-separated fields to return, or "all" |
| api_key * | string | API key for authentication |
| exclude | ["string","null"] | Source classes to leave out, comma separated, such as "inferred" or "inferred,observed". Checks the selected fields that have a source column, keeps a property when one of them keeps its value, and empties the rest. |
| filters | ["array","null"] | Filters array. Format: "field_operator=value", with the value as plain text and not URL encoded. Use search_api_documentation for reference. |
| latitude * | number | Center latitude (e.g., 51.0447) |
| longitude * | number | Center longitude (e.g., -114.0719) |
| price_quote | ["boolean","null"] | Return the cost of this request without billing it or returning data |
| results_per_page | ["integer","null"] | Results per page |
| filter_expand_match | ["string","null"] | "any" or "all". Use only when filtering on values inside expanded records. |
{
"name": "geocoding_endpoint",
"description": "Find properties near coordinates (reverse geocoding). Billed per field, per home returned. Required: latitude, longitude. Optional: radius (km), shape (circle/square). This endpoint has no country, province, city, community or address parameters. To narrow by place, put filters such as country_abbreviation_eq=CA or city_eq=Calgary in filters, spelled exactly as location_endpoint returns them, letter case included. With no such filter the point and radius may cover no more homes than one country holds, and a filter that names more than one country is refused with a 400. For active or marketable properties, add has_expand_listings_eq=true to filters, which is far cheaper than expanding listings just to filter on their presence.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"api_key",
"latitude",
"longitude"
],
"properties": {
"page": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Page number for pagination"
},
"shape": {
"type": [
"string",
"null"
],
"description": "Search shape: \"circle\" (default) or \"square\""
},
"expand": {
"type": [
"string",
"null"
],
"description": "Comma-separated. Values: \"listings\", \"listings_rent\", \"permits\", \"assessments\". Each attached record is a flat charge. To filter to properties that HAVE a set, use the has_expand_* boolean filters instead."
},
"radius": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Search radius in kilometers"
},
"select": {
"type": [
"string",
"null"
],
"description": "Comma-separated fields to return, or \"all\""
},
"api_key": {
"type": "string",
"description": "API key for authentication"
},
"exclude": {
"type": [
"string",
"null"
],
"description": "Source classes to leave out, comma separated, such as \"inferred\" or \"inferred,observed\". Checks the selected fields that have a source column, keeps a property when one of them keeps its value, and empties the rest."
},
"filters": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Filters array. Format: \"field_operator=value\", with the value as plain text and not URL encoded. Use search_api_documentation for reference."
},
"latitude": {
"type": "number",
"format": "double",
"description": "Center latitude (e.g., 51.0447)"
},
"longitude": {
"type": "number",
"format": "double",
"description": "Center longitude (e.g., -114.0719)"
},
"price_quote": {
"type": [
"boolean",
"null"
],
"description": "Return the cost of this request without billing it or returning data"
},
"results_per_page": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Results per page"
},
"filter_expand_match": {
"type": [
"string",
"null"
],
"description": "\"any\" or \"all\". Use only when filtering on values inside expanded records."
}
}
}
}Get the places Houski holds property data for, as a hierarchy of countries, provinces (or states or regions), cities and communities, with links and slugs. Billed per location returned, a small fraction of a cent each. This is the source of every country_abbreviation, province_abbreviation, city and community the other tools take. There is no paging and every matching location comes back, so scope every call: resolution=country and resolution=province are small, while resolution=city or community with no country_abbreviation and province_abbreviation returns every city of every country in one very large response. Naming a level requires naming its parents, and the endpoint returns a 400 saying so if you skip one. filters keeps only the places where at least one property matches, which is the cheapest way to check coverage. A call with filters must name exactly one country, with country_abbreviation, or something narrower inside one country, or it is refused with a 400: country_abbreviation=ca with resolution=country and filters=["parcel_number_regex=."] returns Canada only when it holds parcel numbers. Several countries take one call each. A call with no filters needs no place.
| Parameter | Type | Description |
|---|---|---|
| city | ["string","null"] | City name. Requires country_abbreviation and province_abbreviation, and the endpoint returns a 400 if either is missing. |
| flat | ["boolean","null"] | Return flat format instead of nested (default: false). Flat is roughly four times larger, because each row repeats the whole country and province block instead of nesting under it, and carries a null key for every level below the resolution. Prefer nested unless you specifically want one row per loc… |
| api_key * | string | API key for authentication |
| filters | ["array","null"] | Filters that keep only the locations holding at least one matching property, in the "field_operator=value" form. "<field>_regex=." keeps the places where some property has a value for that field, which is how to check a field's coverage by country or region. A call with filters must also name exactl… |
| community | ["string","null"] | Community/neighborhood name. Requires country_abbreviation, province_abbreviation and city, and the endpoint returns a 400 if any is missing. |
| resolution | ["string","null"] | Depth: "country", "province", "city", or "community" (default). This is the main size lever. With no country_abbreviation and province_abbreviation, stay on "country" or "province". |
| price_quote | ["boolean","null"] | Return the cost of this request without billing it or returning data |
| country_abbreviation | ["string","null"] | Country abbreviation (for example "CA"). Pass it with province_abbreviation on anything finer than resolution=province, or the response covers the whole country. |
| province_abbreviation | ["string","null"] | Province, state or region abbreviation (for example "AB"). Requires country_abbreviation. The two together keep a resolution=city call to one province instead of every city of the country. |
{
"name": "location_endpoint",
"description": "Get the places Houski holds property data for, as a hierarchy of countries, provinces (or states or regions), cities and communities, with links and slugs. Billed per location returned, a small fraction of a cent each. This is the source of every country_abbreviation, province_abbreviation, city and community the other tools take. There is no paging and every matching location comes back, so scope every call: resolution=country and resolution=province are small, while resolution=city or community with no country_abbreviation and province_abbreviation returns every city of every country in one very large response. Naming a level requires naming its parents, and the endpoint returns a 400 saying so if you skip one. filters keeps only the places where at least one property matches, which is the cheapest way to check coverage. A call with filters must name exactly one country, with country_abbreviation, or something narrower inside one country, or it is refused with a 400: country_abbreviation=ca with resolution=country and filters=[\"parcel_number_regex=.\"] returns Canada only when it holds parcel numbers. Several countries take one call each. A call with no filters needs no place.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"api_key"
],
"properties": {
"city": {
"type": [
"string",
"null"
],
"description": "City name. Requires country_abbreviation and province_abbreviation, and the endpoint returns a 400 if either is missing."
},
"flat": {
"type": [
"boolean",
"null"
],
"description": "Return flat format instead of nested (default: false). Flat is roughly four times larger, because each row repeats the whole country and province block instead of nesting under it, and carries a null key for every level below the resolution. Prefer nested unless you specifically want one row per location."
},
"api_key": {
"type": "string",
"description": "API key for authentication"
},
"filters": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Filters that keep only the locations holding at least one matching property, in the \"field_operator=value\" form. \"<field>_regex=.\" keeps the places where some property has a value for that field, which is how to check a field's coverage by country or region. A call with filters must also name exactly one country, with country_abbreviation, or something narrower inside one country, so several countries take one call each."
},
"community": {
"type": [
"string",
"null"
],
"description": "Community/neighborhood name. Requires country_abbreviation, province_abbreviation and city, and the endpoint returns a 400 if any is missing."
},
"resolution": {
"type": [
"string",
"null"
],
"description": "Depth: \"country\", \"province\", \"city\", or \"community\" (default). This is the main size lever. With no country_abbreviation and province_abbreviation, stay on \"country\" or \"province\"."
},
"price_quote": {
"type": [
"boolean",
"null"
],
"description": "Return the cost of this request without billing it or returning data"
},
"country_abbreviation": {
"type": [
"string",
"null"
],
"description": "Country abbreviation (for example \"CA\"). Pass it with province_abbreviation on anything finer than resolution=province, or the response covers the whole country."
},
"province_abbreviation": {
"type": [
"string",
"null"
],
"description": "Province, state or region abbreviation (for example \"AB\"). Requires country_abbreviation. The two together keep a resolution=city call to one province instead of every city of the country."
}
}
}
}Get map data: pins, clusters, or heatmaps. Billed per cluster or heatmap cell returned, or per field, per home returned for pins. Scope it with all four bbox coordinates or a polygon. With no place filter, the box or polygon may cover no more homes than one country holds. A call with neither must carry a filter on one country, such as country_abbreviation_eq=CA, or on a narrower place inside one country. A call that names no place, covers more than one country's homes, or filters on more than one country is refused with a 400, so several countries take one call each. A heatmap needs all four bbox coordinates, and a heatmap scoped by a polygon alone is refused. Modes: cluster=true, heatmap=true. There is no cap on how many properties a request may match, so set abort_over yourself if you want a request to give up past a certain number. For maps of active inventory, add has_expand_listings_eq=true to filters so listing-less parcels don't pad results.
| Parameter | Type | Description |
|---|---|---|
| page | ["integer","null"] | Page number for pagination, pins only (default: 1) |
| select | ["string","null"] | Comma-separated fields to return |
| api_key * | string | API key for authentication |
| cluster | ["boolean","null"] | Force clustering (default: false) |
| exclude | ["string","null"] | Source classes to leave out, comma separated, such as "inferred" or "inferred,observed". Checks the selected fields that have a source column and the heatmap field, and a heatmap of a field uses only the kept values (heatmap_values_used counts them). |
| filters | ["array","null"] | Filters array. Format: "field_operator=value", with the value as plain text and not URL encoded. Use search_api_documentation for reference. |
| heatmap | ["boolean","null"] | Enable heatmap mode (default: false) |
| polygon | ["string","null"] | Polygon coordinates "lat_lng,lat_lng,lat_lng", an alternative to bbox for pins and clusters. A heatmap needs all four bbox values and is refused with a polygon alone. |
| abort_over | ["integer","null"] | Abort if results exceed this count (cost protection) |
| bbox_ne_lat | ["number","null"] | Bounding box northeast latitude |
| bbox_ne_lng | ["number","null"] | Bounding box northeast longitude |
| bbox_sw_lat | ["number","null"] | Bounding box southwest latitude |
| bbox_sw_lng | ["number","null"] | Bounding box southwest longitude |
| price_quote | ["boolean","null"] | Return the cost of this request without billing it or returning data |
| cluster_over | ["integer","null"] | Auto-cluster when results exceed this count |
| results_per_page | ["integer","null"] | Results per page (for pins only) |
| heatmap_cell_limit | ["integer","null"] | Max heatmap cells (default: 1000, max: 10000) |
| heatmap_aggregation_type | ["string","null"] | Heatmap aggregation: "mean", "median", or "sum" |
| heatmap_aggregation_field | ["string","null"] | Field for heatmap intensity (e.g., "estimate_list_price"). Without this, uses density. |
| heatmap_aggregation_invert_intensity | ["boolean","null"] | Invert intensity (true = lower values show higher intensity, good for affordability) |
{
"name": "map_endpoint",
"description": "Get map data: pins, clusters, or heatmaps. Billed per cluster or heatmap cell returned, or per field, per home returned for pins. Scope it with all four bbox coordinates or a polygon. With no place filter, the box or polygon may cover no more homes than one country holds. A call with neither must carry a filter on one country, such as country_abbreviation_eq=CA, or on a narrower place inside one country. A call that names no place, covers more than one country's homes, or filters on more than one country is refused with a 400, so several countries take one call each. A heatmap needs all four bbox coordinates, and a heatmap scoped by a polygon alone is refused. Modes: cluster=true, heatmap=true. There is no cap on how many properties a request may match, so set abort_over yourself if you want a request to give up past a certain number. For maps of active inventory, add has_expand_listings_eq=true to filters so listing-less parcels don't pad results.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"api_key"
],
"properties": {
"page": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Page number for pagination, pins only (default: 1)"
},
"select": {
"type": [
"string",
"null"
],
"description": "Comma-separated fields to return"
},
"api_key": {
"type": "string",
"description": "API key for authentication"
},
"cluster": {
"type": [
"boolean",
"null"
],
"description": "Force clustering (default: false)"
},
"exclude": {
"type": [
"string",
"null"
],
"description": "Source classes to leave out, comma separated, such as \"inferred\" or \"inferred,observed\". Checks the selected fields that have a source column and the heatmap field, and a heatmap of a field uses only the kept values (heatmap_values_used counts them)."
},
"filters": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Filters array. Format: \"field_operator=value\", with the value as plain text and not URL encoded. Use search_api_documentation for reference."
},
"heatmap": {
"type": [
"boolean",
"null"
],
"description": "Enable heatmap mode (default: false)"
},
"polygon": {
"type": [
"string",
"null"
],
"description": "Polygon coordinates \"lat_lng,lat_lng,lat_lng\", an alternative to bbox for pins and clusters. A heatmap needs all four bbox values and is refused with a polygon alone."
},
"abort_over": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Abort if results exceed this count (cost protection)"
},
"bbox_ne_lat": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Bounding box northeast latitude"
},
"bbox_ne_lng": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Bounding box northeast longitude"
},
"bbox_sw_lat": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Bounding box southwest latitude"
},
"bbox_sw_lng": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Bounding box southwest longitude"
},
"price_quote": {
"type": [
"boolean",
"null"
],
"description": "Return the cost of this request without billing it or returning data"
},
"cluster_over": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Auto-cluster when results exceed this count"
},
"results_per_page": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Results per page (for pins only)"
},
"heatmap_cell_limit": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Max heatmap cells (default: 1000, max: 10000)"
},
"heatmap_aggregation_type": {
"type": [
"string",
"null"
],
"description": "Heatmap aggregation: \"mean\", \"median\", or \"sum\""
},
"heatmap_aggregation_field": {
"type": [
"string",
"null"
],
"description": "Field for heatmap intensity (e.g., \"estimate_list_price\"). Without this, uses density."
},
"heatmap_aggregation_invert_intensity": {
"type": [
"boolean",
"null"
],
"description": "Invert intensity (true = lower values show higher intensity, good for affordability)"
}
}
}
}Predict property values over time. Billed per predicted field, once for each date and each property. Required: property_id, start_date, fields. Find the property_id first with search_endpoint or properties_endpoint. Supports batch requests and parameter overrides for scenario testing.
| Parameter | Type | Description |
|---|---|---|
| last | ["integer","null"] | Periods before start_date to include. A range reaching before 2021-01-01 is refused |
| next | ["integer","null"] | Periods after start_date to include. A range reaching past today is refused, because the models do not forecast |
| fields * | string | Fields to predict: "estimate_sale_price", "estimate_list_price", "estimate_rent_monthly" |
| period | ["string","null"] | Time granularity: "day", "week", "month" (default), "year" |
| api_key * | string | API key for authentication |
| overrides | any | What-if changes to the property before predicting, for scenario testing. Anything left out keeps the property's real value. |
| start_date * | string | Reference date in YYYY-MM-DD format, from 2021-01-01 to today |
| price_quote | ["boolean","null"] | Return the cost of this request without billing it or returning data |
| property_id * | string | Property ID(s), comma-separated for batch requests |
{
"name": "predict_endpoint",
"description": "Predict property values over time. Billed per predicted field, once for each date and each property. Required: property_id, start_date, fields. Find the property_id first with search_endpoint or properties_endpoint. Supports batch requests and parameter overrides for scenario testing.",
"inputSchema": {
"type": "object",
"$defs": {
"ScenarioOverrides": {
"type": "object",
"properties": {
"den": {
"type": [
"integer",
"null"
],
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"description": "Den count"
},
"bedroom": {
"type": [
"integer",
"null"
],
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"description": "Bedroom count"
},
"bathroom_full": {
"type": [
"integer",
"null"
],
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"description": "Full bathroom count"
},
"bathroom_half": {
"type": [
"integer",
"null"
],
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"description": "Half bathroom count"
},
"interior_sq_m": {
"type": [
"number",
"null"
],
"format": "float",
"description": "Interior size in square metres"
},
"property_type": {
"type": [
"string",
"null"
],
"description": "Property type. Use field_detail on property_type for accepted values."
},
"maintenance_fee": {
"type": [
"number",
"null"
],
"format": "float",
"description": "Monthly maintenance or condo fee"
},
"construction_year": {
"type": [
"integer",
"null"
],
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"description": "Year the property was built"
},
"garage_type_first": {
"type": [
"string",
"null"
],
"description": "Garage type. Use field_detail on garage_type_first for accepted values."
}
},
"description": "What-if property changes accepted by both /avm and /predict."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"api_key",
"property_id",
"fields",
"start_date"
],
"properties": {
"last": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Periods before start_date to include. A range reaching before 2021-01-01 is refused"
},
"next": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Periods after start_date to include. A range reaching past today is refused, because the models do not forecast"
},
"fields": {
"type": "string",
"description": "Fields to predict: \"estimate_sale_price\", \"estimate_list_price\", \"estimate_rent_monthly\""
},
"period": {
"type": [
"string",
"null"
],
"description": "Time granularity: \"day\", \"week\", \"month\" (default), \"year\""
},
"api_key": {
"type": "string",
"description": "API key for authentication"
},
"overrides": {
"anyOf": [
{
"$ref": "#/$defs/ScenarioOverrides"
},
{
"type": "null"
}
],
"description": "What-if changes to the property before predicting, for scenario testing. Anything left out keeps the property's real value."
},
"start_date": {
"type": "string",
"description": "Reference date in YYYY-MM-DD format, from 2021-01-01 to today"
},
"price_quote": {
"type": [
"boolean",
"null"
],
"description": "Return the cost of this request without billing it or returning data"
},
"property_id": {
"type": "string",
"description": "Property ID(s), comma-separated for batch requests"
}
}
}
}Retrieve property data (hundreds of fields) with filtering, sorting, and expansion. Billed per field, per home returned: each selected field's price for each home that has a value for it, so a field with no value for a home is not billed. Always set select= to limit fields. For comparables, 'good' properties, or active inventory, add has_expand_listings_eq=true to filters: a fast indexed boolean filter that excludes the long tail of listing-less parcels (use has_expand_listings_rent_eq=true for rentals). Use expand=listings,permits,assessments only when you actually need the related records, not just to filter on their existence (has_expand_permits_eq=true and has_expand_assessments_eq=true cover that). Take place names and abbreviations from location_endpoint. Every call must name exactly one country, with country_abbreviation, or something narrower inside one country, such as a province, a city, or a property_id_eq or property_id_in filter. A bounding box or a polygon alone is not enough, and a call that names no place, or more than one country, is refused with a 400. Several countries take one call each. When select names a field with a source column, pass exclude=inferred unless the user wants inferred values too or the call looks up one named property. Set price_quote=true first when the row count is unknown. See search_api_documentation for full filter syntax.
| Parameter | Type | Description |
|---|---|---|
| city | ["string","null"] | City name as location_endpoint returns it (for example "Calgary"). Letter case, accents and punctuation do not matter. Requires country_abbreviation and province_abbreviation, and the request is refused with a 400 error if either is missing. |
| page | ["integer","null"] | Page number for pagination (default: 1) |
| expand | ["string","null"] | Comma-separated. Values: "listings", "listings_rent", "permits", "assessments". Each attached record is a flat charge, so only include when you need the related records themselves. To filter to properties that HAVE a set, prefer the indexed boolean filters passed via `filters` (has_expand_listings_e… |
| select | ["string","null"] | Comma-separated fields to return, or "all". Use field_list to discover fields. |
| address | ["string","null"] | Address for a single property lookup. Letter case and punctuation do not matter, but abbreviations are not rewritten, so write road types in full as the address field does ("Place", not "Pl"). Requires country_abbreviation, province_abbreviation and city. For fuzzy, abbreviated or partial addresses … |
| api_key * | string | API key for authentication |
| exclude | ["string","null"] | Source classes to leave out, comma separated: "inferred" leaves out every value Houski worked out, and "inferred,observed" keeps only values from a linked public record. Checks the selected fields that have a source column (field_detail names it), keeps a property when one of them keeps its value, a… |
| filters | ["array","null"] | Filters array. Format: "field_operator=value", with the value as plain text and not URL encoded. Operators: _eq, _neq, _gte, _lte, _gt, _lt, _in, _regex, _nregex (rows that do not match the regex). Text values compare exactly, letter case included (property_type_eq=House). To narrow to a place, use … |
| polygon | ["string","null"] | Polygon coordinates "lat_lng,lat_lng,lat_lng", latitude and longitude joined by an underscore. Maximum 100 points, simplify a shape that has more. |
| sort_by | ["string","null"] | Sort field. Format: "field_sort=asc" or "field_sort=desc" |
| community | ["string","null"] | Community/neighborhood name. Letter case, accents and punctuation do not matter. Requires country_abbreviation, province_abbreviation and city, and the request is refused with a 400 error if any is missing. |
| bbox_ne_lat | ["number","null"] | Bounding box northeast latitude. All four bbox values are required together. |
| bbox_ne_lng | ["number","null"] | Bounding box northeast longitude. All four bbox values are required together. |
| bbox_sw_lat | ["number","null"] | Bounding box southwest latitude. All four bbox values are required together. |
| bbox_sw_lng | ["number","null"] | Bounding box southwest longitude. All four bbox values are required together. |
| price_quote | ["boolean","null"] | Return the cost of this request without billing it or returning data |
| community_in | ["string","null"] | Several community names, comma separated. This is a plain filter on the community name, so it compares each name exactly, letter case included, and spelled as location_endpoint returns it. It needs no other location parameter, but without city it matches communities with those names in every city. |
| results_per_page | ["integer","null"] | Results per page (default: 6, max: 1000) |
| filter_expand_match | ["string","null"] | "any" or "all". Use this only when filtering on values inside expanded records (for example expand_permit_content_regex). To filter on mere presence of a set, use the has_expand_* boolean filters in `filters` instead. |
| country_abbreviation | ["string","null"] | Country abbreviation as location_endpoint returns it (for example "CA", "US", "GB" or "KR"). Any letter case is accepted. Pass it on every call that does not name a narrower place with a filter such as property_id_in, because a call that names no place is refused. A call covers one country, so sever… |
| province_abbreviation | ["string","null"] | Province, state or region abbreviation as location_endpoint returns it (for example "AB" in Canada). Any letter case is accepted. Requires country_abbreviation. |
{
"name": "properties_endpoint",
"description": "Retrieve property data (hundreds of fields) with filtering, sorting, and expansion. Billed per field, per home returned: each selected field's price for each home that has a value for it, so a field with no value for a home is not billed. Always set select= to limit fields. For comparables, 'good' properties, or active inventory, add has_expand_listings_eq=true to filters: a fast indexed boolean filter that excludes the long tail of listing-less parcels (use has_expand_listings_rent_eq=true for rentals). Use expand=listings,permits,assessments only when you actually need the related records, not just to filter on their existence (has_expand_permits_eq=true and has_expand_assessments_eq=true cover that). Take place names and abbreviations from location_endpoint. Every call must name exactly one country, with country_abbreviation, or something narrower inside one country, such as a province, a city, or a property_id_eq or property_id_in filter. A bounding box or a polygon alone is not enough, and a call that names no place, or more than one country, is refused with a 400. Several countries take one call each. When select names a field with a source column, pass exclude=inferred unless the user wants inferred values too or the call looks up one named property. Set price_quote=true first when the row count is unknown. See search_api_documentation for full filter syntax.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"api_key"
],
"properties": {
"city": {
"type": [
"string",
"null"
],
"description": "City name as location_endpoint returns it (for example \"Calgary\"). Letter case, accents and punctuation do not matter. Requires country_abbreviation and province_abbreviation, and the request is refused with a 400 error if either is missing."
},
"page": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Page number for pagination (default: 1)"
},
"expand": {
"type": [
"string",
"null"
],
"description": "Comma-separated. Values: \"listings\", \"listings_rent\", \"permits\", \"assessments\". Each attached record is a flat charge, so only include when you need the related records themselves. To filter to properties that HAVE a set, prefer the indexed boolean filters passed via `filters` (has_expand_listings_eq=true, has_expand_listings_rent_eq=true, has_expand_permits_eq=true, has_expand_assessments_eq=true) over expanding with `filter_expand_match=all`. They are far faster and cheaper."
},
"select": {
"type": [
"string",
"null"
],
"description": "Comma-separated fields to return, or \"all\". Use field_list to discover fields."
},
"address": {
"type": [
"string",
"null"
],
"description": "Address for a single property lookup. Letter case and punctuation do not matter, but abbreviations are not rewritten, so write road types in full as the address field does (\"Place\", not \"Pl\"). Requires country_abbreviation, province_abbreviation and city. For fuzzy, abbreviated or partial addresses use search_endpoint instead."
},
"api_key": {
"type": "string",
"description": "API key for authentication"
},
"exclude": {
"type": [
"string",
"null"
],
"description": "Source classes to leave out, comma separated: \"inferred\" leaves out every value Houski worked out, and \"inferred,observed\" keeps only values from a linked public record. Checks the selected fields that have a source column (field_detail names it), keeps a property when one of them keeps its value, and empties the rest. search_api_documentation page filter lists every class."
},
"filters": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Filters array. Format: \"field_operator=value\", with the value as plain text and not URL encoded. Operators: _eq, _neq, _gte, _lte, _gt, _lt, _in, _regex, _nregex (rows that do not match the regex). Text values compare exactly, letter case included (property_type_eq=House). To narrow to a place, use the country_abbreviation, province_abbreviation, city, community and address arguments, which ignore letter case, rather than filters such as city_eq. Use search_api_documentation for full reference."
},
"polygon": {
"type": [
"string",
"null"
],
"description": "Polygon coordinates \"lat_lng,lat_lng,lat_lng\", latitude and longitude joined by an underscore. Maximum 100 points, simplify a shape that has more."
},
"sort_by": {
"type": [
"string",
"null"
],
"description": "Sort field. Format: \"field_sort=asc\" or \"field_sort=desc\""
},
"community": {
"type": [
"string",
"null"
],
"description": "Community/neighborhood name. Letter case, accents and punctuation do not matter. Requires country_abbreviation, province_abbreviation and city, and the request is refused with a 400 error if any is missing."
},
"bbox_ne_lat": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Bounding box northeast latitude. All four bbox values are required together."
},
"bbox_ne_lng": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Bounding box northeast longitude. All four bbox values are required together."
},
"bbox_sw_lat": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Bounding box southwest latitude. All four bbox values are required together."
},
"bbox_sw_lng": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Bounding box southwest longitude. All four bbox values are required together."
},
"price_quote": {
"type": [
"boolean",
"null"
],
"description": "Return the cost of this request without billing it or returning data"
},
"community_in": {
"type": [
"string",
"null"
],
"description": "Several community names, comma separated. This is a plain filter on the community name, so it compares each name exactly, letter case included, and spelled as location_endpoint returns it. It needs no other location parameter, but without city it matches communities with those names in every city."
},
"results_per_page": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Results per page (default: 6, max: 1000)"
},
"filter_expand_match": {
"type": [
"string",
"null"
],
"description": "\"any\" or \"all\". Use this only when filtering on values inside expanded records (for example expand_permit_content_regex). To filter on mere presence of a set, use the has_expand_* boolean filters in `filters` instead."
},
"country_abbreviation": {
"type": [
"string",
"null"
],
"description": "Country abbreviation as location_endpoint returns it (for example \"CA\", \"US\", \"GB\" or \"KR\"). Any letter case is accepted. Pass it on every call that does not name a narrower place with a filter such as property_id_in, because a call that names no place is refused. A call covers one country, so several countries take one call each."
},
"province_abbreviation": {
"type": [
"string",
"null"
],
"description": "Province, state or region abbreviation as location_endpoint returns it (for example \"AB\" in Canada). Any letter case is accepted. Requires country_abbreviation."
}
}
}
}Access API documentation pages for filter syntax, field references, and endpoint details. Does not bill per call. Pass an unknown page to get the full list of pages back.
| Parameter | Type | Description |
|---|---|---|
| page * | string | Documentation page to read, for example "filter", "properties" or "pricing". Pass an unknown value to get the full list of pages back in the error. |
{
"name": "search_api_documentation",
"description": "Access API documentation pages for filter syntax, field references, and endpoint details. Does not bill per call. Pass an unknown page to get the full list of pages back.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"page"
],
"properties": {
"page": {
"type": "string",
"description": "Documentation page to read, for example \"filter\", \"properties\" or \"pricing\". Pass an unknown value to get the full list of pages back in the error."
}
}
}
}Find property_id using fuzzy address matching. Billed per field, per home returned. Handles typos, abbreviations, partial addresses. Pass country_abbreviation to keep every match in one country. Use returned property_id with other endpoints for detailed data.
| Parameter | Type | Description |
|---|---|---|
| query * | string | Address query. Handles partial addresses, building names, typos. Include city for better accuracy. |
| select | ["string","null"] | Comma-separated fields to return |
| api_key * | string | API key for authentication |
| exclude | ["string","null"] | Source classes to leave out, comma separated, such as "inferred" or "inferred,observed". Checks the selected fields that have a source column, keeps a match when one of them keeps its value, and empties the rest. |
| max_results | ["integer","null"] | Max results (default: 10, max: 25) |
| price_quote | ["boolean","null"] | Return the cost of this request without billing it or returning data |
| country_abbreviation | ["string","null"] | Only return matches from one country, by its country_abbreviation as location_endpoint returns it (for example "GB"). Default: every country. A query that names a province, a state, or a postal code already ranks its own country first. |
{
"name": "search_endpoint",
"description": "Find property_id using fuzzy address matching. Billed per field, per home returned. Handles typos, abbreviations, partial addresses. Pass country_abbreviation to keep every match in one country. Use returned property_id with other endpoints for detailed data.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"api_key",
"query"
],
"properties": {
"query": {
"type": "string",
"description": "Address query. Handles partial addresses, building names, typos. Include city for better accuracy."
},
"select": {
"type": [
"string",
"null"
],
"description": "Comma-separated fields to return"
},
"api_key": {
"type": "string",
"description": "API key for authentication"
},
"exclude": {
"type": [
"string",
"null"
],
"description": "Source classes to leave out, comma separated, such as \"inferred\" or \"inferred,observed\". Checks the selected fields that have a source column, keeps a match when one of them keeps its value, and empties the rest."
},
"max_results": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Max results (default: 10, max: 25)"
},
"price_quote": {
"type": [
"boolean",
"null"
],
"description": "Return the cost of this request without billing it or returning data"
},
"country_abbreviation": {
"type": [
"string",
"null"
],
"description": "Only return matches from one country, by its country_abbreviation as location_endpoint returns it (for example \"GB\"). Default: every country. A query that names a province, a state, or a postal code already ranks its own country first."
}
}
}
}Property data for Canada, the United States, Great Britain, Latvia, Slovenia, Czechia, France, Spain, the Netherlands, Finland, Poland, Norway, Switzerland, Estonia, Austria and South Korea: 220+ million properties, 400+ fields each. Each property is one home with its own address and property_id, so each flat in a building is its own row. Where a building's homes have no addresses of their own, the building is one row, a Duplex or Multiplex in property_type. Property data costs about $0.001 per field, per home returned, plus $0.001 per nested row for each expand= set. A field with no value for a home is not billed, and every matching home is still returned. Endpoints that do not return property records are billed per thing returned instead: $0.01 per aggregation, $0.001 per predicted field per date per property, $0.00001 per map cluster or heatmap cell, $0.00001 per location. Nothing is billed on how much data was searched, only on what comes back, so a filter across the whole country costs the same as one across a single street when the same amount is returned. Start with the tools that do not bill per call. field_list names every field, field_detail gives a field's type, accepted filter values, whether it can be sorted, filtered, aggregated or predicted, its expand set and its price per home returned, search_api_documentation reads the documentation pages, and auth_endpoint checks a key. Every billed tool takes price_quote=true, which returns what the call would cost without billing it or returning data. Three levers control both cost and answer quality: 1. Narrow the columns: always set select= to only the fields you'll actually use. 2. Narrow the rows to records with real signal. Many properties in the database are homes with little recorded data beyond their address. For comparables, market analysis, 'find me a property like X', or anything where the user expects active or marketable inventory, add has_expand_listings_eq=true (or has_expand_listings_rent_eq=true for rentals) to filters. These are indexed boolean filters on the property record itself, so they're far cheaper and faster than expanding listings just to drop empties with filter_expand_match=all. Skip them only when the user explicitly wants the full universe (mailing lists, full market footprint, raw counts). 3. Check what the place covers before a large query. Coverage differs by country and region, so a field that is filled in one country can be empty in another. To see which countries hold any value for a filterable field, call location_endpoint with country_abbreviation=ca, resolution=country and filters=["<field>_regex=."], once for each country to check: the country comes back only when at least one of its properties has that field, for a fraction of a cent. A location_endpoint call that carries a filter covers one country, so several countries take one call each. To count the properties that hold it, call aggregate_endpoint with aggregation=count on the field, one entry per country in the aggregations array, because count leaves out empty values. Places come from location_endpoint, never from memory. resolution=country lists every country with its country_abbreviation, and resolution=province with one country_abbreviation lists its provinces, states or regions. One country per call: every call must name exactly one country, with country_abbreviation, or something narrower inside one country (a province, a city, a community or a list of property ids), and a call that names no place, or more than one country, is refused with a 400 that says what to change. Several countries take one call each. On properties_endpoint and aggregate_endpoint a bounding box or a polygon alone is not enough, and each entry of the aggregations array names its own place, so different entries may name different countries. On map_endpoint a bounding box or a polygon is enough as long as it covers no more homes than one country holds, and on geocoding_endpoint the point and r
Names, descriptions and schemas were written by the server and are shown as data.