Overview
The Industry Search API resolves an industry from a free-text query such as saywarehouse automationand returns a ranked list of matching industry codes and names. Results are ordered by similarity score, so callers can pick the best match or present several candidates to a user. This is a free endpoint and does not consume credits. Results are returned in the API response.
Endpoint Details
- Method: GET
- Endpoint:
/v1/industry/search
Authentication requirements
- Include a valid API key in the
x-api-keyrequest header.
Request
Request Parameters
Header Parameters
Your API key.
URL Parameters
Free-text industry name or topic to search for. Example:
warehouse automationRequest Example
Response
Successful Response Fields
Returns a JSON object with the following structure:List of matching industry objects, ranked by similarity score. Returns an empty array when no matches are found. See Industry Object Fields below.
Number of industry objects returned in the
data array.Credits consumed by the request. This endpoint is free and always returns
0.Industry Object Fields
Unique industry code.
Full name of the industry.
Similarity score between the query and the matched industry, ranging from
0 to 1. Higher values indicate a closer match. Results are returned in descending order of relevance, though scores are not guaranteed to be strictly sorted for ties..png?fit=max&auto=format&n=tMpg-r-6yeOIk-hz&q=85&s=e0cafcb914826d8adc60e5092187e1ca)
.png?fit=max&auto=format&n=tMpg-r-6yeOIk-hz&q=85&s=f214ebe0a940d8aa0f19a709a6bfd7fa)