Identification de 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]

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

radiusintegerRequis

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

Example: 1000

Réponses

get

HTTPcURLJavaScriptPython

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

{
  "next": "text",
  "previous": "text",
  "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"
        }
      ],
      "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_scorefloatOptionnel

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

get

HTTPcURLJavaScriptPython

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

{
  "next": "text",
  "previous": "text",
  "cle_interop_ban": "text",
  "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",
          "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"
        }
      ]
    }
  ]
}

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

get

HTTPcURLJavaScriptPython

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

{
  "next": "text",
  "previous": "text",
  "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"
        }
      ]
    }
  ]
}