Getting started
Welcome to the AVM API documentation. Use the left navigation to browse endpoints and guides.
Environments
https://appraisal.realitycs.it
https://sandbox-appraisal.realitycs.it
All the requests do require an OAUTH 2.0 auth token in the header, see the authentication page for details.
What the service does
The AVM (Automated Valuation Model) estimates the value of a single property from its attributes and its position. Every call is self contained: you describe the property in the request and you get the estimate back, there is nothing to create beforehand and no state to keep between calls.
| Endpoint | Returns |
|---|---|
| Valuation (AVM) | Market value, and optionally the suggested asking price |
| Valore Cauzionale Assicurabile | Mortgage collateral value and insurable value |
Request format
Both endpoints are POST and take a JSON body:
Content-Type: application/json
The two endpoints do not share the same body layout
Valuation expects the fields at the top level of the body, while Valore Cauzionale Assicurabile nests them inside a Filters object. Follow the example on each page rather than reusing the same payload.
Locating the property
The valuation is driven by the coordinates: latitudine and longitudine are mandatory, while indirizzo is optional and only labels the result. An address alone is not enough to run a valuation.
Codified fields
Fields such as tipologia_id, stato, classe_energetica, riscaldamento and contratto are codified: the accepted values are listed in Taxonomies.
Two different tipologia_id sets
The two endpoints do not accept the same typologies: Valore Cauzionale Assicurabile supports a smaller set than Valuation. Taxonomies lists the two tables separately, make sure you read the one matching the endpoint you are calling.
Prefer the cadastral category when you have it
On Valore Cauzionale Assicurabile the property can be identified either by categoria_catastale or by tipologia_id. When the cadastral category is available it is the preferred input, and for non residential properties it is the better choice.
Response format
The response carries the valuation blocks directly, without a _metadata envelope.
- VALORE: estimated market value, with its range and the unit value. Always returned.
- OFFERTA: suggested asking price to publish the listing at. Returned when the request asks for it through the
outputfield. - uid: identifier of the valuation request that produced the response.
Inside VALORE, avm is the estimate and avm_dettaglio details it with avm_min, avm_max, the unit value avm_mq and the confidence index avm_idx.
Changes
All updates to the endpoints are tracked in the Changelog.