/youtube-transcript-api

REST API for fetching YouTube video transcripts.

Primary LanguageTypeScriptMIT LicenseMIT

YouTube Transcript API

REST API for fetching YouTube video transcripts.

Description

This project is a REST API with Express, TypeScript and TS-REST for fetching YouTube video transcripts. It allows you to get the transcript of a YouTube video by providing the video ID.

Technologies Used

Prerequisites

  1. Install Node.js (LTS version recommended).
  2. Enable Corepack to use a stable version of Yarn:
corepack enable

Getting Started

  1. Clone the repository:
git clone git@github.com:jhordyess/youtube-transcript-api.git
  1. Open the project folder:
cd youtube-transcript-api

  1. Create a .env file in the root folder by copying the example from the .env.example file. Replace the values with your own.

  2. Install the dependencies:

yarn install
  1. Run the project:
yarn dev
  1. Now you can test the endpoints at http://localhost:3000. The API docs (Swagger UI) will be available at http://localhost:3000/docs.

To-Do

  • Add more API endpoints
  • Improve error handling

Contribution

If you would like to contribute to the project, open an issue or make a pull request on the repository.

License

© 2025> Jhordyess. Under the MIT license. See the LICENSE file for more details.

Made with 💪 by Jhordyess