Kick

App · 19 actions

Read channels, categories, livestreams and rewards; manage chat, moderation and channel rewards.

Actions

ActionWhat it does
Accept reward redemptionsAccept Channel Reward Redemptions.
Ban userBan a viewer from a channel's chat, or time them out for a number of minutes, with an optional reason.
Create channel rewardCreate Channel Reward.
Delete channel rewardDelete Channel Reward.
Delete chat messageDelete Chat Message.
Get categoryGet Category.
Get channelsGet Channels.
Get KICKs leaderboardGet KICKs Leaderboard.
Get livestream statisticsGet Livestreams Stats.
Get usersGet Users.
List categoriesGet Categories.
List channel rewardsGet Channel Rewards.
List livestreamsGet Livestreams.
List reward redemptionsGet Channel Reward Redemptions.
Reject reward redemptionsReject Channel Reward Redemptions.
Send chat messagePost Chat Message.
Unban userLift a ban or timeout so a viewer can chat in the channel again.
Update channelPatch Channels.
Update channel rewardUpdate Channel Reward.

Accept reward redemptions

Accept Channel Reward Redemptions.

Inputs

IdsidslistRequired
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 userbroadcaster_user_idtextRequired
Broadcaster user ID.
Durationdurationnumber
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.
Reasonreasontext
Reason.
Member IDmember_idtextRequired
Member ID.

Outputs

dataobject
Kick response data.
Example output
{
  "data": {
    "data": {},
    "message": "example"
  }
}

Create channel reward

Create Channel Reward.

Inputs

Background colorbackground_colortext
Background color.Default: #00e701.
CostcostnumberRequired
Cost.At least 1.
Descriptiondescriptiontext
Description.
Is enabledis_enabledtrue/false
Is enabled.Default: true.
Is user input requiredis_user_input_requiredtrue/false
Is user input required.Default: false.
Should redemptions skip request queueshould_redemptions_skip_request_queuetrue/false
Should redemptions skip request queue.Default: false.
TitletitletextRequired
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

IdidtextRequired
Reward ID

Outputs

dataobject
Kick response data.
Example output
{
  "data": {}
}

Delete chat message

Delete Chat Message.

Inputs

Message IDmessage_idtextRequired
Message ID

Outputs

dataobject
Kick response data.
Example output
{
  "data": {}
}

Get category

Get Category.

Inputs

Category IDcategory_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 userbroadcaster_user_idlist
Broadcaster User IDs (cannot be used with slug)
Slugsluglist
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

Toptopnumber
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

Ididlist
User IDs

Outputs

dataobject
Kick response data.
Example output
{
  "data": {
    "data": [],
    "message": "example"
  }
}

List categories

Get Categories.

Inputs

QqtextRequired
Search query
Pagepagenumber
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 userbroadcaster_user_idlist
Broadcaster User IDs (up to 50)
Category IDcategory_idtext
Category ID
Languagelanguagetext
Language of the livestream
Limitlimitnumber
Limit the number of resultsFrom 1 to 100. Default: 25.
Sortsorttext
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

Rewardreward_idtext
Optionally provide a reward ID to list redemptions for that specific reward.
Statusstatustext
Optionally provide a specific status to filter by. Defaults to pending.One of: pending, accepted, rejected.
Ididlist
Optionally provide a list of redemption IDs to filter by. You cannot provide any other filters if you filter by redemption IDs.
Cursorcursortext
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

IdsidslistRequired
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 userbroadcaster_user_idtext
Broadcaster user ID.
ContentcontenttextRequired
Content.
Reply to message IDreply_to_message_idtext
Reply to message ID.
TypetypetextRequired
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 userbroadcaster_user_idtextRequired
Broadcaster user ID.
Member IDmember_idtextRequired
Member ID.

Outputs

dataobject
Kick response data.
Example output
{
  "data": {
    "data": {},
    "message": "example"
  }
}

Update channel

Patch Channels.

Inputs

Category IDcategory_idtext
Category ID.
Custom tagscustom_tagslist
Custom tags.
Stream titlestream_titletext
Stream title.

Outputs

dataobject
Kick response data.
Example output
{
  "data": {}
}

Update channel reward

Update Channel Reward.

Inputs

IdidtextRequired
Reward ID
Background colorbackground_colortext
Background color.
Costcostnumber
Cost.At least 1.
Descriptiondescriptiontext
Description.
Is enabledis_enabledtrue/false
Is enabled.
Is pausedis_pausedtrue/false
Is paused.
Is user input requiredis_user_input_requiredtrue/false
Is user input required.
Should redemptions skip request queueshould_redemptions_skip_request_queuetrue/false
Should redemptions skip request queue.
Titletitletext
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"
  }
}

On this page