Skip to content

Account API

Use the account actions to learn about the channel before you change anything. get_account_overview is the first call for every script and agent.

Each action is a REST endpoint under https://kickbot.com/api/v1 and an MCP tool with the same name. The MCP area name is account. Use it to load only this area: https://kickbot.com/api/v1/mcp?areas=account.

Every team member with API access can use this area. It needs no feature permission. Owners and admins have every permission. Write actions also need a read and write key or connection. See Permissions and security.

How the feature works in the dashboard: Add KickBot as a moderator, Account settings.

ToolRESTAccess
get_account_overviewGET /accountRead
get_channel_activityGET /account/activityRead
refresh_kick_dataPOST /account/refresh-kick-dataWrite
check_moderator_statusPOST /account/check-moderatorWrite

Get the account overview. Start here. Returns the channel, its plan (free or premium) and plan limits, your team role and permissions, what this credential may do, and which areas of KickBot you can use. Call it before making changes.

GET /api/v1/account

No input fields.

Get the channel activity of the last 30 days. The dashboard Home page: KickBot interactions per day and per feature in the last 30 days (tts, clips, commands, timed_message, chat_alert, ai_character, ai_images, tips, moderated), the busiest day, highlights (top clip, top TTS voice, top command), which features are on, counts at a glance, when the TTS widget was last open in OBS, and the public links (tip page, clips page, voice list). Tip money (tips_amount_30d_cents, biggest_tip_cents, in US cents) is shown only with the tipping configuration permission; otherwise it is null.

GET /api/v1/account/activity
FieldTypeRequiredDescription
time_zone (query)stringNoIANA time zone for the day boundaries, for example “Europe/Berlin”. Default UTC. An unknown zone uses UTC.

Refresh the Kick channel data. Load the channel name, profile picture, follower count, and stream link from Kick again (the same as “Refresh Kick data” in Settings). Use it after the streamer changed something on Kick. partial: true means Kick gave the name and picture but not the follower count and stream link this time.

POST /api/v1/account/refresh-kick-data

Needs a read and write key or connection. This has an effect outside your settings (for example on your live stream). Rate limit: 20 per minute.

No input fields.

Check if KickBot is a moderator. Check on Kick now whether KickBot is a moderator in the channel, and save the answer (the same as the “Check again” button in the dashboard warning). Many chat features need KickBot as a moderator: the streamer types /mod KickBot in their Kick chat, then you call this.

POST /api/v1/account/check-moderator

Needs a read and write key or connection. This has an effect outside your settings (for example on your live stream). Rate limit: 20 per minute.

No input fields.