Analysis
POST
https://api.casafari.com/market-analytics-api/analysisBearer token42 parameters
On the existing API at https://api.casafari.com (contract clients): send Authorization: Bearer $CASAFARI_TOKEN; see how to get a token. New users: the platform's REST API, platform API keys.
Over MCP: no tool does this. MCP and REST compared.
Description
Market analysis based on the requested property parameters.
Request body
Content type application/json. Required. Type: object.
custom_location_boundaryobjectrequired3 properties
location_idsinteger[]List of location IDs.
1–10 items1–2147483647
polygonobject[]List of geo-points to search within. Polygon must contain at least 4 points. First and last points must match.
at least 4 items
2 properties
latitudenumberrequired-90–90
longitudenumberrequired-180–180
circleobjectCircle boundary to search within.
2 properties
distanceintegerrequiredMaximum distance in meters from the requested
target_point to the properties.50–50000
target_pointobjectrequiredTarget point coordinates to search around.
2 properties
latitudenumberrequired-90–90
longitudenumberrequired-180–180
business_typestringrequiredOperation type for which the property is available.
sale renttypesstring[]requiredThe list of property types by type groups: apartment: ["apartment", "studio", "duplex", "penthouse", "dachgeschosswohnung", "etagenwohnung", "erdgeschosswohnung"] house: ["country_house", "house", "palace", "townhouse", "villa", "country_estate", "chalet", "bungalow", "family_house", "reihenhaus", "reihenendhaus", "reihenmittelhaus", "einfamilienhaus", "zweifamilienhaus", "landwirtschaftliche_betriebe"] room: ["room"] building: ["apartment_building", "office_building", "mix_use_building"] investment: ["retail", "office", "industrial", "warehouse", "hotel", "building", "other_commercial", "restaurant", "werkstatt"] development: ["apartment_development", "house_development"] plot: ["urban_plot", "rural_plot"] other: ["parking", "garage", "other"] Note that you can select multiple types only from one property type group. Some types exist only in some countries: Germany: dachgeschosswohnung, etagenwohnung, erdgeschosswohnung, family_house, reihenhaus, reihenendhaus, reihenmittelhaus, einfamilienhaus, zweifamilienhaus, landwirtschaftliche_betriebe, restaurant, werkstatt; France, Germany, Italy, Portugal, Spain: urban_plot, rural_plot.
42 allowed values
apartment studio duplex penthouse dachgeschosswohnung etagenwohnung erdgeschosswohnung country_house house palace townhouse villa country_estate chalet bungalow family_house reihenhaus reihenendhaus reihenmittelhaus einfamilienhaus zweifamilienhaus landwirtschaftliche_betriebe retail office industrial warehouse hotel building other_commercial restaurant werkstatt urban_plot rural_plot room parking garage other apartment_building office_building mix_use_building apartment_development house_developmentat least 1 item
conditionsstring[]nullableProperty conditions, as returned by the GET /api/v1/references/conditions endpoint.
used ruin very-good new otherat least 1 item
energy_ratingsstring[]nullableList of energy ratings that attests to the energy efficiency of the property.
Unknown A+ A B C D E F G Hat least 1 item
orientationsstring[]nullableProperty view orientation.
exterior interiorat least 1 item
viewsstring[]nullableList of views from the property.
water landscape city golf parkat least 1 item
directionsstring[]nullableList of cardinal directions the property faces.
north south east westat least 1 item
floorsstring[]nullableList of floor types.
no_floor ground middle topat least 1 item
price_rangeobjectnullable2 properties
minintegernullable1–2147483647
maxintegernullable1–2147483647
rooms_rangeobjectnullable2 properties
minintegernullable1–15000
maxintegernullable1–15000
bedrooms_rangeobjectnullable2 properties
minintegernullable0–15000
maxintegernullable0–15000
bathrooms_rangeobjectnullable2 properties
minintegernullable1–15000
maxintegernullable1–15000
total_area_rangeobjectnullable2 properties
minintegernullable1–1000000
maxintegernullable1–1000000
plot_area_rangeobjectnullable2 properties
minintegernullable1–1000000
maxintegernullable1–1000000
construction_year_rangeobjectnullable2 properties
minintegernullable1–3000
maxintegernullable1–3000
characteristicsobjectnullable2 properties
must_havestring[]Include only properties that have all these characteristics.
balcony elevator no_elevator garage garden parking storage swimming_pool terrace rental_license furniture rented_out life_annuityexcludestring[]Exclude properties that contain any of these characteristics.
balcony elevator no_elevator garage garden parking storage swimming_pool terrace rental_license furniture rented_out life_annuityExample request
Placeholders only: replace the token and the values with your own.
curl -X POST "https://api.casafari.com/market-analytics-api/analysis" \
-H "Authorization: Bearer $CASAFARI_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"types": [
"apartment"
],
"business_type": "sale",
"custom_location_boundary": {
"location_ids": [
11737
]
}
}'Responses
200 Successful Response
Type: object.
Show the response shape (33 fields)
price_statisticsobjectrequiredStatistics including the average price and average price per square meter for properties matching the requested filters.
2 properties
average_priceintegerrequiredaverage_price_per_sqmintegerrequiredprice_estimationobjectrequiredProvides estimated prices, including a quick sale price
fast_market_price and an inflated price out_of_market_price.2 properties
fast_market_priceintegerrequiredout_of_market_priceintegerrequiredprice_evolutionobjectrequiredRepresents time series data showing how average prices and prices per square meter have changed over time for inactive properties.
2 properties
avg_priceobjectrequired5 properties
for_the_last_1_monthintegerrequiredfor_the_last_3_monthintegerrequiredfor_the_last_6_monthintegerrequiredfor_the_last_9_monthintegerrequiredfor_the_last_12_monthintegerrequiredavg_price_per_sqmobjectrequired5 properties
for_the_last_1_monthintegerrequiredfor_the_last_3_monthintegerrequiredfor_the_last_6_monthintegerrequiredfor_the_last_9_monthintegerrequiredfor_the_last_12_monthintegerrequiredsummary_price_evolutionobjectrequiredRepresents time series data showing how average prices and prices per square meter have changed over time for both active and inactive properties.
2 properties
avg_priceobjectrequired5 properties
for_the_last_1_monthintegerrequiredfor_the_last_3_monthintegerrequiredfor_the_last_6_monthintegerrequiredfor_the_last_9_monthintegerrequiredfor_the_last_12_monthintegerrequiredavg_price_per_sqmobjectrequired5 properties
for_the_last_1_monthintegerrequiredfor_the_last_3_monthintegerrequiredfor_the_last_6_monthintegerrequiredfor_the_last_9_monthintegerrequiredfor_the_last_12_monthintegerrequiredaverage_days_on_the_marketintegerrequiredIndicates the average number of days properties remain listed on the market before being sold or removed.
Example from a real call (Madrid, apartments for sale)
{
"price_statistics": {
"average_price": 1011690,
"average_price_per_sqm": 7305
},
"price_estimation": {
"fast_market_price": 539298,
"out_of_market_price": 596067
},
"price_evolution": {
"avg_price": {
"for_the_last_1_month": 578551,
"for_the_last_3_month": 577572,
"for_the_last_6_month": 574922,
"for_the_last_9_month": 571344,
"for_the_last_12_month": 567683
},
"avg_price_per_sqm": {
"for_the_last_1_month": 4820,
"for_the_last_3_month": 4802,
"for_the_last_6_month": 4771,
"for_the_last_9_month": 4733,
"for_the_last_12_month": 4693
}
},
"summary_price_evolution": {
"avg_price": {
"for_the_last_1_month": 615491,
"for_the_last_3_month": 613654,
"for_the_last_6_month": 613816,
"for_the_last_9_month": 611901,
"for_the_last_12_month": 608941
},
"avg_price_per_sqm": {
"for_the_last_1_month": 5071,
"for_the_last_3_month": 5038,
"for_the_last_6_month": 5024,
"for_the_last_9_month": 4992,
"for_the_last_12_month": 4953
}
},
"average_days_on_the_market": 133
}400 Bad Request
Type: object.
Show the response shape (3 fields)
messagestringrequirederrorsstring[]nullabledetailsstringnullable404 Not Found
Type: object.
Show the response shape (3 fields)
messagestringrequirederrorsstring[]nullabledetailsstringnullable422 Validation Error
Type: object.
Show the response shape (6 fields)
detailobject[]5 properties
loc(string | integer)[]requiredmsgstringrequiredtypestringrequiredinputanyctxobject