The Companies API icon

The Companies API

Access company data, enrichment, analytics and more using The Companies API

Overview

This node integrates with The Companies API to search for countries based on various criteria. It allows users to query country data with pagination, sorting, and filtering options. This is useful in scenarios where you need to retrieve geographic location data filtered by specific search terms or sorted by certain metrics, such as the number of companies in each country.

Practical examples include:

  • Finding countries with a high concentration of companies for market research.
  • Filtering countries by custom criteria using advanced filters.
  • Paginating through large sets of country data to display in dashboards or reports.

Properties

Name Meaning
Search A string to search countries by name or other text-based criteria.
Page The page number of results to retrieve (pagination).
Size The number of results per page.
Sort key The key by which to sort the results. Currently supports "Counts > companies".
Sort order The order of sorting: ascending (asc) or descending (desc).
Filters Additional filter criteria as a string to refine the search results.

Output

The node outputs JSON data containing the search results from The Companies API. Each item in the output corresponds to a country matching the search criteria, including relevant metadata such as counts of companies or other attributes provided by the API.

If the API returns binary data (not indicated here), it would be summarized accordingly, but this operation focuses on JSON data representing country information.

Dependencies

  • Requires an API token credential for authenticating requests to The Companies API.
  • Uses the official SDK of The Companies API (@thecompaniesapi/sdk).
  • Requires network access to The Companies API endpoints.
  • No additional environment variables are explicitly required beyond the API token.

Troubleshooting

  • Unknown operation error: If the operation parameter is incorrect or unsupported, the node throws an error indicating "Unknown operation". Ensure the operation is set to searchCountries.
  • SDK method not found: If the SDK does not have the expected method, verify that the SDK version matches the node's expectations.
  • Empty or invalid parameters: Parameters like page, size, or sortKey default to predefined values if empty or zero. Providing invalid values may cause unexpected results.
  • API authentication errors: Ensure the API token credential is valid and has sufficient permissions.
  • Network issues: Connectivity problems to The Companies API will result in request failures.

To resolve these issues:

  • Double-check input parameters and their types.
  • Verify API token validity.
  • Confirm network connectivity.
  • Review node configuration for correct resource and operation selection.

Links and References

Discussion