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=xxx@exemple.fr

Le endpoint suivant est en cours de dépréciation. Sa philosophie était de pouvoir combiner un certain nombre d'indices concernant un bâtiment à identifier (position, adresse, nom du bâtiment) et de réussir à deviner le bâtiment correspondant. En pratique il n'est quasiment jamais appelé avec des indices multiples !

Nous sommes donc en train de le remplacer par une série d'endpoints plus simples qui permettront également d'identifier un bâtiment de diverses manières avec de meilleures performances.

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.

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.

PrécédentListing de bâtiments SuivantDifférentiel entre deux dates

Dernière mise à jour il y a 10 jours

Identification de bâtiment

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

Bâtiments les plus proches d'un point

Ce 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 (/).

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

Query parameters

Response

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

Body

nextnullable string

URL de la page de résultats suivante

previousnullable string

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

resultsarray of all of

Request

const response = await fetch('https://rnb-api.beta.gouv.fr/api/alpha/buildings/closest/?point=text&radius=0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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

Ce 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 (/).

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

Query parameters

Response

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

Body

nextnullable string

URL de la page de résultats suivante

previousnullable string

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

cle_interop_bannullable string

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

statusstring

'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_banfloat

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.

resultsnullable array of Building (object)

Request

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

Response

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

Bâtiments sur une parcelle cadastrale

Ce 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 (/).

GEThttps://rnb-api.beta.gouv.fr/api/alpha/buildings/plot/{plot_id}/

Path parameters

plot_id*string

Identifiant de la parcelle cadastrale.

Example: "01402000AB0051"

Response

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

Body

nextnullable string

URL de la page de résultats suivante

previousnullable string

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

resultsarray of all of

Request

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

Response

{
  "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"
        }
      ]
    }
  ]
}

Nous sommes donc en train de le remplacer par une série d'endpoints plus simples qui permettront également d'identifier un bâtiment de diverses manières avec de meilleures performances.

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

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

Body

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

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

Response

[
  {
    "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.

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.

PrécédentListing de bâtiments SuivantDifférentiel entre deux dates

Dernière mise à jour il y a 10 jours