Authentification

• Pour utiliser cette API, vous devez nous contacter à contact@immosquare.com. Après vérification, nous vous fournirons apiKey et apiToken à inclure dans les headers de vos requêtes.

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

# GET
GET /path
apiKey: xz1232xzd213213er213213dczxcc3loizxzs12dczx
apiToken: xz1287xzdwer213213dczxcas12dczx

Codes HTTP

💚 Succès (2xx)

🚫 Erreurs client (4xx)

🔧 Erreurs serveur (5xx)

Introduction

Authentification

Définition

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

GET /path
apiKey: xz1232xzd213213er213213dczxcc3loizxzs12dczx
apiToken: xz1287xzdwer213213dczxcas12dczx

Errors

HTTP Status Code Summary
------------------------------------ --------------------------------------------

200 - OK                             Everything worked as expected.
400 - Bad Request                    Often missing a required parameter.
401 - Unauthorized                   No valid API key provided.
402 - Request Failed                 Parameters were valid but request failed.
404 - Not Found                      The requested item doesn’t exist.
429 - Too Many Requests              Too many requests hit the API too quickly.
500, 502, 503, 504 - Server Errors   Something went wrong
------------------------------------ --------------------------------------------

Objets

Properties

Adresse

Mls

Utilisateur

Détails de l'agence

Exemple Request

{
  "agency_login": "MAGXXXX",
  "agency_pass" : "I8!JHJJKKH;"
}

Exemple Réponse

{
  "id": XXXXX,
  "authorized": true,
  "name": "XXXXX",
  "phone": "XXXXX",
  "email": "XXXXX",
  "website_url": "XXXXX",
  "company_director": {
    "id": XXXXX,
    "name": "XXXXX",
    "firstname": "XXXXX",
    "lastname": "XXXXX",
    "email": "XXXXX",
    "phone": "XXXXX"
  },
  "address": {
    "address_formatted": "4 Boulevard de Cimiez 06000 NICE",
    "street_number": 4,
    "street_name": "Boulevard de Cimiez",
    "zipcode": "06000",
    "locality": "NICE",
    "sublocality": null,
    "latitude": 43.70521740017596,
    "longitude": 7.272207856181012,
    "administrative_area_level1": "Alpes-Maritimes",
    "administrative_area_level2": null,
    "country": "FRANCE"
  },
  "mls": [
    {
      "id": 1,
      "name": "MLS Côte d'Azur",
      "export_filename": "mls_codedazur.zip",
      "required_fields": {
        "property_tax": true,
        "fee": true,
        "fee_seller": true,
        "fee_rate": true,
        "address": true,
        "address_if_simple": true,
        "address_if_exclusif": true,
        "mobile_phone_broker": true,
        "name_broker": true,
        "firstname_broker": true,
        "mail_broker": true
      },
      "mandate": {
        "exclusive_mandate": true,
        "simple_mandate": true,
        "for_rent_mandate": true,
        "sold_mandate": true,
        "sale_agreement_mandate": true
      },
      "mls_group": "Alpes-Maritimes",
      "mls_section": "Nice",
      "authorized": true
    }
  ],
  "users": [
    {
      "id": X,
      "name": "XXXXX",
      "firstname": "XXXXX",
      "lastname": "XXXXX",
      "email": "XXXXX",
      "phone": "XXXXX"
    },
    ...
  ]
}

HTTP Request

QUERY Parameters

Réponse

Droits d'accès à un MLS

Exemple Request

{
  "agency_login": "MAGXXXX",
  "agency_pass" : "I8!JHJJKKH;"
}

Exemple Réponse

[
    {
      "id": 1,
      "name": "MLS Côte d'Azur",
      "active": true,
      "mls_group": null,
      "mls_sub_group": null
    },
    {
      "id": 10,
      "name": "XXXXXXXX",
      "active": false,
      "mls_group": null,
      "mls_sub_group": null
    }
]

HTTP Request

QUERY Parameters

Réponse

Obtenir toutes les propriétés d'une agence

HTTP Request

Exemple Request

{
  "agency_login": "MAGXXXX",
  "agency_pass" : "I8!JHJJKKH;",
  "page" : 1,
  "active" : 1
}

Exemple Réponse

{
  "ads_count": 2319,
  "page_count": 24,
  "current_page": 2,
  "per_page": 100,
  "properties": [
    {
      "id": 395356,
      "active": false,
      "diffusion": null,
      "property_type": "Appartement",
      "subtype": null,
      "publication_date": 1562943653,
      "last_modification_date": 1562943653,
      "reference": {
        "ref_mls": "FR395356",
        "mandate": "121",
        "import": {
          "is_from_import": true,
          "ref_from_import": null,
          "ref_from_logiciel": null
        }
      },
      "status": {
        "transaction_type": "à vendre",
        "is_rental": false,
        "is_transaction": true,
        "is_sold_or_rented": false,
        "is_sales_agreement": false,
        "sold_or_rented_date": null,
        "sales_agreement_date": null,
        "offer_state": 0,
        "offer_state_label": "Aucune offre",
        "life_lease": {
          "is_life_lease": false,
          "life_lease_type": null,
          "venal_value": 0.0,
          "life_annuity": 0.0
        }
      },
      "mls": [
        1
      ],
      "address": {
        "address_formatted": "165 Avenue du Maréchal Lyautey 06000 NICE",
        "street_number": 165,
        "street_name": "Avenue du Maréchal Lyautey",
        "zipcode": "06000",
        "locality": "NICE",
        "sublocality": "PASTEUR",
        "latitude": 43.7213171,
        "longitude": 7.2862886,
        "administrative_area_level1": "Alpes-Maritimes",
        "administrative_area_level2": null,
        "country": "FRANCE"
      },
      "agency": {
        "id": XXX,
        "name": "XXXXXXX",
        "email": "XXXXXXX",
      },
      "broker": {
        "id": XX,
        "name": "XXXXX",
        "firstname": "XXXXXX",
        "lastname": "XXXXX",
        "license": "XXXXXX",
        "email": "XXXXXX",
        "phone": "XXXXXXX"
      },
      "energy": {
        "energy_consumption": 153.0,
        "energy_consumption_date": null,
        "energy_emission": 5.0,
        "energy_emission_date": 0,
        "no_energy_consumption": false,
        "free_of_dpe": false
      },
      "diagnostic": {
        "french_standard": false,
        "ecology_hqe": false,
        "abestos": false,
        "lead": false,
        "electric": false,
        "carrez_law": false,
        "dpe": false,
        "gas": false
      },
      "descriptions": {
        "general_title": "Appartement - PASTEUR",
        "general_description": "Quai Lyautey: secteur en pleine expansion, proche Nouveau Pôle Hospitalier Pasteur 2, écoles et commerces et à moins de 2 minutes à pieds du tramway. Beau 3 pièces en étage élevé, traversant Est/Ouest avec balcons des deux cotés, vues dégagées sur colline de Cimiez ou Paillon. Composé comme tel : entrée, cuisine ouverte sur séjour, 1 chambre puis coin nuit avec WC SDB dressing et 1 chambre. Dans un immeuble calme et bien entretenu (50 lots), possibilité d'acquérir ou louer un stationnement sur le parking de la co-propriété. charges 130?/mois environ. Pas de procédure en cours. Foncier 779?",
        "confidential_informations": "",
        "visit_informations": "",
        "translated": []
      },
      "surface_area": {
        "unit_formatted": "m²",
        "total_area": 53.0,
        "carrez_law": 53.0,
        "living_room": 0.0,
        "terrace": 0.0,
        "garden": 0.0,
        "land": 0.0,
        "storeroom": 0.0,
        "ground": 0.0,
        "land_registry": 0.0,
        "balcony": 0.0,
        "floor_area": 0.0,
        "cos": 0.0
      },
      "parkings": {
        "garage": 0,
        "outside": 0,
        "underground": 0,
        "location_number": "0",
        "visitor": 0,
        "parkings_nearby": false
      },
      "general": {
        "rooms": 3,
        "bedrooms": 0,
        "bathroom": 0,
        "toilet": 0,
        "floor": 0,
        "level": 0,
        "cellar": 1,
        "maid_room": 0,
        "loggia": true,
        "attic": 0,
        "convertible_attic": false,
        "high_ceilings": 0.0,
        "minimum_division": 0.0,
        "shop_window_width": 0.0,
        "quiet_property": false,
        "shared_services": false,
        "last_floor": false,
        "key_at_agency": false,
        "building_permit": false,
        "building_permit_date": 0,
        "private_garden": false,
        "air_conditioning": false,
        "partition": false,
        "cable_tray": false,
        "investor_program": false,
        "urgent_sale": false,
        "furnished": false,
        "fireplace": false,
        "construction_date": 0,
        "ground_floor_bedrooms": 0,
        "outbuildings": "",
        "activities": "",
        "authorized_activities": "",
        "lot_number": "",
        "house_name": "",
        "school_nearby": false,
        "convenient_store_nearby": false,
        "transports_nearby": true,
        "works_planned": false,
        "viabilisation": false,
        "facades_number": 0,
        "shower_number": 0,
        "alarm": false,
        "possibility_of_liberal_profession": false,
        "local_business_type": "",
        "vehicle_number": 0,
        "park": false,
        "pool": false,
        "tennis": false
      },
      "type": {
        "transport": null,
        "glazing": null,
        "garage_status": null,
        "heating": null,
        "hot_water": null,
        "kitchen": "Equipée",
        "condition": "Bon état",
        "exposition": "Est-Ouest",
        "adjoining_building": null,
        "standing": null,
        "view": "Dégagée",
        "house_type": null,
        "vegetation": null,
        "access": null,
        "surroundings": null,
        "configuration": null,
        "garage": null,
        "sanitation": null,
        "closure": null,
        "flooring": null,
        "style": null,
        "woodwork": null,
        "shutte": null,
        "heating_method": "------",
        "roof": null,
        "external_wall": null,
        "floor": null
      },
      "financial": {
        "price": 169000,
        "price_formatted": "169 000 €",
        "mandate_type": "Simple",
        "mandate_start_date": 1560988800,
        "mandate_end_date": 1592524800,
        "urgency_sale": false,
        "availability_date": null,
        "new_program": false,
        "new_program_delivery": null,
        "tax_system": null,
        "property_tax": 779,
        "charges_not_included": false,
        "monthly_charge": 0,
        "cadastral_income": 0.0,
        "housing_tax": 0.0,
        "heating_annual_charges": 0.0,
        "legal_status": null,
        "transferred_element": null,
        "subjected_to_tva": false,
        "transaction": {
          "fee": 10140,
          "fee_type": "Vendeur",
          "fee_buyer": 0,
          "fee_seller": 10140,
          "fee_rate": 0.0,
          "sold_rented": true,
          "sold_rented_rent": 0,
          "joint_ownership": {
            "is_joint_ownership": true,
            "procedure_in_progress": false,
            "number_of_lots": 50,
            "lot_number": "46",
            "joint_ownership_share_annual": 0.0,
            "procedure_details": [
              {
                "label": "Demande de désignation d'un mandataire ad'hoc (impayés de charges) / art. 29-1 de la loi du 10/07/1965",
                "status": false
              },
              {
                "label": "Demande de désignation d'un administrateur provisoire (équilibre financier compromis ou impossibilité de pourvoir à la conservation de l'immeuble) / art. 29-1 de la loi du 10/07/1965",
                "status": false
              },
              {
                "label": "Demande de désignation d'expert(s) (incapcité d'assurer la conservation de l'immeuble ou la sécurité des occupants) / art. L 615-6 du code de la construction et de l'habitation",
                "status": false
              }
            ]
          }
        },
        "rental": {
          "lease_type": null,
          "fee": 10140,
          "is_student_rental": false,
          "is_seasonal_rental": false,
          "visit_fee": 0.0,
          "visit_carrez_price": 0.0,
          "inventories_fee": 0.0,
          "inventories_carrez_price": 0.0,
          "modality_of_charges": "Forfaitaires mensuelles",
          "rental_charges": 0.0,
          "rental_addition": 0.0
        }
      },
      "buildings": {
        "name": "AVENUE DU MARÉCHAL LYAUTEY (165)",
        "heating": "Individuel",
        "hot_water": "Individuel          ",
        "number_of_floors": 0,
        "total_area": null,
        "last_renovating_facade": 0,
        "caretaker": false,
        "park": false,
        "garden": false,
        "pool": false,
        "tennis": false,
        "elevator": false,
        "secure_access": false,
        "private_garden": false,
        "security": "-----",
        "handicapped_access": false,
        "parking_lot": false,
        "construction_type": null,
        "works_planned": false,
        "outbuildings": "",
        "period": "1960",
        "standing": "Plan Courant",
        "children_playground": false,
        "bike_storage": false,
        "laundry": false,
        "sports_hall": false,
        "land_register_reference": ""
      },
      "photos": [
        {
          "id": 2123555,
          "url": "http://....",
          "name": "",
          "title": "",
          "order": 1,
          "do_not_display": false,
          "media_type": "Images",
          "photo_type": null
        },
        ...
      ],
      "medias": [],
      "rooms_details": [],
      "lot_details": []
    },
  ....
]

QUERY Parameters

Réponse

Obtenir une propriété d'une agence

Exemple Request

{
  "agency_login": "MAGXXXX",
  "agency_pass" : "I8!JHJJKKH;"
}

Exemple Réponse

{
  "id": 397767,
  "active": false,
  "diffusion": null,
  "property_type": "Maison",
  "subtype": "Maison de ville",
  "publication_date": 1569845630,
  "last_modification_date": 1571326532,
  "reference": {
    "ref_mls": "FR397767",
    "mandate": "502",
    "import": {
      "is_from_import": true,
      "ref_from_import": null,
      "ref_from_logiciel": ""
    }
  },
  "status": {
    "transaction_type": "à vendre",
    "is_rental": false,
    "is_transaction": true,
    "is_sold_or_rented": false,
    "is_sales_agreement": false,
    "sold_or_rented_date": null,
    "sales_agreement_date": null,
    "offer_state": 0,
    "offer_state_label": "Aucune offre",
    "life_lease": {
      "is_life_lease": false,
      "life_lease_type": null,
      "venal_value": 0.0,
      "life_annuity": 0.0
    }
  },
  "mls": [
      1,
      2,
      3,
      4
  ],
  "address": {
    "address_formatted": "203 Chemin des Chênes 06740 CHATEAUNEUF GRASSE",
    "street_number": 203,
    "street_name": "Chemin des Chênes",
    "zipcode": "06740",
    "locality": "CHATEAUNEUF GRASSE",
    "sublocality": "LE VIGNAL",
    "latitude": 43.6764686,
    "longitude": 6.9695027,
    "administrative_area_level1": "Alpes-Maritimes",
    "administrative_area_level2": null,
    "country": "FRANCE"
  },
  "agency": {
    "id": xxxxxxX,
    "name": "XXXXXX",
    "email": "XXXXXX"
  },
  "broker": {
    "id": X,
    "name": "XXXXXX",
    "firstname": "XXXXXXX",
    "lastname": "XXXXXX",
    "license": "XXXXX",
    "email": "XXXXXXX",
    "phone": "XXXXXXXX"
  },
  "energy": {
    "energy_consumption": 52.0,
    "energy_consumption_date": 1571356800,
    "energy_emission": 5.0,
    "energy_emission_date": 1571184000,
    "no_energy_consumption": false,
    "free_of_dpe": false
  },
  "diagnostic": {
    "french_standard": true,
    "ecology_hqe": true,
    "abestos": true,
    "lead": true,
    "electric": true,
    "carrez_law": true,
    "dpe": true,
    "gas": true
  },
  "descriptions": {
    "general_title": "Maison - LE VIGNAL",
    "general_description": "Cette unique et belle villa avec une vue imprenable sur le paysage verdoyant et la mer Méditerranée est située dans un quartier résidentiel recherché à quelques minutes du village de Chateauneuf et du golf d'Opio. Beau jardin avec piscine chauffée, au calme et très ensoleillé, exposition sud-ouest.\r\n\r\nLa villa se compose d'un spacieux hall d'entrée avec placards et toilettes invités, d'un séjour lumineux avec une belle cheminée, avec vue sur la mer et la piscine. Belle cuisine provençale avec plans de travail en pierre de lave et une salle à manger ouverte avec des hauts plafonds. Chambre d'invité en suite avec salle de bains, wc et une terrasse privée. Buanderie et accès garage.\r\n\r\nAu niveau supérieur:\r\nUn magnifique Escalier ouvert moderne mène à l'étage supérieur et ses 3 chambres en suite avec salle de bain somptueuse, salle de douche et wc. Deux chambres bénéficient de belles terrasses avec de belles vues sur la mer et orientées sud.\r\n\r\nGrandes terrasses tout autour de la villa, dont une couverte au niveau de la cuisine avec barbecue. Un grand parking et un grand garage double avec atelier. Cave à vin.\r\nChauffage avec pompe à chaleur et chauffage au sol, tous les sols sont en marbre travertin. Air conditionné dans toutes les chambres, aspirateur central.\r\nSurface habitable 230m2 et 70m² de dépendances sur un terrain de 2500m2.\r\nProduit unique à la vente de part la qualité de construction et son emplacement.",
    "confidential_informations": "",
    "visit_informations": "Le Lorem Ipsum est simplement du faux texte employé dans la composition et la mise en page avant impression. Le Lorem Ipsum est le faux texte standard de l'imprimerie depuis les années 1500, quand un imprimeur anonyme assembla ensemble des morceaux de texte pour réaliser un livre spécimen de polices de texte. Il n'a pas fait que survivre cinq siècles, mais s'est aussi adapté à la bureautique informatique, sans que son contenu n'en soit modifié. Il a été popularisé dans les années 1960 grâce à la vente de feuilles Letraset contenant des passages du Lorem Ipsum, et, plus récemment, par son inclusion dans des applications de mise en page de texte, comme Aldus PageMaker.",
    "descriptions": [
      {
        "lang": "fr",
        "text": "Cette unique et belle villa avec une vue imprenable sur le paysage verdoyant et la mer Méditerranée est située dans un quartier résidentiel recherché à quelques minutes du village de Chateauneuf et du golf d'Opio. Beau jardin avec piscine chauffée, au calme et très ensoleillé, exposition sud-ouest.\r\n\r\nLa villa se compose d'un spacieux hall d'entrée avec placards et toilettes invités, d'un séjour lumineux avec une belle cheminée, avec vue sur la mer et la piscine. Belle cuisine provençale avec plans de travail en pierre de lave et une salle à manger ouverte avec des hauts plafonds. Chambre d'invité en suite avec salle de bains, wc et une terrasse privée. Buanderie et accès garage.\r\n\r\nAu niveau supérieur:\r\nUn magnifique Escalier ouvert moderne mène à l'étage supérieur et ses 3 chambres en suite avec salle de bain somptueuse, salle de douche et wc. Deux chambres bénéficient de belles terrasses avec de belles vues sur la mer et orientées sud.\r\n\r\nGrandes terrasses tout autour de la villa, dont une couverte au niveau de la cuisine avec barbecue. Un grand parking et un grand garage double avec atelier. Cave à vin.\r\nChauffage avec pompe à chaleur et chauffage au sol, tous les sols sont en marbre travertin. Air conditionné dans toutes les chambres, aspirateur central.\r\nSurface habitable 230m2 et 70m² de dépendances sur un terrain de 2500m2.\r\nProduit unique à la vente de part la qualité de construction et son emplacement.",
        "title": "Maison  6 Pièce(s) 300 m²  à vendre "
      },
      {
        "lang": "en",
        "text": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.",
        "title": "House  6 Rooms 300 m²  for sale "
      },
      {
        "lang": "es",
        "text": "Lorem Ipsum es simplemente el texto de relleno de las imprentas y archivos de texto. Lorem Ipsum ha sido el texto de relleno estándar de las industrias desde el año 1500, cuando un impresor (N. del T. persona que se dedica a la imprenta) desconocido usó una galería de textos y los mezcló de tal manera que logró hacer un libro de textos especimen. No sólo sobrevivió 500 años, sino que tambien ingresó como texto de relleno en documentos electrónicos, quedando esencialmente igual al original. Fue popularizado en los 60s con la creación de las hojas \"Letraset\", las cuales contenian pasajes de Lorem Ipsum, y más recientemente con software de autoedición, como por ejemplo Aldus PageMaker, el cual incluye versiones de Lorem Ipsum.",
        "title": "Chalet  6 Cuartos : 300 m²  En venta "
      },
      {
        "lang": "it",
        "text": "Lorem Ipsum è un testo segnaposto utilizzato nel settore della tipografia e della stampa. Lorem Ipsum è considerato il testo segnaposto standard sin dal sedicesimo secolo, quando un anonimo tipografo prese una cassetta di caratteri e li assemblò per preparare un testo campione. È sopravvissuto non solo a più di cinque secoli, ma anche al passaggio alla videoimpaginazione, pervenendoci sostanzialmente inalterato. Fu reso popolare, negli anni ’60, con la diffusione dei fogli di caratteri trasferibili “Letraset”, che contenevano passaggi del Lorem Ipsum, e più recentemente da software di impaginazione come Aldus PageMaker, che includeva versioni del Lorem Ipsum.",
        "title": "Casa  6 Locali 300 m²  In vendita "
      },
      {
        "lang": "nl",
        "text": "Lorem Ipsum is slechts een proeftekst uit het drukkerij- en zetterijwezen. Lorem Ipsum is de standaard proeftekst in deze bedrijfstak sinds de 16e eeuw, toen een onbekende drukker een zethaak met letters nam en ze door elkaar husselde om een font-catalogus te maken. Het heeft niet alleen vijf eeuwen overleefd maar is ook, vrijwel onveranderd, overgenomen in elektronische letterzetting. Het is in de jaren '60 populair geworden met de introductie van Letraset vellen met Lorem Ipsum passages en meer recentelijk door desktop publishing software zoals Aldus PageMaker die versies van Lorem Ipsum bevatten.",
        "title": "Huis  6 Slaapkamer(s) 300 m²  te koop "
      },
      {
        "lang": "ru",
        "text": "Lorem Ipsum је једноставно модел текста који се користи у штампарској и словослагачкој индустрији. Lorem ipsum је био стандард за модел текста још од 1500. године, када је непознати штампар узео кутију са словима и сложио их како би направио узорак књиге. Не само што је овај модел опстао пет векова, него је чак почео да се користи и у електронским медијима, непроменивши се. Популаризован је шездесетих година двадесетог века заједно са листовима летерсета који су садржали Lorem Ipsum пасусе, а данас са софтверским пакетом за прелом као што је Aldus PageMaker који је садржао Lorem Ipsum верзије.",
        "title": "House  6 Rooms 300 m²  for sale "
      },
      {
        "lang": "se",
        "text": "Lorem Ipsum är en utfyllnadstext från tryck- och förlagsindustrin. Lorem ipsum har varit standard ända sedan 1500-talet, när en okänd boksättare tog att antal bokstäver och blandade dem för att göra ett provexemplar av en bok. Lorem ipsum har inte bara överlevt fem århundraden, utan även övergången till elektronisk typografi utan större förändringar. Det blev allmänt känt på 1960-talet i samband med lanseringen av Letraset-ark med avsnitt av Lorem Ipsum, och senare med mjukvaror som Aldus PageMaker.",
        "title": "House  6 Rooms 300 m²  for sale "
      },
      {
        "lang": "de",
        "text": "Lorem Ipsum ist ein einfacher Demo-Text für die Print- und Schriftindustrie. Lorem Ipsum ist in der Industrie bereits der Standard Demo-Text seit 1500, als ein unbekannter Schriftsteller eine Hand voll Wörter nahm und diese durcheinander warf um ein Musterbuch zu erstellen. Es hat nicht nur 5 Jahrhunderte überlebt, sondern auch in Spruch in die elektronische Schriftbearbeitung geschafft (bemerke, nahezu unverändert). Bekannt wurde es 1960, mit dem erscheinen von \"Letraset\", welches Passagen von Lorem Ipsum enhielt, so wie Desktop Software wie \"Aldus PageMaker\" - ebenfalls mit Lorem Ipsum.",
        "title": "House  6 Rooms 300 m²  for sale "
      },
      {
        "lang": "no",
        "text": "Lorem Ipsum er rett og slett dummytekst fra og for trykkeindustrien. Lorem Ipsum har vært bransjens standard for dummytekst helt siden 1500-tallet, da en ukjent boktrykker stokket en mengde bokstaver for å lage et prøveeksemplar av en bok. Lorem Ipsum har tålt tidens tann usedvanlig godt, og har i tillegg til å bestå gjennom fem århundrer også tålt spranget over til elektronisk typografi uten vesentlige endringer. Lorem Ipsum ble gjort allment kjent i 1960-årene ved lanseringen av Letraset-ark med avsnitt fra Lorem Ipsum, og senere med sideombrekkingsprogrammet Aldus PageMaker som tok i bruk nettopp Lorem Ipsum for dummytekst.",
        "title": "House  6 Rooms 300 m²  for sale "
      },
      {
        "lang": "dk",
        "text": "Lorem Ipsum er ganske enkelt fyldtekst fra print- og typografiindustrien. Lorem Ipsum har været standard fyldtekst siden 1500-tallet, hvor en ukendt trykker sammensatte en tilfældig spalte for at trykke en bog til sammenligning af forskellige skrifttyper. Lorem Ipsum har ikke alene overlevet fem århundreder, men har også vundet indpas i elektronisk typografi uden væsentlige ændringer. Sætningen blev gjordt kendt i 1960'erne med lanceringen af Letraset-ark, som indeholdt afsnit med Lorem Ipsum, og senere med layoutprogrammer som Aldus PageMaker, som også indeholdt en udgave af Lorem Ipsum.",
        "title": "House  6 Rooms 300 m²  for sale "
      },
      {
        "lang": "pt",
        "text": "O Lorem Ipsum é um texto modelo da indústria tipográfica e de impressão. O Lorem Ipsum tem vindo a ser o texto padrão usado por estas indústrias desde o ano de 1500, quando uma misturou os caracteres de um texto para criar um espécime de livro. Este texto não só sobreviveu 5 séculos, mas também o salto para a tipografia electrónica, mantendo-se essencialmente inalterada. Foi popularizada nos anos 60 com a disponibilização das folhas de Letraset, que continham passagens com Lorem Ipsum, e mais recentemente com os programas de publicação como o Aldus PageMaker que incluem versões do Lorem Ipsum.",
        "title": "House  6 Rooms 300 m²  for sale "
      }
    ]
  },
  "surface_area": {
    "unit_formatted": "m²",
    "total_area": 500.0,
    "carrez_law": 300.0,
    "living_room": 2.0,
    "terrace": 15151.0,
    "garden": 454.0,
    "land": 1500.0,
    "storeroom": 0.0,
    "ground": 0.0,
    "land_registry": 1523.0,
    "balcony": 0.0,
    "floor_area": 0.0,
    "cos": 0.0
  },
  "parkings": {
    "garage": 1,
    "outside": 2,
    "underground": 2,
    "location_number": "0",
    "visitor": 0,
    "parkings_nearby": false
  },
  "general": {
    "rooms": 6,
    "bedrooms": 4,
    "bathroom": 2,
    "toilet": 1,
    "floor": 0,
    "level": 2,
    "cellar": 22,
    "maid_room": 0,
    "loggia": true,
    "attic": 1,
    "convertible_attic": true,
    "high_ceilings": 0.0,
    "minimum_division": 0.0,
    "shop_window_width": 0.0,
    "quiet_property": false,
    "shared_services": false,
    "last_floor": false,
    "key_at_agency": true,
    "subjected_to_tva": false,
    "building_permit": false,
    "building_permit_date": 0,
    "private_garden": false,
    "air_conditioning": true,
    "partition": false,
    "cable_tray": false,
    "investor_program": true,
    "urgent_sale": true,
    "furnished": false,
    "fireplace": true,
    "construction_date": 1571270400,
    "effective_date": 1571356800,
    "ground_floor_bedrooms": 2,
    "outbuildings": "au fond du jardin",
    "activities": "",
    "authorized_activities": "",
    "lot_number": "",
    "house_name": "La Batisse",
    "school_nearby": true,
    "convenient_store_nearby": true,
    "transports_nearby": true,
    "works_planned": false,
    "viabilisation": false,
    "facades_number": 4,
    "shower_number": 1,
    "alarm": true,
    "possibility_of_liberal_profession": true,
    "local_business_type": "",
    "vehicle_number": 0,
    "park": true,
    "pool": true,
    "tennis": false
  },
  "type": {
    "transport": "Bus / Métro",
    "glazing": "Double",
    "garage_status": "En sus",
    "heating": "Bois",
    "hot_water": "Cumulus",
    "kitchen": "Equipée",
    "condition": "A rafraichir",
    "exposition": "Sud-Ouest",
    "adjoining_building": "Individuelle",
    "standing": "Grand Standing",
    "view": "Montagne",
    "house_type": "Maison de ville",
    "vegetation": null,
    "access": null,
    "surroundings": "Commercial",
    "configuration": null,
    "garage": null,
    "sanitation": "Inexistant",
    "closure": null,
    "flooring": null,
    "style": "Ancien",
    "woodwork": "Alu ouvrant",
    "shutte": "Ouvrants",
    "heating_method": "Air pulsé",
    "roof": "Ardoise",
    "external_wall": "Briques",
    "floor": "Bois"
  },
  "financial": {
    "price": 1950000,
    "price_formatted": "1 950 000 €",
    "mandate_type": "Simple",
    "mandate_start_date": 1569196800,
    "mandate_end_date": 1600732800,
    "effect_date": 1571356800,
    "urgency_sale": true,
    "availability_date": null,
    "new_program": true,
    "new_program_delivery": 1569801600,
    "tax_system": "Droits d'enreg.",
    "property_tax": 1500,
    "charges_not_included": false,
    "monthly_charge": 0,
    "cadastral_income": 0.0,
    "housing_tax": 1500.0,
    "heating_annual_charges": 150.0,
    "legal_status": "Pleine propriété",
    "transferred_element": null,
    "transaction": {
      "fee": 97500,
      "fee_type": "Vendeur",
      "fee_type_id": 2,
      "fee_buyer": 0,
      "fee_seller": 97500,
      "fee_rate": 5.0,
      "sold_rented": false,
      "sold_rented_rent": null,
      "joint_ownership": {
        "is_joint_ownership": false,
        "procedure_in_progress": false,
        "procedure_details": [
          {
            "label": "Demande de désignation d'un mandataire ad'hoc (impayés de charges) / art. 29-1 de la loi du 10/07/1965",
            "status": false
          },
          {
            "label": "Demande de désignation d'un administrateur provisoire (équilibre financier compromis ou impossibilité de pourvoir à la conservation de l'immeuble) / art. 29-1 de la loi du 10/07/1965",
            "status": false
          },
          {
            "label": "Demande de désignation d'expert(s) (incapcité d'assurer la conservation de l'immeuble ou la sécurité des occupants) / art. L 615-6 du code de la construction et de l'habitation",
            "status": false
          }
        ],
        "number_of_lots": 0,
        "lot_number": "",
        "joint_ownership_share_annual": 0.0
      }
    },
    "rental": {
      "lease_type": null,
      "fee": 97500,
      "is_student_rental": false,
      "is_seasonal_rental": false,
      "visit_fee": 0.0,
      "visit_carrez_price": 0.0,
      "inventories_fee": 0.0,
      "inventories_fcarrez_price": 0.0,
      "modality_of_charges": "Forfaitaires mensuelles",
      "rental_charges": 0.0,
      "rental_addition": 0.0
    }
  },
  "buildings": [],
  "photos": [
    {
      "id": 2154718,
      "url": "https://www.mls.fr/shared/depot/3/biens/397767/images/2154718.jpg",
      "name": "images.png",
      "title": "images.png",
      "order": 1,
      "do_not_display": false,
      "media_type": "Images",
      "photo_type": "Intérieur"
    }
  ],
  "medias": [
    {
      "id": 2154730,
      "url": "www.youtube.com/watch?v=5IpvHQatEyk\u0026feature=youtu.be",
      "name": "Lien vidéo",
      "title": "",
      "media_type": "Liens externe"
    },
    {
      "id": 2154731,
      "url": "https://www.mls.fr/shared/depot/3/biens/397767/documents/2154731.pdf",
      "name": "Fichier PDF",
      "title": "",
      "media_type": "PDF"
    }
  ],
  "rooms_details": [
    {
      "id": 592089,
      "floor": "Béton lissé",
      "wall": "Peinture",
      "surface": 17.0,
      "storage": true,
      "balcony": true,
      "terrace": false,
      "garden": false,
      "name": "Chambre",
      "air_conditioning": true,
      "comments": "Nickel !",
      "level": "1"
    }
  ],
  "lot_details": []
}

HTTP Request

QUERY Parameters

Réponse

Obtenir les propriétés du panier export logiciel d'une agence

Exemple Request

{
  "agency_login": "MAGXXXX",
  "agency_pass" : "I8!JHJJKKH;",
  "page" : 1
}

Exemple Réponse

{
  "ads_count": 2319,
  "page_count": 24,
  "current_page": 2,
  "per_page": 100,
  "properties": [
    {
      "id": 395356,
      "active": false,
      "diffusion": true,
      "property_type": "Appartement",
      "subtype": null,
      "publication_date": 1562943653,
      "last_modification_date": 1562943653,
      "reference": {
        "ref_mls": "FR395356",
        "mandate": "121",
        "import": {
          "is_from_import": true,
          "ref_from_import": null,
          "ref_from_logiciel": null
        }
      },
      "status": {
        "transaction_type": "à vendre",
        "is_rental": false,
        "is_transaction": true,
        "is_sold_or_rented": false,
        "is_sales_agreement": false,
        "sold_or_rented_date": null,
        "sales_agreement_date": null,
        "offer_state": 0,
        "offer_state_label": "Aucune offre",
        "life_lease": {
          "is_life_lease": false,
          "life_lease_type": null,
          "venal_value": 0.0,
          "life_annuity": 0.0
        }
      },
      "mls": [
        1
      ],
      "address": {
        "address_formatted": "165 Avenue du Maréchal Lyautey 06000 NICE",
        "street_number": 165,
        "street_name": "Avenue du Maréchal Lyautey",
        "zipcode": "06000",
        "locality": "NICE",
        "sublocality": "PASTEUR",
        "latitude": 43.7213171,
        "longitude": 7.2862886,
        "administrative_area_level1": "Alpes-Maritimes",
        "administrative_area_level2": null,
        "country": "FRANCE"
      },
      "agency": {
        "id": XXX,
        "name": "XXXXXXX",
        "email": "XXXXXXX",
      },
      "broker": {
        "id": XX,
        "name": "XXXXX",
        "firstname": "XXXXXX",
        "lastname": "XXXXX",
        "license": "XXXXXX",
        "email": "XXXXXX",
        "phone": "XXXXXXX"
      },
      "energy": {
        "energy_consumption": 153.0,
        "energy_consumption_date": null,
        "energy_emission": 5.0,
        "energy_emission_date": 0,
        "no_energy_consumption": false,
        "free_of_dpe": false
      },
      "diagnostic": {
        "french_standard": false,
        "ecology_hqe": false,
        "abestos": false,
        "lead": false,
        "electric": false,
        "carrez_law": false,
        "dpe": false,
        "gas": false
      },
      "descriptions": {
        "general_title": "Appartement - PASTEUR",
        "general_description": "Quai Lyautey: secteur en pleine expansion, proche Nouveau Pôle Hospitalier Pasteur 2, écoles et commerces et à moins de 2 minutes à pieds du tramway. Beau 3 pièces en étage élevé, traversant Est/Ouest avec balcons des deux cotés, vues dégagées sur colline de Cimiez ou Paillon. Composé comme tel : entrée, cuisine ouverte sur séjour, 1 chambre puis coin nuit avec WC SDB dressing et 1 chambre. Dans un immeuble calme et bien entretenu (50 lots), possibilité d'acquérir ou louer un stationnement sur le parking de la co-propriété. charges 130?/mois environ. Pas de procédure en cours. Foncier 779?",
        "confidential_informations": "",
        "visit_informations": "",
        "translated": []
      },
      "surface_area": {
        "unit_formatted": "m²",
        "total_area": 53.0,
        "carrez_law": 53.0,
        "living_room": 0.0,
        "terrace": 0.0,
        "garden": 0.0,
        "land": 0.0,
        "storeroom": 0.0,
        "ground": 0.0,
        "land_registry": 0.0,
        "balcony": 0.0,
        "floor_area": 0.0,
        "cos": 0.0
      },
      "parkings": {
        "garage": 0,
        "outside": 0,
        "underground": 0,
        "location_number": "0",
        "visitor": 0,
        "parkings_nearby": false
      },
      "general": {
        "rooms": 3,
        "bedrooms": 0,
        "bathroom": 0,
        "toilet": 0,
        "floor": 0,
        "level": 0,
        "cellar": 1,
        "maid_room": 0,
        "loggia": true,
        "attic": 0,
        "convertible_attic": false,
        "high_ceilings": 0.0,
        "minimum_division": 0.0,
        "shop_window_width": 0.0,
        "quiet_property": false,
        "shared_services": false,
        "last_floor": false,
        "key_at_agency": false,
        "building_permit": false,
        "building_permit_date": 0,
        "private_garden": false,
        "air_conditioning": false,
        "partition": false,
        "cable_tray": false,
        "investor_program": false,
        "urgent_sale": false,
        "furnished": false,
        "fireplace": false,
        "construction_date": 0,
        "ground_floor_bedrooms": 0,
        "outbuildings": "",
        "activities": "",
        "authorized_activities": "",
        "lot_number": "",
        "house_name": "",
        "school_nearby": false,
        "convenient_store_nearby": false,
        "transports_nearby": true,
        "works_planned": false,
        "viabilisation": false,
        "facades_number": 0,
        "shower_number": 0,
        "alarm": false,
        "possibility_of_liberal_profession": false,
        "local_business_type": "",
        "vehicle_number": 0,
        "park": false,
        "pool": false,
        "tennis": false
      },
      "type": {
        "transport": null,
        "glazing": null,
        "garage_status": null,
        "heating": null,
        "hot_water": null,
        "kitchen": "Equipée",
        "condition": "Bon état",
        "exposition": "Est-Ouest",
        "adjoining_building": null,
        "standing": null,
        "view": "Dégagée",
        "house_type": null,
        "vegetation": null,
        "access": null,
        "surroundings": null,
        "configuration": null,
        "garage": null,
        "sanitation": null,
        "closure": null,
        "flooring": null,
        "style": null,
        "woodwork": null,
        "shutte": null,
        "heating_method": "------",
        "roof": null,
        "external_wall": null,
        "floor": null
      },
      "financial": {
        "price": 169000,
        "price_formatted": "169 000 €",
        "mandate_type": "Simple",
        "mandate_start_date": 1560988800,
        "mandate_end_date": 1592524800,
        "urgency_sale": false,
        "availability_date": null,
        "new_program": false,
        "new_program_delivery": null,
        "tax_system": null,
        "property_tax": 779,
        "charges_not_included": false,
        "monthly_charge": 0,
        "cadastral_income": 0.0,
        "housing_tax": 0.0,
        "heating_annual_charges": 0.0,
        "legal_status": null,
        "transferred_element": null,
        "subjected_to_tva": false,
        "transaction": {
          "fee": 10140,
          "fee_type": "Vendeur",
          "fee_buyer": 0,
          "fee_seller": 10140,
          "fee_rate": 0.0,
          "sold_rented": true,
          "sold_rented_rent": 0,
          "joint_ownership": {
            "is_joint_ownership": true,
            "procedure_in_progress": false,
            "number_of_lots": 50,
            "lot_number": "46",
            "joint_ownership_share_annual": 0.0,
            "procedure_details": [
              {
                "label": "Demande de désignation d'un mandataire ad'hoc (impayés de charges) / art. 29-1 de la loi du 10/07/1965",
                "status": false
              },
              {
                "label": "Demande de désignation d'un administrateur provisoire (équilibre financier compromis ou impossibilité de pourvoir à la conservation de l'immeuble) / art. 29-1 de la loi du 10/07/1965",
                "status": false
              },
              {
                "label": "Demande de désignation d'expert(s) (incapcité d'assurer la conservation de l'immeuble ou la sécurité des occupants) / art. L 615-6 du code de la construction et de l'habitation",
                "status": false
              }
            ]
          }
        },
        "rental": {
          "lease_type": null,
          "fee": 10140,
          "is_student_rental": false,
          "is_seasonal_rental": false,
          "visit_fee": 0.0,
          "visit_carrez_price": 0.0,
          "inventories_fee": 0.0,
          "inventories_carrez_price": 0.0,
          "modality_of_charges": "Forfaitaires mensuelles",
          "rental_charges": 0.0,
          "rental_addition": 0.0
        }
      },
      "buildings": {
        "name": "AVENUE DU MARÉCHAL LYAUTEY (165)",
        "heating": "Individuel",
        "hot_water": "Individuel          ",
        "number_of_floors": 0,
        "total_area": null,
        "last_renovating_facade": 0,
        "caretaker": false,
        "park": false,
        "garden": false,
        "pool": false,
        "tennis": false,
        "elevator": false,
        "secure_access": false,
        "private_garden": false,
        "security": "-----",
        "handicapped_access": false,
        "parking_lot": false,
        "construction_type": null,
        "works_planned": false,
        "outbuildings": "",
        "period": "1960",
        "standing": "Plan Courant",
        "children_playground": false,
        "bike_storage": false,
        "laundry": false,
        "sports_hall": false,
        "land_register_reference": ""
      },
      "photos": [
        {
          "id": 2123555,
          "url": "http://....",
          "name": "",
          "title": "",
          "order": 1,
          "do_not_display": false,
          "media_type": "Images",
          "photo_type": null
        },
        ...
      ],
      "medias": [],
      "rooms_details": [],
      "lot_details": []
    },
  ....
]

HTTP Request

QUERY Parameters

Réponse

Obtenir les autorisations de diffusion d'une agence

Exemple Request

{
  "agency_login": "MAGXXXX",
  "agency_pass" : "I8!JHJJKKH;"
}

Exemple Réponse

[
  {
    "id": 137137,
    "ref_mls": "FR137137"
  },
  {
    "id": 169884,
    "ref_mls": "FR169884"
  },
  {
    "id": 182954,
    "ref_mls": "FR182954"
  },
  {
    "id": 183002,
    "ref_mls": "FR183002"
  },
  {
    "id": 344437,
    "ref_mls": "FR344437"
  }
]

HTTP Request

QUERY Parameters