KickApi 0.3.7
A Python package for interacting with the Kick API to retrieve channel and video data.
Requires Python: >=3.8
Keywords: kick, api, kickapi, live streaming, kick.com, video api, streaming platform, python kick sdk, kick bot, kick integration

<p align="center">
  <img src="logo.png" alt="Kick API Logo" width="100"/>
</p>

# Kick API for Python

The `KickApi` Python package is your gateway to seamless integration with the Kick API, providing a robust and user-friendly interface for retrieving comprehensive channel and video data. Empowering developers to harness the full potential of Kick's capabilities, this package simplifies data retrieval, enabling a wide range of applications from content analysis to user interaction.

## Installation

Getting started is a breeze. Install the KickApi package with a single command

```bash
pip install KickApi
```

### Using uv (optional, recommended)

If you prefer a fast, reproducible workflow with an isolated virtual environment, you can use uv.

- Install uv: see the [installation guide](https://docs.astral.sh/uv/getting-started/installation/).
- From the project root, create/sync the environment and install deps: `uv sync`
- Run your code inside the environment: `uv run python -c "import kickapi; print('OK')"`
- Build distributions (wheel/sdist): `uv build`

uv reads `pyproject.toml` for project metadata and dependencies and manages a local virtual environment automatically.

## Packaging

This project has fully migrated to `pyproject.toml` (PEP 621) with setuptools as the backend (PEP 517).

- Build distributions: `uv build`
- Sync environment for development: `uv sync`
- Install from source (PEP 517): `pip install .`

## Usage

Integrate the KickApi into your Python project with ease:

### Fetch Channel Data

The KickAPI package allows you to fetch detailed information about a Kick channel effortlessly. The example code below demonstrates how to use KickAPI to retrieve and display channel data.

```python
from kickapi import KickAPI

# Create an instance of KickAPI
kick_api = KickAPI()

# Fetch channel data by username
channel = kick_api.channel("username")

# Access channel attributes
print("Channel ID:", channel.id)
print("Username:", channel.username)
print("Bio:", channel.bio)
print("Avatar URL:", channel.avatar)
print("Followers:", channel.followers)
print("Playback URL:", channel.playback)
```

### Fetch Video Data

To obtain insights into Kick videos, including details such as title, thumbnail URL, duration, and more, you can use KickAPI to fetch video data. The example code below demonstrates how to retrieve and display video details.

```python
from kickapi import KickAPI

# Create an instance of KickAPI
kick_api = KickAPI()

# Fetch video data by video ID
video = kick_api.video("video_id")

# Access video attributes
print("Video ID:", video.id)
print("Title:", video.title)
print("Thumbnail URL:", video.thumbnail)
print("Duration:", video.duration)
print("Live Stream ID:", video.live_stream_id)
print("Created At:", video.created_at)
print("Updated At:", video.updated_at)
print("UUID:", video.uuid)
print("Views:", video.views)
print("Language:", video.language)
print("Stream Video URL:", video.stream)

# Access channel data associated with the video
print("Channel ID:", video.channel.id)
print("Channel Username:", video.channel.username)
```

You can also view the channel's videos through the username.

```python
from kickapi import KickAPI

# Create an instance of KickAPI
kick_api = KickAPI()

# Fetch channel data using username
channel = kick_api.channel("username")

# Fetch and print videos associated with the channel
print("Channel Videos:")
for video in channel.videos:
    print(f"Title: {video.title}")
    print(f"Duration: {video.duration}")
    print(f"Views: {video.views}")
    print(f"Stream URL: {video.stream}")
    print("-" * 30)
```

### Fetch Clip Data

Retrieve detailed information about a specific clip using its unique clip ID. This is useful when you already have a clip ID and want to display or analyze its metadata.

```python
from kickapi import KickAPI

# Create an instance of KickAPI
kick_api = KickAPI()

# Fetch clip data using KickAPI
clip = kick_api.clip("clip_id")

# Display clip information
print("🎞 Clip Information")
print(f"Title: {clip.title}")
print(f"Clip ID: {clip.id}")
print(f"Created At: {clip.created_at}")
print(f"Thumbnail: {clip.thumbnail}")
print(f"Duration: {clip.duration}")
print(f"Stream URL: {clip.stream}")

# Optional: Show creator details if available
if clip.creator:
    print(f"Created By: {clip.creator.username}")
    print(f"Creator Category: {clip.category.name}")
```

You can access the clips from a channel, including metadata like title, creator, and category.

```python
from kickapi import KickAPI

# Create an instance of KickAPI
kick_api = KickAPI()

# Fetch channel data using username
channel = kick_api.channel("username")

# Fetch and print clips associated with the channel
print("Channel Clips:")
for clip in channel.clips:
    print(f"Title: {clip.title}")
    print(f"Clip ID: {clip.id}")
    print(f"Created By: {clip.creator.username}")
    print(f"Category: {clip.category.name}")
    print("-" * 30)
```

### Fetch Channel Leaderboards

Display leaderboard data for a Kick channel, including top gifters of all time, this week, and this month.

```python
from kickapi import KickAPI

# Create an instance of KickAPI
kick_api = KickAPI()

# Fetch channel data using username
channel = kick_api.channel("username")

# Fetch leaderboard data
leaderboard = channel.leaderboards

# Gifts leaderboard
print("🎁 Gifts Leaderboard:")
for user in leaderboard.gifts:
    print(f"{user.username} - {user.quantity} gifts")

# Weekly leaderboard
print("\n📅 Weekly Gifts Leaderboard:")
for user in leaderboard.gifts_week:
    print(f"{user.username} - {user.quantity} gifts")

# Monthly leaderboard
print("\n🗓 Monthly Gifts Leaderboard:")
for user in leaderboard.gifts_month:
    print(f"{user.username} - {user.quantity} gifts")
```

### Fetch Chat Data

The KickAPI package allows you to fetch chat data for a specific video, providing insights into the conversation history. The example code below demonstrates how to use KickAPI to retrieve and display chat messages.

```python
from kickapi import KickAPI

# Create an instance of KickAPI
kick_api = KickAPI()

# Fetch video data
channel = kick_api.channel('username')

# Fetch chat data for the video's channel and a specific date
chat = kick_api.chat(channel.id, '<DATE_TIME>') # Example 2024-01-1T01:00:00.000Z

# Iterate over messages and print sender's username and text
for message in chat.messages:
    print("{}: {}".format(message.sender.username, message.text))
```

### Fetch Live Chat Data

To fetch live chat data and receive real-time updates on the ongoing conversation, you can continuously retrieve messages at intervals. The example code below demonstrates how to use KickAPI to fetch and display live chat messages.

```python
from kickapi import KickAPI
from datetime import datetime, timedelta
import time

# Create an instance of KickAPI
kick_api = KickAPI()

# Fetch video data
video = kick_api.video('video_id')

while True:
    # Convert to datetime object and format in the desired way
    original_date_obj = datetime.strptime(video.start_time, '%Y-%m-%d %H:%M:%S')
    formatted_date_str = original_date_obj.strftime('%Y-%m-%dT%H:%M:%S.000Z')

    # Fetch chat data for the video's channel and the specific date
    chat = kick_api.chat(video.channel.id, formatted_date_str)

    # Iterate over messages and print sender's username and text
    for message in chat.messages:
        print("{}: {}".format(message.sender.username, message.text))

    # Update start_time for the next iteration and pause for 5 seconds
    video.start_time = (original_date_obj + timedelta(seconds=5)).strftime('%Y-%m-%d %H:%M:%S')
    time.sleep(5)
```

### Fetch and Save Avatar Image

You can use the KickAPI to fetch a channel's avatar image and save it locally. Below is an example code snippet demonstrating how to achieve this:

```python
from kickapi import KickAPI
import requests

# Create an instance of KickAPI
kick_api = KickAPI()

# Fetch channel data by username
channel = kick_api.channel("username")

# Send a request to get the avatar URL from the channel data
response = requests.get(channel.avatar)

# Check if the request was successful (status code 200)
if response.status_code == 200:
    # Open a file handler to create a new file named 'avatar.webp'
    with open('avatar.webp', "wb") as file:
        # Write the content of the response to the file
        file.write(response.content)
        print("Avatar image saved successfully.")
else:
    print(f"Failed to fetch avatar. Status Code: {response.status_code}")
```

## Features

- **Channel Insights**  
  Obtain a detailed snapshot of Kick channels effortlessly. Retrieve essential information such as channel ID, bio, avatar URL, followers count, and playback URL.

- **Video Analytics**  
  Dive deep into Kick videos with a wealth of data at your fingertips. Retrieve details including video title, thumbnail URL, duration, live stream ID, creation and update timestamps, UUID, views count, language, stream video URL, and associated channel details.

- **Clip Access**  
  Fetch clips by channel or by clip ID. Each clip includes metadata such as clip ID, title, thumbnail, creation time, duration, and creator details.

- **Leaderboard Integration**  
  Retrieve leaderboard data for channels, including top contributors by gifts. Access weekly, monthly, and all-time leaderboards with structured user information (ID, username, quantity).

- **Category & Language Support**  
  Explore video and stream categories as well as available languages for better content filtering and organization.

- **Dynamic Data Handling**  
  The API is smartly designed to pull values either from livestream data or fallback to main video/channel data if necessary, ensuring robustness even with partial responses.

- **Chat Integration**  
  Stay connected with Kick chat functionality. Retrieve and interact with chat messages, including sender details, message content, and timestamps.

- **Live Chat Tracking**  
  Monitor real-time chat activity in a livestream by continuously polling messages using the video's start time.

## Contributing

We welcome contributions from the community! If you'd like to contribute to the development of KickApi, please follow these guidelines:

- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and ensure the code passes all tests.
- Submit a pull request with a clear description of your changes.

## License

This project is licensed under the MIT License - see the LICENSE file for details.
Make sure to include a `LICENSE` file in your project's root directory and specify the licensing details in that file. The provided link in the "License" section should point to the actual `LICENSE` file in your project.