Skip to main content

A simple and easy-to-use YouTube API Wrapper

Project description

Simple YouTube API

A lightweight Python wrapper for extracting video metadata and transcripts from YouTube videos.

Features

  • 🎥 Extract video metadata (title, thumbnail, description)
  • 📝 Get video transcripts in multiple languages
  • ⚡ Simple and easy to use interface
  • 🔒 No API key required
  • 🌐 Support for both YouTube URL formats (youtube.com and youtu.be)

Installation

pip install simple-yt-api

Quick Start

from simple_yt_api import YouTubeAPI

# Initialize with a YouTube URL
url = "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
yt = YouTubeAPI(url)

# Get video metadata
metadata = yt.data()
print(metadata['title'])

# Get video transcript
transcript = yt.get_transcript(languages=['en'])  # Get English transcript
print(transcript)

# Get both metadata and transcript at once
data, transcript = yt.get_video_data_and_transcript(
    languages=['en', 'tr'],  # Priority languages
    as_dict=False  # Return transcript as plain text
)

API Reference

YouTubeAPI Class

YouTubeAPI(url: str)

Initialize the API with a YouTube video URL.

data() -> dict

Returns video metadata dictionary containing:

  • video_id: YouTube video ID
  • title: Video title
  • img_url: Thumbnail URL
  • short_description: Video description

get_transcript(languages: list = [], as_dict: bool = False) -> str | dict

Get video transcript in specified languages.

  • languages: List of language codes (e.g., ['en', 'tr'])
  • as_dict: If True, returns timestamp dictionary format

get_video_data_and_transcript(languages: list = [], as_dict: bool = False) -> tuple

Returns both video metadata and transcript for a YouTube video in one call without worrying about errors.

Error Handling

The library includes custom exceptions:

  • InvalidURL: Invalid YouTube URL format
  • NoVideoFound: Video not accessible or doesn't exist
  • NoTranscriptFound: No transcript available for the video

Requirements

  • requests>=2.32.3
  • beautifulsoup4>=4.13.3
  • youtube-transcript-api>=0.6.3

License

This project is licensed under the MIT License.

Links

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

simple_yt_api-1.1.1.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

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

simple_yt_api-1.1.1-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file simple_yt_api-1.1.1.tar.gz.

File metadata

  • Download URL: simple_yt_api-1.1.1.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.1

File hashes

Hashes for simple_yt_api-1.1.1.tar.gz
Algorithm Hash digest
SHA256 9b50c36630103f2dbd140e30d05a6d7f71be6ccdbe23a48de92f75baf4e35a85
MD5 73541567e83ed5a2b97307003d0c9c40
BLAKE2b-256 f7be89af505b4b5462bdb43d47254c5b08b58c3696228f548b940ea1565752cb

See more details on using hashes here.

File details

Details for the file simple_yt_api-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: simple_yt_api-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.1

File hashes

Hashes for simple_yt_api-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bcf763beb10e9ae2237f1fe727aa7ee068190c9a93943c90abf182ce1f93ad6a
MD5 1d71b8575ad4decbb0d2be04af3f9b73
BLAKE2b-256 f30bcdf211b47d72942769f06db34d29bb4b3a9e78ec5834a6cd40a48c14133b

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