Skip to main content
Python PyPI version Downloads License Coverage

Chat Downloader is a simple tool used to retrieve chat messages from livestreams, videos, clips and past broadcasts. No authentication needed!

Installation

This tool is distributed on PyPI and can be installed with pip:

$ pip install sebastientromp-chat-downloader

To update to the latest version, add the --upgrade flag to the above command.

Alternatively, the tool can be installed with git:

$ git clone https://github.com/xenova/chat-downloader.git
$ cd chat-downloader
$ python setup.py install

Usage

Command line

usage: chat_downloader [-h] [--version] [--start_time START_TIME]
                       [--end_time END_TIME]
                       [--message_types MESSAGE_TYPES | --message_groups MESSAGE_GROUPS]
                       [--max_attempts MAX_ATTEMPTS]
                       [--retry_timeout RETRY_TIMEOUT]
                       [--interruptible_retry [INTERRUPTIBLE_RETRY]]
                       [--max_messages MAX_MESSAGES]
                       [--inactivity_timeout INACTIVITY_TIMEOUT]
                       [--timeout TIMEOUT] [--format FORMAT]
                       [--format_file FORMAT_FILE] [--chat_type {live,top}]
                       [--ignore IGNORE]
                       [--message_receive_timeout MESSAGE_RECEIVE_TIMEOUT]
                       [--buffer_size BUFFER_SIZE] [--output OUTPUT]
                       [--overwrite [OVERWRITE]] [--sort_keys [SORT_KEYS]]
                       [--indent INDENT] [--pause_on_debug | --exit_on_debug]
                       [--logging {none,debug,info,warning,error,critical} | --testing | --verbose | --quiet]
                       [--cookies COOKIES] [--proxy PROXY]
                       url

For example, to save messages from a livestream to a JSON file, you can use:

$ chat_downloader https://www.youtube.com/watch?v=jfKfPfyJRdk --output chat.json

For a description of these options, as well as advanced command line use-cases and examples, consult the Command Line Usage page.

Python

from chat_downloader import ChatDownloader

url = 'https://www.youtube.com/watch?v=jfKfPfyJRdk'
chat = ChatDownloader().get_chat(url)       # create a generator
for message in chat:                        # iterate over messages
    chat.print_formatted(message)           # print the formatted message

For advanced python use-cases and examples, consult the Python Documentation.

Chat Items

Chat items/messages are parsed into JSON objects (a.k.a. dictionaries) and should follow a format similar to this:

{
    ...
    "message_id": "xxxxxxxxxx",
    "message": "actual message goes here",
    "message_type": "text_message",
    "timestamp": 1613761152565924,
    "time_in_seconds": 1234.56,
    "time_text": "20:34",
    "author": {
        "id": "UCxxxxxxxxxxxxxxxxxxxxxxx",
        "name": "username_of_sender",
        "images": [
            ...
        ],
        "badges": [
            ...
        ]
    },
    ...
}

For an extensive, documented list of included fields, consult the Chat Item Fields page.

Frequently Asked Questions

Coming soon

Issues

Found a bug or have a suggestion? File an issue here. To assist the developers in fixing the issue, please follow the issue template as closely as possible.

Contributing

If you would like to help improve the tool, you’ll find more information on contributing in our Contributing Guide.

Supported sites:

  • YouTube.com - Livestreams, past broadcasts and premieres.

  • Twitch.tv - Livestreams, past broadcasts and clips.

  • Zoom.us - Past broadcasts

  • Facebook.com (currently in development) - Livestreams and past broadcasts.

Metadata

Release files for sebastientromp-chat-downloader 0.2.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sebastientromp-chat-downloader 0.2.8
File Size Uploaded
sebastientromp_chat_downloader-0.2.8.tar.gz 111.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sebastientromp-chat-downloader 0.2.8
File Interpreter ABI Platform
sebastientromp_chat_downloader-0.2.8-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 190.1 kB

Release files / sebastientromp_chat_downloader-0.2.8.tar.gz

Download URL sebastientromp_chat_downloader-0.2.8.tar.gz
Size 111.4 kB
Tags Source
SHA-256 checksum
How to use checksums
e7ee9948a637c65f020be5f5c8757c615e6630b2724603c39c6d2a36abfb6ae3
BLAKE2b-256 checksum
How to use checksums
dc080288e089baba0eb02478c8768c0fac7bdbe3f847842b0d35b046a59805a4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.3

Release files / sebastientromp_chat_downloader-0.2.8-py2.py3-none-any.whl

Download URL sebastientromp_chat_downloader-0.2.8-py2.py3-none-any.whl
Size 78.6 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
20f0d6d31bcabed87b7e70b18f8d3c8e896871e5b21aa37b85cc10cef3805c48
BLAKE2b-256 checksum
How to use checksums
e1ade24a948b97f76271fdbd59f94120ddc044e06775137b33f263f260b52080
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.3

Release history Release notifications | RSS feed

This release

0.2.8 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page