Votre API d'enrichissement pour booster votre produit et votre marketing
Recherchez des entreprises, enrichissez une liste de domaines et trouvez des entreprises similaires.
Documentation de l'API
The Companies API est organisée selon l'architecture REST. Nos routes acceptent des requêtes encodées au format form et retournent des réponses encodées au format JSON. Vous pouvez sauter d'une fonctionnalité à l'autre avec le menu de navigation à gauche. Des exemples avec des réponses réelles sont fournis sur le côté droit de la page.
Envoyez nous un message dans la chatbox. Un développeur vous répondra dès que possible pour répondre à vos questions.
Nous pouvons vous aider à intégrer notre API. Envoyez-nous un message dans la chatbox.
Authentification
The Companies API utilise des jetons d'API pour authentifier les requêtes. Vous pouvez gérer vos jetons d'API dans vos paramètres ou sur le côté droit de cette section.
Il y a deux façons d'authentifier vos requêtes HTTP vers l'API:
En ajoutant un en-tête "Autorization". L'en-tête "Authorization" est formaté comme suit : "Authorization: Basic MY-API-TOKEN" (remplacez "MY-API-TOKEN" par l'un des vôtres).
En envoyant le jeton API en tant que paramètre "GET". Comme ceci "?token=MY-API-TOKEN" (principalement utilisé pour tester rapidement un endpoint).
Bon à savoir
Aucun token API trouvé
Créez un token API pour commencer à utiliser nos endpoints.
Erreurs & Rate-Limiting
The Companies API utilise des codes de réponse HTTP conventionnels pour indiquer le succès ou l'échec d'une requête API. En général, les codes dans la plage 2xx indiquent un succès. Les codes dans la plage 4xx indiquent une erreur qui a échoué compte tenu des informations fournies (par exemple, un paramètre requis a été omis). Les codes dans la plage 5xx indiquent une erreur avec nos serveurs (ce sont des cas rares).
Certaines erreurs 4xx qui peuvent être gérées de manière programmable comprennent un code d'erreur qui explique brièvement ce qu'il s'est produit.
Objet d'erreur
Pour certaines erreurs qui peuvent être gérées de manière programmable, un chiffre indiquant le code d'erreur rapporté.
403
Un message lisible par un humain fournissant plus de détails sur l'erreur.
Missing API token
Le type d'erreur retourné (voir la liste à votre droite).
apiConnectionError
Valeurs possibles
Webhooks
The Companies API utilise des webhooks pour vous notifier des changements ou lorsqu'une opération est terminée. Vous pouvez gérer vos webhooks sur le côté droit de cette section ou dans vos paramètres.
Les webhooks sont utiles pour recevoir les résultats de nos algorithmes. Par exemple, lorsque une nouvelle entreprise que vous avez demandée a été scrappée.
Aucun webhook trouvé
Créez un webhook pour recevoir une notification pour les événements importants.
Entreprises
Vous trouverez ci-dessous toutes nos fonctionnalités concernant notre base de données d'entreprises.
Vous pouvez rechercher des entreprises avec une condition spécifique ou par nom. Vous pouvez également récupérer le profil d'une entreprise en fournissant son nom de domaine ou l'une de ses URL de réseaux sociaux.
Vous désirez également récupérer des entreprises similaires ou même les patterns d'e-mails qu'elles utilisent? Nous avons la solution.
Rechercher des entreprises
Vous avez besoin de rechercher des entreprises situées dans un pays donné pour un secteur d'activité spécifique et qui utilisent une technologie particulière ? Combinez nos conditions et créez des requêtes de recherche puissantes pour les identifier.
Paramètres de requête
Un array de conditions que les entreprises doivent remplir.
Assurez-vous que ce paramètre soir stringifié et encodé.
Une liste de domaines séparés par des virgules à exclure des résultats.
…/companies?domainsToExclude=amazon.com,gucci.com
Une liste d'URLs LinkedIn séparées par des virgules à exclure des résultats.
…/companies?linkedinToExclude=https://www.linkedin.com/company/gucci,https://www.linkedin.com/company/amazon
La page à récupérer (par défaut 1).
…/companies?page=1
Une requête de recherche supplémentaire appliquée au nom de l'entreprise ou au domaine.
…/companies?search=amazon
Définissez les champs à rechercher.
…/companies?searchFields[]=domain&searchFields[]=name
Valeurs possibles
Retourne une version simplifiée des entreprises (aucun crédit déduit mais des limitations sont appliquées sur le plan gratuit). C'est utile pour prévisualiser les données avant de récupérer la version complète. Par défaut à false.
…/companies?simplified=true
Valeurs possibles
Le nombre d'entreprises à retourner (entre 1 et 100). Par défaut 10.
…/companies?size=10
Un array de plusieurs champs combinés pour trier les résultats.
…/companies?sortFields=%5B%7B%22key%22%3A%22meta.score%22%2C%22order%22%3A%22desc%22%7D%5D
Assurez-vous que ce paramètre soir stringifié et encodé.
Le champ pour trier les résultats.
…/companies?sortKey=meta.score
Valeurs possibles
L'ordre pour trier les résultats.
…/companies?sortOrder=asc
Valeurs possibles
Réponse
Les entreprises qui correspondent à vos conditions.
Les informations sur les métas.
Les conditions que les entreprises doivent remplir.
Rechercher des entreprises par nom
Récupérez un profil d'entreprise en fournissant le nom de l'entreprise. Vous pouvez utiliser ce endpoint si vous avez besoin de plus d'informations sur l'entreprise, mais soyez prudent. Deux entreprises peuvent avoir le même nom, par exemple, Bolt. C'est pourquoi cette fonctionnalité peut retourner plusieurs entreprises.
Paramètres de requête
Le nom de l'entreprise.
…/companies/by-name?name=amazon
La page à récupérer (par défaut 1).
…/companies/by-name?page=1
Les pays pour filtrer les entreprises. Vous pouvez fournir plusieurs pays séparés par une virgule. Par défaut à tous les pays.
…/companies/by-name?countries=us,fr,de
Valeurs possibles
Si défini à true, le nom de l'entreprise doit correspondre aux mots recherchés. 'Bank of A' ne retournera pas Bank of America mais 'Bank of' et 'Bank of America' le feront. Par défaut à true.
…/companies/by-name?exactWordsMatch=false
Les identifiants séparés par des virgules de vos listes contenant les entreprises à exclure des résultats.
…/companies/by-name?listsToExclude=3920,3925
Retourne une version simplifiée des entreprises (aucun crédit déduit mais des limitations sont appliquées sur le plan gratuit). C'est utile pour prévisualiser les données avant de récupérer la version complète. Par défaut à false.
…/companies/by-name?simplified=true
Valeurs possibles
Le nombre d'entreprises à retourner (entre 1 et 25). Par défaut à 1.
…/companies/by-name?name=amazon&size=2
Un array de plusieurs champs combinés pour trier les résultats.
…/companies/by-name?sortFields=%5B%7B%22key%22%3A%22meta.score%22%2C%22order%22%3A%22desc%22%7D%5D
Assurez-vous que ce paramètre soir stringifié et encodé.
Le champ pour trier les résultats.
…/companies/by-name?sortKey=meta.score
Valeurs possibles
L'ordre pour trier les résultats.
…/companies/by-name?sortOrder=asc
Valeurs possibles
Réponse
Les entreprises qui correspondent au nom.
Les informations sur les métas.
Rechercher des entreprises en utilisant un prompt
Décrivez les entreprises que vous recherchez, et notre modèle d'IA les trouvera pour vous. Vous pouvez ajuster le seuil de similarité pour améliorer la précision de vos résultats.
Paramètres de requête
Le prompt que notre modèle d'IA utilisera pour rechercher des entreprises.
…/companies/by-prompt?prompt=…
Les identifiants séparés par des virgules de vos listes contenant les entreprises à exclure des résultats.
…/companies/by-prompt?listsToExclude=3920,3925
La page à récupérer (par défaut 1).
…/companies/by-prompt?page=1
Le seuil de similarité à utiliser pour la recherche (entre 0 et 1). Par défaut à 0.75.
…/companies/by-prompt?similarity=0.75
S'il faut retourner une version simplifiée du profil de l'entreprise. Par défaut à false.
…/companies/by-prompt?simplified=true
Le nombre d'entreprises à retourner (entre 1 et 25). Par défaut à 10.
…/companies/by-prompt?size=10
Un array de plusieurs champs combinés pour trier les résultats.
…/companies/by-prompt?sortFields=%5B%7B%22key%22%3A%22meta.score%22%2C%22order%22%3A%22desc%22%7D%5D
Assurez-vous que ce paramètre soir stringifié et encodé.
Le champ pour trier les résultats.
…/companies/by-prompt?sortKey=meta.score
Valeurs possibles
L'ordre pour trier les résultats.
…/companies/by-prompt?sortOrder=asc
Valeurs possibles
Réponse
La liste des entreprises correspondant à votre prompt.
Les informations sur les métas.
Recherchez des entreprises similaires (concurrents, vos clients, etc.)
Envoyez-nous un ou plusieurs noms de domaine et nous vous retournerons une liste d'entreprises similaires.
Paramètres de requête
Une liste de domaines séparés par des virgules.
…/companies/similar?domains[]=gucci.com&domains[]=wix.com
La page à récupérer (par défaut à 1).
…/companies/similar?domains[]=…&page=1
Le nombre de sociétés similaires à retourner (entre 1 et 100). Par défaut à 10.
…/companies/similar?domains[]=…&size=50
Un array de plusieurs champs combinés pour trier les résultats.
…/companies/similar?sortFields=%5B%7B%22key%22%3A%22meta.score%22%2C%22order%22%3A%22desc%22%7D%5D
Assurez-vous que ce paramètre soir stringifié et encodé.
Le champ pour trier les résultats.
…/companies/similar?sortKey=meta.score
Valeurs possibles
L'ordre pour trier les résultats.
…/companies/similar?sortOrder=asc
Valeurs possibles
Réponse
Les sociétés similaires pour votre liste de domaines.
Les informations sur les métas.
Enrichir une entreprise à partir d'un nom de domaine
Enrichissez une entreprise en nous envoyant son nom de domaine. Le nom de domaine est un meilleur identifiant que le nom de l'entreprise car il est unique et moins sujet aux fautes de frappe.
Paramètres de requête
Le nom de domaine de l'entreprise.
gucci.com
Réponse
Informations générales sur l'entreprise.
Données analytiques et performances du site web.
Informations sur les applications offertes par l'entreprise.
Ressources de l'entreprise, y compris les actifs numériques.
Offres d'emploi et opportunités de carrière dans l'entreprise.
Codes de classification industrielle standard pour l'entreprise et autres codes d'identification.
Détails sur les entreprises liées telles que les acquisitions et les filiales.
Informations de contact, y compris les emails et les téléphones.
Contenu fourni par l'entreprise comme les blogs, les podcasts et plus.
Descriptions de l'entreprise et mots-clés associés convertis en anglais avec notre IA.
Détails concernant le nom de domaine de l'entreprise.
Données financières et informations sur les revenus de l'entreprise.
Informations légales et politiques de l'entreprise.
Emplacements géographiques et sièges sociaux de l'entreprise.
Informations méta sur l'entreprise.
Détails sur les produits offerts par l'entreprise.
Informations supplémentaires sur l'entreprise que nous n'avons pas pu catégoriser.
Liens et métriques des réseaux sociaux de l'entreprise.
Technologies utilisées par l'entreprise.
Enrichir une entreprise à partir d'une url de réseau social (LinkedIn, Instagram, etc.)
Récupérer le profil d'une entreprise en nous envoyant une URL de réseau social (voir la liste ci-dessous pour ceux que nous acceptons).
Paramètres de requête
L'URL Dribbble de l'entreprise.
…/companies/by-social?dribbble=https://dribbble.com/microsoft
L'URL Facebook de l'entreprise.
…/companies/by-social?facebook=https://www.facebook.com/microsoft
L'URL GitHub de l'entreprise.
…/companies/by-social?github=https://github.com/microsoft
L'URL Instagram de l'entreprise.
…/companies/by-social?instagram=https://www.instagram.com/microsoft
L'URL LinkedIn de l'entreprise. Nous gérons à la fois les URL alpha (/company/microsoft) et les identifiants numériques (/company/6585).
…/companies/by-social?linkedin=https://www.linkedin.com/company/microsoft
L'URL Pinterest de l'entreprise.
…/companies/by-social?pinterest=https://www.pinterest.com/microsoft
L'URL Snapchat de l'entreprise.
…/companies/by-social?snapchat=https://www.snapchat.com/add/microsoft
L'URL TikTok de l'entreprise.
…/companies/by-social?tiktok=https://www.tiktok.com/@microsoft
L'URL Twitter de l'entreprise.
…/companies/by-social?twitter=https://twitter.com/microsoft
L'URL Wellfound de l'entreprise.
…/companies/by-social?wellfound=https://wellfound.com/company/microsoft
L'URL YouTube de l'entreprise.
…/companies/by-social?youtube=https://www.youtube.com/@microsoft
Réponse
Informations générales sur l'entreprise.
Données analytiques et performances du site web.
Informations sur les applications offertes par l'entreprise.
Ressources de l'entreprise, y compris les actifs numériques.
Offres d'emploi et opportunités de carrière dans l'entreprise.
Codes de classification industrielle standard pour l'entreprise et autres codes d'identification.
Détails sur les entreprises liées telles que les acquisitions et les filiales.
Informations de contact, y compris les emails et les téléphones.
Contenu fourni par l'entreprise comme les blogs, les podcasts et plus.
Descriptions de l'entreprise et mots-clés associés convertis en anglais avec notre IA.
Détails concernant le nom de domaine de l'entreprise.
Données financières et informations sur les revenus de l'entreprise.
Informations légales et politiques de l'entreprise.
Emplacements géographiques et sièges sociaux de l'entreprise.
Informations méta sur l'entreprise.
Détails sur les produits offerts par l'entreprise.
Informations supplémentaires sur l'entreprise que nous n'avons pas pu catégoriser.
Liens et métriques des réseaux sociaux de l'entreprise.
Technologies utilisées par l'entreprise.
Enrichir une entreprise avec ses formats d'email
Envoyez-nous un nom de domaine et récupérez tous les formats d'emails qu'ils utilisent avec le pourcentage d'utilisation.
Paramètres de requête
Le domaine de l'entreprise.
…/companies/gucci.com/email-patterns
Réponse
Les modèles d'emails utilisés.
Compter les entreprises correspondant à votre filtre
Comptez les entreprises correspondant à votre filtre. Utile si vous construisez votre propre moteur de recherche d'entreprises.
Paramètres de requête
Un array de conditions que les entreprises doivent remplir.
Assurez-vous que ce paramètre soir stringifié et encodé.
Une requête de recherche supplémentaire appliquée au nom de l'entreprise ou au domaine.
…/companies/count?search=amazon
Définissez les champs à rechercher.
…/companies/count?searchFields[]=domain&searchFields[]=name
Valeurs possibles
Réponse
Le nombre d'entreprises correspondant aux conditions.
Actions
Vous trouverez ci-dessous un aperçu complet des actions que vous pouvez effectuer avec les entreprises.
Ces actions sont particulièrement puissantes pour automatiser les processus au sein de votre produit en utilisant notre API.
Elles vous permettent non seulement d'enrichir les entreprises qui ne sont pas encore présentes dans notre base de données, mais aussi de réaliser un enrichissement plus détaillé sur celles qui y figurent déjà si nécessaire (comme l'extraction de produits pour un site e-commerce).
Demander une action pour une ou plusieurs entreprises
Cet endpoint vous permet de demander une action pour une seule entreprise, plusieurs entreprises ou une liste complète d'entreprises.
Body de la requête
Les domaines à traiter.
["gucci.com","united.com"]
Indique si vous demandez une estimation de prix.
Valeurs possibles
Le type de tâche à effectuer.
Valeurs possibles
L'ID de la liste à traiter.
42
Réponse
Les événements déclenchés par la demande.
Indique si vous demandez une estimation de prix.
Récupérer les évènements de vos actions
Cet endpoint vous permet de récupérer vos dernières demandes d'action et événements.
Paramètres de requête
La page à récupérer (par défaut 1).
1
Le nombre d'évènements à retourner (entre 1 et 25). Par défaut à 10.
10
Le statut des évènements à récupérer.
Valeurs possibles
Le type des évènements à récupérer.
Valeurs possibles
Réponse
La liste des évènements.
Les informations sur les métas.
Industries
Recherchez des industries spécifiques et obtenez des informations telles que le nombre d'entreprises qu'elle contient.
Rechercher des industries
Recherchez dans notre base de données d'industries et obtenez des informations telles que le nombre d'entreprises qu'elle contient. Les résultats sont triés par "companies_count".
Paramètres de requête
La page à récupérer (par défaut 1).
…/industries?page=1
Une requête de recherche supplémentaire appliquée au nom de l'industrie.
…/industries?search=saas
Le nombre d'industries à renvoyer (entre 1 et 100). Par défaut 25.
…/industries?size=10
Réponse
Les industries qui correspondent à vos critères.
Les informations sur les métas.
Trouver des industries similaires
Découvrez des industries similaires avec notre API. Identifiez les secteurs connexes et élargissez vos opportunités commerciales.
Paramètres de requête
Les industries à comparer (max: 10).
…/industries/similar?industries[]=saas&industries[]=fintech
La page à récupérer (par défaut 1).
…/industries/similar?page=1
Le nombre d'industries à renvoyer (entre 1 et 100). Par défaut 25.
…/industries/similar?size=10
Réponse
Les industries qui correspondent à vos critères.
Les informations sur les métas.
Technologies
Nous traquons actuellement 350 technologies. Si vous avez besoin d'une technologie qui n'est pas répertoriée, n'hésitez pas à discuter avec nous car il nous faut généralement moins de 48 heures pour l'ajouter.
Rechercher des technologies
Parcourez les technologies que nous identifions et obtenez des informations telles que le nombre d'entreprises l'utilisant.
Paramètres de requête
La page à récupérer (par défaut 1).
…/technologies?page=1
Une requête de recherche supplémentaire appliquée au nom de la technologie.
…/technologies?search=shopify
Le nombre de technologies à renvoyer (entre 1 et 100). Par défaut 25.
…/technologies?size=10
Réponse
Les technologies que nous identifions qui correspondent à vos conditions.
Les informations sur les métas.
Localisations
Les endpoints suivants vous permettent de rechercher toutes nos localisations: villes, départements, régions, pays et continents.
Rechercher des villes
Recherchez nos villes pour filtrer les entreprises dans un lieu spécifique.
Paramètres de requête
La page à récupérer (par défaut 1).
Une recherche additionnelle appliquée au nom de la ville.
Le nombre de villes à retourner (entre 1 et 20). Par défaut 10.
Réponse
Les villes qui correspondent à vos conditions.
Les informations sur les métas.
Rechercher des départements
Rechercher des départements pour filtrer les entreprises dans un lieu spécifique.
Paramètres de requête
La page à récupérer (par défaut 1).
Une requête de recherche supplémentaire appliquée au nom du département.
Le nombre de départements à retourner (entre 1 et 20). Par défaut 10.
Réponse
Les départements qui correspondent à vos critères.
Les informations sur les métas.
Rechercher des états
Rechercher nos régions pour filtrer nos entreprises dans un lieu spécifique.
Paramètres de requête
La page à récupérer (par défaut 1).
Une recherche additionnelle appliquée au nom de la région.
Le nombre d'états à retourner (entre 1 et 20). Par défaut 10.
Réponse
Les états qui correspondent à vos critères.
Les informations sur les métas.
Rechercher des pays
Rechercher des pays pour filtrer les entreprises dans un lieu spécifique.
Paramètres de requête
La page à récupérer (par défaut 1).
Une recherche additionnelle appliquée au nom du pays.
Le nombre de pays à retourner (entre 1 et 20). Par défaut 10.
Réponse
Les pays qui correspondent à vos critères.
Les informations sur les métas.
Rechercher des continents
Rechercher des continents pour filtrer les entreprises dans un endroit spécifique.
Paramètres de requête
La page à récupérer (par défaut 1).
Une recherche additionnelle appliquée au nom du continent.
Le nombre de continents à retourner (entre 1 et 20). Par défaut 10.
Réponse
Les continents qui correspondent à vos conditions.
Les informations sur les métas.
Professions
Vous trouverez toutes nos fonctionnalités concernant notre base de données de professions ci-dessous. Recherchez ou enrichissez des professions avec les départements et les niveaux de seniorité. Vous pouvez utiliser ces fonctionnalités pour apporter plus de contexte à vos clients dans votre CRM ou pour cibler des employés avec d'autres fournisseurs.
Enrichir une profession à partir de son nom
Envoyez-nous une profession (par exemple, directeur général) et récupérez des informations supplémentaires telles que les départements et les niveaux de responsabilité. Nous supportons les langues suivantes: anglais, français et espagnol.
Paramètres de requête
Le nom de la profession.
…/job-titles/enrich?name=chief%20executive%20officer
Réponse
Le service de la profession
marketing
Valeurs possibles
Département secondaire de la profession
content marketing
Valeurs possibles
Le nom anglais de la profession
Le nom espagnol de la profession
Le nom français de la profession
Le niveau d'ancienneté de la profession
Valeurs possibles
Listes
Les entreprises peuvent être sauvegardés dans vos listes. Les endpoints suivants vous permettent de récupérer vos listes et de gérer les entreprises qui y sont associés.
Récupérer vos listes
Ce endpoint vous permet de récupérer les listes qui appartiennent à votre équipe.
Paramètres de requête
La page à récupérer (par défaut: 1).
…/lists?page=1
Le nombre de listes à récupérer (entre 1 et 100). Par défaut à 10.
…/lists?size=10
Réponse
Les listes qui appartiennent à votre équipe.
Les informations sur les métas.
Créer une liste d'entreprises
Ce point d'entrée vous permet de créer une liste d'entreprises.
Body de la requête
Si la liste est dynamique ou non. Si défini à true, la liste sera mise à jour automatiquement lorsque de nouvelles entreprises seront ajoutés à la base de données.
Valeurs possibles
Le nom de la liste.
Le type de liste à créer.
Valeurs possibles
Réponse
L'analytics de la liste.
Quand la liste a été créée.
2022-02-22T07:23:52.000+00:00
Si la liste est dynamique ou statique.
true
L'identifiant de la liste.
3838
Si la liste a été importée.
true
Les intégrations associées à la liste.
Le nom de la liste
French NodeJS Companies
Le statut de processus actif de la liste (pour usage interne).
true
L'indicateur d'initialisation du processus (à usage interne).
true
Lorsque la liste est en cours de traitement.
2022-02-22T07:23:52.000+00:00
La requête utilisée pour générer la liste.
Récupérer les entreprises de votre liste
Ce endpoint vous permet de récupérer les entreprises de vos listes.
Paramètres de requête
La page à récupérer (par défaut 1).
…/lists/:listId/companies?page=1
Le nombre d'entreprises à récupérer (entre 1 et 100). Par défaut 10.
…/lists/:listId/companies?size=10
Un array de plusieurs champs combinés pour trier les résultats.
…/lists/:listId/companies?sortFields=%5B%7B%22key%22%3A%22meta.score%22%2C%22order%22%3A%22desc%22%7D%5D
Assurez-vous que ce paramètre soir stringifié et encodé.
Le champ pour trier les résultats.
…/lists/:listId/companies?sortKey=meta.score
Valeurs possibles
L'ordre pour trier les résultats.
…/lists/:listId/companies?sortOrder=asc
Valeurs possibles
Réponse
Les entreprises qui appartiennent à votre liste.
Les informations sur les métas.
Gérer votre équipe
Les endpoints suivants vous permettent de gérer et de récupérer des informations détaillées sur l'équipe associée à votre jeton API.
Récupérer votre équipe
Cet endpoint vous permet de récupérer l'équipe associée à votre token API.
Réponse
Le pays de l'équipe.
us
La date de création de l'équipe.
2020-06-29 08:21:01
Les crédits de l'équipe.
500000
Si l'équipe est abonnée à un plan payant.
true
L'identifiant de l'équipe.
1