OmdbApiNet 1.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package OmdbApiNet --version 1.1.0
NuGet\Install-Package OmdbApiNet -Version 1.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="OmdbApiNet" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add OmdbApiNet --version 1.1.0
#r "nuget: OmdbApiNet, 1.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install OmdbApiNet as a Cake Addin
#addin nuget:?package=OmdbApiNet&version=1.1.0

// Install OmdbApiNet as a Cake Tool
#tool nuget:?package=OmdbApiNet&version=1.1.0

OMDb-API.NET

OMDb-API.NET is a .NET Standard 2.0 (C#) REST client for the Open Movie Database API, a web service to obtain movie information as found on IMDb.

Usage

Create OMDb Client

    var omdb = new OmdbClient("your_apikey");
    
    // enable ratings from Rotten Tomatoes
    var omdb = new OmdbClient("your_apikey", true);

You can get an api key on the OMDb website.

Get an Item (movie or series)

    // Item GetItemByTitle(string title, bool fullPlot = false);
    var item = omdb.GetItemByTitle("title");
    var item = omdb.GetItemByTitle("title", true);

    // Item GetItemByTitle(string title, OmdbType type, bool fullPlot = false);
    var item = omdb.GetItemByTitle("title", OmdbType.Movie);
    var item = omdb.GetItemByTitle("title", OmdbType.Series, true);
    
    // Item GetItemByTitle(string title, int? year, bool fullPlot = false);
    var item = omdb.GetItemByTitle("title", 2017);
    var item = omdb.GetItemByTitle("title", 2017, true);
    
    // Item GetItemByTitle(string title, OmdbType type, int? year, bool fullPlot = false);
    var item = omdb.GetItemByTitle("title", OmdbType.Series, 2017);
    var item = omdb.GetItemByTitle("title", OmdbType.Movie, 2017, true);

    // Item GetItemById(string id, bool fullPlot = false);
    var item = omdb.GetItemById("imdb_id");
    var item = omdb.GetItemById("imdb_id", true);

You can get the type of an item with item.Type. item.Type can either be "movie", "series" or "episode". For getting an episode use GetEpisodeBySeriesId(), GetEpisodeBySeriesTitle() or GetEpisodeByEpisodeId() instead.

Get an Episode

    // Episode GetEpisodeBySeriesId(string seriesId, int seasonNumber, int episodeNumber);
    var episode = omdb.GetEpisodeBySeriesId("imdb_series_id", 1, 1);
    
    // Episode GetEpisodeBySeriesTitle(string seriesTitle, int seasonNumber, int episodeNumber);
    var episode = omdb.GetEpisodeBySeriesTitle("imdb_series_title", 1, 1);
    
    // Episode GetEpisodeByEpisodeId(string episodeId);
    var episode = omdb.GetEpisodeByEpisodeId("imdb_id");

Get a Season

    // Season GetSeasonBySeriesId(string seriesId, int seasonNumber);
    var season = omdb.GetSeasonBySeriesId("imdb_series_id", 1);
    
    // Season GetSeasonBySeriesTitle(string seriesTitle, int seasonNumber);
    var season = omdb.GetSeasonBySeriesTitle("imdb_series_title", 1);

Get Search Results (movies and series)

    // SearchList GetSearchList(string query, int page = 1);
    var searchList = omdb.GetSearchList("query");
    var searchList = omdb.GetSearchList("query", 2);
    
    // SearchList GetSearchList(string query, OmdbType type, int page = 1);
    var searchList = omdb.GetSearchList("query", OmdbType.Movie);
    var searchList = omdb.GetSearchList("query", OmdbType.Series, 2);
    
    // SearchList GetSearchList(int? year, string query, int page = 1);
    var searchList = omdb.GetSearchList(2017, "query");
    var searchList = omdb.GetSearchList(2017, "query", 2);
    
    // SearchList GetSearchList(int? year, string query, OmdbType type, int page = 1);
    var searchList = omdb.GetSearchList(2017, "query", OmdbType.Movie);
    var searchList = omdb.GetSearchList(2017, "query", OmdbType.Series, 2);

The query can contain whitespaces.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.3.0 6,239 7/28/2019
1.2.0 1,863 2/2/2019
1.1.0 1,162 10/26/2018