@thecompaniesapi/sdk
Advanced tools
An enrichment platform to search and retrieve information about companies
A fully-featured TypeScript SDK for The Companies API, providing type-safe access to company data, locations, industries, technologies, job titles, lists, and more.
If you need more details about a specific endpoint, you can find the corresponding documentation in the API reference.
You can also contact us on our livechat if you have any questions.
# with npm
npm install @thecompaniesapi/sdk
# with yarn
yarn add @thecompaniesapi/sdk
# with pnpm
pnpm add @thecompaniesapi/sdk
Get your API token from your settings page and initialize our client with createClient.
The API token is required to authenticate your requests and should be kept secure. Never commit your API token to version control or share it publicly.
import createClient from '@thecompaniesapi/sdk'
const tca = createClient({
apiToken: 'your-api-token',
})
🕹️ Use case: How to build a company search engine with our API
🔍 To learn more about our query system, please read our documentation.
// Search companies by industry and size
await tca.searchCompanies({
query: [
{ attribute: 'about.industries', operator: 'or', sign: 'equals', values: ['computer-software'] },
{ attribute: 'about.totalEmployees', operator: 'or', sign: 'equals', values: ['10-50'] }
],
size: 25
})
const companies = response.data.companies // Companies that match the query
const meta = response.data.meta // Meta information
🕹️ Use case: Add a company search with autocomplete to your application
const response = await tca.searchCompaniesByName({
name: 'The Companies API',
size: 2
})
const companies = response.data.companies // Companies that match the name
const meta = response.data.meta // Meta information
// Search 25 companies for a specific prompt
const response = await tca.searchCompaniesByPrompt({
prompt: 'SaaS Companies in the United States with more than 100 employees',
size: 25
})
const companies = response.data.companies // Companies that match the prompt
const meta = response.data.meta // Meta information
// Search 25 companies that are similar to Crisp and Intercom
const response = await tca.searchSimilarCompanies({
domains: ['crisp.chat', 'intercom.com'],
size: 25
})
const companies = response.data.companies // Companies that are similar to the domains
const meta = response.data.meta // Meta information
// Count how many companies are in the computer-software industry
const response = await tca.countCompanies({
query: [
{
attribute: 'about.industries',
operator: 'or',
sign: 'equals',
values: ['computer-software']
}
]
})
const count = response.data // Number of companies that match the query
// Fetch company data from our database without enrichment (faster response)
const response = await tca.fetchCompany({
domain: 'microsoft.com'
})
const company = response.data // The company profile
// Fetch company data and re-analyze it in real-time to get fresh, up-to-date information (slower but more accurate)
const response = await tca.fetchCompany({
domain: 'microsoft.com',
refresh: true
})
const company = response.data // The company profile
🕹️ c Enrich your users at signup with the latest information about their company
// Fetch the company profile behind a professional email address
const response = await tca.fetchCompanyByEmail({
email: 'jack@openai.com'
})
const company = response.data // The company profile
// Fetch the company profile behind a social network URL
const response = await tca.fetchCompanyBySocial({
linkedin: 'https://www.linkedin.com/company/apple'
})
const company = response.data // The company profile
// Fetch the company email patterns for a specific domain
const response = await tca.fetchCompanyEmailPatterns({
domain: 'apple.com'
})
const patterns = response.data // The company email patterns
// Ask what products a company offers using its domain
const response = await tca.askCompany({
domain: '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'
}
]
})
const answer = response.data.answer // Structured AI response
const meta = response.data.meta // Meta information
// Get AI-generated strategic insights about a company
const response = await tca.fetchCompanyContext({
domain: 'microsoft.com'
})
const context = response.data.context // Includes market, model, differentiators, etc.
const meta = response.data.meta // Meta information
// Analyze company distribution by business type
const response = await tca.fetchCompaniesAnalytics({
attribute: 'about.businessType',
query: [
{
attribute: 'locations.headquarters.country.code',
operator: 'or',
sign: 'equals',
values: ['us', 'gb', 'fr']
}
]
})
const analytics = response.data.data // Aggregated values
const meta = response.data.meta // Meta information
// Export analytics to CSV
const response = await tca.exportCompaniesAnalytics({
format: 'csv',
attributes: ['about.industries', 'about.totalEmployees'],
query: [
{
attribute: 'technologies.active',
operator: 'or',
sign: 'equals',
values: ['shopify']
}
]
})
const analytics = response.data.data // Aggregated values
const meta = response.data.meta // Meta information
// Request an enrichment job on multiple companies
const response = await tca.requestAction({
domains: ['microsoft.com', 'apple.com'],
job: 'enrich-companies',
estimate: false
})
const actions = response.data.actions // Track this via fetchActions
const meta = response.data.meta // Meta information
// Fetch recent actions
const response = await tca.fetchActions({
status: 'completed',
page: 1,
size: 5
})
const actions = response.data.actions // Actions that match the query
const meta = response.data.meta // Meta information
// Search industries by keyword
const response = await tca.searchIndustries({
search: 'software',
size: 10
})
const industries = response.data.industries // Industries that match the keyword
const meta = response.data.meta // Meta information
// Find industries similar to given ones
const response = await tca.searchIndustriesSimilar({
industries: ['saas', 'fintech']
})
const similar = response.data.industries // Industries that are similar to the given ones
const meta = response.data.meta // Meta information
// Search technologies by keyword
const response = await tca.searchTechnologies({
search: 'shopify',
size: 10
})
const technologies = response.data.technologies // Technologies that match the keyword
const meta = response.data.meta // Meta information
// Search cities by name
const response = await tca.searchCities({
search: 'new york',
size: 5
})
const cities = response.data.cities // Cities that match the name
const meta = response.data.meta // Meta information
// Search counties by name
const response = await tca.searchCounties({
search: 'orange',
size: 5
})
const counties = response.data.counties // Counties that match the name
const meta = response.data.meta // Meta information
// Search states by name
const response = await tca.searchStates({
search: 'california',
size: 5
})
const states = response.data.states // States that match the name
const meta = response.data.meta // Meta information
// Search countries by name
const response = await tca.searchCountries({
search: 'france',
size: 5
})
const countries = response.data.countries // Countries that match the name
const meta = response.data.meta // Meta information
// Search continents by name
const response = await tca.searchContinents({
search: 'asia',
size: 5
})
const continents = response.data.continents // Continents that match the name
const meta = response.data.meta // Meta information
// Enrich "chief marketing officer"
const response = await tca.enrichJobTitles({
name: 'chief marketing officer'
})
const jobTitle = response.data // Contains department, seniority, etc.
// Fetch your lists
const response = await tca.fetchLists()
const lists = response.data.lists // Lists that match the query
const meta = response.data.meta // Meta information
// Create a list of companies
const response = await tca.createList({
name: 'My SaaS List',
type: 'companies'
})
const newList = response.data // The new list
// Fetch companies in a list
const response = await tca.fetchCompaniesInList({
listId: 1234
})
const companies = response.data.companies // Companies that match the list
const meta = response.data.meta // Meta information
// Add companies to a list
const response = await tca.toggleCompaniesInList({
listId: 1234,
companies: ['apple.com', 'stripe.com']
})
const list = response.data // The updated list
// Fetch your team details
const response = await tca.fetchTeam()
const team = response.data // Your team details
// Check API health status
const response = await tca.fetchApiHealth()
const health = response.data // The health of the API
// Fetch OpenAPI schema
const response = await tca.fetchOpenApi()
const schema = response.data // The OpenAPI schema
MIT License © TheCompaniesAPI
FAQs
An enrichment platform to search and retrieve information about companies
The npm package @thecompaniesapi/sdk receives a total of 1,957 weekly downloads. As such, @thecompaniesapi/sdk popularity was classified as popular.
We found that @thecompaniesapi/sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
A supply chain attack on Axios introduced a malicious dependency, plain-crypto-js@4.2.1, published minutes earlier and absent from the project’s GitHub releases.
Research
Malicious versions of the Telnyx Python SDK on PyPI delivered credential-stealing malware via a multi-stage supply chain attack.
Security News
TeamPCP is partnering with ransomware group Vect to turn open source supply chain attacks on tools like Trivy and LiteLLM into large-scale ransomware operations.