Twitch
API actions for the Twitch integration.
Twitch
Look up Twitch profiles, find live streams, list channel followers, and create clips from live broadcasts.
Create a clip
Capture a clip from a channel that is currently live. The channel must be streaming at the time.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | The Twitch username of the live channel to clip, for example 'ninja'. |
has_delay | boolean | No | Turn on to add a short delay before the clip is captured. Most clips leave this off. |
Response
{
"edit_url": "mock_value",
"id": "mock_value"
}Get user profile
Look up a Twitch user's profile by their username.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
user_login | string | Yes | The Twitch username to look up, for example 'ninja'. |
Response
{
"user": {
"description": "mock_value",
"display_name": "mock_value",
"id": "mock_value",
"login": "mock_value"
}
}List channel followers
List the people who follow a channel, along with when they followed and the total follower count. You can only list followers for your own channel or a channel you moderate.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
channel | string | Yes | The channel's Twitch username, for example 'ninja'. This must be your own channel or one you moderate. |
first | number | No | Maximum number of followers to return, from 1 to 100. Defaults to 20. |
Response
{
"followers": [
{
"followed_at": "mock_value",
"user_id": "mock_value",
"user_name": "mock_value"
}
],
"total": 1024
}List live streams
List live streams by channel name or game.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
user_login | string | No | Only show the live stream for this channel's username, for example 'ninja'. |
game_id | string | No | Only show streams playing this game or category. Use the numeric ID Twitch assigns to the game or category. |
first | number | No | Maximum number of streams to return, from 1 to 100. Defaults to 20. |
Response
{
"streams": [
{
"id": "mock_value",
"title": "mock_value",
"user_id": "mock_value",
"user_name": "mock_value",
"viewer_count": 123
}
]
}