Skip to content

Files

Latest commit

e9770d2 · Nov 22, 2024

History

History
168 lines (134 loc) · 6.59 KB

README.md

File metadata and controls

168 lines (134 loc) · 6.59 KB

Contributors Forks Stargazers Issues LinkedIn


The TVDB Logo
thetvdb.com

tvdb-java-client

A swagger-generated TheTVDB v4 java client.
Maven Project Info - Javadoc
Report Bug - Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Recipes
  4. Contributing
  5. License
  6. Contact

About The Project

An auto-generated client for Java programmatic access to TheTVDB v4 API.

Getting Started

You'll need to register for your own API key via The TVDB API and Data Licensing

Recipes

Authenticating the default ApiClient

final ApiClientFactory clientFactory = new ApiClientFactory("MyApiKey");
clientFactory.authenticateDefaultClient();

final SearchApi searchApi = new SearchApi();
final List<SearchResult> resultList = searchApi.getSearchResults(
        "friends",  // query
        null,       // q
        "series",   // type
        null,       // year
        null,       // company 
        null,       // country
        null,       // director
        null,       // language
        null,       // primaryType
        null,       // network
        null,       // remoteId
        null,       // offset
        new BigDecimal(3) /* limit */).getData();

Obtaining an authenticated ApiClient

final ApiClientFactory clientFactory = new ApiClientFactory("MyApiKey");
final ApiClient myClient = clientFactory.getAuthenticatedClient();

// You can explicitly pass the authenticated client to each Api
final SearchApi searchApi = new SearchApi(myClient);

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT license. See LICENSE for more information.

Contact

Andy Miles - andy.miles (at) amilesend.com

Project Link: https://github.com/andy-miles/tvdb-java-client