Skip to content

Suggest Topics

The /v1/suggest/topics endpoint provides autocomplete functionality for searching topics by name prefix. It is useful for building filter interfaces: the returned id can be passed directly to the topic.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/topics

This endpoint returns a list of topics 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 topic objects with the following structure:

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

Response Fields

FieldTypeDescription
idstringTopic identifier (slug, e.g. industry.aerospace_news). Use it directly in the topic.id filter.
namestringTopic name
links.selfstringURL to get news articles on this topic (/v1/news/topic/{id})

Request Examples

Using query parameter

bash
curl "https://api.apitube.io/v1/suggest/topics?prefix=election&api_key=YOUR_API_KEY"
python
import requests

resp = requests.get(
    "https://api.apitube.io/v1/suggest/topics",
    params={"prefix": "election", "api_key": "YOUR_API_KEY"},
)
print(resp.json())
javascript
const params = new URLSearchParams({ prefix: "election", api_key: "YOUR_API_KEY" });
const resp = await fetch(`https://api.apitube.io/v1/suggest/topics?${params}`);
console.log(await resp.json());
php
$query = http_build_query(["prefix" => "election", "api_key" => "YOUR_API_KEY"]);
$data = json_decode(file_get_contents("https://api.apitube.io/v1/suggest/topics?$query"), true);
print_r($data);
go
package main

import (
	"encoding/json"
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	u, _ := url.Parse("https://api.apitube.io/v1/suggest/topics")
	q := u.Query()
	q.Set("prefix", "election")
	q.Set("api_key", "YOUR_API_KEY")
	u.RawQuery = q.Encode()

	resp, _ := http.Get(u.String())
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	var data map[string]any
	json.Unmarshal(body, &data)
	fmt.Println(data)
}
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.apitube.io/v1/suggest/topics?prefix=election&api_key=YOUR_API_KEY"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}
text
Write a script in your preferred language that calls the APITube News API:

GET https://api.apitube.io/v1/suggest/topics?prefix=election

Read the API key from an environment variable (do not hardcode it), handle request
errors, and print the key fields of each result.
Docs: https://docs.apitube.io/platform/news-api/parameters

Using header authentication

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

Using Bearer token

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

Response Example

json
[
  {
    "id": "elections",
    "name": "Elections",
    "links": {
      "self": "https://api.apitube.io/v1/news/topic/elections"
    }
  }
]

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