1. Go to this page and download the library: Download thecompaniesapi/sdk-php library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
thecompaniesapi / sdk-php example snippets
heCompaniesApi\Sdk\Client;
$client = new Client([
'apiToken' => 'your-api-token',
]);
// Search companies by industry and size
$response = $client->searchCompanies([
'query' => [
['attribute' => 'about.industries', 'operator' => 'or', 'sign' => 'equals', 'values' => ['computer-software']],
['attribute' => 'about.totalEmployees', 'operator' => 'or', 'sign' => 'equals', 'values' => ['10-50']]
],
'size' => 25
]);
$companies = $response->companies; // Companies that match the query
$meta = $response->meta; // Meta information
$response = $client->searchCompaniesByName([
'name' => 'The Companies API',
'size' => 2
]);
$companies = $response->companies; // Companies that match the name
$meta = $response->meta; // Meta information
// Search 25 companies for a specific prompt
$response = $client->searchCompaniesByPrompt([
'prompt' => 'SaaS Companies in the United States with more than 100 employees',
'size' => 25
]);
$companies = $response->companies; // Companies that match the prompt
$meta = $response->meta; // Meta information
// Search 25 companies that are similar to Crisp and Intercom
$response = $client->searchSimilarCompanies([
'domains' => ['crisp.chat', 'intercom.com'],
'size' => 25
]);
$companies = $response->companies; // Companies that are similar to the domains
$meta = $response->meta; // Meta information
// Count how many companies are in the computer-software industry
$response = $client->countCompanies([
'query' => [
[
'attribute' => 'about.industries',
'operator' => 'or',
'sign' => 'equals',
'values' => ['computer-software']
]
]
]);
$count = $response; // Number of companies that match the query
// Fetch company data from our database without enrichment (faster response)
$response = $client->fetchCompany('microsoft.com');
$company = $response; // The company profile
// Fetch company data and re-analyze it in real-time to get fresh, up-to-date information (slower but more accurate)
$response = $client->fetchCompany('microsoft.com', [
'refresh' => true
]);
$company = $response; // The company profile
// Fetch the company profile behind a professional email address
$response = $client->fetchCompanyByEmail([
'email' => '[email protected]'
]);
$company = $response; // The company profile
// Fetch the company profile behind a social network URL
$response = $client->fetchCompanyBySocial([
'linkedin' => 'https://www.linkedin.com/company/apple'
]);
$company = $response; // The company profile
// Fetch the company email patterns for a specific domain
$response = $client->fetchCompanyEmailPatterns('apple.com');
$patterns = $response; // The company email patterns
// Ask what products a company offers using its domain
$response = $client->askCompany('microsoft.com', [
'question' => 'What products does this company offer?',
'model' => 'large', // 'small' is also available
'fields' => [
[
'key' => 'products',
'type' => 'array|string',
'description' => 'The products that the company offers'
]
]
]);
$answer = $response->answer; // Structured AI response
$meta = $response->meta; // Meta information
// Get AI-generated strategic insights about a company
$response = $client->fetchCompanyContext('microsoft.com');
$context = $response->context; // Includes market, model, differentiators, etc.
$meta = $response->meta; // Meta information
// Analyze company distribution by business type
$response = $client->fetchCompaniesAnalytics([
'attribute' => 'about.businessType',
'query' => [
[
'attribute' => 'locations.headquarters.country.code',
'operator' => 'or',
'sign' => 'equals',
'values' => ['us', 'gb', 'fr']
]
]
]);
$analytics = $response->data; // Aggregated values
$meta = $response->meta; // Meta information
// Search industries by keyword
$response = $client->searchIndustries([
'search' => 'software',
'size' => 10
]);
$industries = $response->industries; // Industries that match the keyword
$meta = $response->meta; // Meta information
// Find industries similar to given ones
$response = $client->searchIndustriesSimilar([
'industries' => ['saas', 'fintech']
]);
$similar = $response->industries; // Industries that are similar to the given ones
$meta = $response->meta; // Meta information
// Search technologies by keyword
$response = $client->searchTechnologies([
'search' => 'shopify',
'size' => 10
]);
$technologies = $response->technologies; // Technologies that match the keyword
$meta = $response->meta; // Meta information
// Search cities by name
$response = $client->searchCities([
'search' => 'new york',
'size' => 5
]);
$cities = $response->cities; // Cities that match the name
$meta = $response->meta; // Meta information
// Search counties by name
$response = $client->searchCounties([
'search' => 'orange',
'size' => 5
]);
$counties = $response->counties; // Counties that match the name
$meta = $response->meta; // Meta information
// Search states by name
$response = $client->searchStates([
'search' => 'california',
'size' => 5
]);
$states = $response->states; // States that match the name
$meta = $response->meta; // Meta information
// Search countries by name
$response = $client->searchCountries([
'search' => 'france',
'size' => 5
]);
$countries = $response->countries; // Countries that match the name
$meta = $response->meta; // Meta information
// Search continents by name
$response = $client->searchContinents([
'search' => 'asia',
'size' => 5
]);
$continents = $response->continents; // Continents that match the name
$meta = $response->meta; // Meta information
// Fetch your lists
$response = $client->fetchLists();
$lists = $response->lists; // Lists that match the query
$meta = $response->meta; // Meta information
// Create a list of companies
$response = $client->createList([
'name' => 'My SaaS List',
'type' => 'companies'
]);
$newList = $response; // The new list
// Update a list
$response = $client->updateList('1234', [
'name' => 'Updated SaaS List',
'description' => 'Updated list description'
]);
$updatedList = $response; // The updated list
// Delete a list
$response = $client->deleteList('1234');
$result = $response; // Deletion confirmation
// Fetch companies in a list
$response = $client->fetchCompaniesInList('1234');
$companies = $response->companies; // Companies that match the list
$meta = $response->meta; // Meta information
// Fetch companies in a list with additional filtering
$response = $client->fetchCompaniesInListPost('1234', [
'query' => [
[
'attribute' => 'about.totalEmployees',
'operator' => 'or',
'sign' => 'gte',
'values' => ['100']
]
],
'size' => 10
]);
$companies = $response->companies; // Filtered companies in the list
$meta = $response->meta; // Meta information
// Get a specific company in a list
$response = $client->fetchCompanyInList('1234', 'apple.com');
$company = $response; // The company in the list
// Add companies to a list
$response = $client->toggleCompaniesInList('1234', [
'companies' => ['apple.com', 'stripe.com'],
'action' => 'add'
]);
$list = $response; // The updated list
// Remove companies from a list
$response = $client->toggleCompaniesInList('1234', [
'companies' => ['apple.com'],
'action' => 'remove'
]);
$list = $response; // The updated list
// Fetch your team details
$response = $client->fetchTeam('team-id-123');
$team = $response; // Your team details
// Update your team
$response = $client->updateTeam('team-id-123', [
'name' => 'Updated Team Name',
'description' => 'Updated team description'
]);
$team = $response; // Updated team details
// Fetch current user details
$response = $client->fetchUser();
$user = $response; // Current user information
// Fetch prompts history
$response = $client->fetchPrompts([
'page' => 1,
'size' => 10
]);
$prompts = $response->prompts; // Prompts history
$meta = $response->meta; // Meta information
// Query the product prompt
$response = $client->productPrompt([
'query' => 'Find companies similar to Slack',
'context' => 'collaboration software'
]);
$result = $response; // Product prompt response
// Convert a natural language query to segmentation
$response = $client->promptToSegmentation([
'prompt' => 'Companies in California with more than 100 employees'
]);
$segmentation = $response; // Generated segmentation query
// Check API health status
$response = $client->fetchApiHealth();
$health = $response; // The health of the API