Consulter 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=[e-mail]

API RNB au standard OGC API - Features

En plus du endpoint décrit sur cette page, nous proposons un endpoint respectant le standard OGC API - Features. Il permet d'utiliser plus facilement notre API dans des outils comme QGIS, FME ou ArcGIS.

Consulter

Consultation d'un bâtiment

get

Cet endpoint permet de récupérer l'ensemble des attributs d'un bâtiment à partir de son identifiant RNB. NB : l'URL se termine nécessairement par un slash (/).

Paramètres de chemin

rnb_idstringRequis

Identifiant unique du bâtiment dans le RNB (ID-RNB)

Example: PG46YY6YWCX8

Paramètres de requête

withPlotsstringOptionnel

Inclure les parcelles intersectant le bâtiment. Valeur attendue : 1. Chaque parcelle associée intersecte le bâtiment correspondant. Elle contient son identifiant ainsi que le taux de couverture du bâtiment par cette parcelle.

Example: 1

formatstringOptionnel

Format de la réponse. Valeurs possibles : json (par défaut) ou geojson. En format geojson, la réponse est un objet de type Feature tel que défini dans le standard GeoJSON.

Example: geojson

Réponses

200

Détails du bâtiment

application/json

rnb_idstringOptionnel

Identifiant unique du bâtiment dans le RNB

Example: PG46YY6YWCX8

statusstring · enumOptionnel

Statut du bâtiment

Example: constructedValeurs possibles:

is_activebooleanOptionnel

Indique si l'identifiant RNB est actif (True) ou inactif (False). Un identifiant inactif désigne un objet ne correspondant pas à la définition d'un bâtiment.

Example: true

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/{rnb_id}/

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

{
  "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,
  "plots": [
    {
      "id": "01402000AB0051",
      "bdg_cover_ratio": 0.403
    }
  ]
}