Le service peut également être utilisé au travers de son API, qui est décrite ici.

Généralités

Le domaine racine (endpoint) est le suivant : https://insee.arbre.app

Les résultats sont retournés au format json.

Il n'y a pas besoin de s'authentifier ; l'accès est libre et ne nécessite pas de jeton. Pour le bon fonctionnement des services il vous est demandé de ne pas abuser de l'API : essayez de rester au dessous des 3600 requêtes par heure et par adresse IP. Privilégiez par ailleurs la définition d'un champ User-Agent explicite (même si cela n'est pas requis).

Recherche de fiches

Permet de lancer une recherche parmi les fiches individuelles.

Méthode /persons (GET)

Paramètre	Description	Type de valeur	Valeur par défaut
surname	Nom(s) de famille	Chaîne	(paramètre requis)
name	Prénom(s)	Chaîne
place	Identifiant du lieu*	Entier positif
event	Type d'événement	birth ou death	birth
after	Borne inférieure de l'année	Année
before	Borne supérieure de l'année	Année
order	Ordre de tri	ascending ou descending	ascending
offset	Décalage	Entier positif	0
limit	Limite	Entier de 0 à 100	10

^* : voir plus bas.

Exemple : https://insee.arbre.app/persons?surname=chirac&name=jacques+rene

{
  "code": 200,
  "count": 1,
  "results": [
    {
      "birthDate": "1932-11-29",
      "birthPlace": "Paris 5e Arrondissement, Paris, Île-de-France, France",
      "deathDate": "2019-09-26",
      "deathPlace": "Paris 6e Arrondissement, Paris, Île-de-France, France",
      "gender": true,
      "nom": "CHIRAC",
      "prenom": "Jacques René"
    }
  ]
}
                                

Recherche de lieux

Permet d'obtenir l'identifiant d'un lieu.

Méthode /places (GET)

Paramètre	Description	Type de valeur	Valeur par défaut
prefix	Recherche	Chaîne	(paramètre requis)
limit	Limite	Entier de 0 à 25	10

Exemple : https://insee.arbre.app/places?prefix=paris&limit=3

{
  "code": 200,
  "results": [
    {
      "fullname": "Paris, Île-de-France, France",
      "id": 99
    },
    {
      "fullname": "Paris 14e Arrondissement, Paris, Île-de-France, France",
      "id": 108
    },
    {
      "fullname": "Paris 15e Arrondissement, Paris, Île-de-France, France",
      "id": 103
    }
  ]
}
                                

Statistiques géographiques

Permet d'obtenir des statistiques géographiques pour une recherche.

Méthode /stats/geography (GET)

Paramètre	Description	Type de valeur	Valeur par défaut
surname	Nom(s) de famille	Chaîne	(paramètre requis)
name	Prénom(s)	Chaîne

Exemple : https://insee.arbre.app/stats/geography?surname=chirac&name=jacques

{
  "code": 200,
  "results": [
    {
      "count": 1,
      "name": "D-75"
    },
    {
      "count": 1,
      "name": "D-19"
    },
    {
      "count": 1,
      "name": "D-63"
    }
  ]
}
                            

Statistiques annuelles

Permet d'obtenir des statistiques par année pour une recherche.

Méthode /stats/time (GET)

Paramètre	Description	Type de valeur	Valeur par défaut
surname	Nom(s) de famille	Chaîne	(paramètre requis)
name	Prénom(s)	Chaîne
place	Identifiant du lieu	Entier positif
event	Type d'événement	birth ou death	birth

Exemple : https://insee.arbre.app/stats/time?surname=chirac&name=jacques&event=birth

{
  "code": 200,
  "results": [
    {
      "count": 1,
      "name": "1926"
    },
    {
      "count": 1,
      "name": "1932"
    }
  ]
}