Skip to content
Kicklet.app
SearchK
Main Navigation HomeDocumentation
Appearance
Menu
On this page
Sidebar Navigation
Documentation
Introduction
Default Commands
JavaScript / Template
How to use JavaScript
Example Commands
Usage of API Token
On this page
• Generating an API Token
• Using the API Token
Usage of API Token
API Tokens allow you to access the Kicklet platform programmatically, enabling you to interact
with the same functionality you have via the web interface, plus additional features like sending
messages to Kick chats as Kicklet.
Generating an API Token
To create an API Token, follow these steps:
1. Go to Profile Settings
Navigate to your Kicklet Profile Settings.
2. Find API Tokens
Scroll down to the "API tokens" section, as shown in the image below:
3. Generate a New Token
Click on the green plus button (+) to generate a new API Token. A prompt will open,
asking you to name the token. Once you name it, click Generate. Here's how it looks:
4. Copy Your Token
After generating the token, it will appear in the list of tokens. Copy it by clicking the
copy icon next to the token:
Important: Treat your API Token like a password. Never share it publicly.
Using the API Token
With your API Token, you can now perform any requests available via the Kicklet web interface
programmatically. It also includes sending messages to the Kick chat as Kicklet.
Sending Messages via API
To send a message to the Kick chat, use the following endpoint:
POST https://kicklet.app/api/kick/message
Example request body:
json
{
"content": "test message"
}
Set the token as a header in your request:
Authorization: apitoken YOURTOKEN
Example response body:
json
{
"id": "f28bcec7-8825-422a-aa9c-e24d0fddf388",
"content": "test message"
}
Searching for a User
You can also search for a user via the following API endpoint:
GET
https://kicklet.app/api/stats/{kickId}/viewer/ranking?page=1&pageSize=50&orde
rBy=watchtime&order=desc&search=SEARCH_TERM
• KICK_ID: This parameter represents your unique Kick account identifier. Replace
{kickId} with your actual Kick ID.
• SEARCH_TERM: This is the term used to search for a particular user. It could be part
of the user's username or the full username. Replace SEARCH_TERM with the value
you want to search for.
Example response:
json
{
"count": 1,
"ranking": [
{
"viewerKickUserID": 324342,
"viewerKickUsername": "Test",
"watchTime": 466321367161466,
"lastActivity": "2024-09-15T20:12:56.497151Z",
"points": 5000,
"messagesSent": 4700,
"rank": 6
}
]
}
Changing Points for a User
To update a user's points, use one of the following endpoints depending on your desired action:
• Add Points: PATCH /stats/{kickId}/points/{viewer}/add/{points}
• Remove Points: PATCH /stats/{kickId}/points/{viewer}/remove/{points}
• Set Points: PATCH /stats/{kickId}/points/{viewer}/set/{points}
Parameters:
• {kickId}: Your unique Kick user ID. Replace {kickId} with your actual Kick ID.
• {viewer}: The username of the viewer whose points you want to update. Replace
{viewer} with the actual username.
• {points}: The number of points to add, remove, or set.
Example Request:
To add 12 points to a user, the request would look like this:
http
PATCH https://kicklet.app/api/stats/{kickId}/points/{viewername}/add/12
Pager
Previous pageExample Commands
