Documentation de l'API

Nous travaillons à rendre notre API à la fois puissante et facile d'utilisation. Vous trouverez dans cette documentation l'ensemble des éléments nécessaires à son utilisation.

N'hésitez pas à nous contacter si vous avez besoin de précisions : [email protected]

Introduction

Tous les échanges à l'API se font en JSON. Les résultats et les erreurs vous serons renvoyés ainsi.

Erreurs

Dans le cas où la requête ne fonctionne pas correctement, vous recevrez un message d'erreur ainsi qu'un status code adapté. Voici la liste des messages possibles:

  • 401 Echec de l'authentification.
  • 404 Ressource non trouvée. Notamment dans le cas où l'entreprise n'existe pas.
  • 429 Limite de résultats mensuelle dépassée.
  • 5xx Cette erreur est de notre faute.

Exemple d'erreur (404) :

{ "status":"error", "message":"Entreprise avec le siren 111111111 non trouvée" }

Afficher une entreprise

Vous pouvez obtenir l'ensemble des informations dont nous disposons sur une entreprise à partir de son numéro de SIREN.

Endpoint : /api/v1/companies/803417153

Exemple de réponse si l'entreprise existe :

{ "status": "success", "params": { "siren": "803417153" }, "company": { "siren": "803417153", "names": { "best": "Firmapi", "denomination": "FIRMAPI", "commercial_name": "Firmapi", "sigle": null, "first_name": null, "last_name": null }, "legal_form": "SARL", "address": "5 rue d'Alsace", "activity": "Informatique, services aux entreprises.", "postal_code": "69100", "city": "Villeurbanne", "vat_number": "FR30803417153", "capital": 1000, "administration": "Gérant : FINKELSTEIN Antoine Victor nom d'usage : FINKELSTEIN. ", "radie": false, "last_legal_update": "2015-02-08", "established_on": "2014-07-22", "id": 2441090 } }

Si l'entreprise n'est pas trouvée, nous renvoyons un message d'erreur avec le statut 404 :

{ "status":"error", "message":"Entreprise avec le siren 111111111 non trouvée" }

Rechercher des entreprises

Les recherches s'effectuent toutes sur un seul endpoint. En fonction de vos besoins, vous faîtes donc varier les paramètres.

Pour information :

  • Si vous n'indiquez aucun critère de recherche, vous allez pouvoir parcourir l'ensemble de la base de données. Cela peut être intéressant si vous souhaitez la dupliquer sur votre système.
  • En raison de la taille de la base, la pagination ne fonctionne pas avec un offset mais un pointeur. Ainsi vous devez prendre l'id de la dernière entreprise et le passer comme argument au paramètre start_after= pour obtenir la page suivante.
Endpoint : /api/v1/companies

Paramètres autorisés :

  • postal_code
  • radie ; Defaut : false.
  • department
  • legal_form
  • name ; Recherche une entreprise par nom. Indiquer d'autres critères améliorera la probabilité de trouver la bonne entreprise.
  • limit ; Par défaut de 100, le nombre de résultat peut être compris entre 1 et 1 000.
  • start_after ; Utiliser l'id du dernier élément de la page actuelle.

Exemple de réponse :

{ "status": "success", "params": { "name": "Firmapi" }, "companies": [ { "siren": "803417153", "names": { "best": "Firmapi", "denomination": "FIRMAPI", "commercial_name": "Firmapi", "sigle": null, "first_name": null, "last_name": null }, "legal_form": "SARL", "address": "5 rue d'Alsace", "activity": "Informatique, services aux entreprises.", "postal_code": "69100", "city": "Villeurbanne", "vat_number": "FR30803417153", "capital": 1000, "administration": "Gérant : FINKELSTEIN Antoine Victor nom d'usage : FINKELSTEIN. ", "radie": false, "last_legal_update": "2015-02-08", "established_on": "2014-07-22", "id": 2441090 }, {...} ] }

Lister les créations d'entreprises

Vous pouvez lister les entreprises en fonction de leur date de création. Nous mettons à jour en permanence la base de données, vous pouvez donc obtenir avec un délai très limité la liste des nouvelles entreprises en France ou dans un secteur plus limité.

Par défaut, nous renvoyons les entreprises par date de création décroissante. En indiquant la limite maximale de 10 000 vous pouvez ainsi facilement obtenir les nouvelles entreprises créées en France.

Endpoint : /api/v1/new-companies

Paramètres autorisés :

  • established_after ; Liste les entreprises créées après cette date
  • established_before ; Liste les entreprises créées avant cette date
  • legal_form
  • postal_code
  • department
  • limit ; Par défaut de 100, le nombre de résultat peut être compris entre 1 et 10 000.
  • radie ; Defaut : false.

Exemple de réponse :

{ "status": "success", "params": { "established_before": "2015-07-21" }, "companies": [ ... ] }

Lister les annonces BODACC pour une entreprise en particulier

Notre source de données sont les annonces du BODACC. Nous travaillons à les retraiter pour vous. Si cela ne suffit pas vous pouvez bien sûr nous contacter afin que nous améliorons notre système. Toutefois si vous avez besoin des annonces pour une entreprise nous pouvons également vous les envoyer.

Endpoint : /api/v1/companies/803417153/notices

Exemple de réponse :

{ "status": "success", "params": { "siren": "803417153" }, "notices": [ { "nojo": "BXA14196002432H", "publication_date": "2014-07-22", "content": { "acte": { "creation": { "categorieCreation": "Immatriculation d'une personne morale (B, C, D) suite à création d'un établissement principal", "dateCommencementActivite": "2014-07-02" } }, "nojo": "BXA14196002432H", "tribunal": "GREFFE DU TRIBUNAL DE COMMERCE DE TOULOUSE", "personnes": { "personne": { "adresse": { "france": { "ville": "Toulouse", "nomVoie": "Lascrosses ", "typeVoie": "boulevard ", "codePostal": "31000", "numeroVoie": "15 ", "complGeographique": "Bâtiment f " } }, "capital": { "devise": "EUR", "montantCapital": "1000.00 " }, "personneMorale": { "denomination": "Firmapi", "nomCommercial": "Firmapi", "administration": "Gérant : FINKELSTEIN Antoine Victor nom d'usage : FINKELSTEIN. ", "formeJuridique": "Société à Responsabilité Limitée", "numeroImmatriculation": { "codeRCS": "RCS", "nomGreffeImmat": "Toulouse", "numeroIdentification": "803 417 153" } } } }, "typeAnnonce": { "annonce": null }, "etablissement": { "activite": "Informatique, services aux entreprises." }, "numeroAnnonce": "239", "numeroDepartement": "31" } } ] }

Télécharger l'ensemble de la base de données

Pour les besoins les plus complexes, il est parfois plus efficace de télécharger l'ensemble de notre base de données au format CSV.

Cet extraction toutes les informations de l'API. Sa mise à jour est quotidienne. Cette fonctionnalité est la seule limitée aux abonnés.

Endpoint : /api/v1/database-extract

Paramètres autorisés :

  • download Si la valeur de ce paramètre est égale à 1, vous recevrez directement le lien de téléchargement dans une réponse au format texte et non JSON. C'est ce que nous faisons dans le board.

Exemple de réponse :

{ "status": "success", "url": "https://firmapi-database-extract.s3-eu-west-1.amazonaws.com/database-development.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Credential=AKIAITZ4Q6IVONJAW6OQ%2F20151015%2Feu-west-1%2Fs3%2Faws4_request\u0026X-Amz-Date=20151015T150752Z\u0026X-Amz-Expires=900\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Signature=fb4944dabdaff4ad0a5f8d2a6b46716b29a58cefe8f5601b514fac53febf2da9" }