Get Company Field

The "Get Company Field" endpoint allows you to define any field you are interested in, and the AI will do its best to capture that information from public sources. This is particularly useful for obtaining specific or non-standard data points about a company.

Endpoint

POST /v1/companies/get-field-value

Parameters

• field_name (required, string): The specific field you want to retrieve (e.g., "Revenue", "Offering Description").

• company_name (string): The name of the target company. It’s recommended to use the common name (e.g., "Google") rather than the full legal name ("Google LLC") to increase the chances of a successful match.

• company_domain (string): The web domain of the target company (e.g., "google.com"). This helps to uniquely identify the company.

Note: Both company_name or web_domain must be provided. Providing both will improve the accuracy of the results.

Example Request

POST /v1/companies/get-field-value
{
  "field_name": "revenue",
  "company_name": "Google",
  "company_domain": "google.com"
}

Example Response

{
  "field_name": "revenue",
  "company_name": "Google",
  "company_domain": "google.com",
  "value": "182.5 billion USD"
}

Usage Notes

• Custom Field Retrieval: Define any field of interest, and the AI will search available public sources to provide the best possible match.

• Specifying the Company: While using at least the company name is recommended, using both the company name and web domain will yield the best results.