A fully-featured Go 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.
- Expose all our 30+ endpoints and gives access to 50M+ companies from your codebase
- Type-safe API client with full access to our OpenAPI schemas
- Real-time company enrichment with both synchronous and asynchronous options
- Powerful search capabilities with filters, sorting and pagination
- Create and manage your company lists
- Track and monitor enrichment actions and requests
- Generate detailed analytics and insights for searches and lists
- Natural language querying for structured company information
- Lightweight with minimal dependencies
go get github.com/thecompaniesapi/sdk-go- Go 1.19 or higher
- Valid API key from The Companies API
package main
import (
"context"
"fmt"
"log"
tca "github.com/thecompaniesapi/sdk-go"
)
func main() {
// Initialize the client
client, err := tca.ApiClient("your-api-key-here")
if err != nil {
log.Fatal(err)
}
// Search for technology companies
page := float32(1)
size := float32(10)
search := "technology"
response, err := client.SearchCompanies(context.Background(), &tca.SearchCompaniesParams{
Page: &page,
Size: &size,
Search: &search,
})
if err != nil {
log.Fatal(err)
}
if response.JSON200 != nil {
fmt.Printf("Found %d companies\n", response.JSON200.Meta.Total)
for _, company := range response.JSON200.Companies {
if company.About != nil && company.About.Name != nil {
fmt.Printf("- %s\n", *company.About.Name)
}
}
}
}// Search companies with basic filters
page := float32(1)
size := float32(10)
search := "artificial intelligence"
response, err := client.SearchCompanies(ctx, &tca.SearchCompaniesParams{
Page: &page,
Size: &size,
Search: &search,
})
companies := response.JSON200.Companies // Companies that match the search
meta := response.JSON200.Meta // Meta information (pagination, etc.)// Advanced search with complex query conditions
response, err := client.SearchCompaniesPost(ctx, tca.SearchCompaniesPostJSONRequestBody{
Query: &[]tca.QueryCondition{
{
Attribute: "about.industries",
Operator: "or",
Sign: "equals",
Values: []string{"artificial-intelligence", "machine-learning"},
},
{
Attribute: "locations.headquarters.country.code",
Operator: "and",
Sign: "equals",
Values: []string{"us"},
},
},
Page: tca.Float32Ptr(1),
Size: tca.Float32Ptr(20),
})
companies := response.JSON200.Companies // Companies matching the query
meta := response.JSON200.Meta // Meta information// Search companies by their name
name := "microsoft"
response, err := client.SearchCompaniesByName(ctx, &tca.SearchCompaniesByNameParams{
Name: &name,
})
companies := response.JSON200.Companies // Companies with matching names// Use natural language to find companies
prompt := "Find me SaaS companies in San Francisco with more than 100 employees"
response, err := client.SearchCompaniesByPrompt(ctx, &tca.SearchCompaniesByPromptParams{
Prompt: &prompt,
})
companies := response.JSON200.Companies // Companies matching the prompt// Find companies similar to given domains
domains := "apple.com,microsoft.com"
response, err := client.SearchSimilarCompanies(ctx, &tca.SearchSimilarCompaniesParams{
Domains: &domains,
})
companies := response.JSON200.Companies // Similar companies// Count how many companies are in the computer-software industry
response, err := client.CountCompaniesPost(ctx, tca.CountCompaniesPostJSONRequestBody{
Query: &[]tca.QueryCondition{
{
Attribute: "about.industries",
Operator: "or",
Sign: "equals",
Values: []string{"computer-software"},
},
},
})
count := response.JSON200 // Number of companies that match the query// Fetch company data from our database without enrichment (faster response)
response, err := client.FetchCompany(ctx, "microsoft.com", &tca.FetchCompanyParams{})
company := response.JSON200 // The company profile// Fetch company data and re-analyze it in real-time to get fresh, up-to-date information
refresh := true
response, err := client.FetchCompany(ctx, "microsoft.com", &tca.FetchCompanyParams{
Refresh: &refresh,
})
company := response.JSON200 // The company profile (refreshed)🕹️ Enrich your users at signup with the latest information about their company
// Fetch the company profile behind a professional email address
email := "[email protected]"
response, err := client.FetchCompanyByEmail(ctx, &tca.FetchCompanyByEmailParams{
Email: &email,
})
company := response.JSON200 // The company profile// Fetch the company profile behind a social network URL
linkedin := "https://www.linkedin.com/company/apple"
response, err := client.FetchCompanyBySocial(ctx, &tca.FetchCompanyBySocialParams{
Linkedin: &linkedin,
})
company := response.JSON200 // The company profile// Fetch the company email patterns for a specific domain
response, err := client.FetchCompanyEmailPatterns(ctx, "apple.com", &tca.FetchCompanyEmailPatternsParams{})
patterns := response.JSON200 // The company email patterns// Ask what products a company offers using its domain
response, err := client.AskCompany(ctx, "microsoft.com", tca.AskCompanyJSONRequestBody{
Question: "What products does this company offer?",
Model: tca.StringPtr("large"), // 'small' is also available
Fields: &[]tca.QuestionField{
{
Key: "products",
Type: "array|string",
Description: tca.StringPtr("The products that the company offers"),
},
},
})
answer := response.JSON200.Answer // Structured AI response
meta := response.JSON200.Meta // Meta information// Get AI-generated strategic insights about a company
response, err := client.FetchCompanyContext(ctx, "microsoft.com")
context := response.JSON200.Context // Includes market, model, differentiators, etc.
meta := response.JSON200.Meta // Meta information// Analyze company distribution by business type
attribute := "about.businessType"
response, err := client.FetchCompaniesAnalytics(ctx, &tca.FetchCompaniesAnalyticsParams{
Attribute: &attribute,
Query: &[]tca.QueryCondition{
{
Attribute: "locations.headquarters.country.code",
Operator: "or",
Sign: "equals",
Values: []string{"us", "gb", "fr"},
},
},
})
analytics := response.JSON200 // Aggregated values
meta := response.JSON200.Meta // Meta information// Export analytics to CSV
response, err := client.ExportCompaniesAnalytics(ctx, tca.ExportCompaniesAnalyticsJSONRequestBody{
Format: "csv",
Attributes: []string{"about.industries", "about.totalEmployees"},
Query: &[]tca.QueryCondition{
{
Attribute: "technologies.active",
Operator: "or",
Sign: "equals",
Values: []string{"shopify"},
},
},
})
analytics := response.JSON200 // Aggregated values
meta := response.JSON200.Meta // Meta information// Request an enrichment job on multiple companies
estimate := false
response, err := client.RequestAction(ctx, tca.RequestActionJSONRequestBody{
Domains: []string{"microsoft.com", "apple.com"},
Job: "enrich-companies",
Estimate: &estimate,
})
actions := response.JSON200.Actions // Track this via FetchActions
meta := response.JSON200.Meta // Meta information// Fetch recent actions
status := "completed"
page := float32(1)
size := float32(5)
response, err := client.FetchActions(ctx, &tca.FetchActionsParams{
Status: &status,
Page: &page,
Size: &size,
})
actions := response.JSON200.Actions // Actions that match the query
meta := response.JSON200.Meta // Meta information// Search industries by keyword
search := "software"
size := float32(10)
response, err := client.SearchIndustries(ctx, &tca.SearchIndustriesParams{
Search: &search,
Size: &size,
})
industries := response.JSON200.Industries // Industries that match the keyword
meta := response.JSON200.Meta // Meta information// Find industries similar to given ones
industries := "saas,fintech"
response, err := client.SearchIndustriesSimilar(ctx, &tca.SearchIndustriesSimilarParams{
Industries: &industries,
})
similar := response.JSON200.Industries // Industries that are similar to the given ones
meta := response.JSON200.Meta // Meta information// Search technologies by keyword
search := "shopify"
size := float32(10)
response, err := client.SearchTechnologies(ctx, &tca.SearchTechnologiesParams{
Search: &search,
Size: &size,
})
technologies := response.JSON200.Technologies // Technologies that match the keyword
meta := response.JSON200.Meta // Meta information// Search cities by name
search := "new york"
size := float32(5)
response, err := client.SearchCities(ctx, &tca.SearchCitiesParams{
Search: &search,
Size: &size,
})
cities := response.JSON200.Cities // Cities that match the name
meta := response.JSON200.Meta // Meta information// Search counties by name
search := "orange"
size := float32(5)
response, err := client.SearchCounties(ctx, &tca.SearchCountiesParams{
Search: &search,
Size: &size,
})
counties := response.JSON200.Counties // Counties that match the name
meta := response.JSON200.Meta // Meta information// Search states by name
search := "california"
size := float32(5)
response, err := client.SearchStates(ctx, &tca.SearchStatesParams{
Search: &search,
Size: &size,
})
states := response.JSON200.States // States that match the name
meta := response.JSON200.Meta // Meta information// Search countries by name
search := "france"
size := float32(5)
response, err := client.SearchCountries(ctx, &tca.SearchCountriesParams{
Search: &search,
Size: &size,
})
countries := response.JSON200.Countries // Countries that match the name
meta := response.JSON200.Meta // Meta information// Search continents by name
search := "asia"
size := float32(5)
response, err := client.SearchContinents(ctx, &tca.SearchContinentsParams{
Search: &search,
Size: &size,
})
continents := response.JSON200.Continents // Continents that match the name
meta := response.JSON200.Meta // Meta information// Enrich "chief marketing officer"
name := "chief marketing officer"
response, err := client.EnrichJobTitles(ctx, &tca.EnrichJobTitlesParams{
Name: &name,
})
jobTitle := response.JSON200 // Contains department, seniority, etc.// Fetch your lists
response, err := client.FetchLists(ctx, &tca.FetchListsParams{})
lists := response.JSON200.Lists // Lists that match the query
meta := response.JSON200.Meta // Meta information// Create a list of companies
response, err := client.CreateList(ctx, tca.CreateListJSONRequestBody{
Name: "My SaaS List",
Type: "companies",
})
newList := response.JSON200 // The new list// Fetch companies in a list
listId := float32(1234)
response, err := client.FetchCompaniesInList(ctx, listId, &tca.FetchCompaniesInListParams{})
companies := response.JSON200.Companies // Companies that match the list
meta := response.JSON200.Meta // Meta information// Add companies to a list
listId := float32(1234)
response, err := client.ToggleCompaniesInList(ctx, listId, tca.ToggleCompaniesInListJSONRequestBody{
Companies: []string{"apple.com", "stripe.com"},
})
list := response.JSON200 // The updated list// Fetch your team details
teamId := float32(1234)
response, err := client.FetchTeam(ctx, teamId)
team := response.JSON200 // Your team details// Check API health status
response, err := client.FetchApiHealth(ctx)
health := response.JSON200 // The health of the API// Fetch OpenAPI schema
response, err := client.FetchOpenApi(ctx)
schema := response.JSON200 // The OpenAPI schemaThis SDK is released under the MIT License. See LICENSE for details.