Authentification

Pour utiliser cette api, vous devez nous contacter à contact@immosquare.com. Après vérification nous vous fournirons une clé et un token pour vous connecter à l'api. Il vous suffira ensuite d'appeler l'api avec vos identifiants et de les envoyer dans le header de la requête REST.

POST /path
Content-Type: application/json
apiKey: xz1232xzd213213er213213dczxcc3loizxzs12dczx
apiToken: xz1287xzdwer213213dczxcas12dczx

GET /path
apiKey: xz1232xzd213213er213213dczxcc3loizxzs12dczx
apiToken: xz1287xzdwer213213dczxcas12dczx

Erreurs

shareimmo utilise des codes conventionnels de réponse HTTP pour indiquer le succès ou l'échec d'une requêtes API.

En général, les codes débutant par 2xx indiquent un succès, les codes débutant par 4xx indiquent une error qui résulte des informations fournies lors de l'appel ( par exemple : un paramètre est manquant,... ), et les codes débutant par 5xx indiquent une erreur interne sur notre serveur.

HTTP Statut Code Description
200 - OK Succès de la requête.
400 - Bad Request Paramètres manquants, mauvais type envoyé,...
401 - Unauthorized API Key/token invalide
402 - Request Failed Paramètres ok mais la requête a échoué
404 - Not Found Cette requête n'existe pas
429 - Too Many Requests Trop de requête
500, 502, 503, 504 - Server Errors Erreur interne

Accounts

This is an object representing a shareimmo account.

Create an account

POST https://shareimmo.com/api/v2/accounts

Call

Attributes  
uid
string
required
 The identifier of the account in your system
(must be unique)
email
string
required
 login email
(must be unique)
password
string
required
 password 
{
  "uid": "123",
  "email": "johndoe@email.com",
  "password": "your-password"
}

Reponse

{
  "id": 2,
  "uid": "123",
  "email": "johndoe@email.com",
  "message": "User was created"
}

Update an account

PUT https://shareimmo.com/api/v2/accounts/123
Attributes  
uid
string
required
 The identifier of the account in your system
(must be unique & can't be update)
reference
string		 An identifier of the account for your system, you can update it
country
string
required
 The country attached to the account with ISO 3166-1 alpha-2 standard
public_email
string		 User public email
first_name
string		  
last_name
string		  
phone
string		 Phone number connected to the account without the international prefix
phone_sms
string		 Phone number for sms reception connected to the account without the international prefix
phone_office
string		 Phone number for fax reception connected to the account without the international prefix
phone_visibility
integer
0 - no
1 - yes		 if 0 any phone numbers are displayed on ads
website
string		 The url of the account's website (without http://)
spoken_languages
string		 spoken languages separated by commas with ISO 3166-1 alpha-2 standard
picture_url
string		 Max: 2Mo Square format for the best result (500x500)
facebook_url
string		 Facebook page of the account
twitter_url
string		 Twitter page of the account
linkedin_url
string		 Linkedin page of the account
pinterest_url
string		 Pinterest page of the account
instagram_url
string		 Instagram page of the account
youtube_url
string		 Youtube page of the account
color1
string		 Primary color, hexadecimal code
color2
string		 Secondary color, hexadecimal code
color1_print
string		 Primary color, pantone code
color2_print
string		 Secondary color, pantone code
corporate_account
integer
0 - no
1 - yes		  
company_name
string		  
company_phone
string		  
company_email
string		  
companylogourl
string		 Max: 2Mo Square format for the best result (500x500)
presentation_text
string		 Small presentation text of the account
bio
text		 Complete Presentation text of the account (html accepted)
baseline
string		 Commercial hook
billing_address
string		  
shipping_address
string		 By default the same as the billing address

Call

{
  "reference": "ref:123456",
  "country": "FR",
  "public_email": "jonhdoe@email.com",
  "first_name": "Jonh",
  "last_name": "Doe",
  "phone": "514 123 4578",
  "phone_sms": "514 123 4578",
  "phone_office": "514 568-6781",
  "phone_visibility": 1,
  "picture_url": "http://lorempicsum.com/futurama/255/200/5",
  "website": "www.wgroupe.com",
  "spoken_languages": "fr,en",
  "facebook_url": "https://www.facebook.com/jules.welsch",
  "twitter_url": "https://twitter.com/jules",
  "linkedin_url": "https://ca.linkedin.com/pub/jules-welsch/91/463/991",
  "pinterest_url": "https://www.pinterest.com/juleswelsch/",
  "google_plus_url": "https://plus.google.com/",
  "instagram_url": "https://instagram.com/cyrielle_bocquet/",
  "youtube_url": "https://www.youtube.com/",
  "color1": "#ee2737",
  "color2": "#00c389",
  "color1_print": "1788 C",
  "color2_print": "3395 C",
  "corporate_account": 1,
  "company_name": "John Doe Agency",
  "company_phone": "514 700-1963",
  "company_email": "contact@immosquare.com",
  "company_logo_url": "http://lorempicsum.com/futurama/350/200/6",
  "presentation_text": {
    "fr": "professionnel de l'immobilier de luxe",
    "en": "Luxury real estate broker",
    "it": "Immobili di lusso professionale",
    "es": "Lujo profesional de bienes raíces"
  },
  "bio": {
    "fr": "<h1>Bonjour</h1>,<p>je m'appelle ...</p>",
    "en": "<h1>Hello</h1><p> I'm ...</p>",
    "it": "<h1>Hello</h1><p> Sono ...</p>",
    "es": "<h1>Hola</h1><p> Estoy ...</p>"
  },
  "baseline": {
    "fr": "la meilleur place pour acheter",
    "en": "the best place to buy",
    "it": "il posto migliore per comprare",
    "es": "el mejor lugar para comprar"
  },
  "billing_address": {
    "address1": "460 rue Sainte Catherine Ouest",
    "address2": "suite 300",
    "city": "Montréal",
    "country": "Canada",
    "province": "Québec",
    "zipcode": "H3B 1A7"
  },
  "shipping_address": {
    "address1": "480 rue Sainte Catherine Ouest",
    "address2": "suite 400",
    "city": "Montréal",
    "country": "Canada",
    "province": "Québec",
    "zipcode": "H3B 1A7"
  }
}

Reponse

{
  "reference": "ref:123456",
  "country": "FR",
  "public_email": "jonhdoe@email.com",
  "first_name": "Jonh",
  "last_name": "Doe",
  "phone": "514 123 4578",
  "phone_sms": "514 123 4578",
  "phone_office": "514 568-6781",
  "phone_visibility": 1,
  "picture_url": "http://lorempicsum.com/futurama/255/200/5",
  "website": "www.wgroupe.com",
  "spoken_languages": "fr,en",
  "facebook_url": "https://www.facebook.com/jules.welsch",
  "twitter_url": "https://twitter.com/jules",
  "linkedin_url": "https://ca.linkedin.com/pub/jules-welsch/91/463/991",
  "pinterest_url": "https://www.pinterest.com/juleswelsch/",
  "google_plus_url": "https://plus.google.com/",
  "instagram_url": "https://instagram.com/cyrielle_bocquet/",
  "youtube_url": "https://www.youtube.com/",
  "color1": "#ee2737",
  "color2": "#00c389",
  "color1_print": "1788 C",
  "color2_print": "3395 C",
  "corporate_account": 1,
  "company_name": "John Doe Agency",
  "company_phone": "514 700-1963",
  "company_email": "contact@immosquare.com",
  "company_logo_url": "http://lorempicsum.com/futurama/350/200/6",
  "presentation_text": {
    "fr": "professionnel de l'immobilier de luxe",
    "en": "Luxury real estate broker",
    "it": "Immobili di lusso professionale",
    "es": "Lujo profesional de bienes raíces"
  },
  "bio": {
    "fr": "<h1>Bonjour</h1>,<p>je m'appelle ...</p>",
    "en": "<h1>Hello</h1><p> I'm ...</p>",
    "it": "<h1>Hello</h1><p> Sono ...</p>",
    "es": "<h1>Hola</h1><p> Estoy ...</p>"
  },
  "baseline": {
    "fr": "la meilleur place pour acheter",
    "en": "the best place to buy",
    "it": "il posto migliore per comprare",
    "es": "el mejor lugar para comprar"
  },
  "billing_address": {
    "address1": "460 rue Sainte Catherine Ouest",
    "address2": "suite 300",
    "city": "Montréal",
    "country": "Canada",
    "province": "Québec",
    "zipcode": "H3B 1A7"
  },
  "shipping_address": {
    "address1": "480 rue Sainte Catherine Ouest",
    "address2": "suite 400",
    "city": "Montréal",
    "country": "Canada",
    "province": "Québec",
    "zipcode": "H3B 1A7"
  },
  "created_at": "2014-06-14T13:01:49.000-04:00",
  "updated_at": "2018-02-28T16:53:06.000-05:00",
  "uids": [
    {
      "uid": "123",
      "provider": "kangalou"
    },
    {
      "uid": "1",
      "provider": "gercop"
    },
    {
      "uid": "1",
      "provider": "shareimmo"
    },
    {
      "uid": "1",
      "provider": "publimax"
    },
    {
      "uid": "remaxadobe",
      "provider": "remaxmx"
    }
  ]
}

Retrieve an account

GET https://shareimmo.com/api/v2/accounts/:uid
Attributes  
uid
string
required
 Your identifier of the account to be retrieved

Response

{
  "reference": "ref:123456",
  "country": "FR",
  "public_email": "jonhdoe@email.com",
  "first_name": "Jonh",
  "last_name": "Doe",
  "phone": "514 123 4578",
  "phone_sms": "514 123 4578",
  "phone_office": "514 568-6781",
  "phone_visibility": 1,
  "picture_url": "http://lorempicsum.com/futurama/255/200/5",
  "website": "www.wgroupe.com",
  "spoken_languages": "fr,en",
  "facebook_url": "https://www.facebook.com/jules.welsch",
  "twitter_url": "https://twitter.com/jules",
  "linkedin_url": "https://ca.linkedin.com/pub/jules-welsch/91/463/991",
  "pinterest_url": "https://www.pinterest.com/juleswelsch/",
  "google_plus_url": "https://plus.google.com/",
  "instagram_url": "https://instagram.com/cyrielle_bocquet/",
  "youtube_url": "https://www.youtube.com/",
  "color1": "#ee2737",
  "color2": "#00c389",
  "color1_print": "1788 C",
  "color2_print": "3395 C",
  "corporate_account": 1,
  "company_name": "John Doe Agency",
  "company_phone": "514 700-1963",
  "company_email": "contact@immosquare.com",
  "company_logo_url": "http://lorempicsum.com/futurama/350/200/6",
  "presentation_text": {
    "fr": "professionnel de l'immobilier de luxe",
    "en": "Luxury real estate broker",
    "it": "Immobili di lusso professionale",
    "es": "Lujo profesional de bienes raíces"
  },
  "bio": {
    "fr": "<h1>Bonjour</h1>,<p>je m'appelle ...</p>",
    "en": "<h1>Hello</h1><p> I'm ...</p>",
    "it": "<h1>Hello</h1><p> Sono ...</p>",
    "es": "<h1>Hola</h1><p> Estoy ...</p>"
  },
  "baseline": {
    "fr": "la meilleur place pour acheter",
    "en": "the best place to buy",
    "it": "il posto migliore per comprare",
    "es": "el mejor lugar para comprar"
  },
  "billing_address": {
    "address1": "460 rue Sainte Catherine Ouest",
    "address2": "suite 300",
    "city": "Montréal",
    "country": "Canada",
    "province": "Québec",
    "zipcode": "H3B 1A7"
  },
  "shipping_address": {
    "address1": "480 rue Sainte Catherine Ouest",
    "address2": "suite 400",
    "city": "Montréal",
    "country": "Canada",
    "province": "Québec",
    "zipcode": "H3B 1A7"
  },
  "created_at": "2014-06-14T13:01:49.000-04:00",
  "updated_at": "2018-02-28T16:53:06.000-05:00",
  "uids": [
    {
      "uid": "123",
      "provider": "kangalou"
    },
    {
      "uid": "1",
      "provider": "gercop"
    },
    {
      "uid": "1",
      "provider": "shareimmo"
    },
    {
      "uid": "1",
      "provider": "publimax"
    },
    {
      "uid": "remaxadobe",
      "provider": "remaxmx"
    }
  ]
}

Delete an account

DELETE https://shareimmo.com/api/v2/accounts/:uid
Attributes  
uid
string
required
 The identifier of the account in your system
(must be unique)

Reponse

{
  "uid": 123,
  "message": "Deletion was done"
}

Buildings

This is an object representing a shareimmo buildings. You can use the same url to create and update a property. In order to continuously have more impact in the display of your properties, it is possible to associate several properties to a single building.

Create & Update a building

POST|PUT https://shareimmo.com/api/v2/buildings
Attributes  
uid
string
required
 In order to continuously have more impact in the display of your ads. It is possible to associate several ads to a single building
account_uid
string
required
 This entry is used to allocate a building to a user
name
string
required for creation (POST)
 Building name
units
integer		 Number of units in the building
levels
integer		 Number of floors in the building
address.address_formatted
string		 property's full address (can be geocoded)
address.street_number
string		 Street number
address.street_name
string		 Street name (without street number)
address.zipcode
string		 Zipcode
address.locality
string		 Town
address.sublocality
string		 Neighborhood
address.administrative_area_level1
string		 Region/province
address.administrative_area_level2
string		 Municipality/county
address.country
string		  
address.latitude
float		  
address.longitude
float		  
description_short
text		 Building description in different languages (can NOT use html content)
description
text		 Building description in different languages (can use html content)
pictures
string		 max:10Mo Use 1920x1080px to obtain the best results
address_visibility
integer
0 - no
1 - yes		 Do you wish your address to be visible?

Call

{
  "uid": "3",
  "account_uid": "123",
  "name": "Le nordelec",
  "units": 250,
  "levels": 8,
  "address": {
    "address_formatted": "1740 Rue St-Patrick, Montréal, QC H3K 2H2, Canada",
    "street_number": "1740",
    "street_name": "Rue Saint-Patrick",
    "zipcode": "H3K 2H2",
    "locality": "Montréal",
    "sublocality": "Pointe-Saint-Charles",
    "administrative_area_level1": "Québec",
    "administrative_area_level2": "Communauté-Urbaine-de-Montréal",
    "country": "CA",
    "latitude": 45.4854,
    "longitude": -73.5629
  },
  "description_short": {
    "fr": "Construit en 1913, le Nordelec demeure un exemple remarquable...",
    "en": "Built in 1913, the Nordelec remains an outstanding example ...",
    "it": "Costruito nel 1913, il Nordelec rimane un esempio eccezionale ...",
    "es": "Construido en 1913, el Nordelec sigue siendo un ejemplo sobresaliente ..."
  },
  "description": {
    "fr": "<p><span>Un des beaux avantages de la vie aux condos Nordelec est l’accès exclusif à des espaces communs peu ordinaires</span></p>",
    "en": "<p><span>One of the beautiful advantages of living in the condos is Nordelec exclusive access to unusual public areas</span></p>",
    "it": "<p><span>Una delle belle vantaggi di vivere in condomini è l'accesso esclusivo a Nordelec insolite aree pubbliche</span></p>",
    "es": "<p><span>Una de las hermosas ventajas de vivir en los condominios es Nordelec acceso exclusivo a las zonas comunes inusuales</span></p>"
  },
  "pictures": [
    {
      "url": "http://lorempicsum.com/nemo/627/300/9"
    },
    {
      "url": "http://lorempicsum.com/nemo/627/300/2"
    },
    {
      "url": "http://lorempicsum.com/nemo/627/300/1"
    }
  ]
}

Reponse

{
  "id": 12,
  "uid": "3",
  "account_id": 2,
  "account_uid": "123",
  "name": "Le nordelec",
  "units": 250,
  "levels": 8,
  "address": {
    "address_formatted": "1740 Rue St-Patrick, Montréal, QC H3K 2H2, Canada",
    "street_number": "1740",
    "street_name": "Rue Saint-Patrick",
    "zipcode": "H3K 2H2",
    "locality": "Montréal",
    "sublocality": "Pointe-Saint-Charles",
    "administrative_area_level1": "Québec",
    "administrative_area_level2": "Communauté-Urbaine-de-Montréal",
    "country": "CA",
    "latitude": 45.4854,
    "longitude": -73.5629
  },
  "description_short": {
    "fr": "Construit en 1913, le Nordelec demeure un exemple remarquable...",
    "en": "Built in 1913, the Nordelec remains an outstanding example ...",
    "it": "Costruito nel 1913, il Nordelec rimane un esempio eccezionale ...",
    "es": "Construido en 1913, el Nordelec sigue siendo un ejemplo sobresaliente ..."
  },
  "description": {
    "fr": "<p><span>Un des beaux avantages de la vie aux condos Nordelec est l’accès exclusif à des espaces communs peu ordinaires</span></p>",
    "en": "<p><span>One of the beautiful advantages of living in the condos is Nordelec exclusive access to unusual public areas</span></p>",
    "it": "<p><span>Una delle belle vantaggi di vivere in condomini è l'accesso esclusivo a Nordelec insolite aree pubbliche</span></p>",
    "es": "<p><span>Una de las hermosas ventajas de vivir en los condominios es Nordelec acceso exclusivo a las zonas comunes inusuales</span></p>"
  },
  "pictures": {
    "in_progess": true
  }
}

Retrieve a building

GET https://shareimmo.com/api/v2/buildings/:uid
Attributes  
uid
string		 Your identifier of the building to be retrieved

Reponse

{
  "id": 12,
  "uid": "3",
  "account_id": 2,
  "account_uid": "123",
  "name": "Le nordelec",
  "units": 250,
  "levels": 8,
  "address": {
    "address_formatted": "1740 Rue St-Patrick, Montréal, QC H3K 2H2, Canada",
    "street_number": "1740",
    "street_name": "Rue Saint-Patrick",
    "zipcode": "H3K 2H2",
    "locality": "Montréal",
    "sublocality": "Pointe-Saint-Charles",
    "administrative_area_level1": "Québec",
    "administrative_area_level2": "Communauté-Urbaine-de-Montréal",
    "country": "CA",
    "latitude": 45.4854,
    "longitude": -73.5629
  },
  "description_short": {
    "fr": "Construit en 1913, le Nordelec demeure un exemple remarquable...",
    "en": "Built in 1913, the Nordelec remains an outstanding example ...",
    "it": "Costruito nel 1913, il Nordelec rimane un esempio eccezionale ...",
    "es": "Construido en 1913, el Nordelec sigue siendo un ejemplo sobresaliente ..."
  },
  "description": {
    "fr": "<p><span>Un des beaux avantages de la vie aux condos Nordelec est l’accès exclusif à des espaces communs peu ordinaires</span></p>",
    "en": "<p><span>One of the beautiful advantages of living in the condos is Nordelec exclusive access to unusual public areas</span></p>",
    "it": "<p><span>Una delle belle vantaggi di vivere in condomini è l'accesso esclusivo a Nordelec insolite aree pubbliche</span></p>",
    "es": "<p><span>Una de las hermosas ventajas de vivir en los condominios es Nordelec acceso exclusivo a las zonas comunes inusuales</span></p>"
  },
  "pictures": [
    {
      "small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_56_small.jpg",
      "medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_56_medium.jpg",
      "large": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_56_large.jpg",
      "hd_small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_56_hd_s.jpg",
      "hd_medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_56_hd_m.jpg",
      "hd": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_56_hd.jpg"
    },
    {
      "small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_55_small.jpg",
      "medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_55_medium.jpg",
      "large": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_55_large.jpg",
      "hd_small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_55_hd_s.jpg",
      "hd_medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_55_hd_m.jpg",
      "hd": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_55_hd.jpg"
    },
    {
      "small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_53_small.jpg",
      "medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_53_medium.jpg",
      "large": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_53_large.jpg",
      "hd_small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_53_hd_s.jpg",
      "hd_medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_53_hd_m.jpg",
      "hd": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_53_hd.jpg"
    },
    {
      "small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_40_small.jpg",
      "medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_40_medium.jpg",
      "large": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_40_large.jpg",
      "hd_small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_40_hd_s.jpg",
      "hd_medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_40_hd_m.jpg",
      "hd": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_40_hd.jpg"
    }
  ]
}

Get the uids of all your buildings

This method will return all the uids of all your buildings, with their status online/offline.

GET https://shareimmo.com/api/v2/buildings/get_uids

Reponse

{
  "uids": [
    {
      "uid": "3",
      "online": 0
    },
    {
      "uid": "145",
      "online": 1
    }
  ]
}

Delete a building

DELETE https://shareimmo.com/api/v2/buildings/:uid
Attributes  
uid
string		 Your identifier of the building to be deleted

Reponse

{
  "id": 12,
  "uid": "3",
  "account_id": 2,
  "account_uid": "123",
  "message": "Building deletion was launched0"
}

Deactivate a building

Set offline without deleting it. This method will deactivate your building, without deleting it.

POST https://shareimmo.com/api/v2/buildings/deactivate/:uid
Attributes  
uid
string		 Your identifier of the building to be deactivated

Reponse

{
  "id": 12,
  "uid": "3",
  "account_id": 2,
  "account_uid": "123",
  "message": "Building with uid 3 deactivated"
}

Properties

This is an object representing a shareimmo properties

Create & Update a property

In order to continuously have more impact in the display of your properties, it is possible to associate several properties to a single building.

POST|PUT https://shareimmo.com/api/v2/properties
Attributes  
uid
string
required
 The unique identifier of the property in your system (must be unique)
master
integer		 Property is orginal version ?
0 - Duplicate property
1 - Original property
reference
string		 Your public idetifier of the property in your system
account_uid
string
required
 This entry is used to allocate a property to a user
building_uid This entry is used to allocate a property to a building
online
integer
 Property status
0 - Offline
1 - Online
classification_id
integer
required for creation (POST)
 See classification list below
status_id
integer
required for creation (POST)
 In what state is the property?
1 - New
2 - Used
listing_id
integer
required for creation (POST)
 Is the property for sale or for rent?
1 - For sale
2 - For rent
unit
string		 Unit number of the property
level
integer		 Floor number in the building
cadastre
string		 The property's land register number
flag_id
integer		 1 - Newness
2 - Price Reduction
3 - Open House
4 - Favorite
5 - Sold/Rented
6 - Compromised
7 - Off MLS
8 - Under offer
9 - No longer available
year_of_built
integer		 Year when the property was built
availability_date
datetime		 Availability date of the property
is_luxurious
integer		 Is it luxurious ad?
0 - no
1- yes
virtual_visit_link
string
homstaging_link
string
youtube_link
string
address.address_visibility
integer		 Do you wish your address to be visible?
0 - no
1- yes
address.address_formatted
string		 property's full address (can be geocoded)
address.street_number
string		 Street number
address.street_name
string		 Street name (without street number)
address.zipcode
string		 Zipcode
address.locality
string		 Town
address.sublocality
string		 Neighborhood
address.administrative_area_level1
string		 Region/province
address.administrative_area_level2
string		 Municipality/county
address.country
string		  
address.latitude
float		  
address.longitude
float		  
area.living
integer		 Living surface of the property
area.balcony
integer		 Balcony surface
area.land
integer		 Land surface
area.unit_id
integer		 1 - square meter (m2) (default)
2 - square foot (sq)
rooms.rooms
integer		 Total number of rooms
rooms.bathrooms
integer		 Number of bathrooms
rooms.bedrooms
integer		 Number of bedrooms
rooms.showerrooms
integer		 Number of shower rooms
rooms.toilets
integer		 Number of toilets
rooms.people_capacity
integer		  
rooms.beds
integer		 Number of bed(s)
title
string		 Title of the ad in different languages
description_short
text		 Ad description in different languages (can NOT use html content)
description
text		 description of the ad in different languages (can use html content)
url
text		 Url of the original ad in different languages
financial.price
float		 Property price
financial.price_with_tax
integer		 Property price contains tax?
0 - no
1- yes
financial.price_from
integer		 Display sentence Price from behind the price
0 - no
1- yes
financial.price_unit_id
integer		 1 - metric (default)
2- imperial
financial.rent
float		 Rent amount
financial.fees
float		 Amount of monthly property fees
financial.fees_frequency
integer		 Rent Frequency
1 - per month
2 - per year
financial.rent_frequency
integer		 Rent Frequency
1 - per day
7 - per week
30 - per month
90 - per 3 months
180 - per 6 months
365 - per year
financial.rent_unit_id
integer		 1 - metric (default)
2- imperial
financial.tax1_annual
float		 Tax #1 annually
financial.tax2_annual
float		 Tax #2 annually
financial.income_annual
float		 Annual income for an income property
financial.seller_honorary_percentage
float		  
financial.seller_honorary
float		  
financial.buyer_honorary_percentage
float		  
financial.buyer_honorary
float		  
financial.seller_net_price
float		  
financial.total_honorary
float		  
financial.other_fees
float		  
financial.inventory
float		 The cost of the inventory
financial.property_fees_payment_method_id
integer		 1 - Annual adjustment
2 - Packages (no regularization)
3 - On receipt
4 - No objec
financial.property_honorary_payment_method_id
integer		 1 - Net seller
2 - Final price
financial.currency
string		 currency with ISO 4217 standard (CAD, USD, EUR...)
more_datas
JSON		 Anything you would add
pictures
string		 max:10Mo Use 900x600px to obtain the best results
france.dpe_indice
string		 France DPE Indice
A
B
C
D
E
F
G
france.dpe_value
string		 France DPE Value (KWh/m2)
france.ges_indice
string		 France GES (Gazes à effet de serre) indice
A
B
C
D
E
F
G
H
I
france.ges_value
string		 France GES Value (CO2/m2/an)
france.alur_is_condo
string		 LOI ALUR - property is on co-ownership?
0 - no
1- yes
france.alur_units
integer		 LOI ALUR - number of units
france.alur_uninhabitables
integer		 LOI ALUR - number of uninhabitable units
france.alur_spending
integer		 LOI ALUR - Annual Spending
france.alur_legal_action
integer		 LOI ALUR - Syndic d'immeuble en procédure judiciaire?
0 - no
1- yes
france.rent_honorary
integer		 Honoraires de location
france.rent_honorary_visit
integer		 Honoraires de location (partie visites)
france.rent_honorary_edl
integer		 Honoraires de location (partie état des lieux)
france.mandat_exclusif
integer		 Mandat Exclusif
0 - no
1- yes
belgium.peb_indice
string		 Belgium peb Indice
A
B
C
D
E
F
G
belgium.peb_value
string		 Belgium peb Value (KWh/m2)
belgium.peb_id
string		 Belgium peb Identification
belgium.building_permit
integer		 building permit
0 - no
1- yes
belgium.done_assignments
integer		 Done assignments
0 - no
1- yes
belgium.preemption_property
integer		 Preemption on this property
0 - no
1- yes
belgium.subdivision_permits
integer		 Subdivision permits
0 - no
1- yes
belgium.sensitivefloodarea
integer		 Sensitive floods area
0 - no
1- yes
belgium.delimitedfloodzone
integer		 Delimited flood zone
0 - no
1- yes
belgium.risk_area
integer		 Area with risk
0 - no
1- yes
other.orientation.north
integer		 North orientation?
0 - no
1- yes
other.orientation.south
integer		 South orientation?
0 - no
1- yes
other.orientation.east
integer		 East orientation?
0 - no
1- yes
other.orientation.west
integer		 West orientation?
0 - no
1- yes
other.inclusion.air_conditioning
integer		 Property equipped with air conditionning?
0 - no
1- yes
other.inclusion.hot_water
integer		 Heated water included in rent?
0 - no
1- yes
other.inclusion.heated
integer		 Heating included in rent?
0 - no
1- yes
other.inclusion.electricity
integer		 Electricity included in rent?
0 - no
1- yes
other.inclusion.furnished
integer		 Is the property furnished?
0 - no
1- yes
other.inclusion.fridge
integer		 Property equipped with a fridge?
0 - no
1- yes
other.inclusion.cooker
integer		 Property equipped with a cooker?
0 - no
1- yes
other.inclusion.dishwasher
integer		 Property equipped with a dishwasher?
0 - no
1- yes
other.inclusion.dryer
integer		 Property equipped with a dryer?
0 - no
1- yes
other.inclusion.washer
integer		 Property equipped with a washer?
0 - no
1- yes
other.inclusion.microwave
integer		 Property equipped with a microwave?
0 - no
1- yes
other.detail.elevator
integer		 Building equipped with a elevator?
0 - no
1- yes
other.detail.laundry
integer		 Property/Building equipped with a laundry?
0 - no
1- yes
other.detail.garbage_chute
integer		 Building equipped with a garbage chute?
0 - no
1- yes
other.detail.common_space
integer		 Common spaces in the building?
0 - no
1- yes
other.detail.janitor
integer		 Janitorial service in the building?
0 - no
1- yes
other.detail.gym
integer		 Gym service in the building?
0 - no
1- yes
other.detail.golf
integer		 Property equipped with private golf course?
0 - no
1- yes
other.detail.tennis
integer		 Property equipped with private tennis court?
0 - no
1- yes
other.detail.sauna
integer		 Property equipped with sauna?
0 - no
1- yes
other.detail.spa
integer		 Property equipped with spa?
0 - no
1- yes
other.detail.inside_pool
integer		 Property equipped with inside pool?
0 - no
1- yes
other.detail.outside_pool
integer		 Property equipped with outside pool?
0 - no
1- yes
other.detail.inside_parking
integer		 Property equipped with inside parking?
0 - no
1- yes
other.detail.outside_parking
integer		 Property equipped with outside parking?
0 - no
1- yes
other.detail.parkingonstreet
integer		 Parking only possible on street?
0 - no
1- yes
other.detail.garagebox
integer		 Garabox Available
0 - no
1- yes
other.halffurnished.livingroom
integer		 Only the living room is furnished
0 - no
1- yes
other.half_furnished.bedrooms
integer		 Only the bedrooms are furnished
0 - no
1- yes
other.half_furnished.kitchen
integer		 Only the kitchen is furnished
0 - no
1- yes
other.half_furnished.other
integer		 Only another room is furnished
0 - no
1- yes
other.indoor.attic
integer		 Property equipped with attic?
0 - no
1- yes
other.indoor.attic_convertible
integer		 Property equipped with convertible attic?
0 - no
1- yes
other.indoor.attic_converted
integer		 Property equipped with converted attic?
0 - no
1- yes
other.indoor.cellar
integer		 Property equipped with cellar?
0 - no
1- yes
other.indoor.central_vacuum
integer		 Property equipped with central vacuum?
0 - no
1- yes
other.indoor.entries_washer_dryer
integer		 Property equipped with washer/dryer?
0 - no
1- yes
other.indoor.entries_washer_dishwasher
integer		 Property equipped with dishwasher entry?
0 - no
1- yes
other.indoor.fireplace
integer		 Property equipped with fireplace?
0 - no
1- yes
other.indoor.storage
integer		 Property equipped with storage?
0 - no
1- yes
other.indoor.walk_in
integer		 Property equipped with walkin?
0 - no
1- yes
other.indoor.no_smoking
integer		 smoking is forbidden in the building?
0 - no
1- yes
other.indoor.double_gazing
integer		 Property equipped with double glazing?
0 - no
1- yes
other.indoor.triple_glazing
integer		 Property equipped with triple glazing?
0 - no
1- yes
other.indoor.carpet
integer		 Carpet flooring in the property?
0 - no
1- yes
other.floor.wood
integer		 Wood floor in the property?
0 - no
1- yes
other.floor.floating
integer		 Floating floor in the property?
0 - no
1- yes
other.floor.ceramic
integer		 Ceramic floor in the property?
0 - no
1- yes
other.floor.parquet
integer		 Parquet floor in the property?
0 - no
1- yes
other.floor.cushion
integer		 Cushion floor in the property?
0 - no
1- yes
other.floor.vinyle
integer		 Vynile floor in the property?
0 - no
1- yes
other.floor.marble
integer		 Marble floor in the property?
0 - no
1- yes
other.exterior.land_access
integer		 Access to exterior land in the property?
0 - no
1- yes
other.exterior.back_balcony
integer		 Property equipped with a back balcony?
0 - no
1- yes
other.exterior.front_balcony
integer		 Property equipped with a front balcony?
0 - no
1- yes
other.exterior.private_patio
integer		 Property equipped with a private patio?
0 - no
1- yes
other.exterior.storage
integer		 Property equipped with exterior storage?
0 - no
1- yes
other.exterior.terrace
integer		 Property equipped with a terrace?
0 - no
1- yes
other.exterior.veranda
integer		 Property equipped with a veranda?
0 - no
1- yes
other.exterior.garden
integer		 Property equipped with a garden?
0 - no
1- yes
other.exterior.sea_view
integer		 Property has a sea view?
0 - no
1- yes
other.exterior.mountain_view
integer		 Property has a mountain view?
0 - no
1- yes
other.accessibility.elevator
integer		 Elevator adapted for use by disabled people
0 - no
1- yes
other.accessibility.balcony
integer		 Balcony adapted for use by disabled people
0 - no
1- yes
other.accessibility.grab_bar
integer		 Property equipped with brab bars for disabled people
0 - no
1- yes
other.accessibility.wider_corridors
integer		 Corridors widened for use by disabled people
0 - no
1- yes
other.accessibility.lowered_switches
integer		 Switches lowered for use by disabled people
0 - no
1- yes
other.accessibility.ramp
integer		 Property equipped with access ramp
0 - no
1- yes
other.senior.autonomy
integer		 Retirement home for autonomous seniors
0 - no
1- yes
other.senior.half_autonomy
integer		 Retirement home for semi-autonomous seniors
0 - no
1- yes
other.senior.no_autonomy
integer		 Retirement home for non-autonomous seniors
0 - no
1- yes
other.senior.meal
integer		 Retirement home prepared meals
0 - no
1- yes
other.senior.nursery
integer		 Retirement home with nursery
0 - no
1- yes
other.senior.domestic_help
integer		 Retirement home with domestic help
0 - no
1- yes
other.senior.community
integer		 Retirement home with community spaces
0 - no
1- yes
other.senior.activities
integer		 Retirement home with community activities
0 - no
1- yes
other.senior.validated_residence
integer		 Certified retirement home
0 - no
1- yes
other.senior.housing_cooperative
integer		 Housing cooperative
0 - no
1- yes
other.pet.allow
integer		 Pets allowed in property
0 - no
1- yes
other.pet.not_allow
integer		 Pets not allowed in property
0 - no
1- yes
other.pet.cat
integer		 Cats allowed in property
0 - no
1- yes
other.pet.dog
integer		 Dogs allowed in property
0 - no
1- yes
other.pet.little_dog
integer		 Little dogs allowed in property
0 - no
1- yes
other.pet.cage_aquarium
integer		 Aquariums allowed in property
0 - no
1- yes
other.service.internet
integer		 Internet subscription included in rent
0 - no
1- yes
other.service.tv
integer		 TV subscription included in rent
0 - no
1- yes
other.service.tv_sat
integer		 Sat TV subscription included in rent
0 - no
1- yes
other.service.phone
integer		 Phone subscription included in rent
0 - no
1- yes
other.composition.bar
integer		 Property equipped with bar
0 - no
1- yes
other.composition.living
integer		 Property equipped with living room
0 - no
1- yes
other.composition.dining
integer		 Property equipped with dining room
0 - no
1- yes
other.composition.separate_toilet
integer		 Property equipped with separate toilet
0 - no
1- yes
other.composition.open_kitchen
integer		 Property equipped with open kitchen
0 - no
1- yes
other.heating.electric
integer		 Heating is electric
0 - no
1- yes
other.heating_solar
integer		 Heating is solar
0 - no
1- yes
other.heating.gaz
integer		 Heating with gas
0 - no
1- yes
other.heating.condensation
integer		 Heating with condensation
0 - no
1- yes
other.heating.fuel
integer		 Heating with fuel
0 - no
1- yes
other.heating.heat_pump
integer		 Heating with heatpump
0 - no
1- yes
other.heating.floor_heating
integer		 Floor heating
0 - no
1- yes
other.transport.bicycle_path
integer		 Bicycle path in proximity to property
0 - no
1- yes
other.transport.public_transport
integer		 Public transport in proximity to property
0 - no
1- yes
other.transport.public_bike
integer		 Public bike in proximity to property
0 - no
1- yes
other.transport.subway
integer		 Subway in proximity to property
0 - no
1- yes
other.transport.train_station
integer		 Train station path in proximity to property
0 - no
1- yes
other.security.guardian
integer		 Guard services in property
0 - no
1- yes
other.security.alarm
integer		 Property equipped with alarm
0 - no
1- yes
other.security.intercom
integer		 Property equipped with alarm
0 - no
1- yes
other.security.camera
integer		 Property equipped with camera
0 - no
1- yes
other.security.smoke_detector
integer		 Property equipped with smoke detector
0 - no
1- yes
List of available subclassifications :
Category Code Type
House 101 House
House 102 Twin house
House 103 Attached house
House 104 Mansion
House 105 Individual house
House 106 House to renovate
House 107 Farm
House 108 Farmhouse
House 109 Villa
House 110 Bungalow
House 111 Castle
House 112 Monastery
House 113 Cottage
House 114 Town house
House 115 Village house
House 116 House without land
House 117 Property
House 118 Two-family house
House 119 Various
House 120 Waterfront
House 121 Building
House 122 Domain
Apartment 201 Apartment
Apartment 202 Room
Apartment 203 Studio
Apartment 204 Duplex
Apartment 205 Triplex
Apartment 206 Penthouse
Apartment 207 Loft
Apartment 208 Furnished apartment
Apartment 209 Plex
Apartment 210 Condo
Garage 301 Garage
Garage 302 Parking
Garage 303 Covered parking
Garage 304 Open parking
Garage 305 Box
Land 401 Land
Land 402 Construction land
Land 403 Agricultural land
Land 404 Land for leisure
Land 405 Industrial land
Land 406 Island
Land 407 Vineyard
Income property 501 Income property
Income property 502 Income land
Income property 503 Duplex
Income property 504 Triplex
Income property 505 Quadruplex
Income property 506 Quintuplex
Income property 507 Multiplex
Allotment 601 Allotment
Allotment 602 Future project
Allotment 603 Residential development
Allotment 604 Land to build
Residence 701 Residence
Residence 702 Construction project
Residence 703 New construction
Residence 704 Residence under construction
Commercial use 801 Commercial use
Commercial use 802 Office
Commercial use 803 Virtual office
Commercial use 804 Commercial
Commercial use 805 Warehouse
Commercial use 806 Storehouse
Commercial use 807 Restaurant
Commercial use 808 Hotel
Commercial use 809 Liberal profession office
Commercial use 810 Hangar
Commercial use 811 Industrial
Commercial use 812 Parking
Commercial use 813 Residential
Commercial use 814 Retail
Commercial use 815 Other
Commercial use 816 Golf
Commercial use 817 Showroom

Call

{
  "uid": "50",
  "master": 1,
  "reference": "your_ref",
  "account_uid": "123",
  "building_uid": "3",
  "online": 1,
  "classification_id": 201,
  "unit": "Appt #603",
  "level": 6,
  "cadastre": "nordelec-603",
  "status_id": 1,
  "listing_id": 2,
  "flag_id": 1,
  "year_of_built": 2012,
  "availability_date": "2017-01-16",
  "is_luxurious": 1,
  "virtual_visit_link": "your_link_here.com",
  "homestaging_link": "your_link_here.com",
  "youtube_link": "your_link_here.com",
  "is_furnished": 1,
  "address": {
    "address_visibility": 1,
    "address_formatted": "1740 Rue St-Patrick, Montréal, QC H3K 2H2, Canada",
    "street_number": "1740",
    "street_name": "Rue Saint-Patrick",
    "zipcode": "H3K 2H2",
    "locality": "Montréal",
    "sublocality": "Pointe-Saint-Charles",
    "administrative_area_level1": "Québec",
    "administrative_area_level2": "Communauté-Urbaine-de-Montréal",
    "country": "CA",
    "latitude": 45.4854,
    "longitude": -73.5629
  },
  "area": {
    "living": 1000,
    "balcony": 20,
    "land": null,
    "unit_id": 2
  },
  "rooms": {
    "rooms": 5,
    "bathrooms": 1,
    "bedrooms": 3,
    "showerrooms": null,
    "toilets": 1,
    "people_capacity": 4,
    "beds": 4
  },
  "title": {
    "fr": "Superbe Appartement",
    "en": "superb Apartment",
    "it": "schitterend Appartement",
    "es": "Excelente Apartamento"
  },
  "description_short": {
    "fr": "Construit en 1913, le Nordelec demeure un exemple remarquable...",
    "en": "Built in 1913, the Nordelec remains an outstanding example ...",
    "it": "Costruito nel 1913, il Nordelec rimane un esempio eccezionale ...",
    "es": "Construido en 1913, el Nordelec sigue siendo un ejemplo sobresaliente ..."
  },
  "description": {
    "fr": "<p><span>Un des beaux avantages de la vie aux condos Nordelec est l’accès exclusif à des espaces communs peu ordinaires</span></p>",
    "en": "<p><span>One of the beautiful advantages of living in the condos is Nordelec exclusive access to unusual public areas</span></p>",
    "it": "<p><span>Una delle belle vantaggi di vivere in condomini è l'accesso esclusivo a Nordelec insolite aree pubbliche</span></p>",
    "es": "<p><span>Una de las hermosas ventajas de vivir en los condominios es Nordelec acceso exclusivo a las zonas comunes inusuales</span></p>"
  },
  "url": {
    "fr": "http://www.exemple.com/fr/55",
    "en": "http://www.exemple.com/en/55",
    "it": "http://www.exemple.com/it/55"
  },
  "financial": {
    "price": 0,
    "price_with_tax": 1,
    "price_from": 0,
    "price_unit_id": 2,
    "rent": 1150,
    "deposit": 150,
    "fees": 145,
    "fees_frequency": 1,
    "rent_frequency": 30,
    "rent_unit_id": 2,
    "tax1_annual": 1500,
    "tax2_annual": 2541,
    "income_annual": "0",
    "seller_honorary_percentage": 15,
    "seller_honorary": 400,
    "buyer_honorary_percentage": 10,
    "buyer_honorary": 100,
    "seller_net_price": 150000,
    "total_honorary": 1550,
    "other_fees": 150,
    "inventory": null,
    "property_fees_payment_method_id": 4,
    "property_honorary_payment_method_id": 2,
    "currency": "CAD"
  },
  "more_data": [
    {
      "key1": "value 1, some stuffs"
    },
    {
      "key2": "value 2, some other stuffs"
    }
  ],
  "pictures": [
    {
      "url": "http://lorempicsum.com/nemo/627/300/9"
    },
    {
      "url": "http://lorempicsum.com/nemo/627/300/2"
    },
    {
      "url": "http://lorempicsum.com/nemo/627/300/1"
    }
  ],
  "france": {
    "dpe_indice": null,
    "dpe_value": null,
    "dpe_id": null,
    "ges_indice": null,
    "ges_value": null,
    "alur_is_condo": null,
    "alur_units": null,
    "alur_uninhabitables": null,
    "alur_spending": null,
    "alur_legal_action": null,
    "alur_designation_agent": null,
    "alur_designation_administrator": null,
    "alur_designation_expert": null,
    "mandat_exclusif": null
  },
  "belgium": {
    "peb_indice": null,
    "peb_value": null,
    "peb_id": null,
    "building_permit": null,
    "done_assignments": null,
    "preemption_property": null,
    "subdivision_permits": null,
    "sensitive_flood_area": null,
    "delimited_flood_zone": null,
    "risk_area": null
  },
  "other": {
    "orientation": {
      "north": 1,
      "south": 0,
      "east": 0,
      "west": 1
    },
    "inclusion": {
      "air_conditioning": 1,
      "hot_water": 1,
      "heated": 1,
      "electricity": 0,
      "furnished": 0,
      "fridge": 1,
      "cooker": 1,
      "dishwasher": 1,
      "dryer": 1,
      "washer": 1,
      "microwave": 0
    },
    "detail": {
      "elevator": 1,
      "laundry": 0,
      "garbage_chute": 1,
      "common_space": 1,
      "janitor": 1,
      "gym": 1,
      "golf": 1,
      "tennis": 1,
      "sauna": 1,
      "spa": 1,
      "inside_pool": 0,
      "outside_pool": 1,
      "inside_parking": 1,
      "outside_parking": 1,
      "parking_on_street": 1,
      "garagebox": 0,
      "staff_room": 0
    },
    "half_furnished": {
      "living_room": 0,
      "bedrooms": 0,
      "kitchen": 0,
      "other": 0
    },
    "indoor": {
      "attic": 0,
      "attic_convertible": 0,
      "attic_converted": 0,
      "cellar": 0,
      "central_vacuum": 0,
      "entries_washer_dryer": 1,
      "entries_dishwasher": 1,
      "fireplace": 0,
      "storage": 1,
      "walk_in": 1,
      "no_smoking": 1,
      "double_glazing": 0,
      "triple_glazing": 1
    },
    "floor": {
      "carpet": 0,
      "wood": 1,
      "floating": 0,
      "ceramic": 0,
      "parquet": 0,
      "cushion": 0,
      "vinyle": 0,
      "lino": 0,
      "marble": 0
    },
    "exterior": {
      "land_access": 0,
      "back_balcony": 0,
      "front_balcony": 1,
      "private_patio": 1,
      "storage": 1,
      "terrace": 1,
      "veranda": 0,
      "garden": 0,
      "sea_view": 0,
      "mountain_view": 0
    },
    "accessibility": {
      "elevator": 0,
      "balcony": 0,
      "grab_bar": 0,
      "wider_corridors": 0,
      "lowered_switches": 0,
      "ramp": 0
    },
    "senior": {
      "autonomy": 0,
      "half_autonomy": 0,
      "no_autonomy": 0,
      "meal": 0,
      "nursery": 0,
      "domestic_help": 0,
      "community": 0,
      "activities": 0,
      "validated_residence": 0,
      "housing_cooperative": 0
    },
    "pet": {
      "allow": 1,
      "cat": 1,
      "dog": 1,
      "little_dog": 1,
      "cage_aquarium": 1,
      "not_allow": 0
    },
    "service": {
      "internet": 1,
      "tv": 1,
      "tv_sat": 1,
      "phone": 1
    },
    "composition": {
      "bar": 0,
      "living": 0,
      "dining": 0,
      "separate_toilet": 0,
      "open_kitchen": 1
    },
    "heating": {
      "electric": 1,
      "solar": 0,
      "gaz": 0,
      "condensation": 0,
      "fuel": 0,
      "heat_pump": 0,
      "floor_heating": 0
    },
    "transport": {
      "bicycle_path": 1,
      "public_transport": 1,
      "public_bike": 1,
      "subway": 1,
      "train_station": 1
    },
    "security": {
      "guardian": 1,
      "alarm": 1,
      "intercom": 1,
      "camera": 1,
      "smoke_dectector": 1
    }
  }
}

Reponse

{
  "meta_title": "Apartement For sale Montreal - 6 rooms",
  "meta_description": "For sale Apartement Montreal - 6 rooms - 2 bedrooms - 2 bathrooms",
  "locale": "en",
  "listed_by": {
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "picture_url": "http://lorempicsum.com/futurama/255/200/5",
    "email": "jonhdoe@email.com",
    "phone": "514 123 4578",
    "presentation_text": {
      "fr": "Courtier immobilier résidentiel",
      "en": "Residential Real Estate Broker",
      "es": null,
      "it": ""
    },
    "agency": {
      "name": "John Doe Agency",
      "logo_url": "http://lorempicsum.com/futurama/350/200/6"
    },
    "agency_office": {
      "name": "SIEGE SOCIAL"
    }
  },
  "id": 149,
  "uid": "50",
  "master": 1,
  "reference": "your_ref",
  "account_id": 2,
  "account_uid": "123",
  "building": {
    "id": 12,
    "uid": "3",
    "name": "Le nordelec",
    "cover_url": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_697_large.jpg",
    "cover_url_hd": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_697_hd.jpg"
  },
  "online": 1,
  "classification_id": 201,
  "classification": {
    "fr": "Appartement",
    "en": "Apartement",
    "category": {
      "id": 2,
      "fr": "Appartement",
      "en": "Apartement"
    }
  },
  "status_id": 1,
  "status": {
    "fr": "Neuf",
    "en": "New"
  },
  "listing_id": 2,
  "listing": {
    "fr": "À Louer",
    "en": "For Rent"
  },
  "unit": "Appt #603",
  "level": 6,
  "cadastre": "nordelec-603",
  "flag_id": 1,
  "flag": {
    "fr": "Nouveauté",
    "en": "Newness"
  },
  "year_of_built": 2012,
  "availability_date": "2017-01-16",
  "is_luxurious": 1,
  "address": {
    "address_visibility": 1,
    "address_formatted": "1740 Rue St-Patrick, Montréal, QC H3K 2H2, Canada",
    "street_number": "1740",
    "street_name": "Rue Saint-Patrick",
    "zipcode": "H3K 2H2",
    "locality": "Montréal",
    "sublocality": "Pointe-Saint-Charles",
    "administrative_area_level1": "Québec",
    "administrative_area_level2": "Communauté-Urbaine-de-Montréal",
    "country": "CA",
    "latitude": 45.4854,
    "longitude": -73.5629
  },
  "area": {
    "living": 1000,
    "balcony": 20,
    "land": null,
    "unit_id": 2
  },
  "rooms": {
    "rooms": 3,
    "bathrooms": 1,
    "bedrooms": 1,
    "showerrooms": null
  },
  "title": {
    "fr": "Superbe Appartement",
    "en": "superb Apartment",
    "de": "Superb Wohnung",
    "nl": "schitterend Appartement",
    "it": "schitterend Appartement",
    "es": "Excelente Apartamento",
    "pt": "Excelente Apartamento"
  },
  "description_short": {
    "fr": "Construit en 1913, le Nordelec demeure un exemple remarquable...",
    "en": "Built in 1913, the Nordelec remains an outstanding example ...",
    "de": "Erbaut im Jahr 1913, bleibt die Nordelec ein hervorragendes Beispiel ...",
    "nl": "Gebouwd in 1913, de Nordelec blijft een uitstekend voorbeeld ...",
    "it": "Costruito nel 1913, il Nordelec rimane un esempio eccezionale ...",
    "es": "Construido en 1913, el Nordelec sigue siendo un ejemplo sobresaliente ...",
    "pt": "Construído em 1913, o Nordelec continua a ser um exemplo notável ..."
  },
  "description": {
    "fr": "<p><span>Un des beaux avantages de la vie aux condos Nordelec est l’accès exclusif à des espaces communs peu ordinaires</span></p>",
    "en": "<p><span>One of the beautiful advantages of living in the condos is Nordelec exclusive access to unusual public areas</span></p>",
    "de": "<p><span>Einer der schönsten Vorteile in den Eigentumswohnungen leben, ist Nordelec exklusiven Zugang zu ungewöhnlichen öffentlichen Bereichen</span></p>",
    "nl": "<p><span>Een van de prachtige voordelen van het wonen in de appartementen is Nordelec exclusieve toegang tot ongebruikelijke openbare ruimten</span></p>",
    "it": "<p><span>Una delle belle vantaggi di vivere in condomini è l'accesso esclusivo a Nordelec insolite aree pubbliche</span></p>",
    "es": "<p><span>Una de las hermosas ventajas de vivir en los condominios es Nordelec acceso exclusivo a las zonas comunes inusuales</span></p>",
    "pt": "<p><span>Uma das belas vantagens de viver em condomínios é de acesso exclusivo Nordelec para espaços públicos incomuns</span></p>"
  },
  "url": {
    "fr": "http://www.exemple.com/fr/55",
    "en": "http://www.exemple.com/en/55",
    "de": "http://www.exemple.com/de/55",
    "nl": "http://www.exemple.com/nl/55",
    "it": "http://www.exemple.com/it/55",
    "es": "http://www.exemple.com/es/55",
    "pt": "http://www.exemple.com/pt/55"
  },
  "financial": {
    "price_with_tax": 1,
    "price_from": 0,
    "fees_frequency": 1,
    "rent_frequency": 30,
    "currency": "CAD",
    "price_formatted": "$1,150/month",
    "price": null,
    "rent": 1150,
    "fees": 140,
    "tax1_annual": 1500,
    "tax2_annual": 2541,
    "income_annual": null,
    "formatted": {
      "price": null,
      "rent": "$1,150",
      "fees": "$140",
      "tax1_annual": "$1,500",
      "tax2_annual": "$2,541",
      "income_annual": null
    }
  },
  "cover_url": "https://s3.amazonaws.com/shareimmo/development/properties/149/shareimmo_149_697_large.jpg",
  "cover_url_hd": "https://s3.amazonaws.com/shareimmo/development/properties/149/shareimmo_149_697_hd.jpg",
  "pictures": {
    "in_progess": true
  },
  "france": {
    "dpe_indice": null,
    "dpe_value": null,
    "dpe_id": null,
    "ges_indice": null,
    "ges_value": null,
    "alur_is_condo": null,
    "alur_units": null,
    "alur_uninhabitables": null,
    "alur_spending": null,
    "alur_legal_action": null,
    "rent_honorary": null,
    "rent_honorary_visit": null,
    "rent_honorary_edl": null,
    "mandat_exclusif": null
  },
  "belgium": {
    "peb_indice": null,
    "peb_value": null,
    "peb_id": null,
    "building_permit": null,
    "done_assignments": null,
    "preemption_property": null,
    "subdivision_permits": null,
    "sensitive_flood_area": null,
    "delimited_flood_zone": null,
    "risk_area": null
  },
  "videos": [

  ],
  "other": {
    "orientation": {
      "north": 1,
      "south": 0,
      "east": 0,
      "west": 1
    },
    "inclusion": {
      "air_conditioning": 1,
      "hot_water": 1,
      "heated": 1,
      "electricity": 0,
      "furnished": 0,
      "fridge": 1,
      "cooker": 1,
      "dishwasher": 1,
      "dryer": 1,
      "washer": 1,
      "microwave": 0
    },
    "detail": {
      "elevator": 1,
      "laundry": 0,
      "garbage_chute": 1,
      "common_space": 1,
      "janitor": 1,
      "gym": 1,
      "golf": 1,
      "tennis": 1,
      "sauna": 1,
      "spa": 1,
      "inside_pool": 0,
      "outside_pool": 1,
      "inside_parking": 1,
      "outside_parking": 1,
      "parking_on_street": 1,
      "garagebox": 0
    },
    "half_furnsihed": {
      "living_room": 0,
      "bedrooms": 0,
      "kitchen": 0,
      "other": 0
    },
    "indoor": {
      "attic": 0,
      "attic_convertible": 0,
      "attic_converted": 0,
      "cellar": 0,
      "central_vacuum": 0,
      "entries_washer_dryer": 1,
      "entries_dishwasher": 1,
      "fireplace": 0,
      "storage": 1,
      "walk_in": 1,
      "no_smoking": 1,
      "double_glazing": 0,
      "triple_glazing": 1
    },
    "floor": {
      "carpet": 0,
      "wood": 1,
      "floating": 0,
      "ceramic": 0,
      "parquet": 0,
      "cushion": 0,
      "vinyle": 0,
      "lino": 0,
      "marble": 0
    },
    "exterior": {
      "land_access": 0,
      "back_balcony": 0,
      "front_balcony": 1,
      "private_patio": 1,
      "storage": 1,
      "terrace": 1,
      "veranda": 0,
      "garden": 0,
      "sea_view": 0,
      "mountain_view": 0
    },
    "accessibility": {
      "elevator": 0,
      "balcony": 0,
      "grab_bar": 0,
      "wider_corridors": 0,
      "lowered_switches": null,
      "ramp": 0
    },
    "senior": {
      "autonomy": 0,
      "half_autonomy": 0,
      "no_autonomy": 0,
      "meal": 0,
      "nursery": 0,
      "domestic_help": 0,
      "community": 0,
      "activities": 0,
      "validated_residence": 0,
      "housing_cooperative": 0
    },
    "pet": {
      "allow": 1,
      "cat": 1,
      "dog": 1,
      "little_dog": 1,
      "cage_aquarium": 1,
      "not_allow": 0
    },
    "service": {
      "internet": 1,
      "tv": 1,
      "tv_sat": 1,
      "phone": 1
    },
    "composition": {
      "bar": 0,
      "living": 0,
      "dining": 0,
      "separe_toilet": 0,
      "open_kitchen": 1
    },
    "heating": {
      "electric": 1,
      "solar": 0,
      "gaz": 0,
      "condensation": 0,
      "fuel": 0,
      "heat_pump": 0,
      "floor_heating": 0
    },
    "transport": {
      "bicycle_path": 1,
      "public_transport": 1,
      "public_bike": 1,
      "subway": 1,
      "train_station": 1
    },
    "security": {
      "guardian": 1,
      "alarm": 1,
      "intercom": 1,
      "camera": 1,
      "smoke_dectector": 1
    }
  }
}

Retrieve a property

GET https://shareimmo.com/api/v2/properties/:uid
Attributes  
uid
string		 Your identifier of the property to be retrieved

Reponse

{
  "meta_title": "Apartement For sale Montreal - 6 rooms",
  "meta_description": "For sale Apartement Montreal - 6 rooms - 2 bedrooms - 2 bathrooms",
  "locale": "en",
  "listed_by": {
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "picture_url": "http://lorempicsum.com/futurama/255/200/5",
    "email": "jonhdoe@email.com",
    "phone": "514 123 4578",
    "presentation_text": {
      "fr": "Courtier immobilier résidentiel",
      "en": "Residential Real Estate Broker",
      "es": null,
      "it": ""
    },
    "agency": {
      "name": "John Doe Agency",
      "logo_url": "http://lorempicsum.com/futurama/350/200/6"
    },
    "agency_office": {
      "name": "SIEGE SOCIAL"
    }
  },
  "id": 123,
  "uid": "123A456_7890",
  "reference": "1234",
  "api_provider_id": 12,
  "is_sync_with_api": 12,
  "master": 1,
  "account_id": 12,
  "account_uid": null,
  "is_furnished": null,
  "virtual_visit_link": null,
  "youtube_link": null,
  "homestaging_link": null,
  "created_at": "2017-04-27T17:42:03.000-04:00",
  "updated_at": "2017-04-28T10:56:40.000-04:00",
  "building": {
    "id": null,
    "uid": null,
    "name": null,
    "cover_url": "https://placehold.co/1920X1280.jpeg",
    "cover_url_hd": "https://placehold.co/1920X1280.jpeg"
  },
  "contacts": [

  ],
  "online": 1,
  "classification_id": 201,
  "classification": {
    "fr": "Appartement",
    "en": "Apartment",
    "es": "Departamento",
    "it": "Appartamento",
    "category": {
      "id": 2,
      "fr": "Appartement",
      "en": "Apartement",
      "es": "Departamento",
      "it": "Appartamento"
    }
  },
  "status_id": 2,
  "status": {
    "fr": "Ancien",
    "en": "Used property",
    "es": null,
    "it": "Usate"
  },
  "listing_id": 1,
  "listing": {
    "fr": "À vendre",
    "en": "For sale",
    "es": "En venta",
    "it": "In Vendita"
  },
  "unit": "",
  "units": null,
  "level": 1,
  "levels": null,
  "cadastre": "",
  "flag_id": null,
  "year_of_built": null,
  "availability_date": null,
  "is_luxurious": null,
  "address": {
    "address_visibility": 1,
    "address_formatted": null,
    "street_number": null,
    "street_name": null,
    "zipcode": "57300",
    "locality": "MONDELANGE",
    "sublocality": null,
    "administrative_area_level1": "",
    "administrative_area_level2": "",
    "country": "FR",
    "latitude": 0,
    "longitude": 0,
    "google_place_id": null
  },
  "area": {
    "living": 78,
    "balcony": null,
    "land": null,
    "unit_id": 1,
    "formatted": {
      "living": "78 m<sup>2</sup>",
      "balcony": null,
      "land": null
    }
  },
  "rooms": {
    "rooms": 4,
    "bathrooms": null,
    "bedrooms": 3,
    "showerrooms": null,
    "toilets": null,
    "beds": null,
    "people_capacity": null
  },
  "title": {
    "fr": "Appartement Mondelange F4 78,60 m2",
    "en": "",
    "es": "",
    "it": ""
  },
  "description_short": {
    "fr": "",
    "en": "",
    "es": "",
    "it": ""
  },
  "description": {
    "fr": "Grande pièce à vivre lumineuse pour ce beau f4, 3 belles chambres, une salle de bains, cuisine. Beau potentiel ! Travaux à prévoir",
    "en": "",
    "es": "",
    "it": ""
  },
  "url": {
    "fr": "",
    "en": "",
    "es": "",
    "it": ""
  },
  "financial": {
    "price_with_tax": 1,
    "price_from": 0,
    "price_unit_id": null,
    "rent_frequency": null,
    "rent_unit_id": null,
    "fees_frequency": 1,
    "currency": "EUR",
    "price_formatted": "111825€",
    "price": 111825,
    "rent": null,
    "fees": null,
    "tax1_annual": null,
    "tax2_annual": null,
    "income_annual": null,
    "deposit": null,
    "seller_honorary_percentage": null,
    "seller_honorary": null,
    "buyer_honorary_percentage": null,
    "buyer_honorary": null,
    "seller_net_price": null,
    "total_honorary": 0,
    "other_fees": null,
    "inventory": null,
    "property_fees_payment_method_id": null,
    "property_honorary_payment_method_id": null,
    "formatted": {
      "price": "111 825 €",
      "rent": null,
      "fees": null,
      "tax1_annual": null,
      "tax2_annual": null,
      "income_annual": null,
      "deposit": null,
      "seller_honorary": null,
      "buyer_honorary": null,
      "total_honorary": "0 €",
      "seller_net_price": null,
      "other_fees": null,
      "inventory": null
    }
  },
  "cover_url": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
  "cover_url_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
  "pictures": [
    {
      "medium": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "medium_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "medium_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "large": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "large_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "large_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "original_optimized": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "original": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "name": {
        "fr": null,
        "en": null,
        "es": null,
        "it": null
      }
    },
    {
      "medium": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "medium_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "medium_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "large": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "large_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "large_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "original_optimized": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "original": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "name": {
        "fr": null,
        "en": null,
        "es": null,
        "it": null
      }
    },
    {
      "medium": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "medium_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "medium_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "large": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "large_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "large_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "original_optimized": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "original": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "name": {
        "fr": null,
        "en": null,
        "es": null,
        "it": null
      }
    },
    {
      "medium": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "medium_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "medium_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "large": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "large_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "large_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "original_optimized": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "original": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "name": {
        "fr": null,
        "en": null,
        "es": null,
        "it": null
      }
    },
    {
      "medium": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "medium_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "medium_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "large": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "large_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "large_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "original_optimized": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "original": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "name": {
        "fr": null,
        "en": null,
        "es": null,
        "it": null
      }
    },
    {
      "medium": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "medium_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "medium_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "large": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "large_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "large_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "original_optimized": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "original": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "name": {
        "fr": null,
        "en": null,
        "es": null,
        "it": null
      }
    }
  ],
  "documents": [

  ],
  "france": {
    "dpe_indice": "",
    "dpe_value": "",
    "dpe_id": "",
    "ges_indice": "",
    "ges_value": "",
    "alur_is_condo": null,
    "alur_units": null,
    "alur_uninhabitables": null,
    "alur_spending": null,
    "alur_legal_action": null,
    "alur_designation_agent": null,
    "alur_designation_administrator": null,
    "alur_designation_expert": null,
    "mandat_exclusif": 0
  },
  "belgium": {
    "peb_indice": null,
    "peb_value": null,
    "peb_id": "",
    "building_permit": null,
    "done_assignments": null,
    "preemption_property": null,
    "subdivision_permits": null,
    "sensitive_flood_area": null,
    "delimited_flood_zone": null,
    "risk_area": null
  },
  "other": {
    "orientation": {
      "north": null,
      "south": null,
      "east": null,
      "west": null
    },
    "inclusion": {
      "air_conditioning": null,
      "hot_water": null,
      "heated": null,
      "electricity": null,
      "furnished": null,
      "fridge": null,
      "cooker": null,
      "dishwasher": null,
      "dryer": null,
      "washer": null,
      "microwave": null
    },
    "detail": {
      "elevator": null,
      "laundry": null,
      "garbage_chute": null,
      "common_space": null,
      "janitor": null,
      "gym": null,
      "golf": null,
      "tennis": null,
      "sauna": null,
      "spa": null,
      "inside_pool": null,
      "outside_pool": null,
      "inside_parking": 0,
      "outside_parking": null,
      "parking_on_street": null,
      "garagebox": 0,
      "staff_room": 0
    },
    "half_furnished": {
      "living_room": null,
      "bedrooms": null,
      "kitchen": null,
      "other": null
    },
    "indoor": {
      "attic": null,
      "attic_convertible": null,
      "attic_converted": null,
      "cellar": 1,
      "central_vacuum": null,
      "entries_washer_dryer": null,
      "entries_dishwasher": null,
      "fireplace": null,
      "storage": null,
      "walk_in": null,
      "no_smoking": null,
      "double_glazing": null,
      "triple_glazing": null
    },
    "floor": {
      "carpet": null,
      "wood": null,
      "floating": null,
      "ceramic": null,
      "parquet": null,
      "cushion": null,
      "vinyle": null,
      "lino": null,
      "marble": null
    },
    "exterior": {
      "land_access": null,
      "back_balcony": 0,
      "front_balcony": null,
      "private_patio": null,
      "storage": null,
      "terrace": 0,
      "veranda": null,
      "garden": null,
      "sea_view": null,
      "mountain_view": null
    },
    "accessibility": {
      "elevator": null,
      "balcony": null,
      "grab_bar": null,
      "wider_corridors": null,
      "lowered_switches": null,
      "ramp": null
    },
    "senior": {
      "autonomy": null,
      "half_autonomy": null,
      "no_autonomy": null,
      "meal": null,
      "nursery": null,
      "domestic_help": null,
      "community": null,
      "activities": null,
      "validated_residence": null,
      "housing_cooperative": null
    },
    "pet": {
      "allow": null,
      "cat": null,
      "dog": null,
      "little_dog": null,
      "cage_aquarium": null,
      "not_allow": null
    },
    "service": {
      "internet": null,
      "tv": null,
      "tv_sat": null,
      "phone": null
    },
    "composition": {
      "bar": null,
      "living": null,
      "dining": null,
      "separe_toilet": null,
      "open_kitchen": null
    },
    "heating": {
      "electric": 0,
      "solar": 0,
      "gaz": 0,
      "condensation": null,
      "fuel": 0,
      "heat_pump": 0,
      "floor_heating": null
    },
    "transport": {
      "bicycle_path": null,
      "public_transport": null,
      "public_bike": null,
      "subway": null,
      "train_station": null
    },
    "security": {
      "guardian": null,
      "alarm": null,
      "intercom": null,
      "camera": null,
      "smoke_dectector": null
    }
  }
}

Get the uids of all your properties

This method will return the uids of all your properties, with their status online/offline.

GET https://shareimmo.com/api/v2/properties/get_uids

Reponse

{
  "uids": [
    {
      "uid": "3",
      "online": 0
    },
    {
      "uid": "145",
      "online": 1
    }
  ]
}

Delete a property

DELETE https://shareimmo.com/api/v2/properties/:uid
Attributes  
uid
string		 Your identifier of the property to be deleted

Reponse

{
  "id": 149,
  "uid": "50",
  "account_id": 2,
  "account_uid": "123",
  "message": "Property deletion was launched"
}

Deactivate a property

Set offline without deleting it. This method will deactivate your property, without deleting it.

POST https://shareimmo.com/api/v2/properties/deactivate/:uid
Attributes  
uid
string		 Your identifier of the property to be deactivated

Reponse

{
  "id": 149,
  "uid": "50",
  "account_id": 2,
  "account_uid": "123",
  "message": "Property with uid 50 deactivated"
}

Contacts

This is an object representing a shareimmo contacts

Create & Update a contact

POST|PUT https://shareimmo.com/api/v2/contacts
Attributes  
uid
string
required
 The unique identifier of the contacts in your system (must be unique)
account_uid
string
required
 This entry is used to allocate a contact to a user
email
string
required
 Contact email
civility
integer		 Contact civility
1 - Mister
2- Madam
3- Miss
first_name
string		 Contact first name
last_name
string		 Contact last name
phone
string		 Contact phone
mobile
string		 Contact mobile
type_id
integer		 Contact type
1 - owner
2- tenant
3- agent
4- manager
5 - Co-worker
type.fr
string		 Denomination of type in french
type.en
string		 Denomination of type in english
type.es
string		 Denomination of type in spanish
type.it
string		 Denomination of type in italian
iban
string		 Contact International Bank Account Number
job.fr
string		 Contact Job in french
job.en
string		 Contact Job in english
job.es
string		 Contact Job in spanish
job.it
string		 Contact Job in italian
website
string		 Contact Website
address.street_name
string		  
address.city
string		  
address.locality
string		  
address.zipcode
string		  
address.country
string		 The country attached to the account with ISO 3166-1 alpha-2 standard
picture_url
string		 Max: 2Mo Square format for the best result (500x500)

Call

{
  "uid": "4",
  "account_uid": "123",
  "email": "johndoe@bienvenue.com",
  "last_name": "John",
  "first_name": "Doe",
  "type": 2,
  "phone": "+1 514 123 4567",
  "address": {
    "street_name": "460, rue Sainte-Catherine Ouest",
    "city": "Montréal",
    "zipcode": "h3E 0A8",
    "country": "CA"
  },
  "picture_url": "https://randomuser.me/api/portraits/men/80.jpg"
}

Reponse

{
  "id": 16,
  "uid": "4",
  "api_provider_id": 21,
  "account_uid": "123",
  "email": "johndoe@bienvenue.com",
  "first_name": "John",
  "last_name": "Doe",
  "phone": "+1 514 123 4567",
  "mobile": null,
  "civility_id": null,
  "type_id": 2,
  "type": {
    "fr": "Locataire",
    "en": "Tenant",
    "es": "Inquilino",
    "it": "Inquilino"
  },
  "job": {
    "fr": null,
    "en": null,
    "es": null,
    "it": null
  },
  "iban": null,
  "website": null,
  "address": {
    "street_name": "460, rue Sainte-Catherine Ouest",
    "city": "Montréal",
    "zipcode": "h3E 0A8",
    "country": "CA"
  },
  "picture_url": "https://s3.amazonaws.com/shareimmo/development/property_contact/picture/82a0f2d4-3dbd-413c-8e75-17532452dc24.jpg"
}

Retrieve a contact

GET https://shareimmo.com/api/v2/contacts/:uid
Attributes  
uid
string		 Your identifier of the contact to be retrieved

Reponse

{
  "id": 16,
  "uid": "4",
  "api_provider_id": 21,
  "account_uid": "123",
  "email": "johndoe@bienvenue.com",
  "first_name": "John",
  "last_name": "Doe",
  "phone": "+1 514 123 4567",
  "mobile": null,
  "civility_id": null,
  "type_id": 2,
  "type": {
    "fr": "Locataire",
    "en": "Tenant",
    "es": "Inquilino",
    "it": "Inquilino"
  },
  "job": {
    "fr": null,
    "en": null,
    "es": null,
    "it": null
  },
  "iban": null,
  "website": null,
  "address": {
    "street_name": "460, rue Sainte-Catherine Ouest",
    "city": "Montréal",
    "zipcode": "h3E 0A8",
    "country": "CA"
  },
  "picture_url": "https://s3.amazonaws.com/shareimmo/development/property_contact/picture/82a0f2d4-3dbd-413c-8e75-17532452dc24.jpg"
}

Delete a contact

DELETE https://shareimmo.com/api/v2/contacts/:uid
Attributes  
uid
string		 Your identifier of the contact to be deleted

Reponse

{
  "id": 35,
  "uid": "4",
  "account_id": 2,
  "account_uid": "123",
  "message": "Contact deletion was launched"
}

Associate a contact to a property

POST https://shareimmo.com/api/v2/contacts/property
Attributes  
contact_uid
string		 Your identifier of the contact
property_uid
string		 Your identifier of the property

Call

{
  "contact_uid": "4",
  "property_uid": "50"
}

Reponse

{
  "uid": "4",
  "property_uid": "50",
  "message": "Contact was associated to property"
}

Searches

By defaults api Key/Token are not authorized on search API. To activated them, please contact us

Search Buildings

GET https://shareimmo.com/api/v2/search/buildings
Filters attributes  
bounds
polygon		 Polygon of coordinates separated by commas.The first coordinate is the South-West corner, and the second is the North-East
custom_circle
string		 Center,Lat,Lng Example : 46.56966,-72.77421,1290.172
custom_poly
polygon		 Polygon of coordinates separated by commas. Example : 46.58022059737275,-72.76528358459473,46.56464375460338,-72.79034614562988,46.553430379448706,-72.75472640991211,46.5681253311492,-72.75429725646973,46.5700135503882,-72.7694034576416
keywords
string		 The keywords to look up for properties which contain this keyword anywhere in their description (you can add several separated by commas). This parameter isn't discriminating
reference
string		 The number which represents the reference of your property in Shareimmo, without the # at the beginning
id
string		 ids of buildings (you can add several separated by commas)
country
string		 countries of properties ISO 3166 (ex: CA,US,FR)(you can add several separated by commas)
Pagination attributes  
page
integer		 The number of the page of properties you are currently looking at on the website
per_page
integer		 The number of the page of properties you are currently looking at on the website
order_by
string		 The parameter you want to order the properties by. Can be any of the building search parameters
order
string		 The order of the buildings (default is 'asc')
asc - Ascendant
desc - Descendant

Reponse

{
  "took": 0,
  "pagination": {
    "total": 1,
    "current_page": 1,
    "previous_page": null,
    "next_page": null,
    "length": 1,
    "offset": 0,
    "from": 1,
    "to": 1,
    "formatted": "1-1 sur 1"
  },
  "buildings": [
    {
      "_index": "shareimmo_development_buildings",
      "_type": "building",
      "_id": "13",
      "_score": 0,
      "_source": {
        "id": 13,
        "uid": "3",
        "draft": 0,
        "api_provider_id": 21,
        "user_id": 1,
        "address": "1740 Rue St-Patrick, Montréal, QC H3K 2H2, Canada",
        "location_geohash": "f25dy035sjn",
        "locality": "Montréal",
        "country": "CA",
        "cover_url": "https://cdheefyn.cloudimg.io/s/width/960/http://lorempicsum.com/nemo/627/300/9",
        "updated_at": "2018-02-22",
        "units": 8,
        "name": "Le nordelec",
        "location": {
          "lat": 45.4854,
          "lon": -73.5629
        },
        "description_short": {
          "fr": "Construit en 1913, le Nordelec demeure un exemple remarquable...",
          "en": "Built in 1913, the Nordelec remains an outstanding example ...",
          "es": "Construido en 1913, el Nordelec sigue siendo un ejemplo sobresaliente ...",
          "it": "Costruito nel 1913, il Nordelec rimane un esempio eccezionale ..."
        },
        "building_classification": {
          "id": 102,
          "fr": "Immeuble de caractère",
          "en": "Building Caracter",
          "es": "Edificio de carácter",
          "it": "Edificio affascinante"
        }
      }
    }
  ]
}

Search Building

This method returns an object building

GET https://shareimmo.com/api/v2/search/buildings/:id
Attributes  
id
string
required
 the shareimmo's id of the building

Response

{
  "id": 12,
  "uid": "3",
  "account_id": 2,
  "account_uid": "123",
  "name": "Le nordelec",
  "units": 250,
  "levels": 8,
  "address": {
    "address_formatted": "1740 Rue St-Patrick, Montréal, QC H3K 2H2, Canada",
    "street_number": "1740",
    "street_name": "Rue Saint-Patrick",
    "zipcode": "H3K 2H2",
    "locality": "Montréal",
    "sublocality": "Pointe-Saint-Charles",
    "administrative_area_level1": "Québec",
    "administrative_area_level2": "Communauté-Urbaine-de-Montréal",
    "country": "CA",
    "latitude": 45.4854,
    "longitude": -73.5629
  },
  "description_short": {
    "fr": "Construit en 1913, le Nordelec demeure un exemple remarquable...",
    "en": "Built in 1913, the Nordelec remains an outstanding example ...",
    "it": "Costruito nel 1913, il Nordelec rimane un esempio eccezionale ...",
    "es": "Construido en 1913, el Nordelec sigue siendo un ejemplo sobresaliente ..."
  },
  "description": {
    "fr": "<p><span>Un des beaux avantages de la vie aux condos Nordelec est l’accès exclusif à des espaces communs peu ordinaires</span></p>",
    "en": "<p><span>One of the beautiful advantages of living in the condos is Nordelec exclusive access to unusual public areas</span></p>",
    "it": "<p><span>Una delle belle vantaggi di vivere in condomini è l'accesso esclusivo a Nordelec insolite aree pubbliche</span></p>",
    "es": "<p><span>Una de las hermosas ventajas de vivir en los condominios es Nordelec acceso exclusivo a las zonas comunes inusuales</span></p>"
  },
  "pictures": [
    {
      "small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_56_small.jpg",
      "medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_56_medium.jpg",
      "large": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_56_large.jpg",
      "hd_small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_56_hd_s.jpg",
      "hd_medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_56_hd_m.jpg",
      "hd": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_56_hd.jpg"
    },
    {
      "small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_55_small.jpg",
      "medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_55_medium.jpg",
      "large": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_55_large.jpg",
      "hd_small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_55_hd_s.jpg",
      "hd_medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_55_hd_m.jpg",
      "hd": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_55_hd.jpg"
    },
    {
      "small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_53_small.jpg",
      "medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_53_medium.jpg",
      "large": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_53_large.jpg",
      "hd_small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_53_hd_s.jpg",
      "hd_medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_53_hd_m.jpg",
      "hd": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_53_hd.jpg"
    },
    {
      "small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_40_small.jpg",
      "medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_40_medium.jpg",
      "large": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_40_large.jpg",
      "hd_small": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_40_hd_s.jpg",
      "hd_medium": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_40_hd_m.jpg",
      "hd": "https://s3.amazonaws.com/shareimmo/development/buildings/12/shareimmo_12_40_hd.jpg"
    }
  ]
}

Search Properties

GET https://shareimmo.com/api/v2/search/properties
Filters attributes  
price_from
integer		 The minimum price of the properties
price_to
integer		 The maximum price of the properties
area_from
integer		 The minimum surface of the properties
area_to
integer		 The maximum surface of the properties
classification
string		 you can add several separated by commas
1 - House
2 - Condo
3 - Garage
4 - Land
5 - Building
6 - Allotment
7 - Residence
8 - Commercial
subclassification
integer		 you can add several separated by commas See classification list above
listing
integer		 Wether your property is for sale or for rent (you can add several separated by commas)
1 - For Sale
2 - For Rent
status
integer		 Wether you property is new or not (you can add several separated by commas)
1 - New
2 - Not new
rooms
integer		 The number of rooms
rooms_from
integer		 The minimum number of rooms
rooms_to
integer		 The maximum number of rooms
bedrooms
integer		 The number of bedrooms
bedrooms_from
integer		 The minimum number of bedrooms
bedrooms_to
integer		 The maximum number of bedrooms
bathrooms
integer		 The number of bathrooms
bathrooms_from
integer		 The minimum number of bathrooms
bathrooms_to
integer		 The maximum number of bathrooms
showerrooms
integer		 The number of showerrooms
showerrooms_from
integer		 The minimum number of showerrooms
showerrooms_to
integer		 The maximum number of showerrooms
keywords
string		 The keywords to look up for properties which contain this keyword anywhere in their description (you can add several separated by commas). This parameter isn't discriminating
flag
string		 The flags on the properties you want to receive (you can add several separated by commas)
1 - Newness
2 - Price Reduction
3 - Open House
4 - Favorite
5 - Sold/Rented
6 - Compromised
7 - Off MLS
8 - Under offer
9 - No longer available
reference
integer		 The number which represents the reference of your property
user
string		 The user who posted the properties (you can add several separated by commas)
id
string		 ids of properties (you can add several separated by commas)
country
string		 countries of properties ISO 3166 (ex: CA,US,FR)(you can add several separated by commas)
building
integer		 ids of buildings (you can add several separated by commas)
bounds
polygon		 Polygon of coordinates separated by commas The first coordinate is the South-West corner, and the second is the North-East corner<
custom_poly
polygon		 Polygon of coordinates separated by commas which corresponds to a custom polygon containing the properties
Example : 46.58022059737275,-72.76528358459473,46.56464375460338,-72.79034614562988,46.553430379448706,-72.75472640991211,46.5681253311492,-72.75429725646973,46.5700135503882,-72.7694034576416
provider
string		 the id of provider (you can add several separated by commas). Exemple 12,13,24
sold_rented
string		 Does your property is for sale or for rent (you can add several separated by commas)
1 - For Sale
  • 2 - For Rent
    		•
    is_luxurious
    string    		 Levels of luxury of your properties (you can add several separated by commas)
    Options attributes  
    page
    integer    		 The number of the page of properties you are currently looking at on the website
    per_page
    integer    		 The number of the page of properties you are currently looking at on the website
    order_by
    string    		 The parameter you want to order the properties by. Can be any of the building search parameters execpt bounds,customcircle,custompoly
    order
    string    		 The order of the propeties (default is 'asc')
    asc - Ascendant
  • desc - Descendant
    		•

    Reponse

    {
  "took": 0,
  "pagination": {
    "total": 5,
    "current_page": 1,
    "previous_page": null,
    "next_page": 2,
    "length": 1,
    "offset": 0,
    "from": 1,
    "to": 1,
    "formatted": "1-1 sur 5"
  },
  "properties": [
    {
      "_index": "shareimmo_development_properties",
      "_type": "property",
      "_id": "1385",
      "_score": 0,
      "_source": {
        "id": 1385,
        "uid": "99999985",
        "reference": "99999985",
        "draft": 0,
        "api_provider_id": 14,
        "is_sync_with_api": 14,
        "user_id": 1,
        "is_luxurious": null,
        "sold_rented": 0,
        "status": 1,
        "address": "1006 Rue Bishop, H3G0A7, Montréal",
        "price": 439900,
        "currency": "cad",
        "price_formatted": "$439,900+TVQ/TPS",
        "prices_formatted": {
          "fr": "$439,900+TVQ/TPS",
          "en": "$439,900+TVQ/TPS",
          "es": "$439,900+TVQ/TPS",
          "it": "$439,900+TVQ/TPS"
        },
        "price_with_tax": 0,
        "price_from": 0,
        "location_geohash": "f25dvf1m2d9",
        "cover_url": "https://cdheefyn.cloudimg.io/s/width/960/--immosquare--/storeimmo/shared/properties_demo/shareimmo_134169_3907910_original.jpeg",
        "cover_url_hd": "https://cdheefyn.cloudimg.io/fit/960x640/c000000/--immosquare--/storeimmo/shared/properties_demo/shareimmo_134169_3907910_original.jpeg",
        "area": 91,
        "area_formatted": "91 m<sup>2</sup>",
        "created_at": "2018-01-18",
        "updated_at": "2018-02-21",
        "link": "/fr/ad/1385",
        "rooms": 6,
        "bedrooms": 2,
        "bathrooms": 1,
        "showerrooms": null,
        "units": null,
        "locality": "Montréal",
        "sublocality": "Le Plateau-Mont-Royal ",
        "country": "CA",
        "unit": "904",
        "geocodable": true,
        "location": {
          "lat": 45.4953,
          "lon": -73.5737
        },
        "property_listing": {
          "id": 1,
          "fr": "À vendre",
          "en": "For sale",
          "es": "En venta",
          "it": "In Vendita"
        },
        "property_status": {
          "id": 2,
          "fr": "Ancien",
          "en": "Used property",
          "es": null,
          "it": "Usate"
        },
        "property_flag": {
          "id": 3,
          "fr": "Visite libre",
          "en": "Open house",
          "es": "Casa abierta",
          "it": "Casa aperta"
        },
        "property_classification": {
          "id": 201,
          "fr": "Appartement",
          "en": "Apartment",
          "es": "Departamento",
          "it": "Appartamento",
          "category": {
            "id": 2,
            "fr": "Appartement",
            "en": "Apartement",
            "es": "Departamento",
            "it": "Appartamento"
          }
        },
        "title": {
          "fr": "Appartement - 1006 Rue Bishop",
          "en": "Apartment - 1006 Rue Bishop",
          "es": "",
          "it": null
        },
        "description_short": {
          "fr": "En plein coeur du Plateau Mont-Royal, sur une belle rue tranquille à quelques minutes des métros Laurier et Mont-Royal. Jardin à usage privatif. Belle pièce de vie à aire ouverte pour cuisine salon. Deux chambres, balcon et remise. Cuisine et salle de bain rénovée. Près de tous services et commerces et parcs.www.raymondlariviere.com",
          "en": "Right in the heart of the Plateau Mont-Royal, on a nice quiet street a few minutes away from subways Laurier and Mount-Royal. Private garden. Nice pen-air kitchen, lounge and dining room. Two becrooms with acces to the balcony. Kitchen and bathroom are renovated. Nearby all amenities and commercial and parks.www.raymondlariviere.com",
          "es": "",
          "it": null
        },
        "description": {
          "fr": "<p>En plein coeur du Plateau Mont-Royal, sur une belle rue tranquille &agrave; quelques minutes des m&eacute;tros Laurier et Mont-Royal. Jardin &agrave; usage privatif. Belle pi&egrave;ce de vie &agrave; aire ouverte pour cuisine salon. Deux chambres, balcon et remise. Cuisine et salle de bain r&eacute;nov&eacute;e. Pr&egrave;s de tous services et commerces et parcs.www.raymondlariviere.com</p><p><br></p><p><br></p><p>*** 6 mois minimum ***</p><p><br></p><p>* Les services de nettoyage disponibles &agrave; un co&ucirc;t suppl&eacute;mentaire</p><p><br></p><p>*Garage disponible pour un co&ucirc;t suppl&eacute;mentaire de 250$ par mois</p><p>*Rangement disponible pour un co&ucirc;t suppl&eacute;mentaire</p><p><br></p><p>***LOCATION.LOCATION.LOCATION***</p><p>Pres de la rue St Catherine</p><p>Entre rue St Catherine et Boul Ren&eacute; L&eacute;vesque</p><p>Pres de la Centre Bell, les restos, les pubs et les boutiques de Rue Crescent et rue la Montagne</p><p>Pharmacie Jean Coutut et Pharmaprix (2 mins) Epicerie Adonis et Provigo (2 mins)</p><p>Lucien L&#39;Allier, Bonaventure, Guy-Concordia Metro</p><p>Autobus 36,74,75,107,420,715</p><p><br></p><p>*Hauts plafonds en beton</p><p>*Unite de climatisation mural</p><p>*Balcon en beton</p><p>*Tous les accessoires de cuisine, draps, serviettes inclus</p><p>*Terrasse sur le toit</p><p>* Salle de bains avec la c&eacute;ramique italienne de haute qualit&eacute;, avec armoire fini grain de bois, douche s&eacute;par&eacute;e (douche de pluie) et baignoire, *Laveuse et s&eacute;cheuse dans l&#39;unit&eacute;</p><p>* Cuisine avec armoires sup&eacute;rieures en finition haute brillance et en bas avec une finition de grain de bois, comptoirs de quartz blanc, encastr&eacute; &eacute;vier et appareils en acier inoxydable</p><p>* Bike Zone Disponible en Garage</p><p>* B&acirc;timent de haute s&eacute;curit&eacute; avec l&#39;acc&egrave;s &eacute;lectronique et cameras</p><p>* Insonorisation sup&eacute;rieure</p><p>* Loyer peut varier en fonction de la dur&eacute;e du bail</p><p><br></p><p>*D&eacute;p&ocirc;t de s&eacute;curit&eacute; requis *Assurance responsabilit&eacute; civile obligatoire *R&eacute;f&eacute;rences requises *Pas d&#39;animaux *Non Fumeurs</p><p><br></p><p><br></p><p><strong>INCLUSIONS</strong></p><p>Tous les luminaires.</p><p><br></p><p><strong>EXCLUSIONS</strong></p><p>Po&ecirc;le, frigo, lave-vaisselle, laveuse, s&eacute;cheuse.</p><p><br></p>",
          "en": "<p>Right in the heart of the Plateau Mont-Royal, on a nice quiet street a few minutes away from subways Laurier and Mount-Royal. Private garden. Nice pen-air kitchen, lounge and dining room. Two becrooms with acces to the balcony. Kitchen and bathroom are renovated. Nearby all amenities and commercial and parks.www.raymondlariviere.com</p><p><br></p><p><br></p><p>*** Minimum 6 Month Rental ***</p><p><br></p><p>*Cleaning services available at extra cost</p><p><br></p><p>*Garage available for an additional cost of $250 per month</p><p>*Locker available for an additional cost</p><p><br></p><p>***LOCATION.LOCATION.LOCATION***</p><p>Located between rue St. Catherine and Boul Ren&eacute; L&eacute;vesque</p><p>Steps to the Bell Centre, Ste-Catherine Street shopping, cafes and restaurants of Crescent Street and Rue de la Montagne.</p><p>Jean Coutu and Pharmaprix on St Catherine (2 mins), Adonis and Provigo on St Catherine (2 mins)</p><p>Lucien-L&#39;Allier, Bonaventure, Guy-Concordia Metro</p><p>Bus 36,74,75,107,420,715</p><p><br></p><p>*High ceilings</p><p>*Split AC unit *Concrete Balcony *Locker and Garage Available for an extra cost</p><p>*All accessories, linens, towels and kitchenware included</p><p>*Rooftop Terrace *Bathroom with high quality Italian ceramics, Vanities with wood grain finish, Separate shower (Rain Shower) and Bathtub, *Washer and Dryer in the unit</p><p>*Kitchen with upper cabinets in high gloss finish and bottom with wood grain finish, white quartz countertops, undermount sink and stainless steel appliances</p><p>*Bike Area Available in Garage</p><p>*High Security Building With Camera and Electronic access passes</p><p>*Superior Sound Barrier</p><p>*Rent can vary depending on the duration of the lease</p><p><br></p><p>*Security deposit required</p><p>*Civil Liability Insurance Required</p><p>*References Required</p><p>*No Pets</p><p>*No Smokers</p><p><br></p><p><br></p><p><strong>INCLUSIONS</strong></p><p>All the lighting</p><p><br></p><p><strong>EXCLUSIONS</strong></p><p>Stove, refrigerator, dishwashing machine, washing machine, dryer.</p><p><br></p>",
          "es": "",
          "it": null
        },
        "building": {
          "id": null,
          "name": null,
          "units": null,
          "cover_url": "https://cdheefyn.cloudimg.io/s/width/960/https://placehold.co/1920X1280.jpeg",
          "cover_url_hd": "https://cdheefyn.cloudimg.io/fit/960x640/c000000/https://placehold.co/1920X1280.jpeg"
        },
        "listed_by": {
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "picture_url": "http://lorempicsum.com/futurama/255/200/5",
          "email": "jonhdoe@email.com",
          "phone": "514 123 4578",
          "presentation_text": {
            "fr": "Courtier immobilier résidentiel",
            "en": "Residential Real Estate Broker",
            "es": null,
            "it": ""
          },
          "agency": {
            "name": "John Doe Agency",
            "logo_url": "http://lorempicsum.com/futurama/350/200/6"
          },
          "agency_office": {
            "name": "SIEGE SOCIAL"
          }
        }
      }
    }
  ]
}

    Search Property

    This method returns an object building

    GET https://shareimmo.com/api/v2/search/properties/:id
    Attributes  
    id
    string
    required
    		 the shareimmo's id of the property

    Reponse

    {
  "meta_title": "Apartement For sale Montreal - 6 rooms",
  "meta_description": "For sale Apartement Montreal - 6 rooms - 2 bedrooms - 2 bathrooms",
  "locale": "en",
  "listed_by": {
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "picture_url": "http://lorempicsum.com/futurama/255/200/5",
    "email": "jonhdoe@email.com",
    "phone": "514 123 4578",
    "presentation_text": {
      "fr": "Courtier immobilier résidentiel",
      "en": "Residential Real Estate Broker",
      "es": null,
      "it": ""
    },
    "agency": {
      "name": "John Doe Agency",
      "logo_url": "http://lorempicsum.com/futurama/350/200/6"
    },
    "agency_office": {
      "name": "SIEGE SOCIAL"
    }
  },
  "id": 123,
  "uid": "123A456_7890",
  "reference": "1234",
  "api_provider_id": 12,
  "is_sync_with_api": 12,
  "master": 1,
  "account_id": 12,
  "account_uid": null,
  "is_furnished": null,
  "virtual_visit_link": null,
  "youtube_link": null,
  "homestaging_link": null,
  "created_at": "2017-04-27T17:42:03.000-04:00",
  "updated_at": "2017-04-28T10:56:40.000-04:00",
  "building": {
    "id": null,
    "uid": null,
    "name": null,
    "cover_url": "https://placehold.co/1920X1280.jpeg",
    "cover_url_hd": "https://placehold.co/1920X1280.jpeg"
  },
  "contacts": [

  ],
  "online": 1,
  "classification_id": 201,
  "classification": {
    "fr": "Appartement",
    "en": "Apartment",
    "es": "Departamento",
    "it": "Appartamento",
    "category": {
      "id": 2,
      "fr": "Appartement",
      "en": "Apartement",
      "es": "Departamento",
      "it": "Appartamento"
    }
  },
  "status_id": 2,
  "status": {
    "fr": "Ancien",
    "en": "Used property",
    "es": null,
    "it": "Usate"
  },
  "listing_id": 1,
  "listing": {
    "fr": "À vendre",
    "en": "For sale",
    "es": "En venta",
    "it": "In Vendita"
  },
  "unit": "",
  "units": null,
  "level": 1,
  "levels": null,
  "cadastre": "",
  "flag_id": null,
  "year_of_built": null,
  "availability_date": null,
  "is_luxurious": null,
  "address": {
    "address_visibility": 1,
    "address_formatted": null,
    "street_number": null,
    "street_name": null,
    "zipcode": "57300",
    "locality": "MONDELANGE",
    "sublocality": null,
    "administrative_area_level1": "",
    "administrative_area_level2": "",
    "country": "FR",
    "latitude": 0,
    "longitude": 0,
    "google_place_id": null
  },
  "area": {
    "living": 78,
    "balcony": null,
    "land": null,
    "unit_id": 1,
    "formatted": {
      "living": "78 m<sup>2</sup>",
      "balcony": null,
      "land": null
    }
  },
  "rooms": {
    "rooms": 4,
    "bathrooms": null,
    "bedrooms": 3,
    "showerrooms": null,
    "toilets": null,
    "beds": null,
    "people_capacity": null
  },
  "title": {
    "fr": "Appartement Mondelange F4 78,60 m2",
    "en": "",
    "es": "",
    "it": ""
  },
  "description_short": {
    "fr": "",
    "en": "",
    "es": "",
    "it": ""
  },
  "description": {
    "fr": "Grande pièce à vivre lumineuse pour ce beau f4, 3 belles chambres, une salle de bains, cuisine. Beau potentiel ! Travaux à prévoir",
    "en": "",
    "es": "",
    "it": ""
  },
  "url": {
    "fr": "",
    "en": "",
    "es": "",
    "it": ""
  },
  "financial": {
    "price_with_tax": 1,
    "price_from": 0,
    "price_unit_id": null,
    "rent_frequency": null,
    "rent_unit_id": null,
    "fees_frequency": 1,
    "currency": "EUR",
    "price_formatted": "111825€",
    "price": 111825,
    "rent": null,
    "fees": null,
    "tax1_annual": null,
    "tax2_annual": null,
    "income_annual": null,
    "deposit": null,
    "seller_honorary_percentage": null,
    "seller_honorary": null,
    "buyer_honorary_percentage": null,
    "buyer_honorary": null,
    "seller_net_price": null,
    "total_honorary": 0,
    "other_fees": null,
    "inventory": null,
    "property_fees_payment_method_id": null,
    "property_honorary_payment_method_id": null,
    "formatted": {
      "price": "111 825 €",
      "rent": null,
      "fees": null,
      "tax1_annual": null,
      "tax2_annual": null,
      "income_annual": null,
      "deposit": null,
      "seller_honorary": null,
      "buyer_honorary": null,
      "total_honorary": "0 €",
      "seller_net_price": null,
      "other_fees": null,
      "inventory": null
    }
  },
  "cover_url": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
  "cover_url_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
  "pictures": [
    {
      "medium": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "medium_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "medium_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "large": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "large_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "large_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "original_optimized": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "original": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-001.jpg",
      "name": {
        "fr": null,
        "en": null,
        "es": null,
        "it": null
      }
    },
    {
      "medium": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "medium_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "medium_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "large": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "large_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "large_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "original_optimized": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "original": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-002.jpg",
      "name": {
        "fr": null,
        "en": null,
        "es": null,
        "it": null
      }
    },
    {
      "medium": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "medium_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "medium_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "large": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "large_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "large_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "original_optimized": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "original": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-003.jpg",
      "name": {
        "fr": null,
        "en": null,
        "es": null,
        "it": null
      }
    },
    {
      "medium": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "medium_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "medium_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "large": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "large_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "large_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "original_optimized": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "original": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-004.jpg",
      "name": {
        "fr": null,
        "en": null,
        "es": null,
        "it": null
      }
    },
    {
      "medium": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "medium_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "medium_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "large": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "large_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "large_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "original_optimized": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "original": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-005.jpg",
      "name": {
        "fr": null,
        "en": null,
        "es": null,
        "it": null
      }
    },
    {
      "medium": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "medium_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "medium_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "large": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "large_crop": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "large_hd": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "original_optimized": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "original": "http://photos4blue.pagesimmo.com/057/57A40743/57A40743-1665-006.jpg",
      "name": {
        "fr": null,
        "en": null,
        "es": null,
        "it": null
      }
    }
  ],
  "documents": [

  ],
  "france": {
    "dpe_indice": "",
    "dpe_value": "",
    "dpe_id": "",
    "ges_indice": "",
    "ges_value": "",
    "alur_is_condo": null,
    "alur_units": null,
    "alur_uninhabitables": null,
    "alur_spending": null,
    "alur_legal_action": null,
    "alur_designation_agent": null,
    "alur_designation_administrator": null,
    "alur_designation_expert": null,
    "mandat_exclusif": 0
  },
  "belgium": {
    "peb_indice": null,
    "peb_value": null,
    "peb_id": "",
    "building_permit": null,
    "done_assignments": null,
    "preemption_property": null,
    "subdivision_permits": null,
    "sensitive_flood_area": null,
    "delimited_flood_zone": null,
    "risk_area": null
  },
  "other": {
    "orientation": {
      "north": null,
      "south": null,
      "east": null,
      "west": null
    },
    "inclusion": {
      "air_conditioning": null,
      "hot_water": null,
      "heated": null,
      "electricity": null,
      "furnished": null,
      "fridge": null,
      "cooker": null,
      "dishwasher": null,
      "dryer": null,
      "washer": null,
      "microwave": null
    },
    "detail": {
      "elevator": null,
      "laundry": null,
      "garbage_chute": null,
      "common_space": null,
      "janitor": null,
      "gym": null,
      "golf": null,
      "tennis": null,
      "sauna": null,
      "spa": null,
      "inside_pool": null,
      "outside_pool": null,
      "inside_parking": 0,
      "outside_parking": null,
      "parking_on_street": null,
      "garagebox": 0,
      "staff_room": 0
    },
    "half_furnished": {
      "living_room": null,
      "bedrooms": null,
      "kitchen": null,
      "other": null
    },
    "indoor": {
      "attic": null,
      "attic_convertible": null,
      "attic_converted": null,
      "cellar": 1,
      "central_vacuum": null,
      "entries_washer_dryer": null,
      "entries_dishwasher": null,
      "fireplace": null,
      "storage": null,
      "walk_in": null,
      "no_smoking": null,
      "double_glazing": null,
      "triple_glazing": null
    },
    "floor": {
      "carpet": null,
      "wood": null,
      "floating": null,
      "ceramic": null,
      "parquet": null,
      "cushion": null,
      "vinyle": null,
      "lino": null,
      "marble": null
    },
    "exterior": {
      "land_access": null,
      "back_balcony": 0,
      "front_balcony": null,
      "private_patio": null,
      "storage": null,
      "terrace": 0,
      "veranda": null,
      "garden": null,
      "sea_view": null,
      "mountain_view": null
    },
    "accessibility": {
      "elevator": null,
      "balcony": null,
      "grab_bar": null,
      "wider_corridors": null,
      "lowered_switches": null,
      "ramp": null
    },
    "senior": {
      "autonomy": null,
      "half_autonomy": null,
      "no_autonomy": null,
      "meal": null,
      "nursery": null,
      "domestic_help": null,
      "community": null,
      "activities": null,
      "validated_residence": null,
      "housing_cooperative": null
    },
    "pet": {
      "allow": null,
      "cat": null,
      "dog": null,
      "little_dog": null,
      "cage_aquarium": null,
      "not_allow": null
    },
    "service": {
      "internet": null,
      "tv": null,
      "tv_sat": null,
      "phone": null
    },
    "composition": {
      "bar": null,
      "living": null,
      "dining": null,
      "separe_toilet": null,
      "open_kitchen": null
    },
    "heating": {
      "electric": 0,
      "solar": 0,
      "gaz": 0,
      "condensation": null,
      "fuel": 0,
      "heat_pump": 0,
      "floor_heating": null
    },
    "transport": {
      "bicycle_path": null,
      "public_transport": null,
      "public_bike": null,
      "subway": null,
      "train_station": null
    },
    "security": {
      "guardian": null,
      "alarm": null,
      "intercom": null,
      "camera": null,
      "smoke_dectector": null
    }
  }
}
    © immosquare 2013-2024 - Mentions légales