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:

  • NotValidURL: 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.

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.0.2.tar.gz (4.4 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.0.2-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: simple_yt_api-1.0.2.tar.gz
  • Upload date:
  • Size: 4.4 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.0.2.tar.gz
Algorithm Hash digest
SHA256 b192c820672ea108657ef8812040136e87026c6e9063f827eb9661c290830f32
MD5 a55f7e1d9f96713e9d11604ebeb6de97
BLAKE2b-256 382dee4497926a426d01157cd59fec681792f720f031d2050d38e8650f65dbc1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: simple_yt_api-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 4.8 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.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 89ac39505188fe42a4e462866ed4ef8e5ddaf8274f64f494e6555eec0672bae5
MD5 039325bd157053e673627defbd57f738
BLAKE2b-256 7b4a0d1976d21e9d8ed593f1fa3aa227378f58096f80ee8fa68f0ab8b80cc9dd

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