location_endpoint
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: resolution=country with filters=["parcel_number_regex=."] lists only the countries that hold parcel numbers.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"api_key": "<api_key>"
},
"name": "location_endpoint"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| city | No | City name. Requires country_abbreviation and province_abbreviation, and the endpoint returns a 400 if either is missing. | |
| flat | No | 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 | Yes | API key for authentication | |
| filters | No | 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. | |
| community | No | Community/neighborhood name. Requires country_abbreviation, province_abbreviation and city, and the endpoint returns a 400 if any is missing. | |
| resolution | No | 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 | No | Return the cost of this request without billing it or returning data | |
| country_abbreviation | No | 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 | No | 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. |