Heatmap of an area by district
https://platform.casafari.com/v1/area-insights/heatmapSend Authorization: Bearer $CASAFARI_API_KEY: a platform API key (cf_sk_...) from the console, or an OAuth access token; X-API-Key carries the key too. See platform API keys. Costs 25 tokens a call (1 token = EUR 0.04). In an AI assistant, the same call as an MCP tool costs 5 tokens a call.
The platform's OpenAPI file leaves the shape open; what is shown comes from the same definitions the platform publishes elsewhere: request: the MCP tool area-insights_get_heatmap's input (its request_data object).
Over MCP: area-insights_get_heatmap (equivalent). See MCP and REST compared.
Description
Kostet 25 Tokens pro Aufruf.
Request-Body
Content-Type application/json. Optional. Typ: object.
type_groupZeichenfolgeerforderlichapartment housebusiness_typeZeichenfolgeerforderlichsale rentprice_rangeobjectkann null sein2 Eigenschaften
minintegerkann null seinmaxintegerkann null seinprice_per_sqm_rangeobjectkann null sein2 Eigenschaften
minintegerkann null seinmaxintegerkann null seinrooms_rangeobjectkann null sein2 Eigenschaften
minintegerkann null seinmaxintegerkann null seinbedrooms_rangeobjectkann null sein2 Eigenschaften
minintegerkann null seinmaxintegerkann null seinbathrooms_rangeobjectkann null sein2 Eigenschaften
minintegerkann null seinmaxintegerkann null seintotal_area_rangeobjectkann null sein2 Eigenschaften
minintegerkann null seinmaxintegerkann null seinplot_area_rangeobjectkann null sein2 Eigenschaften
minintegerkann null seinmaxintegerkann null seinconstruction_year_rangeobjectkann null sein2 Eigenschaften
minintegerkann null seinmaxintegerkann null seincharacteristicsobjectkann null sein2 Eigenschaften
must_havestring[]balcony elevator no_elevator garage garden parking storage swimming_pool terrace rental_license furniture rented_out life_annuityexcludestring[]balcony elevator no_elevator garage garden parking storage swimming_pool terrace rental_license furniture rented_out life_annuityconditionsstring[]used, ruin, very-good, new, other.used ruin very-good new otherprivatebooleanbankbooleanauctionbooleanexclude_outliersbooleanlocation_idintegererforderlichdata_pointZeichenfolgeerforderlichavg_price avg_price_psqm available_on_market new sold_or_rented price_up price_downdate_rangeobjecterforderlich2 Eigenschaften
minstring (Datum)erforderlichYYYY-MM-DD. If the specified date is not Monday - the closest previous Monday will be selectedmaxstring (Datum)kann null seinYYYY-MM-DD. If the specified date is not Sunday - the closest previous Sunday will be selectedBeispielanfrage
Ersetzen Sie den Schlüssel durch Ihren eigenen. Führen Sie ihn vor der Veröffentlichung auf der Plattform aus: Kopieren Sie ihn, fügen Sie Ihren Schlüssel ein, und er funktioniert.
curl -X POST "https://platform.casafari.com/v1/area-insights/heatmap" \
-H "Authorization: Bearer $CASAFARI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type_group": "apartment",
"business_type": "sale",
"location_id": 544116,
"data_point": "avg_price_psqm",
"date_range": {
"min": "2025-01-01",
"max": "2025-12-31"
}
}'Antworten
200 Success.
Typ: object.
Fehler
Jeder Fehler erfolgt als application/problem+json-Body (RFC 9457) mit type (eine Seite zur Erläuterung), title, status, detail (Handlungsempfehlung), instance, code und request_id (bitte bei Supportanfragen angeben). Ein 402-Status enthält eine upgrade_url, ein 429-Status einen Retry-After-Header. Die Codes pro Status:
- 400
invalid_request,key_in_query(https://platform.casafari.com/errors/invalid-request, https://platform.casafari.com/errors/key-in-query) - 401
unauthorized,invalid_credential,credential_revoked,token_expired(https://platform.casafari.com/errors/unauthorized, https://platform.casafari.com/errors/invalid-credential, https://platform.casafari.com/errors/credential-revoked, https://platform.casafari.com/errors/token-expired) - 402
payment_required(https://platform.casafari.com/errors/payment-required) - 403
insufficient_scope,not_entitled,account_suspended(https://platform.casafari.com/errors/insufficient-scope, https://platform.casafari.com/errors/not-entitled, https://platform.casafari.com/errors/account-suspended) - 404
not_found(https://platform.casafari.com/errors/not-found) - 405
method_not_allowed(https://platform.casafari.com/errors/method-not-allowed) - 409
conflict(https://platform.casafari.com/errors/conflict) - 413
payload_too_large(https://platform.casafari.com/errors/payload-too-large) - 415
unsupported_media_type(https://platform.casafari.com/errors/unsupported-media-type) - 422
validation_failed(https://platform.casafari.com/errors/validation-failed) - 429
rate_limited,daily_limit_reached,request_limit_reached,usage_limit_reached(https://platform.casafari.com/errors/rate-limited, https://platform.casafari.com/errors/daily-limit-reached, https://platform.casafari.com/errors/request-limit-reached, https://platform.casafari.com/errors/usage-limit-reached) - 500
internal_error(https://platform.casafari.com/errors/internal-error) - 502
upstream_error(https://platform.casafari.com/errors/upstream-error) - 503
capacity_exhausted,unavailable(https://platform.casafari.com/errors/capacity-exhausted, https://platform.casafari.com/errors/unavailable) - 504
upstream_timeout(https://platform.casafari.com/errors/upstream-timeout)