> For the complete documentation index, see [llms.txt](https://yagato.gitbook.io/holodexwrapper/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://yagato.gitbook.io/holodexwrapper/methods/getchannelinformation.md).

# getChannelInformation

## Returns

A Channel object matching the given channel ID.

## Parameters

| Name      | Type   |
| --------- | ------ |
| channelId | String |

## Usage Example

{% code lineNumbers="true" %}

```java
HolodexClient holodexClient = new HolodexClient("HOLODEX_API_KEY");

ObjectMapper objectMapper = JsonMapper.builder()
                .addModule(new JavaTimeModule())
                .build();

Channel channel = holodexClient.getChannelInformation("UC5CwaMl1eIgY8h02uZw7u8A");

System.out.println(objectMapper
    .writerWithDefaultPrettyPrinter()
    .writeValueAsString(channel));
```

{% endcode %}

## Result Example

{% code lineNumbers="true" %}

```
{
  "id" : "UC5CwaMl1eIgY8h02uZw7u8A",
  "name" : "Suisei Channel",
  "english_name" : "Hoshimachi Suisei",
  "type" : "vtuber",
  "photo" : "https://yt3.ggpht.com/ytc/AGIKgqPUZZxHa5ICd-CZd6g5zBfvrJIo2fFB26JJozKuqw=s800-c-k-c0x00ffffff-no-rj-mo",
  "org" : "Hololive",
  "suborg" : "0x0th Generation",
  "banner" : "https://yt3.googleusercontent.com/_FhQJOY3t5UVdPZp087Wf6qvlr9D9zorMYop3FuaujPAdGfGjwwivk11VgzM7P6_HbdhkXMtiSs",
  "twitter" : "suisei_hosimati",
  "video_count" : "651",
  "subscriber_count" : "1860000",
  "comments_crawled_at" : "2023-05-07T05:57:55.753Z",
  "view_count" : "524664795",
  "clip_count" : "11600",
  "top_topics" : [ "singing", "talk", "minecraft" ],
  "published_at" : "2018-03-18T08:32:39.000Z",
  "inactive" : false,
  "description" : "アイドルVtuberの星街すいせいです！\n歌とお絵かきとアニメが大好きな１８歳です☄☄\n\n目指すはバーチャルライブ！！\nぜったい叶えるから応援よろしくね✯\n\n▼配信情報etcはTwitterにてチェック！▼\nhttps://twitter.com/suisei_hosimati",
  "updated_at" : "2023-05-07T11:30:16.158Z",
  "yt_uploads_id" : "UU5CwaMl1eIgY8h02uZw7u8A",
  "crawled_at" : "2023-05-07T11:09:14.010Z",
  "created_at" : "2021-04-23T07:21:00.045Z",
  "yt_handle" : [ "@hoshimachisuisei" ],
  "yt_name_history" : [ "Suisei Channel" ],
  "group" : "0th Generation"
}
```

{% endcode %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://yagato.gitbook.io/holodexwrapper/methods/getchannelinformation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.