Get topic by ID

Returns the topic details for the given topic ID.

GET /api/v1/topics/{topicId}

Get topic by ID

cURL

curl --request GET \
  --url https://api.example.com/api/v1/topics/{topicId}

import requests

url = "https://api.example.com/api/v1/topics/{topicId}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/topics/{topicId}', 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.example.com/api/v1/topics/{topicId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.example.com/api/v1/topics/{topicId}"

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

	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.example.com/api/v1/topics/{topicId}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/topics/{topicId}")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "admin_key": {
    "_type": "ProtobufEncoded",
    "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"
  },
  "auto_renew_account": "0.0.2",
  "auto_renew_period": 7776000,
  "created_timestamp": "1586567700.453054000",
  "custom_fees": {
    "created_timestamp": "1586567700.453054000",
    "fixed_fees": [
      {
        "amount": 100,
        "collector_account_id": "0.0.2",
        "denominating_token_id": "0.0.2"
      }
    ]
  },
  "deleted": false,
  "fee_exempt_key_list": [
    {
      "_type": "ProtobufEncoded",
      "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"
    }
  ],
  "fee_schedule_key": {
    "_type": "ProtobufEncoded",
    "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"
  },
  "memo": "topic memo",
  "submit_key": {
    "_type": "ProtobufEncoded",
    "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"
  },
  "timestamp": {
    "from": "1586567700.453054000",
    "to": "1586567700.453054000"
  },
  "topic_id": "0.0.2"
}

{
  "_status": {
    "messages": [
      {
        "message": "Invalid parameter: account.id"
      },
      {
        "message": "Invalid Transaction id. Please use \\shard.realm.num-sss-nnn\\ format where sss are seconds and nnn are nanoseconds"
      }
    ]
  }
}

{
  "_status": {
    "messages": [
      {
        "message": "Not found"
      }
    ]
  }
}

Path Parameters

topicId · string | null · required

Topic id Network entity ID in the format of shard.realm.num

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

Example:

"0.0.2"

Response

200

application/json

OK

admin_key · object | null · required

The public key which controls access to various network entities.

Show child attributes

auto_renew_account · string | null · required

Network entity ID in the format of shard.realm.num

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

Example:

"0.0.2"

auto_renew_period · integer<int64> | null · required

The amount of time to attempt to extend the topic's lifetime after expiration.

Example:

7776000

created_timestamp · string | null · required

A Unix timestamp in seconds.nanoseconds format

Pattern: ^\d{1,10}(\.\d{1,9})?$

Example:

"1586567700.453054000"

custom_fees · object · required

Custom fees assessed for each message submitted to the topic

Show child attributes

deleted · boolean | null · required

Whether the topic is deleted or not.

Example:

false

fee_exempt_key_list · (object | null)[] · required

Keys permitted to submit messages to the topic without paying custom fees

The public key which controls access to various network entities.

Show child attributes

fee_schedule_key · object | null · required

The public key which controls access to various network entities.

Show child attributes

memo · string · required

The memo associated with the topic.

Example:

"topic memo"

submit_key · object | null · required

The public key which controls access to various network entities.

Show child attributes

timestamp · object · required

A timestamp range an entity is valid for

Show child attributes

topic_id · string | null · required

Network entity ID in the format of shard.realm.num

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

Example:

"0.0.2"