 |
API Sirene - Documentation des services |
 |
Préambule
Cette documentation présente les fonctionnalités des services web mis à disposition par l'Insee pour l'accès aux données du répertoire Sirene. Un autre document présente le répertoire Sirene et les variables diffusées par ces services. Cette documentation est disponible ici.
Un des objectifs du bouquet de web-services est d'éviter aux utilisateurs de devoir recopier chez eux les données du répertoire Sirene et d'intégrer ses mises à jour.
Cette documentation concerne la version 3.11 d'API Sirene. Elle reste compatible avec la version 3.9. Seules changent l'adresse URL de l'API, les sorties des exemples et les éventuelles listes de variables, puisque 5 nouvelles variables concernant les adresses des établissements apparaissent dans la version 3.11. En cas de montée de version majeure (4.0), la version précédente (3.n) restera disponible au minimum pour 3 mois.
Vous pouvez poser vos questions ou nous signaler toute erreur en utilisant le formulaire de contact du catalogue.
Les données Sirene interrogées sont mises à jour quotidiennement dans la nuit et intègrent les mises à jour de la veille.
Sommaire
1 - Interrogation unitaire par siren
Le service d’interrogation unitaire permet d’interroger l'API Sirene selon deux optiques différentes : obtenir l’historique complet du Siren ou sa situation à une date donnée.
Présentation du service
Exemples et résultats
Appel du service, paramètres et en-tête de la requête
Résultat de la requête et en-tête de la réponse
Résultat de la requête : codes retour
Résultat de la requête : variables de la réponse
Exemple
2 - Interrogation unitaire par siret
Présentation du service
Exemples et résultats
Appel du service, paramètres et en-tête de la requête
Résultat de la requête et en-tête de la réponse
Résultat de la requête : codes retour
Résultat de la requête : variables de la réponse
3 - Recherche multicritère : utilisation du paramètre query
Présentation du service
Paramètre q : recherche sur variable non historisée ou historisée
Recherche par élimination
Recherche sur plusieurs variables (AND, OR)
Recherche exacte, séparateurs de mots et synonymes
Utilisation de caractères spéciaux : « * » et « ? »
Utilisation du caractère spécial « ~ » : recherche approximative
Requête sur une plage de valeurs
Requête sur les variables de type date
Requête avec le paramètre date
Résultat des requêtes multicritères
Pagination des résultats : paramètres debut, nombre, tri
Pagination des résultats : paramètre curseur
Résultat de la requête : codes retour
En-tête et variables de la réponse
4 - Recherche multicritère : utilisation des facettes
Présentation du service - Facettes sur champ
Paramétrage des facettes : debut, nombre, min, tri, manquant, total, modalite et prefixe
Exemples : le paramètre min
Exemples : le paramètre tri
Exemples : le paramètre manquant
Exemples : le paramètre total
Exemples : le paramètre modalite
Exemples : le paramètre prefixe
Facettes sur requête
Facettes sur intervalle
Paramétrer les facettes sur intervalle
Exemples : le paramètre autre
Facettes imbriquées
Exemples avancés : facettes imbriquées, notion de sous-facette
En-têtes de la requête, résultat, en-tête et variables de la réponse
Résultat de la requête : codes retour
5 - Recherche multicritère : les variables en sortie
Paramétrage de la liste des variables en sortie
Champs groupés
Masquer les valeurs nulles
6 - Recherches multicritères spécifiques
Recherche simplifiée
Recherche phonétique
Score
Pondération des variables
7 - Recherche multicritère liens de succession
Présentation et appel du service
En-tête et variables de la réponse. Exemples
Paramètre q : requête sur variable(s), par élimination, sur les variables de type date
En-tête de la requête et résultat ; pagination des résultats : paramètres debut, nombre, tri, curseur
Résultat de la requête : codes retour
8 - Recherche multicritère non diffusibles
Depuis le 21 mars 2023, la modalité non diffusible "N" n’existe plus, et le statut de diffusion des unités antérieurement non diffusibles "N" a été automatiquement passé à "P". Il n’y a donc plus d’unités non diffusibles "N" dans la base Sirene.
Le service n’est donc plus alimenté. Il est obsolète et conservé par rétro compatibilité. Il renvoie désormais un code 405 sytématiquement.
9 - Interrogation des refus d'immatriculation au RCS
Le service n’est plus alimenté. Il est obsolète et conservé par rétro compatibilité. Il renvoie désormais un code 405 sytématiquement.
10 - Service informations
Présentation et appel du service. En-tête de la requête, variables de la réponse et résultat
Codes retour, en-tête et variables de la réponse. Exemple
Annexe : Règles appliquées pour la recherche multicritères :
Variables unité légale, variables établissement, élisions et ponctuation
Tableau des synonymes
Version