Choisir une ressource API

Choisissez l’endpoint selon les informations déjà disponibles dans votre intégration. Une ressource classified représente une annonce source ; une ressource property regroupe les annonces qui se rapportent à un même bien immobilier. La référence API générée reste la source pour les paramètres et les schémas de réponse.

Sélectionnez un endpoint

Vous avez ou recherchez	Utilisez
Un identifiant d’annonce	`GET /classifieds/{id}`
Un identifiant de bien immobilier	`GET /properties/{id}`
Une URL d’annonce	`GET /classifieds/lookup?url=…` ou `GET /properties/lookup?url=…`
La ressource associée	`GET /classifieds/{id}/property` ou `GET /properties/{id}/classifieds`
Un ensemble filtré de biens immobiliers	`POST /properties/search`

Utilisez un endpoint de récupération directe lorsque vous connaissez déjà un identifiant. Un classified est une annonce source ; une property regroupe les annonces qui décrivent le même bien immobilier. Si vous partez d’une URL d’annonce, appelez GET /classifieds/lookup avec le paramètre de requête url pour retrouver cette annonce, ou GET /properties/lookup avec ce même paramètre pour retrouver le bien immobilier regroupé. Utilisez la recherche de biens immobiliers lorsque vous avez besoin d’un ensemble filtré et paginé.

Recherchez une annonce ou un bien à partir de son URL

Choisissez le lookup en fonction de la ressource que votre intégration doit récupérer. Fournissez l’URL d’annonce dans url.

curl --fail-with-body --show-error --silent \
  --get 'https://api.immoteur.com/public/v1/classifieds/lookup' \
  -H "Authorization: Bearer $IMMOTEUR_TOKEN" \
  --data-urlencode 'url=https://www.example.com/annonce/123'

curl --fail-with-body --show-error --silent \
  --get 'https://api.immoteur.com/public/v1/properties/lookup' \
  -H "Authorization: Bearer $IMMOTEUR_TOKEN" \
  --data-urlencode 'url=https://www.example.com/annonce/123'

Pour maintenir une copie locale du flux d’annonces sélectionné plutôt que de consulter une ressource à la fois, utilisez Synchroniser les annonces.

Recherchez des biens immobiliers

Le corps de requête requiert page, transactionType et propertyTypes. Ajoutez des filtres optionnels uniquement lorsqu’ils correspondent au résultat recherché.

curl --fail-with-body --show-error --silent \
  'https://api.immoteur.com/public/v1/properties/search' \
  -H "Authorization: Bearer $IMMOTEUR_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{
    "page": 1,
    "transactionType": "sale",
    "propertyTypes": ["apartment"],
    "locationDepartments": ["75"]
  }'

Si une requête est refusée ou limitée, consultez Fiabilité de l’API. Ouvrez la référence API générée pour les paramètres de lookup et les schémas de réponse exacts.

Parcourez les résultats de recherche

Après chaque réponse à POST /properties/search, lisez meta.nextPage. S’il contient un numéro, envoyez la même requête de recherche avec cette valeur dans page. Lorsqu’il vaut null, il n’y a pas de page suivante.

Démarrer

API

Webhooks

Référence OpenAPI

Choisir une ressource API

Sélectionnez un endpoint

Recherchez une annonce ou un bien à partir de son URL

Recherchez des biens immobiliers

Parcourez les résultats de recherche

​Sélectionnez un endpoint

​Recherchez une annonce ou un bien à partir de son URL

​Recherchez des biens immobiliers

​Parcourez les résultats de recherche

Sélectionnez un endpoint

Recherchez une annonce ou un bien à partir de son URL

Recherchez des biens immobiliers

Parcourez les résultats de recherche