Subtitle API

https://github.com/xeyberigideli/subtitleapi

Admin

Subtitle API is a Node.js web service for searching, scraping, and retrieving movie and TV show...

Tokens:792

Snippets:12

Trust Score:3.9

Update:1 month ago

Show doc for...

Tokens:

Raw

### Installation commands

Source: https://github.com/xeyberigideli/subtitleapi/blob/main/README.md

Commands to clone the repository, navigate into the project directory, and install dependencies.

```bash
git clone https://github.com/yourusername/subtitle-scraper.git

cd subtitle-api

npm install
```

--------------------------------

### Subtitle API Endpoints

Source: https://github.com/xeyberigideli/subtitleapi/blob/main/README.md

API routes for searching and reading movie and TV show subtitles.

```APIDOC
### Search for Movie Subtitles

**Route:** `api/search/movie/tur/Moviename`

**Method:** GET

**Query Parameters:**

- `totalLink` (optional): Number of subtitles to scrape.
- `lang` (optional): Language code(s), comma-separated for multiple languages.

**Description:** Searches for movie subtitles based on the provided movie name and language.

---

### Read Movie SRT File

**Route:** `api/movieName/lang/totLink/num/readMovieSubtitle`

**Method:** GET

**Path Parameters:**

- `movieName`: The name of the movie.
- `lang`: Language code.
- `totLink`: Number of subtitles to scrape.
- `num`: The nth subtitle from the total links.

**Description:** Retrieves and reads the SRT file for a specific movie subtitle.

---

### Search for Show Subtitles

**Route:** `api/search/show/lang/showName`

**Method:** GET

**Query Parameters:**

- `lang` (optional): Language code(s), comma-separated for multiple languages.

**Description:** Searches for TV show subtitles based on the provided show name and language.

---

### Read Show SRT File

**Route:** `api/showName/season/episode/lang/totLink/num/readShowSubtitle`

**Method:** GET

**Path Parameters:**

- `showName`: The name of the TV show.
- `season`: Season number.
- `episode`: Episode number.
- `lang`: Language code.
- `totLink`: Number of subtitles to scrape.
- `num`: The nth subtitle from the total links.

**Description:** Retrieves and reads the SRT file for a specific TV show episode subtitle.

---

**Note:** The API is a Node.js-based web service that scrapes subtitles from OpenSubtitles.org. It provides routes for searching and reading subtitles for movies and TV shows, including unzipping RAR files to access SRT content.
```

Tokens:

Raw