Skip to main content
GET
Industry Search

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: /api/v1/industry/search

Authentication requirements

  • Include a valid API key in the x-api-key request header.

Request

Request Parameters

Header Parameters

string
required
Your API key.

URL Parameters

string
required
Free-text industry name or topic to search for. Example: warehouse automation
string
Restrict results to one or more levels of the industry taxonomy hierarchy. Accepts a single level or a comma-separated list of multiple levels.Available values: l1, l2, l3, l4 , allPassing multiple levels (e.g. l4,l1) returns matches from any of the specified levels, ranked together by similarity score. Default level is l4.

Request Example

Response

Successful Response Fields

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

Industry Object Fields

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

Authorizations

x-api-key
string
header
required

API key obtained from your Akta account.

Query Parameters

query
string
required

Free-text industry name or topic to search for. Example: 'warehouse automation'

level
string

Restrict results to one or more levels of the industry taxonomy hierarchy. Accepts a single level or a comma-separated list of multiple levels. Available values: l1, l2, l3, l4, all. Default is l4.

Response

Industry search results returned

data
object[]
count
integer

Number of industry objects returned in the data array.

credits_consumed
number<float>
Example:

0