The service may also be used through the mean of its API, which is described here.

General

The root domain is the following: https://insee.arbre.app

The results are returned in json format.

Authentication is not needed; access is free and does not require a token. For the good operation of the services you are asked to avoid abusing the API: please try to stay below 3600 requests per hour and per ip address. You are also encouraged to use an explicit User-Agent field (even if this is not mandatory).

Records querying

Performs a query among the individual records.

Method /persons (GET)

Parameter	Description	Value type	Default value
surname	Surname(s)	String	(required parameter)
name	Given name(s)	String
place	Place identifier*	Positive integer
event	Event kind	birth or death	birth
after	Lower bound on the year	Year
before	Upper bound on the year	Year
order	Sorting order	ascending or descending	ascending
offset	Offset	Positive integer	0
limit	Limit	Integer from 0 to 100	10

^*: see below.

Example: 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é"
    }
  ]
}
                                

Place querying

Performs a query among the available places.

Method /places (GET)

Parameter	Description	Value type	Default value
prefix	Search	String	(required parameter)
limit	Limit	Integer from 0 to 25	10

Example: 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
    }
  ]
}
                                

Geographical statistics

Gather geographical statistics for a search query.

Method /stats/geography (GET)

Parameter	Description	Value type	Default value
surname	Surname(s)	String	(required parameter)
name	Given name(s)	String

Example: 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"
    }
  ]
}
                            

Annual statistics

Gather annual statistics for a search query.

Method /stats/time (GET)

Parameter	Description	Value type	Default value
surname	Surname(s)	String	(required parameter)
name	Given name(s)	String
place	Place identifier	Positive integer
event	Event kind	birth or death	birth

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

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