Skip to content

feat(subtitles): add opensubtitles.com rest api provider #1365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
XSAM wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat(subtitles): add opensubtitles.com rest api provider #1365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9aa0abd
Add OpenSubtitles.com REST API provider
XSAM Feb 2, 2026
7576713
Update documents
XSAM Feb 5, 2026
df8bac1
Merge branch 'main' into opensubtitles-com
XSAM Mar 15, 2026
3373adf
Merge branch 'main' into opensubtitles-com
XSAM Apr 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 50 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@

Services currently supported:

| Type | Supported |
| ----------------- | --------------------------------------------------------------------------------- |
| Debrid services | Real Debrid, All Debrid |
| Content services | Plex Watchlist, Overseerr, Mdblist, Listrr, Trakt |
| Scraping services | Comet, Jackett, Torrentio, Orionoid, Mediafusion, Prowlarr, Zilean, Rarbg |
| Media servers | Plex, Jellyfin, Emby |
| Type | Supported |
| ------------------ | --------------------------------------------------------------------------------- |
| Debrid services | Real Debrid, All Debrid |
| Content services | Plex Watchlist, Overseerr, Mdblist, Listrr, Trakt |
| Scraping services | Comet, Jackett, Torrentio, Orionoid, Mediafusion, Prowlarr, Zilean, Rarbg |
| Subtitle services | OpenSubtitles.com |
| Media servers | Plex, Jellyfin, Emby |

and more to come!

Expand All @@ -44,6 +45,7 @@ We are constantly adding features and improvements as we go along and squashing
- [Installation](#installation)
- [Plex](#plex)
- [RivenVFS and Caching](#rivenvfs-and-caching)
- [Subtitles](#subtitles)
- [Contributing](#contributing)
- [License](#license)

Expand Down Expand Up @@ -329,6 +331,48 @@ The range format (e.g., `e01-05` or `E1-5`) is automatically applied based on yo
- File extensions are added automatically
- All names are sanitized for filesystem compatibility

## Subtitles

Riven can automatically download subtitles for your media using the OpenSubtitles.com REST API.

### OpenSubtitles.com Setup

1. Create a free account at [opensubtitles.com](https://www.opensubtitles.com)
2. Get your API key from your account settings (API consumers section)
- This requirement will be removed once we obtained a public API key.
3. Configure in `settings.json`:
Comment on lines +340 to +343
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix tense in the API key note.
Minor wording polish for user-facing docs.

✏️ Suggested edit 
-    - This requirement will be removed once we obtained a public API key.
+    - This requirement will be removed once we obtain a public API key.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
1. Create a free account at [opensubtitles.com](https://www.opensubtitles.com)
2. Get your API key from your account settings (API consumers section)
- This requirement will be removed once we obtained a public API key.
3. Configure in `settings.json`:
1. Create a free account at [opensubtitles.com](https://www.opensubtitles.com)
2. Get your API key from your account settings (API consumers section)
- This requirement will be removed once we obtain a public API key.
3. Configure in `settings.json`:
🤖 Prompt for AI Agents 
In `@README.md` around lines 340 - 343, Update the note about the API key in the
README: change the tense in the sentence "This requirement will be removed once
we obtained a public API key." to present/future-correct wording such as "This
requirement will be removed once we obtain a public API key" (or "once we have
obtained a public API key") so the user-facing text is grammatically correct;
edit the line near the `settings.json` bullet in README.md accordingly.


```json
{
"subtitle": {
"enabled": true,
"languages": ["en", "zh-cn", "fr"],
"providers": {
"opensubtitles_com": {
"enabled": true,
"api_key": "your-api-key",
"username": "your-username",
"password": "your-password"
}
}
}
}
```

**Configuration Options**:

| Setting | Description |
|---------|-------------|
| `subtitle.enabled` | Enable subtitle downloading |
| `subtitle.languages` | Languages to download (ISO 639-1 codes with locale variants, e.g., `en`, `zh-cn`, `pt-br`) |
| `subtitle.providers.opensubtitles_com.enabled` | Enable OpenSubtitles.com provider |
| `subtitle.providers.opensubtitles_com.api_key` | Your OpenSubtitles.com API key |
| `subtitle.providers.opensubtitles_com.username` | Your OpenSubtitles.com username |
| `subtitle.providers.opensubtitles_com.password` | Your OpenSubtitles.com password |
| `subtitle.providers.opensubtitles_com.query_params` | Additional search parameters (e.g., `{"foreign_parts_only": "include"}`) |
| `subtitle.providers.opensubtitles_com.user_agent` | Custom User-Agent header (default: `Riven/1.0`) |

The provider uses JWT authentication with automatic token refresh and multi-strategy search (file hash → IMDB ID → filename fallback) for best subtitle matching.

## Contributing

Expand Down
Loading