Skip to main content
GET
/
topics
/
{topic_id}
Get comprehensive topic information
curl --request GET \
  --url https://api.streamkap.com/topics/{topic_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.streamkap.com/topics/{topic_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.streamkap.com/topics/{topic_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.streamkap.com/topics/{topic_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.streamkap.com/topics/{topic_id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.streamkap.com/topics/{topic_id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.streamkap.com/topics/{topic_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "name": "<string>",
  "entity": {
    "entity_id": "<string>",
    "name": "<string>",
    "topic_ids": [
      "<string>"
    ],
    "topic_db_ids": [
      "<string>"
    ],
    "display_name": "<string>",
    "filtered_snapshot_language": "<string>"
  },
  "kafka": {
    "partitions": {
      "count": 123,
      "replication_factor": 123,
      "under_replicated_count": 123,
      "offline_count": 123,
      "details": [
        {
          "partition_id": 123,
          "replicas": [
            123
          ],
          "in_sync_replicas": [
            123
          ],
          "is_under_replicated": true,
          "is_offline": true
        }
      ]
    },
    "configs": {
      "retention_ms": "<string>",
      "retention_bytes": "<string>",
      "cleanup_policy": "<string>",
      "delete_retention_ms": "<string>",
      "max_message_bytes": "<string>",
      "compression_type": "<string>",
      "min_insync_replicas": "<string>",
      "segment_ms": "<string>",
      "segment_bytes": "<string>",
      "unclean_leader_election": "<string>",
      "message_timestamp_type": "<string>"
    },
    "health": {
      "is_healthy": true,
      "under_replicated_partitions": 123,
      "offline_partitions": 123,
      "total_replicas": 123,
      "in_sync_replicas": 123
    },
    "serialization": {
      "key_format": "unknown",
      "value_format": "unknown",
      "key_converter": "<string>",
      "value_converter": "<string>",
      "schema_registry_enabled": false
    }
  },
  "prefix": "<string>",
  "serialization": {
    "key_format": "unknown",
    "value_format": "unknown",
    "key_converter": "<string>",
    "value_converter": "<string>",
    "schema_registry_enabled": false
  },
  "tags": [
    "<string>"
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

topic_id
string
required

Query Parameters

detailed
boolean
default:false

Response

Successful Response

Topic details with live Kafka information.

id
string
required
name
string
required
entity
TopicDetailsEntity · object
required
kafka
TopicKafkaMetadata · object
required

Live Kafka metadata for a topic.

prefix
string | null
serialization
TopicSerialization · object | null

Serialization format information for this topic (inherited from producer)

tags
string[] | null

List of tag IDs assigned to this topic