ChannelEndpoint
ChannelEndpoint contains methods that return instances directly related to specified Kick channels.
Methods
async getChannel(channel)
Retrieves information about a specified Kick channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | string | true | The channel name you want to retrieve details for |
Returns
Promise<ChannelInstance>
async getLivestream(channel)
Retrieves information about the current livestream on a specified Kick channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | string | true | The channel name you want to retrieve livestream details for |
Returns
Promise<LivestreamInstance>
async getLeaderboards(channel)
Retrieves gifter leaderboards for a specified Kick channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | string | true | The channel name you want to retrieve leaderboards for |
Returns
Promise<GetLeaderboardsResponse>
async getChatroomSettings(channel)
Retrieves chatroom settings for a specified Kick channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | string | true | The channel name you want to retrieve chatroom settings for |
Returns
Promise<GetChatroomSettingsResponse>
async getPoll(channel)
Retrieves information about the current running poll on a specified Kick channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | string | true | The channel name you want to retrieve poll details for |
Returns
Promise<GetPollsResponse>