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 package provides a Python client for interacting with the Kick API, allowing you to retrieve channel and video data.

Installation

Install the package using pip:

pip install KickApi

Usage

You can use the package for many things, and these are examples of them

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 Data Retrieval Fetch detailed information about a Kick channel by providing the username.
Video Data Retrieval Retrieve information about a Kick video using its video ID.

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.2.0.tar.gz (3.1 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.2.0-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for KickApi-0.2.0.tar.gz
Algorithm Hash digest
SHA256 6606799c589ccba4db34cf44b05e16627fe994978c6535560d2636b18dc688cb
MD5 ed5914f7c695c5ed601b3587b1b6a695
BLAKE2b-256 8e9c972b30ad45e400e7ed827fe04e2eb482688d469597924ea0b62d2db26de9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: KickApi-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 3.8 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 081216583e25c0fc1685c1e90c2aa4c5e72d0f9173aa0c4982421dddf1d38f85
MD5 e005c3332dc1f3215eb1dc7c298c4193
BLAKE2b-256 f786eb8c6fd745860d5a95b4a7904833de40d3c80b4127f69ce555b4d5c3256d

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