Comparable

  1. Home
  2. API Library
  3. Comparable
All the data for correctly estimating a property

Access the most comprehensive dataset of property listings

All the knowledge you need

Here you can find some advice to consider to approach this API. If you prefer, we provide code samples, OAS3 documentation, the ability to try the API live via the Swagger UI or import the entire collection into Postman. We also offer a Sandbox environment where you can experiment with all kinds of requests completely free of charge.

Useful tips to start with Comparable

Get the token in the appropriate section before you start.

Use the the online tool or generate it via API. Set the expire date, a usefull name and now add a bunch of scopes to limit the possible actions your token can do.
Read more on oauth API Manage my tokens
API docs by Redocly

Comparabili (1.0.0)

URL: https://openapi.it/en/support License: Apache 2.0 Terms of Service

Service web pour la recherche d'annonces immobilières.

Première fois ici ? Génération d'un nouveau jeton d'accès

Annunci Immobiliari

En partant d'un lieu précis et de son périmètre, ce service vous permet de rechercher des offres de biens immobiliers à proximité et dans cette partie du territoire

Liste des taxonomies

Cette méthode affiche la liste de tous les types de taxinomies

Authorizations:
bearerAuth

Responses

Response Schema: application/json
object (Tassonomie)
success
boolean
message
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://comparabili.openapi.it/tassonomie");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "message": "",
  • "error": null
}

Taxinomie spécifique

Cette méthode montre le type spécifique de taxonomie

Authorizations:
bearerAuth
path Parameters
tassonomia
required
string
Example: categoryType

Type de taxonomie

Responses

Response Schema: application/json
object
success
boolean
message
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://comparabili.openapi.it/tassonomie/%7Btassonomia%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "message": "",
  • "error": null
}

Méthode de recherche

Procédure de recherche d'annonces immobilières par saisie de valeurs d'adresses

Authorizations:
bearerAuth
Request Body schema: application/json
latitude
required
number <double> [ -90 .. 90 ]

Latitude du point sur lequel vous souhaitez centrer la recherche ; elle doit être comprise entre -90,00 et 90,00 degrés.

longitude
required
number <double> [ -180 .. 180 ]

Longitude du point sur lequel vous souhaitez centrer la recherche ; elle doit être comprise entre -180,00 et 180,00 degrés.

contractTypeID
required
integer

Type d'identifiant du contrat

limit
required
integer [ 1 .. 30 ]

Nombre maximal d'annonces à renvoyer. Le nombre maximum d'annonces est de 30

radius
required
integer >= 500

Rayon de recherche en mètres avec une valeur >= 500

maxPrice
integer >= 0

Le prix maximum des annonces à rechercher

minPrice
integer >= 0

Le prix minimum des annonces à rechercher

maxMq
integer >= 0

La surface maximale du terrain à fouiller

minMq
integer >= 0

La surface minimale du terrain à fouiller

minDate
string

Date minimale d'enregistrement des annonces

maxDate
string

Délai maximum pour la diffusion des annonces

categoryTypeID
integer

Catégorie Type id

integer or Array of integers

Type de propriété id

integer or Array of integers

Qualité de la réalisation id

integer or Array of integers

Identification de la qualité de l'objet

integer or Array of integers

Identification du statut d'emploi

integer or Array of integers

Id État de maintenance

integer or Array of integers

Id de l'installation de chauffage

integer or Array of integers

Identification de l'exposition

clientTypeID
integer

Type de client id

integer or Array of integers

Ceinture de centralité id

integer or Array of integers

Statut de publication id

Responses

Response Schema: application/json
object (ResponseRicerca)
success
boolean
message
string
error
integer

Request samples

Content type
application/json
{
  • "latitude": 42,
  • "longitude": 12,
  • "contractTypeID": 1,
  • "limit": 15,
  • "radius": 1500,
  • "categoryTypeID": 1
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "",
  • "success": true,
  • "error": null
}

Détails de l'annonce

Méthode pour obtenir tous les détails d'une annonce immobilière

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 69281343-4e8f-4b77-910c-b81ca1fe4898

ID de l'annonce

Responses

Response Schema: application/json
Array of objects (ResponseImmobile)
success
boolean
message
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://comparabili.openapi.it/immobile/%7Bid%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "message": "",
  • "error": null
}
Web Service Revision: 2.0.0