Skip to content

Getting started

Welcome to the Immobiliare.it Insights documentation.

The Insights API follows REST principles and is engineered to be clear, predictable, and developer-friendly. By adhering to industry best practices, it offers a stable contract between Immobiliare.it Insights and your applications.

Read this guide to get oriented and start integrating.

Endpoint Structure

All endpoints follow a consistent structure: {BASE_URL}/{ENDPOINT_SUFFIX}

General Request Requirements

The following conventions apply to every endpoint:

  • For POST operations, send JSON payloads and advertise it with the header Content-Type: application/json.
  • Each call must include a valid access token. See the Authentication section for how to obtain and supply it.
  • Requests and responses are exchanged in JSON format.
  • Required fields are presented in bold or indicated with stars (*) within the endpoint documentation.

API Stability and Extensibility

To keep integrations robust over time:

  • Additional, non-breaking properties may appear in future releases; clients should accept unexpected fields in responses.
  • Schemas may be extended with new fields without changing the URL version.
  • Existing fields will not be removed or altered in a way that breaks backward compatibility.
  • Prefer resilient parsing that safely ignores unknown keys.
  • All updates to endpoints are tracked in the Changelog.