Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/bobld/youtube-transcript-api-sharp

This is a C# API which allows you to get the transcript/subtitles for a given YouTube video. It also works for automatically generated subtitles and it does not require a headless browser, like other selenium based solutions do! Ported from https://github.com/jdepoix/youtube-transcript-api
https://github.com/bobld/youtube-transcript-api-sharp

captions subtitle subtitles transcript transcripts translating-transcripts youtube youtube-api youtube-caption youtube-captions youtube-subtitles youtube-transcript youtube-transcripts youtube-video

Last synced: 6 months ago
JSON representation

This is a C# API which allows you to get the transcript/subtitles for a given YouTube video. It also works for automatically generated subtitles and it does not require a headless browser, like other selenium based solutions do! Ported from https://github.com/jdepoix/youtube-transcript-api

Awesome Lists containing this project

README 

          
# About the C# version



- Ported from python [youtube-transcript-api ](https://github.com/jdepoix/youtube-transcript-api)

- Below comes from the original README and ported to C#



# From [youtube-transcript-api ](https://github.com/jdepoix/youtube-transcript-api): YouTube Transcript/Subtitle API (including automatically generated subtitles and subtitle translations)



[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BAENLEW8VUJ6G&source=url) (oringal repos donation link)

[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](http://opensource.org/licenses/MIT)



This is a C# API which allows you to get 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!



## Install



It is recommended to [install this module by using Nuget](https://www.nuget.org/):



```

nuget code todo

```



If you want to use it from source, you'll have to install the dependencies manually:



```

todo

```



You can either integrate this module [into an existing application](#api), or just use it via an [CLI](#cli).



## API



The easiest way to get a transcript for a given video is to execute:



```csharp

using YoutubeTranscriptApi;

...

using (var youTubeTranscriptApi = new YouTubeTranscriptApi())

{

    var transcriptItems = youTubeTranscriptApi.GetTranscript(video_id);

}

```



This will return a list of `TranscriptItem` looking somewhat like this:



```csharp

[

    {

        Text: "Hey there",

        Start: 7.58,

        Duration: 6.13

    },

    {

        text: "how are you",

        start: 14.08,

        duration: 7.58

    },

    ...

]

```



You can also add the `languages` param if you want to make sure the transcripts are retrieved in your desired language (it defaults to english).



```csharp

using (var youTubeTranscriptApi = new YouTubeTranscriptApi())

{

    var transcriptItems = youTubeTranscriptApi.GetTranscript(video_id, new[] { "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_transcripts()`](#list-available-transcripts)



To get transcripts for a list of video ids you can call:



```csharp

using (var youTubeTranscriptApi = new YouTubeTranscriptApi())

{

    var transcriptItems = youTubeTranscriptApi.GetTranscripts(video_ids, new[] { "de", "en" });

}

```



`languages` also is optional here.



### List available transcripts



If you want to list all transcripts which are available for a given video you can call:



```csharp

using (var youTubeTranscriptApi = new YouTubeTranscriptApi())

{

    var transcriptList = youTubeTranscriptApi.ListTranscripts(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:



```csharp

using (var youTubeTranscriptApi = new YouTubeTranscriptApi())

{

    var transcript = transcriptList.FindTranscript(new[] { "de", "en" });

}

```



By default this module always picks 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_generated_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()

```



### 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



# retrieve the available transcripts

transcript_list = YouTubeTranscriptApi.list_transcripts('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'])

```



### Using Formatters

Not ported yet



## CLI



Not ported yet



## Proxy



You can specify a https/http proxy, which will be used during the requests to YouTube:  



```python  

from youtube_transcript_api import YouTubeTranscriptApi  



YouTubeTranscriptApi.get_transcript(video_id, proxies={"http": "http://user:pass@domain:port", "https": "https://user:pass@domain:port"})  

```  



As the `proxies` dict is passed on to the `requests.get(...)` call, it follows the [format used by the requests library](http://docs.python-requests.org/en/master/user/advanced/#proxies).  



Using the CLI:



```  

youtube_transcript_api   --http-proxy http://user:pass@domain:port --https-proxy https://user:pass@domain:port  

```



## Cookies



Some videos are age restricted, so this module won't be able to access those videos without some sort of authentication. To do this, you will need to have access to the desired video in a browser. Then, you will need to download that pages cookies into a text file. You can use the Chrome extension [cookies.txt](https://chrome.google.com/webstore/detail/cookiestxt/njabckikapfpffapmjgojcnbfjonfjfg?hl=en) or the Firefox extension [cookies.txt](https://addons.mozilla.org/en-US/firefox/addon/cookies-txt/).



Once you have that, you can use it with the module to access age-restricted videos' captions like so.



```python  

from youtube_transcript_api import YouTubeTranscriptApi  



YouTubeTranscriptApi.get_transcript(video_id, cookies='/path/to/your/cookies.txt')



YouTubeTranscriptApi.get_transcripts([video_id], cookies='/path/to/your/cookies.txt')

```



Using the CLI:



```

youtube_transcript_api   --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!  



## Donation (oringal repos donation link)



If this project makes you happy by reducing your development time, you can make me happy by treating me to a cup of coffee :)  



[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BAENLEW8VUJ6G&source=url)