Skip to content

moviecollection/open-subtitles

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Open Subtitles API

Unofficial implementation of the Open Subtitles API for .NET

NuGet Version NuGet Downloads

Installation

You can install this package via the Package Manager Console in Visual Studio.

Install-Package MovieCollection.OpenSubtitles -PreRelease

Configuration

Get or create a new static HttpClient instance if you don't have one already.

// HttpClient lifecycle management best practices:
// https://learn.microsoft.com/dotnet/fundamentals/networking/http/httpclient-guidelines#recommended-use
private static readonly HttpClient httpClient = new HttpClient();

You need to set your api key and user-agent then pass it to the service's constructor.

// using System.Net.Http.Headers;
// using MovieCollection.OpenSubtitles;

var options = new OpenSubtitlesOptions
{
    ApiKey = "your-api-key",
    ProductInformation = new ProductHeaderValue("your-app-name", "your-app-version"),
};

var service = new OpenSubtitlesService(httpClient, options);

Alternatively, you can set the user-agent via HttpClient's default request headers.

// using System.Net.Http.Headers;

var product = new ProductInfoHeaderValue("your-app-name", "your-app-version");
httpClient.DefaultRequestHeaders.UserAgent.Add(product);

Search for Subtitles

You can search for subtitles via the SearchSubtitles method.

var search = new NewSubtitleSearch
{
    ImdbId = 11204094,
};

var result = await service.SearchSubtitlesAsync(search);

You can also search by the movie name and year.

var search = new NewSubtitleSearch
{
    Query = "Iron Man",
    Year = 2008,
};

You can also specify season and episode number.

var search = new NewSubtitleSearch
{
    Query = "Rick and Morty",
    SeasonNumber = 5,
    EpisodeNumber = 10,
};

You can also search by movie file hash.

string filePath = "D:\\path-to-file\\";

var search = new NewSubtitleSearch
{
    // For best results with automatic searching based on file analysis,
    // send the file name as a query together with the moviehash.
    Query = Path.GetFileName(filePath),

    // Open Subtitles is using a special hash function to match subtitle files against movie files.
    // Hash is not dependent on file name of movie file.
    MovieHash = OpenSubtitlesHasher.GetFileHash(filePath),
};

Please see the demo project for more examples.

Notes

License

This project is licensed under the MIT License.