Getting started
Welcome to the Report Pro 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.
How it works
Report Pro is built around a request identifier (request_uid). The valuation call (AVM) creates the request and returns its identifier; every endpoint described in this section then enriches that same request with a different block of the report.
- Run the valuation call for the property you want to analyse. The response contains the
uidof the request. - Pass that value as
request_uidto any of the report endpoints (IQ, OMI, Market, Context, Comparables, Demand, Negotiation). - Use Request Info at any time to read back the input and the output stored for that request.
Request lifetime
A request_uid refers to a stored request: it is not valid forever and it is not shared between environments. A request_uid created on SANDBOX cannot be used on PRODUCTION, and vice versa. When the identifier is unknown or expired the service answers 400 with {"error": "uid richiesta non trovato"}.
Request format
This service does not accept JSON payloads
Unlike most Insights services, the report endpoints expect a form encoded body:
Content-Type: application/x-www-form-urlencoded
Request Info is the only GET endpoint of this group and takes the identifier as a path parameter.
Common request fields
| Field | Required | Default | Description | Type | Example | Notes |
|---|---|---|---|---|---|---|
request_uid | yes | Identifier of the request, returned by the valuation call | string | a5108688-bf46-4b0a-b6b9-756396769cba | UUID | |
contratto_id | optional | 1 | Contract type | number | 1 | 1 = sale, 2 = rent |
contratto_id
Only Market, Comparables and Demand take contratto_id into account. The other endpoints ignore it.
Response format
Report endpoints return the payload directly, wrapped in a single key named after the block being requested (punteggio, omi, stats, contesto, comparabili, domanda, trattativa). There is no _metadata envelope.
Encrypted geometries
Geographic data is returned as an opaque token: the geometry field holds an encrypted value and geometry_type is set to encrypted. These tokens are meant to be forwarded to the Immobiliare.it mapping components, they cannot be decoded client side.
Errors
On failure the service returns a plain object with a single error key holding a human readable message:
{
"error": "uid richiesta non trovato"
}
| Status | Body | Description |
|---|---|---|
| 400 | Il campo request_uid รจ obbligatorio | request_uid missing from the request body |
| 400 | uid richiesta non trovato | Unknown or expired request_uid |
| 400 | ID richiesta non trovato | Unknown or expired request_uid |
| 400 | 'request_id' non trovata | Unknown or expired identifier on /info |
| 403 | authentication_required | Missing, invalid or expired access token |
See also the general Error Handling page.