Skip to main content

Async library for Kick.com API and webhooks

Project description

kickcom.py

PyPI

Async library for Kick.com API and webhooks

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

Find the kick.com API documentation here

Installation

pip install kickcom.py

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.1.4.tar.gz (14.0 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.1.4-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for kickcom_py-0.1.4.tar.gz
Algorithm Hash digest
SHA256 bff4ffb995587cc8e043bc167fb71a04abe553560889305e35116d2010b7dbce
MD5 ae986fbe8504f1ba4a91d6999c1018ec
BLAKE2b-256 737349d3af6bf401b1eb34705f0eb860e0377eef0d195102d9752b3909a72cfa

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for kickcom_py-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 85fb9fcb246097e101de2939dec37220eab78bcf96c06b079a0fc9880c738694
MD5 83c6133f0625e93e1d9b8f3738d4626a
BLAKE2b-256 411995c35665169741222deee98ba4d39f33e8cc7ce2b9939b7b723946c7b9ca

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