Identification de bâtiment

Identification de bâtiment

Ce endpoint permet d'identifier le bâtiment correspondant à une série de critères. Il permet d'accueillir des données imprécises et tente de les combiner pour fournir le meilleur résultat. NB : l'URL se termine nécessairement par un slash (/).

GEThttps://rnb-api.beta.gouv.fr/api/alpha/buildings/guess/

Query parameters

Response

200

Liste des bâtiments identifiés triés par score descendant.

Body

application/json

rnb_idstring

Identifiant unique du bâtiment dans le RNB

Example: "PG46YY6YWCX8"

statusenum

Statut du bâtiment

Example: "constructed"

constructionProjectcanceledConstructionProjectongoingConstructionconstructedongoingChangenotUsabledemolished

pointobject

Coordonnées géographiques du bâtiment au format GeoJSON. Le système de référence géodésique est le WGS84.

shapeobject

Géométrie du bâtiment au format GeoJSON. Le système de référence géodésique est le WGS84. Elle peut être un multipolygone, un polygone ou un point et correspond notre meilleure connaissance de la réalité:

addressesarray of BuildingAddress (object)

Liste des adresses du bâtiment

ext_idsarray of object

Le ou les identifiants de ce bâtiments au sein de la BD Topo et de la BDNB

scorenumber

Score de correspondance entre la requête et le bâtiment

Example: 0.8

sub_scoresobject

Liste des scores intermédiaires. Leur somme est égale au score principal.

Request

JavaScriptCurlPython

const response = await fetch('https://rnb-api.beta.gouv.fr/api/alpha/buildings/guess/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "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"
      }
    ],
    "score": 0.8
  }
]

Signification et calcul du score

Les résultats de l'identification sont triés par score décroissant. Le détail du calcul du score est détaillé dans la class `GuessBuilding` consultable sur notre repository Github.

1. Calcul d'un score absolu pour chaque bâtiment

Nous utilisons les inputs donnés dans la requête pour calculer un score absolu pour chaque bâtiment. Voici quelques exemples de signaux faisant monter le score d'un bâtiment :

• Le bâtiment est du même côté de la route que le point de la requête

• Le bâtiment est proche du point de la requête (avec un fort bonus si le point est *sur* le bâtiment)

• Le bâtiment a le même identifiant BAN que celui retourné par l'API de la Base Adresse Nationale

• etc ...

A la fin de cette étape le score de chaque bâtiment varie généralement entre 0 et 20 mais fondamentalement le score absolu n'a pas de limite haute.