Lister des bâtiments

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

Liste des batiments

get

Cet endpoint permet de récupérer une liste paginée de bâtiments. Des filtres, notamment par code INSEE de la commune, sont disponibles.Au moins un filtre est requis.NB : l'URL se termine nécessairement par un slash (/).

Paramètres de requête

insee_codestringOptionnel

Filtre les bâtiments dont l'emprise au sol est située dans les limites géographiques de la commune ayant ce code INSEE.

Example: 75101

statusstringOptionnel

Filtre les bâtiments par statut. Il est possible d'utiliser plusieurs valeurs séparées par des virgules. Les valeurs possibles sont : constructionProject : En projetcanceledConstructionProject : Projet annuléongoingConstruction : Construction en coursconstructed : ConstruitongoingChange : En cours de modificationnotUsable : Non utilisabledemolished : Démoli

Example: constructed,demolished

cle_interop_banstringOptionnel

Filtre les bâtiments associés à cette clé d'interopérabilité BAN.

Example: 94067_7115_00073

withPlotsinteger · enumOptionnel

Inclure les parcelles intersectant les bâtiments de la réponse. 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.

Default: 0Example: 1Valeurs possibles:

formatstring · enumOptionnel

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

Default: jsonExample: geojsonValeurs possibles:

limitinteger · min: 1 · max: 100Optionnel

Nombre maximum de bâtiments à retourner dans la page de résultats. Valeur par défaut : 20. Valeur maximale : 100.

Default: 20Example: 50

bboxstringOptionnel

Filtre les bâtiments dont l'emprise au sol est située dans la bounding box.Le format est min_lon,min_lat,max_lon,max_latLa taille de la bbox est limitée par la contrainte (max_lon - min_lon) * (max_lat - min_lat) < 4. Cela correspond à la surface d'environ deux départements français.

Example: 48.845782,2.424525,48.839201,2.434158

bbstringOptionnel

OBSOLÈTE - préférez le paramètre bbox Filtre les bâtiments dont l'emprise au sol est située dans la bounding box définie par les coordonnées Nord-Ouest et Sud-Est. Les coordonnées sont séparées par des virgules. Le format est nw_lat,nw_lon,se_lat,se_lonLa taille de la bbox est limitée par la contrainte (se_lon - nw_lon) * (nw_lat - se_lat) < 4. Cela correspond à la surface d'environ deux départements français.

Example: 48.845782,2.424525,48.839201,2.434158

Réponses

200

Liste paginée de bâtiments

application/json

nextstring · nullableOptionnel

URL de la page de résultats suivante

Example: https://rnb-api.beta.gouv.fr/api/alpha/buildings/?cursor=cD02MzQ3OTk1

previousstring · nullableOptionnel

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

Example: https://rnb-api.beta.gouv.fr/api/alpha/buildings/?cursor=hFG78YEdFR

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/

HTTPcURLJavaScriptPython

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

{
  "next": "https://rnb-api.beta.gouv.fr/api/alpha/buildings/?cursor=cD02MzQ3OTk1",
  "previous": "https://rnb-api.beta.gouv.fr/api/alpha/buildings/?cursor=hFG78YEdFR",
  "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",
          "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
        }
      ],
      "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
        }
      ]
    }
  ]
}