Skip to main content

Overview

The Industry Search API resolves an industry from a free-text query such as say warehouse 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-key request header.

Request

Request Parameters

Header Parameters

x-api-key
string
required
Your API key.

URL Parameters

query
string
required
Free-text industry name or topic to search for. Example: warehouse automation

Request Example

Response

Successful Response Fields

Returns a JSON object with the following structure:
data
array
List of matching industry objects, ranked by similarity score. Returns an empty array when no matches are found. See Industry Object Fields below.
count
integer
Number of industry objects returned in the data array.
credits_consumed
float
Credits consumed by the request. This endpoint is free and always returns 0.

Industry Object Fields

code
string
Unique industry code.
industry_name
string
Full name of the industry.
similarity
float
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.