Rechercher un bâtiment

Tous nos points d'accès acceptent un paramètre optionnel supplémentaire from qui vous permet de renseigner une adresse mail. Celle-ci nous permettra de vous prévenir en cas de changement sur l'un des endpoints qui vous utilisez.

Par exemple : https://rnb-api.beta.gouv.fr/api/alpha/buildings/?from=xxx@exemple.fr

Rechercher un bâtiment peut faire partie d'un contexte plus large de rapprochement entre votre base et le RNB. Si c'est le cas, un article dédié discute du sujet.

Bâtiments les plus proches d'un point

get

Cet endpoint permet d'obtenir une liste paginée des bâtiments présents dans un rayon donné autour d'un point donné. Les bâtiments sont triés par distance croissante par rapport au point donné. NB : l'URL se termine nécessairement par un slash (/).

Paramètres de requête

pointstringRequis

Latitude et longitude, séparées par une virgule, du point de recherche.

Example: 44.8201164915397,-0.5717449803671368

radiusnumberRequis

Rayon de recherche en mètres, autour du point. Compris entre 0 et 1000 mètres.

Example: 1000

Réponses

200

Liste paginée des bâtiments les plus proches du point donné

application/json

nextstring · nullableOptionnel

URL de la page de résultats suivante

previousstring · nullableOptionnel

URL de la page de résultats précédente

400

Requête invalide (données mal formatées ou incomplètes).

429

Le quota de requêtes a été atteint. Un quota maximal de 20 requêtes par secondes est appliqué, mais celui-ci peut varier par requête. Veuillez consulter les headers HTTP de la réponse pour plus d'informations concernant le quota.

get/api/alpha/buildings/closest/

GET /api/alpha/buildings/closest/?point=text&radius=1 HTTP/1.1
Host: rnb-api.beta.gouv.fr
Accept: */*

{
  "next": null,
  "previous": null,
  "results": [
    {
      "rnb_id": "PG46YY6YWCX8",
      "status": "constructed",
      "point": {
        "type": "Point",
        "coordinates": [
          -0.570505392116188,
          44.841034137099996
        ]
      },
      "shape": {
        "type": "Point",
        "coordinates": [
          [
            -0.570505392116188,
            44.841034137099996
          ]
        ]
      },
      "addresses": [
        {
          "id": "02191_0020_00003",
          "ban_id": "a2ef3456-7890-1234-abcd-ef1234567890",
          "source": "bdnb",
          "street_number": "3",
          "street_rep": "bis",
          "street": "rue de l'église",
          "city_name": "Chivy-lès-Étouvelles",
          "city_zipcode": "02000",
          "city_insee_code": 2191
        }
      ],
      "validated_by": [
        {
          "id": 1,
          "username": "n.martin",
          "organization_name": "Mairie de Dreux"
        }
      ],
      "ext_ids": [
        {
          "id": "bdnb-bc-3B85-TYM9-FDSX",
          "source": "bdnb",
          "source_version": "2023_01",
          "created_at": "2023-12-07T13:20:58.310444+00:00"
        }
      ],
      "is_active": true,
      "distance": 6.78
    }
  ]
}

Identification de bâtiments par leur adresse

get

Cet endpoint permet d'obtenir une liste paginée des bâtiments associés à une adresse. NB : l'URL se termine nécessairement par un slash (/).

Paramètres de requête

qstringOptionnel

Adresse texte non structurée. L'adresse fournie est recherchée dans la BAN afin de récupérer la clé d'interopérabilité associée. C'est via cette clé que sont filtrés les bâtiments. Si le geocodage échoue aucun résultat n'est renvoyé et le champ status de la réponse contient geocoding_no_result

Example: 4 rue scipion, 75005 Paris

min_scorenumberOptionnel

Score minimal attendu du géocodage BAN. Valeur par défaut : 0.8. Si le score est strictement inférieur à cette limite, aucun résultat n'est renvoyé et le champ status de la réponse contient geocoding_score_is_too_low

Example: 0.9

cle_interop_banstringOptionnel

Clé d'interopérabilité BAN. Si vous êtes en possession d'une clé d'interoperabilité, il est plus efficace de faire une recherche grâce à elle que via une adresse textuelle.

Example: 75105_8884_00004

Réponses

200

Liste paginée des bâtiments associés à l'adresse donnée.

application/json

nextstring · nullableOptionnel

URL de la page de résultats suivante

previousstring · nullableOptionnel

URL de la page de résultats précédente

cle_interop_banstring · nullableOptionnel

Clé d'interopérabilité BAN utilisée pour lister les bâtiments

statusstringOptionnel

'geocoding_score_is_too_low' si le géocodage BAN renvoie un score inférieur à 'min_score'. 'geocoding_no_result' si le géocodage ne renvoie pas de résultats. 'ok' sinon

score_bannumber · nullableOptionnel

Si un géocodage a lieu, renvoie le score du meilleur résultat, celui utilisé pour lister les bâtiments. Ce score doit être supérieur à 'min_score' pour que des bâtiments soient renvoyés.

400

Requête invalide (données mal formatées ou incomplètes).

429

get/api/alpha/buildings/address/

GET /api/alpha/buildings/address/ HTTP/1.1
Host: rnb-api.beta.gouv.fr
Accept: */*

{
  "next": null,
  "previous": null,
  "cle_interop_ban": null,
  "status": "text",
  "score_ban": null,
  "results": [
    {
      "rnb_id": "PG46YY6YWCX8",
      "status": "constructed",
      "point": {
        "type": "Point",
        "coordinates": [
          -0.570505392116188,
          44.841034137099996
        ]
      },
      "shape": {
        "type": "Point",
        "coordinates": [
          [
            -0.570505392116188,
            44.841034137099996
          ]
        ]
      },
      "addresses": [
        {
          "id": "02191_0020_00003",
          "ban_id": "a2ef3456-7890-1234-abcd-ef1234567890",
          "source": "bdnb",
          "street_number": "3",
          "street_rep": "bis",
          "street": "rue de l'église",
          "city_name": "Chivy-lès-Étouvelles",
          "city_zipcode": "02000",
          "city_insee_code": 2191
        }
      ],
      "validated_by": [
        {
          "id": 1,
          "username": "n.martin",
          "organization_name": "Mairie de Dreux"
        }
      ],
      "ext_ids": [
        {
          "id": "bdnb-bc-3B85-TYM9-FDSX",
          "source": "bdnb",
          "source_version": "2023_01",
          "created_at": "2023-12-07T13:20:58.310444+00:00"
        }
      ],
      "is_active": true
    }
  ]
}

Bâtiments intersectant un polygone

get

Cet endpoint permet d'obtenir une liste paginée des bâtiments dont la géométrie intersecte le polygone fourni. Les bâtiments sont triés par IoU (Intersection over Union) décroissant entre leur géométrie et le polygone fourni. Les bâtiments dont la géométrie RNB est un point sont inclus si ce point est dans le polygone; ils sont placés en fin de liste. NB : l'URL se termine nécessairement par un slash (/).

Paramètres de requête

shapestringRequis

Polygone au format WKT (WGS84). Seul le type Polygon est accepté (pas de MultiPolygon), la géométrie doit être en 2D (les géométries 3D, avec une coordonnée Z, sont refusées) et son aire doit être inférieure à 1 km².

Example: POLYGON((5.7213 45.1848, 5.7213 45.1854, 5.7222 45.1854, 5.7222 45.1848, 5.7213 45.1848))

Réponses

200

Liste paginée des bâtiments intersectant le polygone, triée par IoU décroissant

application/json

nextstring · nullableOptionnel

URL de la page de résultats suivante

previousstring · nullableOptionnel

URL de la page de résultats précédente

400

Requête invalide : paramètre shape manquant, WKT non analysable, géométrie qui n'est pas un Polygon, géométrie 3D, polygone invalide ou aire supérieure à 1 km²

429

get/api/alpha/buildings/intersect/

GET /api/alpha/buildings/intersect/?shape=text HTTP/1.1
Host: rnb-api.beta.gouv.fr
Accept: */*

{
  "next": null,
  "previous": null,
  "results": [
    {
      "rnb_id": "PG46YY6YWCX8",
      "status": "constructed",
      "point": {
        "type": "Point",
        "coordinates": [
          -0.570505392116188,
          44.841034137099996
        ]
      },
      "shape": {
        "type": "Point",
        "coordinates": [
          [
            -0.570505392116188,
            44.841034137099996
          ]
        ]
      },
      "addresses": [
        {
          "id": "02191_0020_00003",
          "ban_id": "a2ef3456-7890-1234-abcd-ef1234567890",
          "source": "bdnb",
          "street_number": "3",
          "street_rep": "bis",
          "street": "rue de l'église",
          "city_name": "Chivy-lès-Étouvelles",
          "city_zipcode": "02000",
          "city_insee_code": 2191
        }
      ],
      "validated_by": [
        {
          "id": 1,
          "username": "n.martin",
          "organization_name": "Mairie de Dreux"
        }
      ],
      "ext_ids": [
        {
          "id": "bdnb-bc-3B85-TYM9-FDSX",
          "source": "bdnb",
          "source_version": "2023_01",
          "created_at": "2023-12-07T13:20:58.310444+00:00"
        }
      ],
      "is_active": true,
      "iou": 0.82,
      "input_covered_by_rnb": 0.9,
      "rnb_covered_by_input": 0.88
    }
  ]
}

Bâtiments sur une parcelle cadastrale

get

Cet endpoint permet d'obtenir une liste paginée des bâtiments présents sur une parcelle cadastrale. Les bâtiments sont triés par taux de recouvrement décroissant entre le bâtiment et la parcelle (le bâtiment entièrement sur une parcelle arrive avant celui à moitié sur la parcelle). La méthode de filtrage est purement géométrique et ne tient pas compte du lien fiscal entre le bâtiment et la parcelle. Des faux positifs sont donc possibles. NB : l'URL se termine nécessairement par un slash (/).

Paramètres de chemin

plot_idstringRequis

Identifiant de la parcelle cadastrale.

Example: 01402000AB0051

Réponses

200

Liste paginée des bâtiments présents sur la parcelle cadastrale

application/json

nextstring · nullableOptionnel

URL de la page de résultats suivante

previousstring · nullableOptionnel

URL de la page de résultats précédente

400

Requête invalide (données mal formatées ou incomplètes).

429

get/api/alpha/buildings/plot/{plot_id}/

GET /api/alpha/buildings/plot/{plot_id}/ HTTP/1.1
Host: rnb-api.beta.gouv.fr
Accept: */*

{
  "next": null,
  "previous": null,
  "results": [
    {
      "rnb_id": "PG46YY6YWCX8",
      "status": "constructed",
      "point": {
        "type": "Point",
        "coordinates": [
          -0.570505392116188,
          44.841034137099996
        ]
      },
      "shape": {
        "type": "Point",
        "coordinates": [
          [
            -0.570505392116188,
            44.841034137099996
          ]
        ]
      },
      "addresses": [
        {
          "id": "02191_0020_00003",
          "ban_id": "a2ef3456-7890-1234-abcd-ef1234567890",
          "source": "bdnb",
          "street_number": "3",
          "street_rep": "bis",
          "street": "rue de l'église",
          "city_name": "Chivy-lès-Étouvelles",
          "city_zipcode": "02000",
          "city_insee_code": 2191
        }
      ],
      "validated_by": [
        {
          "id": 1,
          "username": "n.martin",
          "organization_name": "Mairie de Dreux"
        }
      ],
      "ext_ids": [
        {
          "id": "bdnb-bc-3B85-TYM9-FDSX",
          "source": "bdnb",
          "source_version": "2023_01",
          "created_at": "2023-12-07T13:20:58.310444+00:00"
        }
      ],
      "is_active": true,
      "bdg_cover_ratio": 0.65
    }
  ]
}

PrécédentLister des bâtiments

SuivantStandard OGC API - Features

Mis à jour il y a 29 jours

Ce contenu vous a-t-il été utile ?