Overview
Can be accessed using client.kraken.streams on an
ApiClient
instance.
Example
const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const stream = await api.kraken.streams.getStreamByChannel('125328655');
Methods
getAllLiveStreams(page, limit)
asyncRetrieves a list of all live streams.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| page | number | none |
The result page you want to retrieve. |
|
| limit | number | none |
The number of results you want to retrieve. |
getAllStreams(page, limit)
asyncRetrieves a list of all streams.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| page | number | none |
The result page you want to retrieve. |
|
| limit | number | none |
The number of results you want to retrieve. |
getFollowedStreams(type, page, limit)
asyncRetrieves a list of all streams on channels the currently authenticated user is following.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| type | StreamType | none |
Show only streams of a certain type. |
|
| page | number | none |
The result page you want to retrieve. |
|
| limit | number | 25 |
The number of results you want to retrieve. |
getStreamByChannel(channel)
asyncRetrieves the current stream on the given channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | UserIdResolvable | none |
getStreams(channels, game, languageCode, type, page, limit)
asyncRetrieves a list of streams.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channels | string | Array<string> | none |
A channel ID or a list thereof. |
|
| game | string | none |
Show only streams playing a certain game. |
|
| languageCode | string | none |
Show only streams in a certain language. |
|
| type | StreamType | none |
Show only streams of a certain type. |
|
| page | number | none |
The result page you want to retrieve. |
|
| limit | number | 25 |
The number of results you want to retrieve. |