Skip to content

Suggest Industries

The /v1/suggest/industries endpoint provides autocomplete functionality for searching industries by name prefix. It is useful for building filter interfaces: the returned id can be passed directly to the industry.id parameter of the news endpoints.

To use the API, you'll require an API key. You can obtain an API key by signing up for an account on the APITube website.

Endpoint

GET /v1/suggest/industries

This endpoint returns a list of industries matching the provided name prefix.

Query Parameters

ParameterTypeRequiredDescription
prefixstringYesThe name prefix to search for. Minimum 1 character.
api_keystringYes*Your API key. Can also be provided via headers.

* Required if not provided in headers

Response Format

The endpoint returns an array of industry objects with the following structure:

json
[
  {
    "id": 0,
    "name": "string",
    "links": {
      "self": "string"
    }
  }
]

Response Fields

FieldTypeDescription
idintegerIndustry identifier. Use it directly in the industry.id filter.
namestringIndustry name
links.selfstringURL to get news articles in this industry (/v1/news/industry/{id})

Request Examples

Using query parameter

shell
curl "https://api.apitube.io/v1/suggest/industries?prefix=tech&api_key=YOUR_API_KEY"

Using header authentication

shell
curl -H "X-API-Key: YOUR_API_KEY" \
  "https://api.apitube.io/v1/suggest/industries?prefix=finance"

Using Bearer token

shell
curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.apitube.io/v1/suggest/industries?prefix=health"

Response Example

json
[
  {
    "id": 312,
    "name": "Technology",
    "links": {
      "self": "https://api.apitube.io/v1/news/industry/312"
    }
  }
]

Error Responses

Missing or Invalid API Key

json
{
  "errors": [
    {
      "code": "ER0201",
      "message": "API key is required. Provide it via X-API-Key header or api_key query parameter."
    }
  ]
}

Status Code: 401

Missing Prefix Parameter

json
{
  "errors": [
    {
      "code": "ER0346",
      "message": "`Prefix` in query required."
    }
  ]
}

Status Code: 400