 |
API Sirene - Documentation des services |
 |
Utilisation des facettes pour les requêtes multicritères
Facettes sur intervalle
Les facettes de type intervalle sont principalement disponibles sur les champs de type date, mais aussi sur les champs numériques (nombre de périodes).
La syntaxe est la suivante :
facette.intervalle=nomFacette
Tous ces paramètres sont obligatoires (si il y a une facette de type intervalle et qu’il manque le sous-paramètre demarrage, fin ou pas, la réponse sera de type 400 – Bad Request).
facette.nomFacette.demarrage=valeurDebut
facette.nomFacette.fin=valeurFin
facette.nomFacette.pas=taillePas
Chaque comptage porte par défaut le nom de la borne inférieure de l’intervalle qu’il calcule.
Les dates doivent obligatoirement être indiquées avec la syntaxe suivante :
AAAA-MM-JJThh:mm:ssZ
Les mots clés suivants sont disponibles pour effectuer des opérations simples sur les dates :
où :
• AAAA est l’année
• MM est le mois
• JJ est le jour du mois
• hh est l’heure (sur 24 heures)
• mm est la minute
• ss est la seconde
• NOW
Les opérations disponibles sont : addition (+), soustraction (-) et arrondi (/).
• YEAR
• MONTH
• DAY
• HOUR
• MINUTE
• SECOND
Exemples :
NOW/YEAR = le 1er janvier à 00h de l’année courante
NOW-7DAY = Il y a 1 semaine
NOW+2MONTH/DAY = Dans 2 mois, à 0h de la journée ainsi trouvée
Attention : le symbole « + » doit être échappé (%2B) car il est réservé dans la syntaxe des URL.
Exemple avec un champ numérique
Dénombrement des unités légales suivant leur nombre de périodes par tranche de 5 pour les unités légales présentant 30 périodes ou plus* :
https://api.insee.fr/api-sirene/3.11/siren?facette.intervalle=nombrePeriodesUniteLegale&facette.nombrePeriodesUniteLegale.demarrage=30&facette.nombrePeriodesUniteLegale.fin=71&facette.nombrePeriodesUniteLegale.pas=5&nombre=0
(*) Comme valeurDebut, valeurFin doit forcément être numérique : dans l'exemple ci-dessus, valeurFin est à 71 parce que https://api.insee.fr/api-sirene/3.11/siren?facette.champ=nombrePeriodesUniteLegale&facette.tri=index:desc&nombre=0 donne un maximum de 70 périodes
{
"header": {
"statut": 200,
"message": "OK",
"total": 24820792,
"debut": 0,
"nombre": 0
},
"unitesLegales": [],
"facettes": [
{
"nom": "nombrePeriodesUniteLegale",
"comptages": [
{
"valeur": "30",
"nombre": 140
},
{
"valeur": "35",
"nombre": 69
},
{
"valeur": "40",
"nombre": 22
},
{
"valeur": "45",
"nombre": 5
},
{
"valeur": "50",
"nombre": 4
},
{
"valeur": "70",
"nombre": 1
}
]
}
]
}
Exemples avec un champ date
Dénombrement des entreprises dont la date de création est dans les trois derniers mois, par mois :
https://api.insee.fr/api-sirene/3.11/siren?nombre=0&facette.intervalle=dateCreationUniteLegale&facette.dateCreationUniteLegale.demarrage=NOW-3MONTH&facette.dateCreationUniteLegale.fin=NOW&facette.dateCreationUniteLegale.pas=%2B1MONTH
Dénombrement des établissements par date de création par tranche de 10 ans à partir du 1er janvier 1980.:
Interrogation le 16 mars 2022
{
"header": {
"statut": 200,
"message": "OK",
"total": 24820792,
"debut": 0,
"nombre": 0
},
"unitesLegales": [],
"facettes": [
{
"nom": "dateCreationUniteLegale",
"comptages": [
{
"valeur": "2021-12-16T08:13:11.413",
"nombre": 102073
},
{
"valeur": "2022-01-16T08:13:11.413",
"nombre": 95712
},
{
"valeur": "2022-02-16T08:13:11.413",
"nombre": 54040
}
]
}
]
}
https://api.insee.fr/api-sirene/3.11/siret?nombre=0&facette.intervalle=dateCreationEtablissement&facette.dateCreationEtablissement.demarrage=1980-01-01T00:00:00Z&facette.dateCreationEtablissement.fin=NOW&facette.dateCreationEtablissement.pas=%2B10YEAR
Dénombrement des entreprises dont la date de création est anticipée de 1 à 3 mois, par semaine :
Interrogation le 16 mars 2022
{
"header": {
"statut": 200,
"message": "OK",
"total": 35321739,
"debut": 0,
"nombre": 0
},
"etablissements": [],
"facettes": [
{
"nom": "dateCreationEtablissement",
"comptages": [
{
"valeur": "1980-01-01",
"nombre": 2183582
},
{
"valeur": "1990-01-01",
"nombre": 5062995
},
{
"valeur": "2000-01-01",
"nombre": 7792065
},
{
"valeur": "2010-01-01",
"nombre": 11943553
},
{
"valeur": "2020-01-01",
"nombre": 3664963
}
]
}
]
}
https://api.insee.fr/api-sirene/3.11/siren?nombre=0&facette.intervalle=dateCreationUniteLegale&facette.dateCreationUniteLegale.demarrage=NOW%2B1MONTH&facette.dateCreationUniteLegale.fin=NOW%2B3MONTH&facette.dateCreationUniteLegale.pas=%2B7DAY
Interrogation le 16 mars 2022
{
"header": {
"statut": 200,
"message": "OK",
"total": 24820792,
"debut": 0,
"nombre": 0
},
"unitesLegales": [],
"facettes": [
{
"nom": "dateCreationUniteLegale",
"comptages": [
{
"valeur": "2022-04-16T08:47:26.64",
"nombre": 20
},
{
"valeur": "2022-04-23T08:47:26.64",
"nombre": 21
},
{
"valeur": "2022-04-30T08:47:26.64",
"nombre": 135
},
{
"valeur": "2022-05-07T08:47:26.64",
"nombre": 10
},
{
"valeur": "2022-05-14T08:47:26.64",
"nombre": 10
},
{
"valeur": "2022-05-21T08:47:26.64",
"nombre": 4
},
{
"valeur": "2022-05-28T08:47:26.64",
"nombre": 80
},
{
"valeur": "2022-06-04T08:47:26.64",
"nombre": 5
},
{
"valeur": "2022-06-11T08:47:26.64",
"nombre": 6
}
]
}
]
}
Commentaires
Attention : avec les valeurs numériques comme avec les dates, on note que le total est égal au nombre total d'unités légales (pas de paramètre q). Dans le cas de l'exemple avec valeurs numériques, entrer le paramètre nombre=241 ne permet pas d'afficher les 241 unités dénombrées dans les facettes.
Pour les obtenir, il faut lancer la requête https://api.insee.fr/api-sirene/3.11/siren?q=nombrePeriodesUniteLegale:[30 TO *]&nombre=241&champs=siren,nombrePeriodesUniteLegale&tri=nombrePeriodesUniteLegale asc
Rappel : les facettes ne sont pas disponibles en csv. Les facettes sur intervalle ne sont pas disponibles sur la console.
Pour en savoir plus