Logo de l'API Sirene

API Sirene - Documentation des services

Logo de l'Insee
retour au sommaire

Liens de succession : en-tête de la requête, résultat et pagination

En-tête de la requête

L’authentification se fait en passant votre clé d’accès dans l’en-tête Authorization.
Le seul format de données produit correspond à Accept application/json.
Le contenu de la réponse peut être compressé afin de limiter sa taille. L'algorithme de compression utilisé est le gzip.
Pour recevoir une réponse compressée, il faut ajouter dans l'en-tête HTTP le paramètre Accept-Encoding et le valoriser à gzip.

Résultat de la requête

Les réponses sont par défaut en JSON et renvoient les Siren (resp les Siret) répondant à la requête avec la totalité des périodes pour les variables historisées. Le header est complété par le nombre total de résultats de la requête (total), le rang de début et le nombre de résultats effectivement retournés (20 par défaut) et, si le paramètre curseur est utilisé (Cf. infra), le curseur et le curseur suivant.
Le retour peut être fourni au format CSV par négociation du contenu via le paramètre Accept de l’en-tête http : accept:text/csv

Pagination des résultats : paramètres debut, nombre, tri, curseur

Tous les résultats des recherches multicritères sont renvoyés par page. Plusieurs paramètres peuvent être passés dans l’URL pour paramétrer la page.

Paramètres de pagination recommandés

paramètre

Format demandé : JSON

Format demandé : CSV

possible

valeur limite inférieure

valeur limite supérieure

possible

valeur limite inférieure

valeur limite supérieure

nombre

oui

0

1 000

oui

0

200 000

debut

oui

0

1 000

oui

0

10 000

tri

oui

Sans objet

Sans objet

Automatique

Sans objet

Sans objet

{nombre} d’unités légales ou établissements à afficher par page. La valeur par défaut est 20 réponses par page.
{debut} correspond au rang de classement du premier établissement à afficher sur la page. La valeur par défaut est 0 (attention 0 correspond au premier établissement).
{tri} indique comment les résultats doivent être triés. Par défaut, les résultats sont triés par siretEtablissementPredecesseur croissant. En fixant le paramètre à successeur (et non à siretEtablissementSuccesseur), les résultats sont triés par siretEtablissementSuccesseur croissant. Aucun tri n'est possible sur les dates
Utilisation du paramètre Curseur (format JSON uniquement)
Si vous désirez parcourir un grand nombre de résultats, notamment pour obtenir des résultats au-delà de la limite indiquée ci-dessus, pour des raisons de performance il est fortement recommandé d’utiliser des curseurs.
À votre première requête, ajouter le paramètre curseur=*.
Le retour de la requête contiendra la variable CurseurSuivant qui donnera la valeur à attribuer au paramètre curseur pour obtenir la page suivante.
Quand la valeur de CurseurSuivant dans le résultat est la même que celle envoyée avec la requête (variable Curseur) il n’y a plus de résultat à récupérer.

Exemple d'utilisation du paramètre curseur

Recherche de tous les liens de succession enregistrés entre le 20 et le 22 décembre 2020 :
1ère requête avec curseur :
https://api.insee.fr/api-sirene/3.11/siret/liensSuccession?q=dateLienSuccession:[2020-12-20 TO 2020-12-22]&curseur=*&nombre=1000
{
    "header": {
        "statut": 200,
        "message": "OK",
        "total": 2243,
        "debut": 0,
        "nombre": 1000,
        "curseur": "*",
        "curseurSuivant": "AoMuODA1MTUxMzIxMDAwNDFwwI+mwfYCKTI0Njk1NDMxMA=="
    },
    "liensSuccession": [
        {
            "siretEtablissementPredecesseur": "02407671300023",
            "siretEtablissementSuccesseur": "02407671300031",
            "dateLienSuccession": "2020-12-22",
            "transfertSiege": false,
            "continuiteEconomique": true,
            "dateDernierTraitementLienSuccession": "2021-03-18T19:32:31.423"
...
...
2ème requête avec curseur :
https://api.insee.fr/api-sirene/3.11/siret/liensSuccession?q=dateLienSuccession:[2020-12-20 TO 2020-12-22]&curseur=AoMuODA1MTUxMzIxMDAwNDFwwI%2BmwfYCKTI0Njk1NDMxMA==&nombre=1000
    {
    "header": {
        "statut": 200,
        "message": "OK",
        "total": 2243,
        "debut": 0,
        "nombre": 1000,
        "curseur": "AoMuODA1MTUxMzIxMDAwNDFwwI+mwfYCKTI0Njk1NDMxMA==",
        "curseurSuivant": "AoMuODgzMjI3NjM5MDAwMjdwwI+mwfYCKTI0NjI5MTM1Mw=="
    },
    "liensSuccession": [
        {
            "siretEtablissementPredecesseur": "80517525400012",
            "siretEtablissementSuccesseur": "80517525400020",
...
...
3ème requête avec curseur :
https://api.insee.fr/api-sirene/3.11/siret/liensSuccession?q=dateLienSuccession:[2020-12-20 TO 2020-12-22]&curseur=AoMuODgzMjI3NjM5MDAwMjdwwI%2BmwfYCKTI0NjI5MTM1Mw==&nombre=1000
    {
    "header": {
        "statut": 200,
        "message": "OK",
        "total": 2243,
        "debut": 0,
        "nombre": 243,
        "curseur": "AoMuODgzMjI3NjM5MDAwMjdwwI+mwfYCKTI0NjI5MTM1Mw==",
        "curseurSuivant": "AoMuOTY4NDExODg0MDAwMjRwwI+mwfYCKTI0NjcwOTYwMg=="
    },
    "liensSuccession": [
        {
            "siretEtablissementPredecesseur": "88330621900014",
            "siretEtablissementSuccesseur": "88330621900022",
...
...
4ème requête avec curseur :
https://api.insee.fr/api-sirene/3.11/siret/liensSuccession?q=dateLienSuccession:[2020-12-20 TO 2020-12-22]&curseur=AoMuOTY4NDExODg0MDAwMjRwwI%2BmwfYCKTI0NjcwOTYwMg==&nombre=1000
    {
    "header": {
        "statut": 200,
        "message": "OK",
        "total": 2243,
        "debut": 0,
        "nombre": 0,
        "curseur": "AoMuOTY4NDExODg0MDAwMjRwwI+mwfYCKTI0NjcwOTYwMg==",
        "curseurSuivant": "AoMuOTY4NDExODg0MDAwMjRwwI+mwfYCKTI0NjcwOTYwMg=="
    },
    "liensSuccession": []

Commentaires

La dernière requête renvoie 0 unités et curseur = curseurSuivant.
Rappel : les curseurs ne sont pas disponibles en csv.
Les formats de sortie sont identiques sur la console. Pour en savoir plus

Haut de page