API Sirene - Documentation des services

retour au sommaire

---

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

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. Les paramètres possibles et les limites de valeur des paramètres dépendent du type de sortie demandé (JSON ou CSV).

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).
Attention : lorsque vous souhaitez utiliser le paramètre {debut}, il est fortement recommandé d'utiliser le paramètre {tri}.
{tri} indique si les résultats doivent ou non être triés. Par défaut le paramètre vaut false afin de favoriser la performance de l'appel. Dans ce cas, les résultats sont triés par un score de pertinence. Si plusieurs éléments obtiennent le même score ils peuvent arriver dans n'importe quel ordre et cet ordre peut varier d'une interrogation à l'autre. En fixant le paramètre à true, les éléments obtenant le même score seront classés par siren ou siret selon la collection interrogée. Ce paramétrage à true est fortement recommandé lorsque le paramètre {debut} est utilisé. Le paramètre true est inactif pour la sortie au format CSV (tri automatique par siren ou siret croissant).

Il est possible de paramétrer un tri sur une ou plusieurs variables, en remplissant la zone {tri} par :

- le nom d'une une variable non-historisée ;
- une liste de plusieurs noms de variables non-historisées, séparées par des virgules, sans espace

Pour chaque variable, il peut être précisé si le tri doit être ascendant (asc) ou descendant (desc) ; en l'absence de précision, le tri sera ascendant. Les tris sont appliqués dans l'ordre de la liste.

Exemples de tris

Tri ascendant sur une variable. Recherche de toutes les unités légales ayant exactement wilfrid en premier prénom et dont le deuxième prénom est renseigné, triée sur le deuxième prénom (tri ascendant par défaut) :
https://api.insee.fr/entreprises/sirene/V3.11/siren?q=prenom1UniteLegale:"wilfrid" AND prenom2UniteLegale:*&tri=prenom2UniteLegale&champs=prenom1UniteLegale,prenom2UniteLegale

 "header": {
        "statut": 200,
        "message": "OK",
        "total": 715,
        "debut": 0,
        "nombre": 20
    },
    "unitesLegales": [
        {
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "ADOLPHE"
        },
        {
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "ADRIEN"
        },
        {
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "AIME-CLAUDE"
        },
        {
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "ALAIN"
        },
		...

Tri descendant sur une variable. Recherche de toutes les unités légales ayant exactement wilfrid en premier prénom et dont le deuxième prénom est renseigné, triée sur le deuxième prénom (tri descendant) :
https://api.insee.fr/entreprises/sirene/V3.11/siren?q=prenom1UniteLegale:"wilfrid" AND prenom2UniteLegale:*&tri=prenom2UniteLegale desc&champs=prenom1UniteLegale,prenom2UniteLegale

    "header": {
        "statut": 200,
        "message": "OK",
        "total": 715,
        "debut": 0,
        "nombre": 20
    },
    "unitesLegales": [
        {
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "ZEPHIRIN"
        },
        {
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "YVON"
        },
        {
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "YVES"
        },
        {
            "prenom1UniteLegale": "WILFRID YVAN",
            "prenom2UniteLegale": "YVAN"
        },
		...

Tri ascendant sur plusieurs variables. Recherche de toutes les unités légales ayant exactement wilfrid en premier prénom et dont le deuxième prénom commence par un "e", triée sur le deuxième prénom puis le siren (tri ascendant par défaut sur les deux variables) :
https://api.insee.fr/entreprises/sirene/V3.11/siren?q=prenom1UniteLegale:"wilfrid" AND prenom2UniteLegale:e*&tri=prenom2UniteLegale,siren&champs=prenom1UniteLegale,prenom2UniteLegale,siren

   "header": {
        "statut": 200,
        "message": "OK",
        "total": 34,
        "debut": 0,
        "nombre": 20
    },
    "unitesLegales": [
        {
            "siren": "443659180",
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "EDDY"
        },
        {
            "siren": "903283885",
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "EDDY"
        },
        {
            "siren": "382347003",
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "EDGARD"
        },
        {
            "siren": "517874855",
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "EDGARD"
        },
        {
            "siren": "342548567",
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "EDOUARD"
        },
		...

Tri ascendant sur plusieurs variables. Recherche de toutes les unités légales ayant exactement wilfrid en premier prénom et dont le deuxième prénom commence par un "e", triée sur le deuxième prénom (ascendant par défaut) puis le siren (tri descendant) :
https://api.insee.fr/entreprises/sirene/V3.11/siren?q=prenom1UniteLegale:"wilfrid" AND prenom2UniteLegale:e*&tri=prenom2UniteLegale,siren desc&champs=prenom1UniteLegale,prenom2UniteLegale,siren

"header": {
        "statut": 200,
        "message": "OK",
        "total": 34,
        "debut": 0,
        "nombre": 20
    },
    "unitesLegales": [
        {
            "siren": "903283885",
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "EDDY"
        },
        {
            "siren": "443659180",
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "EDDY"
        },
        {
            "siren": "517874855",
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "EDGARD"
        },
        {
            "siren": "382347003",
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "EDGARD"
        },
        {
            "siren": "353785330",
            "prenom1UniteLegale": "WILFRID",
            "prenom2UniteLegale": "EDOUARD"
        },
		...

Commentaires

Le tri ne doit pas être utilisé avec les curseurs.
Les paramètres de pagination sont également disponibles sur la console. Pour en savoir plus

Haut de page

---