Skip to main content

A Python package for interacting with the Kick API to retrieve channel and video data.

Project description

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:

pip install KickApi

Usage

Integrate the KickApi into your Python project with ease:

Fetch Channel Data

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

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.createdAt)
print("Updated At:", video.updatedAt)
print("UUID:", video.uuid)
print("Views:", video.views)
print("Language:", video.language)
print("Stream Video URL:", video.strem_video)

# Access channel data associated with the video
print("Channel ID:", video.channel.id)
print("Channel Username:", video.channel.username)

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.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

KickApi-0.3.0.tar.gz (3.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

KickApi-0.3.0-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file KickApi-0.3.0.tar.gz.

File metadata

  • Download URL: KickApi-0.3.0.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for KickApi-0.3.0.tar.gz
Algorithm Hash digest
SHA256 0bbfb341aaa00385442d3c2a718eacf6477385093521debba3c20100b6841d9b
MD5 d42cf16bbe4cd925261694ee0e15f7e0
BLAKE2b-256 e2c8cd0b2008ad1846437dd5f76801fc757e0bbb574884895e15b011d44a7ca9

See more details on using hashes here.

File details

Details for the file KickApi-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: KickApi-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 4.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for KickApi-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 85327a3ed696c02f30d603622cffac5b7bede3c5ad65e792f5802fc70437c4ca
MD5 798a9e532a7757cadc6a7a92d7dba7d2
BLAKE2b-256 ea573dd3c9cfb6777d9e9fcc9867606cb4112a846117227f6acba3d80576ad9f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page