Sociétés

Recherche multicritère paginée par curseur (v1.1)

Un filtre géographique est OBLIGATOIRE (code_postal, departement ou region) : c'est lui qui est servi par un index. naf, tranche_effectif, forme_juridique, cree_apres, cree_avant, etat et avec_site_web sont appliqués sur les sociétés de cette zone. Tri : code postal, nom. Une page peut être incomplète (budget de lecture par appel) : continuer avec curseur tant que curseur_suivant n'est pas null. Coût : 1 unité par appel.

get/societes/recherche

Request

  • Base URL: https://api.propecto.eu/v1
  • URL: https://api.propecto.eu/v1/societes/recherche
  • Auth: one of:
    • API key in header x-api-cle
    • HTTP bearer

Query parameters

code_postalstring[]

Codes postaux (FR : 5 chiffres ; BE : 4 chiffres ; 100 au plus) (liste séparée par des virgules)

departementstring[]

Départements, codes INSEE (FR : 01…95, 2A, 2B, 971…976) (liste séparée par des virgules)

regionstring[]

Régions, codes INSEE (FR : 11, 24, 27, 28, 32, 44, 52, 53, 75, 76, 84, 93, 94, 01…06) ou noms (liste séparée par des virgules)

nafstring[]

Activité — FR : NAF rév. 2 (62.01Z, 6201Z, classe 62.01, groupe 62.0, division 62, section J) ; BE : NACE-BEL 2 à 5 chiffres (liste séparée par des virgules)

tranche_effectifstring[]

Tranches INSEE (FR) : NN, 00, 01, 02, 03, 11, 12, 21, 22, 31, 32, 41, 42, 51, 52, 53 (liste séparée par des virgules)

forme_juridiquestring[]

Catégories juridiques INSEE (FR) : 1, 2 ou 4 chiffres (préfixe) (liste séparée par des virgules)

cree_apresstring date

Créée le ou après (AAAA-MM-JJ).

cree_avantstring date

Créée le ou avant (AAAA-MM-JJ).

etat'actif' | 'cesse' | 'tous'

État administratif.

pays'FR' | 'BE'

Pays.

avec_site_webboolean

Seulement les sociétés avec (true) ou sans (false) site web déclaré.

limiteinteger

Nombre de résultats (1 à 100).

curseurstring

Curseur opaque renvoyé par la page précédente (lié aux mêmes filtres).

Response

Page de résultats.

curseur_suivantstring nullable required

Curseur de la page suivante ; null quand la recherche est terminée. Une page peut être incomplète (voire vide) avec un curseur non nul : continuer tant qu'il n'est pas null.

lignes_luesinteger required

Lignes examinées pour produire la page (diagnostic).

Example response

{
  "resultats": [
    {
      "identifiant": "100000009",
      "pays": "FR",
      "siren": "100000009",
      "nom": "EXEMPLE SAS",
      "naf": {
        "code": "62.01Z",
        "libelle": "Programmation informatique"
      },
      "adresse": {
        "code_postal": "75001",
        "ville": "PARIS",
        "departement": "75"
      },
      "date_creation": "2015-06-01",
      "etat": "actif",
      "tranche_effectif": {
        "code": "11",
        "libelle": "10 à 19 salariés",
        "annee": null
      },
      "url_fiche": "https://www.propecto.eu/entreprise/100000009"
    }
  ],
  "curseur_suivant": "eyJ2IjoxfQ",
  "lignes_lues": 1816
}

Changes

No recorded changes to this operation across all 1 revision of this API.