Skip to main content

Async library for Kick.com API and webhooks

Project description

kickcom.py

Async library for Kick.com API and webhooks

Find the kick.com API documentation here

[!NOTE]
This is in alpha stage, it currently only supports app access tokens. PRs to improve are very welcome!

Client

All endpoints available for app access tokens are available.

from kickpy.client import Client

kick_client = Client("KICK_CLIENT_ID", "KICK_CLIENT_SECRET")

user = await kick_client.fetch_user(4377088)
# Returns:
# User(user_id=4377088, name='KickBot', email='', profile_picture='https://files.kick.com/images/user/4377088/profile_image/conversion/8dde6c21-7008-43d1-b6ac-7d9c34b7d9cc-fullsize.webp')

channel = await kick_client.fetch_channel(4377088)
# Returns:
# Channel(broadcaster_user_id=4377088, slug='kickbot', channel_description='Official bot of https://kickbot.app, the #1 tool for Kick streamers. | VOD Downloader | !clip command | Custom Commands | Timed Messages | Customizable overlays | Stream Deck Plugin |\n\nContact: contact@kickbot.app', banner_picture='https://files.kick.com/images/channel/4295080/banner_image/b0d66fa3-3a4e-45d5-94ea-84d0590990d7', stream=Stream(url='', key='', is_live=False, is_mature=False, language='', start_time='0001-01-01T00:00:00Z', viewer_count=0), stream_title='', category=Category(id=0, name='', thumbnail=''))

Webhook server

Support for receiving webhooks events from Kick is also available.

from kickpy.client import Client
from kickpy.models.webhooks.chat_message import ChatMessage
from kickpy.webhooks.enums import WebhookEvent
from kickpy.webhooks.server import WebhookServer

def on_chat_message(payload: ChatMessage):
    print(payload)


async def main():
    kick_client = Client("KICK_CLIENT_ID", "KICK_CLIENT_SECRET")
    webhook_server = WebhookServer(kick_client, callback_route="KICK_CALLBACK_ROUTE")
    webhook_server.dispatcher.listen(WebhookEvent.CHAT_MESSAGE_SENT, on_chat_message)

    await webhook_server.listen(host="localhost", port=3000, access_log=None)


loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
loop.run_until_complete(main())
loop.run_forever()

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

kickcom_py-0.0.2.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

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

kickcom_py-0.0.2-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file kickcom_py-0.0.2.tar.gz.

File metadata

  • Download URL: kickcom_py-0.0.2.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for kickcom_py-0.0.2.tar.gz
Algorithm Hash digest
SHA256 fd3ccb8c45d4a699cdd9e533e4e6455cedd19e022802c636099521d6e6dc8d4e
MD5 588104686b3c82c9e0c6b18c3957b803
BLAKE2b-256 e2283cc5c128f71caf8bceb843f2f9901e8ecfaaed43dc28bbee219fde5c76b6

See more details on using hashes here.

File details

Details for the file kickcom_py-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: kickcom_py-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 16.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for kickcom_py-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 61bfb67fd2c131fedfd4262624fdc246a6f92056b6dc959cec042d82cf32c162
MD5 c309c3e2bf1dcb1ebf70585b10340e0b
BLAKE2b-256 3b747517fe605efd31f87ee1343cfa7a1938993d6b411e7ec84eada9f133e097

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