GET /eco/immo/offres

A propos

Cette requête permet de rechercher des offres immobilières par type de transaction, type de local et autres critères.

Seules les offres publiées sont retournées.
Pour consulter le statut des offres soumises via l'API, utilisez la requête des statuts.

Chaque offre est identifiée par une référence unique.
Consultez la description du modèle pour plus d'informations.

Limitations

En JSON, la liste des offres est paginée et limitée à 10 000 résultats.
Par défaut, chaque page contient 50 résultats, soit 200 pages de résultats maximum.
Il est possible de reduire ou augmenter ce nombre dans la limite de 100 résultats par page.

Pour accéder à une liste de resultats illimités, utilisez les datasets !

En GeoJSON, le nombre de points retournés est limité à 10 000.

Informations

URL https://api.solutions-territoire.fr/eco/immo/offres
Disponibilité 0.7.0
Authentification requise Authorization Code ou Client Credentials
Scope requis Accés aux données économiques
Formats disponibles JSON
Code HTTP attendu 200

Paramètres

search String|Object optionnel Paramètres de recherche des offres immobilières
page Integer optionnel Numéro de la page de résultat
size Integer optionnel Nombre de résultats par page (en JSON seulement, 100 maximum)

Réponse

total Integer Nombre total d'offres (toutes pages confondues)
page Integer Numéro de page
offres Array Un tableau des offres immobilières

Exemples

Les exemples ci-dessous utilises la variable $ACCESS_TOKEN décrite dans la section Exemple : authentification en ligne de commande.

Exemple de requête listant les 50 premières offres :

cURL :

curl -X GET \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://api.solutions-territoire.fr/eco/immo/offres

HTTPie :

http -v GET https://api.solutions-territoire.fr/eco/immo/offres \
  Accept:"application/json" \
  Authorization:"Bearer $ACCESS_TOKEN"

Résultat :

GET /eco/immo/offres HTTP/1.1
Accept: application/json
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "total":          102,
    "page":           1,
    "im_offers": [
        {
            "id":                 "2019-09-00067",
            "reference":          "2019-09-00067",
            "label":              "Grand Local commercial à Paris",
            "code_commune":       "34172",
            "libelle_commune":    "Montpellier",
            "local_type":         "local_commercial",
            "transaction_types":  ["acheter", "louer"],
            "surface":            320,
            "url":                "/v0/eco/immo/offres/2019-09-00067"
        },
        [...]
    ]
}