Kick
App · 19 actions
Read channels, categories, livestreams and rewards; manage chat, moderation and channel rewards.
Actions
| Action | What it does |
|---|---|
| Accept reward redemptions | Accept Channel Reward Redemptions. |
| Ban user | Ban a viewer from a channel's chat, or time them out for a number of minutes, with an optional reason. |
| Create channel reward | Create Channel Reward. |
| Delete channel reward | Delete Channel Reward. |
| Delete chat message | Delete Chat Message. |
| Get category | Get Category. |
| Get channels | Get Channels. |
| Get KICKs leaderboard | Get KICKs Leaderboard. |
| Get livestream statistics | Get Livestreams Stats. |
| Get users | Get Users. |
| List categories | Get Categories. |
| List channel rewards | Get Channel Rewards. |
| List livestreams | Get Livestreams. |
| List reward redemptions | Get Channel Reward Redemptions. |
| Reject reward redemptions | Reject Channel Reward Redemptions. |
| Send chat message | Post Chat Message. |
| Unban user | Lift a ban or timeout so a viewer can chat in the channel again. |
| Update channel | Patch Channels. |
| Update channel reward | Update Channel Reward. |
Accept reward redemptions
Accept Channel Reward Redemptions.
Inputs
- Ids
idslistRequired - List of redemption IDs to accept. A maximum of 25 redemptions can be accepted per request. IDs must be unique.
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": [],
"message": "example"
}
}Ban user
Ban a viewer from a channel's chat, or time them out for a number of minutes, with an optional reason.
Inputs
- Broadcaster user
broadcaster_user_idtextRequired - Broadcaster user ID.
- Duration
durationnumber - To ban a user, don't include this field. To put a user in a timeout, include the timeout period in minutes.From 1 to 10080.
- Reason
reasontext - Reason.
- Member ID
member_idtextRequired - Member ID.
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": {},
"message": "example"
}
}Create channel reward
Create Channel Reward.
Inputs
- Background color
background_colortext - Background color.Default:
#00e701. - Cost
costnumberRequired - Cost.At least 1.
- Description
descriptiontext - Description.
- Is enabled
is_enabledtrue/false - Is enabled.Default:
true. - Is user input required
is_user_input_requiredtrue/false - Is user input required.Default:
false. - Should redemptions skip request queue
should_redemptions_skip_request_queuetrue/false - Should redemptions skip request queue.Default:
false. - Title
titletextRequired - Title.
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": {
"background_color": "example",
"cost": 1,
"description": "example",
"id": "example",
"is_enabled": false,
"is_paused": false,
"is_user_input_required": false,
"should_redemptions_skip_request_queue": false,
"title": "example"
},
"message": "example"
}
}Delete channel reward
Delete Channel Reward.
Inputs
- Id
idtextRequired - Reward ID
Outputs
dataobject- Kick response data.
Example output
{
"data": {}
}Delete chat message
Delete Chat Message.
Inputs
- Message ID
message_idtextRequired - Message ID
Outputs
dataobject- Kick response data.
Example output
{
"data": {}
}Get category
Get Category.
Inputs
- Category ID
category_idtextRequired - Category ID
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": {
"id": 1,
"name": "example",
"tags": [],
"thumbnail": "example",
"viewer_count": 1
},
"message": "example"
}
}Get channels
Get Channels.
Inputs
- Broadcaster user
broadcaster_user_idlist - Broadcaster User IDs (cannot be used with slug)
- Slug
sluglist - Channel slugs (cannot be used with broadcaster_user_id)
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": [],
"message": "example"
}
}Get KICKs leaderboard
Get KICKs Leaderboard.
Inputs
- Top
topnumber - The number of entries from the top of the leaderboard to return. For example, 10 will fetch the top 10 entries.From 1 to 100. Default:
10.
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": {
"lifetime": [],
"month": [],
"week": []
},
"message": "example"
}
}Get livestream statistics
Get Livestreams Stats.
Inputs
None.
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": {
"total_count": 1
},
"message": "example"
}
}Get users
Get Users.
Inputs
- Id
idlist - User IDs
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": [],
"message": "example"
}
}List categories
Get Categories.
Inputs
- Q
qtextRequired - Search query
- Page
pagenumber - Page (defaults to 1 if not provided)Default:
1.
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": [],
"message": "example"
}
}List channel rewards
Get Channel Rewards.
Inputs
None.
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": [],
"message": "example"
}
}List livestreams
Get Livestreams.
Inputs
- Broadcaster user
broadcaster_user_idlist - Broadcaster User IDs (up to 50)
- Category ID
category_idtext - Category ID
- Language
languagetext - Language of the livestream
- Limit
limitnumber - Limit the number of resultsFrom 1 to 100. Default:
25. - Sort
sorttext - Sort by viewer_count or started_atOne of:
viewer_count(Viewer count),started_at(Started at). Default:viewer_count.
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": [],
"message": "example"
}
}List reward redemptions
Get Channel Reward Redemptions.
Inputs
- Reward
reward_idtext - Optionally provide a reward ID to list redemptions for that specific reward.
- Status
statustext - Optionally provide a specific status to filter by. Defaults to pending.One of:
pending,accepted,rejected. - Id
idlist - Optionally provide a list of redemption IDs to filter by. You cannot provide any other filters if you filter by redemption IDs.
- Cursor
cursortext - Optionally provide a cursor to paginate through the results.
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": [],
"message": "example",
"pagination": {
"next_cursor": "example"
}
}
}Reject reward redemptions
Reject Channel Reward Redemptions.
Inputs
- Ids
idslistRequired - List of redemption IDs to reject. A maximum of 25 redemptions can be rejected per request. IDs must be unique.
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": [],
"message": "example"
}
}Send chat message
Post Chat Message.
Inputs
- Broadcaster user
broadcaster_user_idtext - Broadcaster user ID.
- Content
contenttextRequired - Content.
- Reply to message ID
reply_to_message_idtext - Reply to message ID.
- Type
typetextRequired - Type.One of:
user,bot.
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": {
"is_sent": false,
"message_id": "example"
},
"message": "example"
}
}Unban user
Lift a ban or timeout so a viewer can chat in the channel again.
Inputs
- Broadcaster user
broadcaster_user_idtextRequired - Broadcaster user ID.
- Member ID
member_idtextRequired - Member ID.
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": {},
"message": "example"
}
}Update channel
Patch Channels.
Inputs
- Category ID
category_idtext - Category ID.
- Custom tags
custom_tagslist - Custom tags.
- Stream title
stream_titletext - Stream title.
Outputs
dataobject- Kick response data.
Example output
{
"data": {}
}Update channel reward
Update Channel Reward.
Inputs
- Id
idtextRequired - Reward ID
- Background color
background_colortext - Background color.
- Cost
costnumber - Cost.At least 1.
- Description
descriptiontext - Description.
- Is enabled
is_enabledtrue/false - Is enabled.
- Is paused
is_pausedtrue/false - Is paused.
- Is user input required
is_user_input_requiredtrue/false - Is user input required.
- Should redemptions skip request queue
should_redemptions_skip_request_queuetrue/false - Should redemptions skip request queue.
- Title
titletext - Title.
Outputs
dataobject- Kick response data.
Example output
{
"data": {
"data": {
"background_color": "example",
"cost": 1,
"description": "example",
"id": "example",
"is_enabled": false,
"is_paused": false,
"is_user_input_required": false,
"should_redemptions_skip_request_queue": false,
"title": "example"
},
"message": "example"
}
}