OMDB_API_Wrapper 1.1.2

OMDB_API_Wrapper is a RESTful API wrapper for the Open Movie Database API (http://www.omdbapi.com/). This API wrapper focuses on being simple to use, efficient and respects the terminology used in the OMDB API documentation.

There is a newer version of this package available.
See the version list below for details.
Install-Package OMDB_API_Wrapper -Version 1.1.2
dotnet add package OMDB_API_Wrapper --version 1.1.2
<PackageReference Include="OMDB_API_Wrapper" Version="1.1.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add OMDB_API_Wrapper --version 1.1.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: OMDB_API_Wrapper, 1.1.2"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install OMDB_API_Wrapper as a Cake Addin
#addin nuget:?package=OMDB_API_Wrapper&version=1.1.2

// Install OMDB_API_Wrapper as a Cake Tool
#tool nuget:?package=OMDB_API_Wrapper&version=1.1.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

OMDB_API_Wrapper

Current Release: Version 1.1.2

Description

An easy-to-use API wrapper/client for the Open Movie Database / OMDB API, which can be used in any .NET project. Available as a DLL library and a NuGet package. This library focuses on being easy to understand, simple to use and offer full coverage of features offered by the OMDB API. Terminology used by this library is strongly associated to the official OMDB API documentation found online at http://www.omdbapi.com/

Download Links

How to use?

All OMDB_API_Wrapper public classes and public methods available for use by developers have been XML-documented. This means you may access this documentation through your IDE (i.e. hover over method or class) or read it directly within the source code in this GitHub repository. Examples below should also be referenced.

Summary of Response Types Generated for each Request Type

Request Type Response Type
ByTitleRequest ByTitleResponse
ByIDRequest ByTitleResponse
BySearchRequest BySearchResponse

Examples (C#)

OMDB API Client Creation
OmdbClient omdbClient = new OmdbClient("YOUR_API_KEY");
API Key Validation
// Asynchronous
bool isKeyValidAsync = await omdbClient.IsAPIKeyValidAsync();

// Synchronous
bool isKeyValidSync = omdbClient.IsAPIKeyValidSync();
ByTitleRequest Creation
// Basic - No optional parameters - Short plot
ByTitleRequest byTitleRequestBasic = new ByTitleRequest("rick and morty");

// Detailed - With optional parameters - Full plot
ByTitleRequest byTitleRequestDetailed = new ByTitleRequest("rick and morty", VideoType.Series, null, PlotSize.Full);
ByTitleRequest Execution
// Asynchronous 
ByTitleResponse byTitleResponseAsync = await omdbClient.ByTitleRequestAsync(byTitleRequestBasic);

// Synchronous 
ByTitleResponse byTitleResponseSync = omdbClient.ByTitleRequestSync(byTitleRequestBasic);
ByIDRequest Creation
// Short plot
ByIDRequest byIDRequestShortPlot = new ByIDRequest("tt1219827");

// Full plot
ByIDRequest byIDRequestFullPlot = new ByIDRequest("tt1219827", PlotSize.Full);
ByIDRequest Execution (Responses are ByTitleResponse objects)
// Asynchronous 
ByTitleResponse byIDResponseAsync = await omdbClient.ByIDRequestAsync(byIDRequestShortPlot);

// Synchronous 
ByTitleResponse byIDResponseSync = omdbClient.ByIDRequestSync(byIDRequestShortPlot);
BySearchRequest Creation
// All Results - No optional parameters
BySearchRequest bySearchRequestAll = new BySearchRequest("ghost in the shell");

// Page 2 Only (Results 11 to 20 only) - No optional parameters
BySearchRequest bySearchRequestPageSpecific = new BySearchRequest("ghost in the shell", null, null, 2);

// All Results - With optional parameters
BySearchRequest bySearchRequestFiltered = new BySearchRequest("ghost in the shell", VideoType.Movie, 2017);
BySearchRequest Execution
// Asynchronous 
BySearchResponse bySearchResponseAsync = await omdbClient.BySearchRequestAsync(bySearchRequestAll);

// Synchronous 
BySearchResponse bySearchResponseSync = omdbClient.BySearchRequestSync(bySearchRequestAll);

OMDB_API_Wrapper

Current Release: Version 1.1.2

Description

An easy-to-use API wrapper/client for the Open Movie Database / OMDB API, which can be used in any .NET project. Available as a DLL library and a NuGet package. This library focuses on being easy to understand, simple to use and offer full coverage of features offered by the OMDB API. Terminology used by this library is strongly associated to the official OMDB API documentation found online at http://www.omdbapi.com/

Download Links

How to use?

All OMDB_API_Wrapper public classes and public methods available for use by developers have been XML-documented. This means you may access this documentation through your IDE (i.e. hover over method or class) or read it directly within the source code in this GitHub repository. Examples below should also be referenced.

Summary of Response Types Generated for each Request Type

Request Type Response Type
ByTitleRequest ByTitleResponse
ByIDRequest ByTitleResponse
BySearchRequest BySearchResponse

Examples (C#)

OMDB API Client Creation
OmdbClient omdbClient = new OmdbClient("YOUR_API_KEY");
API Key Validation
// Asynchronous
bool isKeyValidAsync = await omdbClient.IsAPIKeyValidAsync();

// Synchronous
bool isKeyValidSync = omdbClient.IsAPIKeyValidSync();
ByTitleRequest Creation
// Basic - No optional parameters - Short plot
ByTitleRequest byTitleRequestBasic = new ByTitleRequest("rick and morty");

// Detailed - With optional parameters - Full plot
ByTitleRequest byTitleRequestDetailed = new ByTitleRequest("rick and morty", VideoType.Series, null, PlotSize.Full);
ByTitleRequest Execution
// Asynchronous 
ByTitleResponse byTitleResponseAsync = await omdbClient.ByTitleRequestAsync(byTitleRequestBasic);

// Synchronous 
ByTitleResponse byTitleResponseSync = omdbClient.ByTitleRequestSync(byTitleRequestBasic);
ByIDRequest Creation
// Short plot
ByIDRequest byIDRequestShortPlot = new ByIDRequest("tt1219827");

// Full plot
ByIDRequest byIDRequestFullPlot = new ByIDRequest("tt1219827", PlotSize.Full);
ByIDRequest Execution (Responses are ByTitleResponse objects)
// Asynchronous 
ByTitleResponse byIDResponseAsync = await omdbClient.ByIDRequestAsync(byIDRequestShortPlot);

// Synchronous 
ByTitleResponse byIDResponseSync = omdbClient.ByIDRequestSync(byIDRequestShortPlot);
BySearchRequest Creation
// All Results - No optional parameters
BySearchRequest bySearchRequestAll = new BySearchRequest("ghost in the shell");

// Page 2 Only (Results 11 to 20 only) - No optional parameters
BySearchRequest bySearchRequestPageSpecific = new BySearchRequest("ghost in the shell", null, null, 2);

// All Results - With optional parameters
BySearchRequest bySearchRequestFiltered = new BySearchRequest("ghost in the shell", VideoType.Movie, 2017);
BySearchRequest Execution
// Asynchronous 
BySearchResponse bySearchResponseAsync = await omdbClient.BySearchRequestAsync(bySearchRequestAll);

// Synchronous 
BySearchResponse bySearchResponseSync = omdbClient.BySearchRequestSync(bySearchRequestAll);

Release Notes

Added MIT License

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
2.0.0 268 9/2/2019
1.1.3 286 2/25/2019
1.1.2 316 1/31/2019