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

prestigemls 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.

Introduction

This document describe the listing importation process and format for PRESTIGE MLS.
A task run automatically the importation everyday at 5:20 AM and fetch the last xml file droped on the ftp.prestige-mls.com server in your home directory.

Authentication & Account

Protocol:  FTP
Host:      ftp.prestige-mls.com
Port:      21
Username:  YourUserName
Password:  YouPassword

You authenticate to the PRESTIGE MLS server (ftp.prestige-mls.com) over FTP (port 21) by providing your username and password. No access to the server will be granted without your credentials.

To obtain your credentials, please contact our customer service team at contact@immosquare.com

Listings

Example

<?xml version="1.0" encoding="utf-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">
  <listings>
    <listing>
      <uid>1234</uid>
      <cadastre>nordelec-603</cadastre>
      <mandat_date>01/20/2019</mandat_date>
      <mandat_reference>123132123</mandat_reference>
      <flag_id>1</flag_id>
      <sharing_partner_status>1</sharing_partner_status>
      <sharing_social_status>1</sharing_social_status>
      <web_visibility_status>1</web_visibility_status>
      <visibility_id>1</visibility_id>
      <classification_id>1</classification_id>
      <transaction_type_id>1</transaction_type_id>
      <contact>...</contact>
      <financial>...</financial>
      <communication>...</communication>
      <address>...</address>
      <area>...</area>
      <rooms>...</rooms>
      <pictures>...</pictures>
      <other>...</other>
    </listing>
    <listing>...</listing>
    <listing>...</listing>
    <listing>...</listing>
    <listing>...</listing>
    <listing>...</listing>
  </listings>
</urlset>

Broker

Broker informations are not mandatory, but, if the e-mail address is provided and match an existing user in PRESTIGE MLS, the property will be directely associated to the broker, otherwise, it will be associated to the Agency Director. Also, the other informations provided in the contact object are only used to fill blank fields of the user's profile, no updated of existing informations will be processed.

Example

<contact>
  <broker>
    <license_number>123456<license_number>
    <first_name>John</first_name>
    <last_name>Doe</last_name>
    <email>johndoe@mail.com</email>
    <phone>5145145144</phone>
    <skype>username<skype/>
    <spoken_languages>English, French, Spanish<spoken_languages>
    <facebook_url>https://www.facebook.com/profile_link</facebook_url>
    <twitter_url>https://twitter.com/#!/profile_link</twitter_url>
    <linkedin_url>https://www.linkedin.com/profile_link</linkedin_url>
    <picture_url>
      http://www.goodies-by-sportcam.com/images/Image/LICORNE-ARC-EN-CIEL-LIC1.png
    </picture_url>
    <bio>
      <en>
        The description... Proin eget tortor risus.<br>
        Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae;<br>
        Donec velit neque, auctor sit amet aliquam vel, ullamcorper sit amet ligula.
      </en>
    </bio>
  </broker>
</contact>

Financial

Example

<financial>
  <price_visibility>1</price_visibility>
  <price>1500000000</price>
  <currency>USD</currency>
  <mensual_fees>50000</mensual_fees>
  <mensual_condo_fees>50000</mensual_condo_fees>
  <commission_rate>15.0</commission_rate>
  <commission_amount>5000</commission_amount>
  <commission_rate_collaborator>15.0</commission_rate_collaborator>
  <commission_amount_collaborator>5000</commission_amount_collaborator>
  <private_note>Cras ultricies ligula sed magna dictum porta. Praesent sapien massa, convallis a pellentesque nec, egestas non nisi.</private_note>
  <tax_annual_1>500000</tax_annual_1>
  <tax_annual_2>500000</tax_annual_2>
  <rent>500000</rent>
  <rent_period>30</rent_period>
  <time_rent>90</time_rent>
  <rent_note>Cras ultricies ligula sed magna dictum porta. Praesent sapien massa, convallis a pellentesque nec, egestas non nisi.</rent_note>
</financial>

Communication

Example

<communication>
  <title>Superb villa for sale</title>
  <description_short>Mauris blandit aliquet elit, eget tincidunt nibh pulvinar a. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Donec velit neque, auctor sit amet aliquam vel, ullamcorper sit amet ligula.</description_short>
  <description>Mauris blandit aliquet elit, eget tincidunt nibh pulvinar a. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Donec velit neque, auctor sit amet aliquam vel, ullamcorper sit amet ligula.Mauris blandit aliquet elit, eget tincidunt nibh pulvinar a. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Donec velit neque, auctor sit amet aliquam vel, ullamcorper sit amet ligula.Mauris blandit aliquet elit, eget tincidunt nibh pulvinar a. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Donec velit neque, auctor sit amet aliquam vel, ullamcorper sit amet ligula.</description>
  <youtube_url>https://link_to_your_video</youtube_url>
  <virtual_visit_url>https://link_to_your_visit</virtual_visit_url>
</communication>

Address

For better results, use the Google Maps format.

Example

<address>
  <address_visibility>1</address_visibility>
  <country>US</country>
  <street_number>4242</street_number>
  <street_name>Broker Street</street_name>
  <locality>Los Angeles</locality>
  <sublocality>Port View<sublocality>
  <administrative_area_level_1>California</administrative_area_level_1>
  <administrative_area_level_2>Los Angeles County</administrative_area_level_2>
  <zipcode>CA 90210</zipcode>
  <latitude>34.052235</latitude>
  <longitude>-118.243683</longitude>
</address>

Area

Example

<area>
  <living>500.0</living>
  <land>3000.0</land>
  <terrace>0.0</terrace>
  <unit_id>1</unit_id>
</area>

Rooms

Example

<rooms>
  <rooms>7</rooms>
  <bathrooms>7</bathrooms>
  <bedrooms>7</bedrooms>
  <showerrooms>7<showerrooms>
  <dressing_rooms>7</dressing_rooms>
  <cellars>7</cellars>
</rooms>

Pictures

Example

<pictures>
  <picture>
    <name>Image 1</name>
    <url>http://url_to_the_img.jpeg</url>
    <position>1</position>
  </picture>
  <picture>...</picture>
  <picture>...</picture>
  <picture>...</picture>
</pictures>

Other

Example

<other>
  <availability>01/20/2019<availability>
  <balcony>0</balcony>
  <garage>2</garage>
  <parking>0</parking>
  <swimming_pool>1</swimming_pool>
  <tennis>0</tennis>
  <fireplace>0</fireplace>
  <floor>0</floor>
  <accomodation>0</accomodation>
  <pet>0</pet>
  <lift>0</lift>
  <air_conditionning>0</air_conditionning>
  <year_of_built>1994</year_of_built>
  <energy_consumption>10</energy_consumption>
  <energy_consumption_class>B</energy_consumption_class>
  <gas_emissions>0</gas_emissions>
  <gas_emissions_class>A</gas_emissions_class>
  <historical>1</historical>
  <waterfront>1</waterfront>
</other>