<h1 align="center">
✨ YouTube Transcript API ✨
</h1>
<p align="center">
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BAENLEW8VUJ6G&source=url">
<img src="https://img.shields.io/badge/Donate-PayPal-green.svg" alt="Donate">
</a>
<a href="https://github.com/jdepoix/youtube-transcript-api/actions">
<img src="https://github.com/jdepoix/youtube-transcript-api/actions/workflows/ci.yml/badge.svg?branch=master" alt="Build Status">
</a>
<a href="https://coveralls.io/github/jdepoix/youtube-transcript-api?branch=master">
<img src="https://coveralls.io/repos/github/jdepoix/youtube-transcript-api/badge.svg?branch=master" alt="Coverage Status">
</a>
<a href="http://opensource.org/licenses/MIT">
<img src="http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat" alt="MIT license">
</a>
<a href="https://pypi.org/project/youtube-transcript-api/">
<img src="https://img.shields.io/pypi/v/youtube-transcript-api.svg" alt="Current Version">
</a>
<a href="https://pypi.org/project/youtube-transcript-api/">
<img src="https://img.shields.io/pypi/pyversions/youtube-transcript-api.svg" alt="Supported Python Versions">
</a>
</p>
<p align="center">
<b>This is a python API which allows you to retrieve the transcript/subtitles for a given YouTube video. It also works for automatically generated subtitles, supports translating subtitles and it does not require a headless browser, like other selenium based solutions do!</b>
</p>
<p align="center">
Maintenance of this project is made possible by all the <a href="https://github.com/jdepoix/youtube-transcript-api/graphs/contributors">contributors</a> and <a href="https://github.com/sponsors/jdepoix">sponsors</a>. If you'd like to sponsor this project and have your avatar or company logo appear below <a href="https://github.com/sponsors/jdepoix">click here</a>. 💖
</p>
<p align="center">
<a href="https://www.searchapi.io">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://www.searchapi.io/press/v1/svg/searchapi_logo_white_h.svg">
<source media="(prefers-color-scheme: light)" srcset="https://www.searchapi.io/press/v1/svg/searchapi_logo_black_h.svg">
<img alt="SearchAPI" src="https://www.searchapi.io/press/v1/svg/searchapi_logo_black_h.svg" height="40px" style="vertical-align: middle;">
</picture>
</a>
<a href="https://supadata.ai">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://supadata.ai/logo-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="https://supadata.ai/logo-light.svg">
<img alt="supadata" src="https://supadata.ai/logo-light.svg" height="40px">
</picture>
</a>
<a href="https://www.dumplingai.com">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://www.dumplingai.com/logos/logo-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="https://www.dumplingai.com/logos/logo-light.svg">
<img alt="Dumpling AI" src="https://www.dumplingai.com/logos/logo-light.svg" height="40px" style="vertical-align: middle;">
</picture>
</a>
</p>
## Install
It is recommended to [install this module by using pip](https://pypi.org/project/youtube-transcript-api/):
```
pip install youtube-transcript-api
```
You can either integrate this module [into an existing application](#api) or just use it via a [CLI](#cli).
## API
The easiest way to get a transcript for a given video is to execute:
```python
from youtube_transcript_api import YouTubeTranscriptApi
ytt_api = YouTubeTranscriptApi()
ytt_api.fetch(video_id)
```
> **Note:** By default, this will try to access the English transcript of the video. If your video has a different
> language, or you are interested in fetching a transcript in a different language, please read the section below.
> **Note:** Pass in the video ID, NOT the video URL. For a video with the URL `https://www.youtube.com/watch?v=12345`
> the ID is `12345`.
This will return a `FetchedTranscript` object looking somewhat like this:
```python
FetchedTranscript(
snippets=[
FetchedTranscriptSnippet(
text="Hey there",
start=0.0,
duration=1.54,
),
FetchedTranscriptSnippet(
text="how are you",
start=1.54,
duration=4.16,
),
# ...
],
video_id="12345",
language="English",
language_code="en",
is_generated=False,
)
```
This object implements most interfaces of a `List`:
```python
ytt_api = YouTubeTranscriptApi()
fetched_transcript = ytt_api.fetch(video_id)
# is iterable
for snippet in fetched_transcript:
print(snippet.text)
# indexable
last_snippet = fetched_transcript[-1]
# provides a length
snippet_count = len(fetched_transcript)
```
If you prefer to handle the raw transcript data you can call `fetched_transcript.to_raw_data()`, which will return
a list of dictionaries:
```python
[
{
'text': 'Hey there',
'start': 0.0,
'duration': 1.54
},
{
'text': 'how are you',
'start': 1.54
'duration': 4.16
},
# ...
]
```
### Retrieve different languages
You can add the `languages` param if you want to make sure the transcripts are retrieved in your desired language
(it defaults to english).
```python
YouTubeTranscriptApi().fetch(video_id, languages=['de', 'en'])
```
It's a list of language codes in a descending priority. In this example it will first try to fetch the german
transcript (`'de'`) and then fetch the english transcript (`'en'`) if it fails to do so. If you want to find out
which languages are available first, [have a look at `list()`](#list-available-transcripts).
If you only want one language, you still need to format the `languages` argument as a list
```python
YouTubeTranscriptApi().fetch(video_id, languages=['de'])
```
### Preserve formatting
You can also add `preserve_formatting=True` if you'd like to keep HTML formatting elements such as `<i>` (italics)
and `<b>` (bold).
```python
YouTubeTranscriptApi().fetch(video_ids, languages=['de', 'en'], preserve_formatting=True)
```
### List available transcripts
If you want to list all transcripts which are available for a given video you can call:
```python
ytt_api = YouTubeTranscriptApi()
transcript_list = ytt_api.list(video_id)
```
This will return a `TranscriptList` object which is iterable and provides methods to filter the list of transcripts for
specific languages and types, like:
```python
transcript = transcript_list.find_transcript(['de', 'en'])
```
By default this module always chooses manually created transcripts over automatically created ones, if a transcript in
the requested language is available both manually created and generated. The `TranscriptList` allows you to bypass this
default behaviour by searching for specific transcript types:
```python
# filter for manually created transcripts
transcript = transcript_list.find_manually_created_transcript(['de', 'en'])
# or automatically generated ones
transcript = transcript_list.find_generated_transcript(['de', 'en'])
```
The methods `find_generated_transcript`, `find_manually_created_transcript`, `find_transcript` return `Transcript`
objects. They contain metadata regarding the transcript:
```python
print(
transcript.video_id,
transcript.language,
transcript.language_code,
# whether it has been manually created or generated by YouTube
transcript.is_generated,
# whether this transcript can be translated or not
transcript.is_translatable,
# a list of languages the transcript can be translated to
transcript.translation_languages,
)
```
and provide the method, which allows you to fetch the actual transcript data:
```python
transcript.fetch()
```
This returns a `FetchedTranscript` object, just like `YouTubeTranscriptApi().fetch()` does.
### Translate transcript
YouTube has a feature which allows you to automatically translate subtitles. This module also makes it possible to
access this feature. To do so `Transcript` objects provide a `translate()` method, which returns a new translated
`Transcript` object:
```python
transcript = transcript_list.find_transcript(['en'])
translated_transcript = transcript.translate('de')
print(translated_transcript.fetch())
```
### By example
```python
from youtube_transcript_api import YouTubeTranscriptApi
ytt_api = YouTubeTranscriptApi()
# retrieve the available transcripts
transcript_list = ytt_api.list('video_id')
# iterate over all available transcripts
for transcript in transcript_list:
# the Transcript object provides metadata properties
print(
transcript.video_id,
transcript.language,
transcript.language_code,
# whether it has been manually created or generated by YouTube
transcript.is_generated,
# whether this transcript can be translated or not
transcript.is_translatable,
# a list of languages the transcript can be translated to
transcript.translation_languages,
)
# fetch the actual transcript data
print(transcript.fetch())
# translating the transcript will return another transcript object
print(transcript.translate('en').fetch())
# you can also directly filter for the language you are looking for, using the transcript list
transcript = transcript_list.find_transcript(['de', 'en'])
# or just filter for manually created transcripts
transcript = transcript_list.find_manually_created_transcript(['de', 'en'])
# or automatically generated ones
transcript = transcript_list.find_generated_transcript(['de', 'en'])
```
## Working around IP bans (`RequestBlocked` or `IpBlocked` exception)
Unfortunately, YouTube has started blocking most IPs that are known to belong to cloud providers (like AWS, Google Cloud
Platform, Azure, etc.), which means you will most likely run into `RequestBlocked` or `IpBlocked` exceptions when
deploying your code to any cloud solutions. Same can happen to the IP of your self-hosted solution, if you are doing
too many requests. You can work around these IP bans using proxies. However, since YouTube will ban static proxies
after extended use, going for rotating residential proxies provide is the most reliable option.
There are different providers that offer rotating residential proxies, but after testing different
offerings I have found [Webshare](https://www.webshare.io/?referral_code=w0xno53eb50g) to be the most reliable and have
therefore integrated it into this module, to make setting it up as easy as possible.
### Using [Webshare](https://www.webshare.io/?referral_code=w0xno53eb50g)
Once you have created a [Webshare account](https://www.webshare.io/?referral_code=w0xno53eb50g) and purchased a
"Residential" proxy package that suits your workload (make sure NOT to purchase "Proxy Server" or
"Static Residential"!), open the
[Webshare Proxy Settings](https://dashboard.webshare.io/proxy/settings?referral_code=w0xno53eb50g) to retrieve
your "Proxy Username" and "Proxy Password". Using this information you can initialize the `YouTubeTranscriptApi` as
follows:
```python
from youtube_transcript_api import YouTubeTranscriptApi
from youtube_transcript_api.proxies import WebshareProxyConfig
ytt_api = YouTubeTranscriptApi(
proxy_config=WebshareProxyConfig(
proxy_username="<proxy-username>",
proxy_password="<proxy-password>",
)
)
# all requests done by ytt_api will now be proxied through Webshare
ytt_api.fetch(video_id)
```
Using the `WebshareProxyConfig` will default to using rotating residential proxies and requires no further
configuration.
Note that [referral links are used here](https://www.webshare.io/?referral_code=w0xno53eb50g) and any purchases
made through these links will support this Open Source project, which is very much appreciated! 💖😊🙏💖
However, you are of course free to integrate your own proxy solution using the `GenericProxyConfig` class, if you
prefer using another provider or want to implement your own solution, as covered by the following section.
### Using other Proxy solutions
Alternatively to using [Webshare](#using-webshare), you can set up any generic HTTP/HTTPS/SOCKS proxy using the
`GenericProxyConfig` class:
```python
from youtube_transcript_api import YouTubeTranscriptApi
from youtube_transcript_api.proxies import GenericProxyConfig
ytt_api = YouTubeTranscriptApi(
proxy_config=GenericProxyConfig(
http_url="http://user:pass@my-custom-proxy.org:port",
https_url="https://user:pass@my-custom-proxy.org:port",
)
)
# all requests done by ytt_api will now be proxied using the defined proxy URLs
ytt_api.fetch(video_id)
```
Be aware that using a proxy doesn't guarantee that you won't be blocked, as YouTube can always block the IP of your
proxy! Therefore, you should always choose a solution that rotates through a pool of proxy addresses, if you want to
maximize reliability.
## Overwriting request defaults
When initializing a `YouTubeTranscriptApi` object, it will create a `requests.Session` which will be used for all
HTTP(S) request. This allows for caching cookies when retrieving multiple requests. However, you can optionally pass a
`requests.Session` object into its constructor, if you manually want to share cookies between different instances of
`YouTubeTranscriptApi`, overwrite defaults, set custom headers, specify SSL certificates, etc.
```python
from requests import Session
http_client = Session()
# set custom header
http_client.headers.update({"Accept-Encoding": "gzip, deflate"})
# set path to CA_BUNDLE file
http_client.verify = "/path/to/certfile"
ytt_api = YouTubeTranscriptApi(http_client=http_client)
ytt_api.fetch(video_id)
# share same Session between two instances of YouTubeTranscriptApi
ytt_api_2 = YouTubeTranscriptApi(http_client=http_client)
# now shares cookies with ytt_api
ytt_api_2.fetch(video_id)
```
## Cookie Authentication
Some videos are age restricted, so this module won't be able to access those videos without some sort of
authentication. Unfortunately, some recent changes to the YouTube API have broken the current implementation of cookie
based authentication, so this feature is currently not available.
## Using Formatters
Formatters are meant to be an additional layer of processing of the transcript you pass it. The goal is to convert a
`FetchedTranscript` object into a consistent string of a given "format". Such as a basic text (`.txt`) or even formats
that have a defined specification such as JSON (`.json`), WebVTT (`.vtt`), SRT (`.srt`), Comma-separated format
(`.csv`), etc...
The `formatters` submodule provides a few basic formatters, which can be used as is, or extended to your needs:
- JSONFormatter
- PrettyPrintFormatter
- TextFormatter
- WebVTTFormatter
- SRTFormatter
Here is how to import from the `formatters` module.
```python
# the base class to inherit from when creating your own formatter.
from youtube_transcript_api.formatters import Formatter
# some provided subclasses, each outputs a different string format.
from youtube_transcript_api.formatters import JSONFormatter
from youtube_transcript_api.formatters import TextFormatter
from youtube_transcript_api.formatters import WebVTTFormatter
from youtube_transcript_api.formatters import SRTFormatter
```
### Formatter Example
Let's say we wanted to retrieve a transcript and store it to a JSON file. That would look something like this:
```python
# your_custom_script.py
from youtube_transcript_api import YouTubeTranscriptApi
from youtube_transcript_api.formatters import JSONFormatter
ytt_api = YouTubeTranscriptApi()
transcript = ytt_api.fetch(video_id)
formatter = JSONFormatter()
# .format_transcript(transcript) turns the transcript into a JSON string.
json_formatted = formatter.format_transcript(transcript)
# Now we can write it out to a file.
with open('your_filename.json', 'w', encoding='utf-8') as json_file:
json_file.write(json_formatted)
# Now should have a new JSON file that you can easily read back into Python.
```
**Passing extra keyword arguments**
Since JSONFormatter leverages `json.dumps()` you can also forward keyword arguments into
`.format_transcript(transcript)` such as making your file output prettier by forwarding the `indent=2` keyword argument.
```python
json_formatted = JSONFormatter().format_transcript(transcript, indent=2)
```
### Custom Formatter Example
You can implement your own formatter class. Just inherit from the `Formatter` base class and ensure you implement the
`format_transcript(self, transcript: FetchedTranscript, **kwargs) -> str` and
`format_transcripts(self, transcripts: List[FetchedTranscript], **kwargs) -> str` methods which should ultimately
return a string when called on your formatter instance.
```python
class MyCustomFormatter(Formatter):
def format_transcript(self, transcript: FetchedTranscript, **kwargs) -> str:
# Do your custom work in here, but return a string.
return 'your processed output data as a string.'
def format_transcripts(self, transcripts: List[FetchedTranscript], **kwargs) -> str:
# Do your custom work in here to format a list of transcripts, but return a string.
return 'your processed output data as a string.'
```
## CLI
Execute the CLI script using the video ids as parameters and the results will be printed out to the command line:
```
youtube_transcript_api <first_video_id> <second_video_id> ...
```
The CLI also gives you the option to provide a list of preferred languages:
```
youtube_transcript_api <first_video_id> <second_video_id> ... --languages de en
```
You can also specify if you want to exclude automatically generated or manually created subtitles:
```
youtube_transcript_api <first_video_id> <second_video_id> ... --languages de en --exclude-generated
youtube_transcript_api <first_video_id> <second_video_id> ... --languages de en --exclude-manually-created
```
If you would prefer to write it into a file or pipe it into another application, you can also output the results as
json using the following line:
```
youtube_transcript_api <first_video_id> <second_video_id> ... --languages de en --format json > transcripts.json
```
Translating transcripts using the CLI is also possible:
```
youtube_transcript_api <first_video_id> <second_video_id> ... --languages en --translate de
```
If you are not sure which languages are available for a given video you can call, to list all available transcripts:
```
youtube_transcript_api --list-transcripts <first_video_id>
```
If a video's ID starts with a hyphen you'll have to mask the hyphen using `\` to prevent the CLI from mistaking it for
a argument name. For example to get the transcript for the video with the ID `-abc123` run:
```
youtube_transcript_api "\-abc123"
```
### Working around IP bans using the CLI
If you are running into `ReqestBlocked` or `IpBlocked` errors, because YouTube blocks your IP, you can work around this
using residential proxies as explained in
[Working around IP bans](#working-around-ip-bans-requestblocked-or-ipblocked-exception). To use
[Webshare "Residential" proxies](https://www.webshare.io/?referral_code=w0xno53eb50g) through the CLI, you will have to
create a [Webshare account](https://www.webshare.io/?referral_code=w0xno53eb50g) and purchase a "Residential" proxy
package that suits your workload (make sure NOT to purchase "Proxy Server" or "Static Residential"!). Then you can use
the "Proxy Username" and "Proxy Password" which you can find in your
[Webshare Proxy Settings](https://dashboard.webshare.io/proxy/settings?referral_code=w0xno53eb50g), to run the following command:
```
youtube_transcript_api <first_video_id> <second_video_id> --webshare-proxy-username "username" --webshare-proxy-password "password"
```
If you prefer to use another proxy solution, you can set up a generic HTTP/HTTPS proxy using the following command:
```
youtube_transcript_api <first_video_id> <second_video_id> --http-proxy http://user:pass@domain:port --https-proxy https://user:pass@domain:port
```
### Cookie Authentication using the CLI
To authenticate using cookies through the CLI as explained in [Cookie Authentication](#cookie-authentication) run:
```
youtube_transcript_api <first_video_id> <second_video_id> --cookies /path/to/your/cookies.txt
```
## Warning
This code uses an undocumented part of the YouTube API, which is called by the YouTube web-client. So there is no
guarantee that it won't stop working tomorrow, if they change how things work. I will however do my best to make things
working again as soon as possible if that happens. So if it stops working, let me know!
## Contributing
To setup the project locally run the following (requires [poetry](https://python-poetry.org/docs/) to be installed):
```shell
poetry install --with test,dev
```
There's [poe](https://github.com/nat-n/poethepoet?tab=readme-ov-file#quick-start) tasks to run tests, coverage, the
linter and formatter (you'll need to pass all of those for the build to pass):
```shell
poe test
poe coverage
poe format
poe lint
```
If you just want to make sure that your code passes all the necessary checks to get a green build, you can simply run:
```shell
poe precommit
```
## Donations
If this project makes you happy by reducing your development time, you can make me happy by treating me to a cup of
coffee, or become a [Sponsor of this project](https://github.com/sponsors/jdepoix) :)
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BAENLEW8VUJ6G&source=url)
Raw data
{
"_id": null,
"home_page": null,
"name": "ytranscripting",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.8",
"maintainer_email": null,
"keywords": "cli, subtitle, subtitles, transcript, transcripts, youtube, youtube-api, youtube-subtitles, youtube-transcripts",
"author": "Jonas Depoix",
"author_email": "jonas.depoix@web.de",
"download_url": "https://files.pythonhosted.org/packages/c8/b0/e8da72bde8271f56b4f0879a421ec298fe9f3ac6e7b31ee366e52f9a7ca0/ytranscripting-1.1.1.1.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n \u2728 YouTube Transcript API \u2728\n</h1>\n\n<p align=\"center\">\n <a href=\"https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BAENLEW8VUJ6G&source=url\">\n <img src=\"https://img.shields.io/badge/Donate-PayPal-green.svg\" alt=\"Donate\">\n </a>\n <a href=\"https://github.com/jdepoix/youtube-transcript-api/actions\">\n <img src=\"https://github.com/jdepoix/youtube-transcript-api/actions/workflows/ci.yml/badge.svg?branch=master\" alt=\"Build Status\">\n </a>\n <a href=\"https://coveralls.io/github/jdepoix/youtube-transcript-api?branch=master\">\n <img src=\"https://coveralls.io/repos/github/jdepoix/youtube-transcript-api/badge.svg?branch=master\" alt=\"Coverage Status\">\n </a>\n <a href=\"http://opensource.org/licenses/MIT\">\n <img src=\"http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat\" alt=\"MIT license\">\n </a>\n <a href=\"https://pypi.org/project/youtube-transcript-api/\">\n <img src=\"https://img.shields.io/pypi/v/youtube-transcript-api.svg\" alt=\"Current Version\">\n </a>\n <a href=\"https://pypi.org/project/youtube-transcript-api/\">\n <img src=\"https://img.shields.io/pypi/pyversions/youtube-transcript-api.svg\" alt=\"Supported Python Versions\">\n </a>\n</p>\n\n<p align=\"center\">\n <b>This is a python API which allows you to retrieve the transcript/subtitles for a given YouTube video. It also works for automatically generated subtitles, supports translating subtitles and it does not require a headless browser, like other selenium based solutions do!</b>\n</p>\n<p align=\"center\">\n Maintenance of this project is made possible by all the <a href=\"https://github.com/jdepoix/youtube-transcript-api/graphs/contributors\">contributors</a> and <a href=\"https://github.com/sponsors/jdepoix\">sponsors</a>. If you'd like to sponsor this project and have your avatar or company logo appear below <a href=\"https://github.com/sponsors/jdepoix\">click here</a>. \ud83d\udc96\n</p>\n\n<p align=\"center\">\n <a href=\"https://www.searchapi.io\">\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://www.searchapi.io/press/v1/svg/searchapi_logo_white_h.svg\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://www.searchapi.io/press/v1/svg/searchapi_logo_black_h.svg\">\n <img alt=\"SearchAPI\" src=\"https://www.searchapi.io/press/v1/svg/searchapi_logo_black_h.svg\" height=\"40px\" style=\"vertical-align: middle;\">\n </picture>\n </a>\n \n <a href=\"https://supadata.ai\">\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://supadata.ai/logo-dark.svg\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://supadata.ai/logo-light.svg\">\n <img alt=\"supadata\" src=\"https://supadata.ai/logo-light.svg\" height=\"40px\">\n </picture>\n </a>\n \n <a href=\"https://www.dumplingai.com\">\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://www.dumplingai.com/logos/logo-dark.svg\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://www.dumplingai.com/logos/logo-light.svg\">\n <img alt=\"Dumpling AI\" src=\"https://www.dumplingai.com/logos/logo-light.svg\" height=\"40px\" style=\"vertical-align: middle;\">\n </picture>\n </a>\n</p>\n\n## Install\n\nIt is recommended to [install this module by using pip](https://pypi.org/project/youtube-transcript-api/):\n\n```\npip install youtube-transcript-api\n```\n\nYou can either integrate this module [into an existing application](#api) or just use it via a [CLI](#cli).\n\n## API\n\nThe easiest way to get a transcript for a given video is to execute:\n\n```python\nfrom youtube_transcript_api import YouTubeTranscriptApi\n\nytt_api = YouTubeTranscriptApi()\nytt_api.fetch(video_id)\n```\n\n> **Note:** By default, this will try to access the English transcript of the video. If your video has a different \n> language, or you are interested in fetching a transcript in a different language, please read the section below.\n\n> **Note:** Pass in the video ID, NOT the video URL. For a video with the URL `https://www.youtube.com/watch?v=12345` \n> the ID is `12345`.\n\nThis will return a `FetchedTranscript` object looking somewhat like this:\n\n```python\nFetchedTranscript(\n snippets=[\n FetchedTranscriptSnippet(\n text=\"Hey there\",\n start=0.0,\n duration=1.54,\n ),\n FetchedTranscriptSnippet(\n text=\"how are you\",\n start=1.54,\n duration=4.16,\n ),\n # ...\n ],\n video_id=\"12345\",\n language=\"English\",\n language_code=\"en\",\n is_generated=False,\n)\n```\n\nThis object implements most interfaces of a `List`:\n\n```python\nytt_api = YouTubeTranscriptApi()\nfetched_transcript = ytt_api.fetch(video_id)\n\n# is iterable\nfor snippet in fetched_transcript:\n print(snippet.text)\n\n# indexable\nlast_snippet = fetched_transcript[-1]\n\n# provides a length\nsnippet_count = len(fetched_transcript)\n```\n\nIf you prefer to handle the raw transcript data you can call `fetched_transcript.to_raw_data()`, which will return \na list of dictionaries:\n\n```python\n[\n {\n 'text': 'Hey there',\n 'start': 0.0,\n 'duration': 1.54\n },\n {\n 'text': 'how are you',\n 'start': 1.54\n 'duration': 4.16\n },\n # ...\n]\n```\n### Retrieve different languages\n\nYou can add the `languages` param if you want to make sure the transcripts are retrieved in your desired language \n(it defaults to english).\n\n```python\nYouTubeTranscriptApi().fetch(video_id, languages=['de', 'en'])\n```\n\nIt's a list of language codes in a descending priority. In this example it will first try to fetch the german \ntranscript (`'de'`) and then fetch the english transcript (`'en'`) if it fails to do so. If you want to find out \nwhich languages are available first, [have a look at `list()`](#list-available-transcripts).\n\nIf you only want one language, you still need to format the `languages` argument as a list\n\n```python\nYouTubeTranscriptApi().fetch(video_id, languages=['de'])\n```\n\n### Preserve formatting\n\nYou can also add `preserve_formatting=True` if you'd like to keep HTML formatting elements such as `<i>` (italics) \nand `<b>` (bold).\n\n```python\nYouTubeTranscriptApi().fetch(video_ids, languages=['de', 'en'], preserve_formatting=True)\n```\n\n### List available transcripts\n\nIf you want to list all transcripts which are available for a given video you can call:\n\n```python\nytt_api = YouTubeTranscriptApi()\ntranscript_list = ytt_api.list(video_id)\n```\n\nThis will return a `TranscriptList` object which is iterable and provides methods to filter the list of transcripts for \nspecific languages and types, like:\n\n```python\ntranscript = transcript_list.find_transcript(['de', 'en'])\n```\n\nBy default this module always chooses manually created transcripts over automatically created ones, if a transcript in \nthe requested language is available both manually created and generated. The `TranscriptList` allows you to bypass this \ndefault behaviour by searching for specific transcript types:\n\n```python\n# filter for manually created transcripts\ntranscript = transcript_list.find_manually_created_transcript(['de', 'en'])\n\n# or automatically generated ones\ntranscript = transcript_list.find_generated_transcript(['de', 'en'])\n```\n\nThe methods `find_generated_transcript`, `find_manually_created_transcript`, `find_transcript` return `Transcript` \nobjects. They contain metadata regarding the transcript:\n\n```python\nprint(\n transcript.video_id,\n transcript.language,\n transcript.language_code,\n # whether it has been manually created or generated by YouTube\n transcript.is_generated,\n # whether this transcript can be translated or not\n transcript.is_translatable,\n # a list of languages the transcript can be translated to\n transcript.translation_languages,\n)\n```\n\nand provide the method, which allows you to fetch the actual transcript data:\n\n```python\ntranscript.fetch()\n```\n\nThis returns a `FetchedTranscript` object, just like `YouTubeTranscriptApi().fetch()` does.\n\n### Translate transcript\n\nYouTube has a feature which allows you to automatically translate subtitles. This module also makes it possible to \naccess this feature. To do so `Transcript` objects provide a `translate()` method, which returns a new translated \n`Transcript` object:\n\n```python\ntranscript = transcript_list.find_transcript(['en'])\ntranslated_transcript = transcript.translate('de')\nprint(translated_transcript.fetch())\n```\n\n### By example\n```python\nfrom youtube_transcript_api import YouTubeTranscriptApi\n\nytt_api = YouTubeTranscriptApi()\n\n# retrieve the available transcripts\ntranscript_list = ytt_api.list('video_id')\n\n# iterate over all available transcripts\nfor transcript in transcript_list:\n\n # the Transcript object provides metadata properties\n print(\n transcript.video_id,\n transcript.language,\n transcript.language_code,\n # whether it has been manually created or generated by YouTube\n transcript.is_generated,\n # whether this transcript can be translated or not\n transcript.is_translatable,\n # a list of languages the transcript can be translated to\n transcript.translation_languages,\n )\n\n # fetch the actual transcript data\n print(transcript.fetch())\n\n # translating the transcript will return another transcript object\n print(transcript.translate('en').fetch())\n\n# you can also directly filter for the language you are looking for, using the transcript list\ntranscript = transcript_list.find_transcript(['de', 'en']) \n\n# or just filter for manually created transcripts \ntranscript = transcript_list.find_manually_created_transcript(['de', 'en']) \n\n# or automatically generated ones \ntranscript = transcript_list.find_generated_transcript(['de', 'en'])\n```\n\n## Working around IP bans (`RequestBlocked` or `IpBlocked` exception)\n\nUnfortunately, YouTube has started blocking most IPs that are known to belong to cloud providers (like AWS, Google Cloud \nPlatform, Azure, etc.), which means you will most likely run into `RequestBlocked` or `IpBlocked` exceptions when \ndeploying your code to any cloud solutions. Same can happen to the IP of your self-hosted solution, if you are doing \ntoo many requests. You can work around these IP bans using proxies. However, since YouTube will ban static proxies \nafter extended use, going for rotating residential proxies provide is the most reliable option.\n\nThere are different providers that offer rotating residential proxies, but after testing different \nofferings I have found [Webshare](https://www.webshare.io/?referral_code=w0xno53eb50g) to be the most reliable and have \ntherefore integrated it into this module, to make setting it up as easy as possible.\n\n### Using [Webshare](https://www.webshare.io/?referral_code=w0xno53eb50g)\n\nOnce you have created a [Webshare account](https://www.webshare.io/?referral_code=w0xno53eb50g) and purchased a \n\"Residential\" proxy package that suits your workload (make sure NOT to purchase \"Proxy Server\" or \n\"Static Residential\"!), open the \n[Webshare Proxy Settings](https://dashboard.webshare.io/proxy/settings?referral_code=w0xno53eb50g) to retrieve \nyour \"Proxy Username\" and \"Proxy Password\". Using this information you can initialize the `YouTubeTranscriptApi` as \nfollows:\n\n```python\nfrom youtube_transcript_api import YouTubeTranscriptApi\nfrom youtube_transcript_api.proxies import WebshareProxyConfig\n\nytt_api = YouTubeTranscriptApi(\n proxy_config=WebshareProxyConfig(\n proxy_username=\"<proxy-username>\",\n proxy_password=\"<proxy-password>\",\n )\n)\n\n# all requests done by ytt_api will now be proxied through Webshare\nytt_api.fetch(video_id)\n```\n\nUsing the `WebshareProxyConfig` will default to using rotating residential proxies and requires no further \nconfiguration.\n\nNote that [referral links are used here](https://www.webshare.io/?referral_code=w0xno53eb50g) and any purchases \nmade through these links will support this Open Source project, which is very much appreciated! \ud83d\udc96\ud83d\ude0a\ud83d\ude4f\ud83d\udc96\n\nHowever, you are of course free to integrate your own proxy solution using the `GenericProxyConfig` class, if you \nprefer using another provider or want to implement your own solution, as covered by the following section.\n\n### Using other Proxy solutions\n\nAlternatively to using [Webshare](#using-webshare), you can set up any generic HTTP/HTTPS/SOCKS proxy using the \n`GenericProxyConfig` class:\n\n```python\nfrom youtube_transcript_api import YouTubeTranscriptApi\nfrom youtube_transcript_api.proxies import GenericProxyConfig\n\nytt_api = YouTubeTranscriptApi(\n proxy_config=GenericProxyConfig(\n http_url=\"http://user:pass@my-custom-proxy.org:port\",\n https_url=\"https://user:pass@my-custom-proxy.org:port\",\n )\n)\n\n# all requests done by ytt_api will now be proxied using the defined proxy URLs\nytt_api.fetch(video_id)\n```\n\nBe aware that using a proxy doesn't guarantee that you won't be blocked, as YouTube can always block the IP of your \nproxy! Therefore, you should always choose a solution that rotates through a pool of proxy addresses, if you want to\nmaximize reliability.\n\n## Overwriting request defaults\n\nWhen initializing a `YouTubeTranscriptApi` object, it will create a `requests.Session` which will be used for all\nHTTP(S) request. This allows for caching cookies when retrieving multiple requests. However, you can optionally pass a\n`requests.Session` object into its constructor, if you manually want to share cookies between different instances of\n`YouTubeTranscriptApi`, overwrite defaults, set custom headers, specify SSL certificates, etc.\n\n```python\nfrom requests import Session\n\nhttp_client = Session()\n\n# set custom header\nhttp_client.headers.update({\"Accept-Encoding\": \"gzip, deflate\"})\n\n# set path to CA_BUNDLE file\nhttp_client.verify = \"/path/to/certfile\"\n\nytt_api = YouTubeTranscriptApi(http_client=http_client)\nytt_api.fetch(video_id)\n\n# share same Session between two instances of YouTubeTranscriptApi\nytt_api_2 = YouTubeTranscriptApi(http_client=http_client)\n# now shares cookies with ytt_api\nytt_api_2.fetch(video_id)\n```\n\n## Cookie Authentication\n\nSome videos are age restricted, so this module won't be able to access those videos without some sort of\nauthentication. Unfortunately, some recent changes to the YouTube API have broken the current implementation of cookie \nbased authentication, so this feature is currently not available.\n\n## Using Formatters\nFormatters are meant to be an additional layer of processing of the transcript you pass it. The goal is to convert a\n`FetchedTranscript` object into a consistent string of a given \"format\". Such as a basic text (`.txt`) or even formats \nthat have a defined specification such as JSON (`.json`), WebVTT (`.vtt`), SRT (`.srt`), Comma-separated format \n(`.csv`), etc...\n\nThe `formatters` submodule provides a few basic formatters, which can be used as is, or extended to your needs:\n\n- JSONFormatter\n- PrettyPrintFormatter\n- TextFormatter\n- WebVTTFormatter\n- SRTFormatter\n\nHere is how to import from the `formatters` module.\n\n```python\n# the base class to inherit from when creating your own formatter.\nfrom youtube_transcript_api.formatters import Formatter\n\n# some provided subclasses, each outputs a different string format.\nfrom youtube_transcript_api.formatters import JSONFormatter\nfrom youtube_transcript_api.formatters import TextFormatter\nfrom youtube_transcript_api.formatters import WebVTTFormatter\nfrom youtube_transcript_api.formatters import SRTFormatter\n```\n\n### Formatter Example\nLet's say we wanted to retrieve a transcript and store it to a JSON file. That would look something like this:\n\n```python\n# your_custom_script.py\n\nfrom youtube_transcript_api import YouTubeTranscriptApi\nfrom youtube_transcript_api.formatters import JSONFormatter\n\nytt_api = YouTubeTranscriptApi()\ntranscript = ytt_api.fetch(video_id)\n\nformatter = JSONFormatter()\n\n# .format_transcript(transcript) turns the transcript into a JSON string.\njson_formatted = formatter.format_transcript(transcript)\n\n# Now we can write it out to a file.\nwith open('your_filename.json', 'w', encoding='utf-8') as json_file:\n json_file.write(json_formatted)\n\n# Now should have a new JSON file that you can easily read back into Python.\n```\n\n**Passing extra keyword arguments**\n\nSince JSONFormatter leverages `json.dumps()` you can also forward keyword arguments into \n`.format_transcript(transcript)` such as making your file output prettier by forwarding the `indent=2` keyword argument.\n\n```python\njson_formatted = JSONFormatter().format_transcript(transcript, indent=2)\n```\n\n### Custom Formatter Example\nYou can implement your own formatter class. Just inherit from the `Formatter` base class and ensure you implement the \n`format_transcript(self, transcript: FetchedTranscript, **kwargs) -> str` and \n`format_transcripts(self, transcripts: List[FetchedTranscript], **kwargs) -> str` methods which should ultimately \nreturn a string when called on your formatter instance.\n\n```python\nclass MyCustomFormatter(Formatter):\n def format_transcript(self, transcript: FetchedTranscript, **kwargs) -> str:\n # Do your custom work in here, but return a string.\n return 'your processed output data as a string.'\n\n def format_transcripts(self, transcripts: List[FetchedTranscript], **kwargs) -> str:\n # Do your custom work in here to format a list of transcripts, but return a string.\n return 'your processed output data as a string.'\n```\n\n## CLI\n\nExecute the CLI script using the video ids as parameters and the results will be printed out to the command line: \n\n``` \nyoutube_transcript_api <first_video_id> <second_video_id> ... \n``` \n\nThe CLI also gives you the option to provide a list of preferred languages: \n\n``` \nyoutube_transcript_api <first_video_id> <second_video_id> ... --languages de en \n```\n\nYou can also specify if you want to exclude automatically generated or manually created subtitles:\n\n``` \nyoutube_transcript_api <first_video_id> <second_video_id> ... --languages de en --exclude-generated\nyoutube_transcript_api <first_video_id> <second_video_id> ... --languages de en --exclude-manually-created\n```\n\nIf you would prefer to write it into a file or pipe it into another application, you can also output the results as \njson using the following line: \n\n``` \nyoutube_transcript_api <first_video_id> <second_video_id> ... --languages de en --format json > transcripts.json\n``` \n\nTranslating transcripts using the CLI is also possible:\n\n``` \nyoutube_transcript_api <first_video_id> <second_video_id> ... --languages en --translate de\n``` \n\nIf you are not sure which languages are available for a given video you can call, to list all available transcripts:\n\n``` \nyoutube_transcript_api --list-transcripts <first_video_id>\n```\n\nIf a video's ID starts with a hyphen you'll have to mask the hyphen using `\\` to prevent the CLI from mistaking it for \na argument name. For example to get the transcript for the video with the ID `-abc123` run:\n\n```\nyoutube_transcript_api \"\\-abc123\"\n```\n\n### Working around IP bans using the CLI\n\nIf you are running into `ReqestBlocked` or `IpBlocked` errors, because YouTube blocks your IP, you can work around this \nusing residential proxies as explained in \n[Working around IP bans](#working-around-ip-bans-requestblocked-or-ipblocked-exception). To use\n[Webshare \"Residential\" proxies](https://www.webshare.io/?referral_code=w0xno53eb50g) through the CLI, you will have to \ncreate a [Webshare account](https://www.webshare.io/?referral_code=w0xno53eb50g) and purchase a \"Residential\" proxy \npackage that suits your workload (make sure NOT to purchase \"Proxy Server\" or \"Static Residential\"!). Then you can use \nthe \"Proxy Username\" and \"Proxy Password\" which you can find in your \n[Webshare Proxy Settings](https://dashboard.webshare.io/proxy/settings?referral_code=w0xno53eb50g), to run the following command:\n\n```\nyoutube_transcript_api <first_video_id> <second_video_id> --webshare-proxy-username \"username\" --webshare-proxy-password \"password\"\n```\n\nIf you prefer to use another proxy solution, you can set up a generic HTTP/HTTPS proxy using the following command:\n\n```\nyoutube_transcript_api <first_video_id> <second_video_id> --http-proxy http://user:pass@domain:port --https-proxy https://user:pass@domain:port\n```\n\n### Cookie Authentication using the CLI\n\nTo authenticate using cookies through the CLI as explained in [Cookie Authentication](#cookie-authentication) run:\n\n```\nyoutube_transcript_api <first_video_id> <second_video_id> --cookies /path/to/your/cookies.txt\n```\n\n## Warning \n\nThis code uses an undocumented part of the YouTube API, which is called by the YouTube web-client. So there is no \nguarantee that it won't stop working tomorrow, if they change how things work. I will however do my best to make things \nworking again as soon as possible if that happens. So if it stops working, let me know! \n\n## Contributing\n\nTo setup the project locally run the following (requires [poetry](https://python-poetry.org/docs/) to be installed):\n```shell\npoetry install --with test,dev\n```\n\nThere's [poe](https://github.com/nat-n/poethepoet?tab=readme-ov-file#quick-start) tasks to run tests, coverage, the \nlinter and formatter (you'll need to pass all of those for the build to pass):\n```shell\npoe test\npoe coverage\npoe format\npoe lint\n```\n\nIf you just want to make sure that your code passes all the necessary checks to get a green build, you can simply run:\n```shell\npoe precommit\n```\n\n## Donations\n\nIf this project makes you happy by reducing your development time, you can make me happy by treating me to a cup of \ncoffee, or become a [Sponsor of this project](https://github.com/sponsors/jdepoix) :) \n\n[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BAENLEW8VUJ6G&source=url)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "ytranscripting",
"version": "1.1.1.1",
"project_urls": {
"Homepage": "https://github.com/TheDevelopmentMachine/ytranscripting",
"Repository": "https://github.com/TheDevelopmentMachine/ytranscripting"
},
"split_keywords": [
"cli",
" subtitle",
" subtitles",
" transcript",
" transcripts",
" youtube",
" youtube-api",
" youtube-subtitles",
" youtube-transcripts"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "97cf95bb94b2a1e168d8fa010a338328ee7a65cc2389512f6df12079ebc82f74",
"md5": "0e302963c430cf1ab017a371c5388bdb",
"sha256": "5d568b2cb46484cf4de0d629ef449a894abfb78dbe0237376e0c724df9ea3a94"
},
"downloads": -1,
"filename": "ytranscripting-1.1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e302963c430cf1ab017a371c5388bdb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.8",
"size": 490931,
"upload_time": "2025-07-09T00:46:06",
"upload_time_iso_8601": "2025-07-09T00:46:06.888394Z",
"url": "https://files.pythonhosted.org/packages/97/cf/95bb94b2a1e168d8fa010a338328ee7a65cc2389512f6df12079ebc82f74/ytranscripting-1.1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c8b0e8da72bde8271f56b4f0879a421ec298fe9f3ac6e7b31ee366e52f9a7ca0",
"md5": "750e4e4623c77e9398d700892487a53d",
"sha256": "e6ddbb3643a61b91da3fca0d35c1fdf86bdf71270246233407dd055e7c5bb23d"
},
"downloads": -1,
"filename": "ytranscripting-1.1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "750e4e4623c77e9398d700892487a53d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.8",
"size": 470919,
"upload_time": "2025-07-09T00:46:08",
"upload_time_iso_8601": "2025-07-09T00:46:08.830047Z",
"url": "https://files.pythonhosted.org/packages/c8/b0/e8da72bde8271f56b4f0879a421ec298fe9f3ac6e7b31ee366e52f9a7ca0/ytranscripting-1.1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-09 00:46:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TheDevelopmentMachine",
"github_project": "ytranscripting",
"github_not_found": true,
"lcname": "ytranscripting"
}
JSON
