Git Product home page Git Product logo

api-thetvdb's Introduction

The TVDB API

Originally written by: Matthew Altman (sTyLeS)

Maintained by: Stuart Boston (Omertron AT Gmail DOT com)

This API uses TheTVDB.com API

Originally written for use by YetAnotherMovieJukebox (YAMJv2 & YAMJv3), but anyone can feel free to use it for other projects as well.

Build Status


TheTVDB.com

TheTVDB.com is an awesome open database for television content.

I strongly encourage you to check it out and contribute to keep it growing.


Usage

Create an instance of TheTVDB using your apiKey which must be requested HERE

TheTVDBApi tvDB = new TheTVDBApi("your_api_key");

Search for Series by name and language

The language is optional and may be null, which would end up defaulting to English

The Resulting Series objects from this call have limited information since it is a generic search

Syntax

searchSeries(String title, String language)

Example

List<Series> results = tvDB.searchSeries("Lost", "en");

Obtain full Series details by ID

May use the series.getId() method from the previous search The language is optional and will default to english if null, but if present the resulting descriptions will be in that language

Syntax

getSeries(String id, String language)

Example

Series series = tvDB.getSeries("73739", "en");

Obtain detailed Episode data

The language is optional and will default to english if null, but will return details in that language if present

Syntax

getEpisode(String id, int seasonNbr, int episodeNbr, String language)

Example

Episode episode = tvDB.getEpisode("73739", 2, 3, "en");

Obtain image references

Returns a Banners object which contains separate lists for series, season, poster, and fanart images

Syntax

getBanners(String id)

Example

Banners banners = tvDB.getBanners("73739");

Obtain list of more detailed Actor data

The Series object does contain a list of actor names, but the Actor object has more details including roles and image references

Syntax

getActors(String id)

Example

List<Actor> actors = tvDB.getActors("73739");

Project Logging

This project uses SLF4J to abstract the logging in the project.

To use the logging in your own project you should add one of the bindings listed HERE

Project Documentation

The automatically generated documentation can be found HERE

api-thetvdb's People

Contributors

criedel avatar omertron avatar r89m avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.