API Reference

Accédez et intégrez facilement nos données via une simple requête HTTP

Version 1.0

Operational

Documentation interactive Swagger

Authentification

L'API utilise des clés API pour authentifier les requêtes.

Header requis

X-Api-Key: YOUR_API_KEY

GET

/api/Poi

Lance la génération asynchrone d'un rapport PDF pour une adresse donnée.

Query Parameters

Paramètre	Type	Requis	Description
Latitude	number	Oui	Latitude de la position cible.
Longitude	number	Oui	Longitude de la position cible.
Radius	number(integer)	Oui	Rayon en mètres.
IncludeTypes	POIType[]	Non	Points d'intêret à inclure
ExcludeTypes	POIType[]	Non	Points d'intêret à exclure
Page	number	Non	-
PageSize	number	Non	Maximum 100.

Exemples

bash

curl -X GET "https://data.rapportimmo.fr/api/Poi?Latitude=48.862725&Longitude=2.287592&Radius=2000&IncludeTypes=Metro&IncludeTypes=BusStop&ExcludeTypes=Gare&ExcludeTypes=Tram&Page=1&PageSize=20" \
  -H "X-Api-Key: YOUR_API_KEY"

Réponse (200 OK)

json

{
  "items": [
     {
      "id": "695f1e914d6cf77dd0372f7a",
      "type": "Metro",
      "latitude": 48.863045,
      "longitude": 2.2871938000000003,
      "distance": 46.035913696029866,
      "label": "Trocadéro",
      "address": "4 Place du Trocadéro et du Onze Novembre 75016 Paris"
    },
    ...
  ],
  "count": 160
}

Définitions

POIType

L'énumération POIType permet de filtrer les points d'intérêts retournés par l'API. Voici les valeurs acceptées classées par catégorie.

typescript

export type POIType = 
  | "Metro" | "BusStop" | "BusStation" | "Gare" | "Tram" | "Velo"
  | "Maternelle" | "EcolePrimaire" | "College" | "Lycee" | "EnseignementSuperieur"
  | "Mairie" | "BureauPoste" | "FranceServices" | "Tribunal" | "Police" | "Gendarmerie" | "Pompiers"
  | "Hopital" | "Pharmacie" | "Laboratoire" | "MaisonSante" | "PMI"
  | "Supermarche" | "Epicerie" | "Boulangerie" | "Boucherie" | "Restaurant" | "BarCafe" 
;