tvdb_api

This Python package is automatically generated by the Swagger Codegen project:

• API version: 3.0.0
• Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

See requirements.txt and requirements-test.txt for details

Implemented methods

Authentication api

• login
• refresh_token
• clear_token

Search api

• search_series_by_name
• search_series_by_imdb_id

Series api

• get_series
• get_series_episodes
• get_series_episode
• get_series_episode_by_absolute_number
• get_series_images_count
• get_series_images
• get_series_highest_rated_image

Episodes api

• get_episode

Updates api

• get_updates

Utilities

• get_artwork_url

Documentation for our client wrapper (tvdb_client)

from tvdb_api.client import TvdbClient

# create instance with your api key
client = TvdbClient(api_key='yourtvdbapikey', user_agent='youruseragent')
# login to authenticate
client.login()
# execute desired method (you can choose from the implemented methods listed above)
client.search_series_by_name('yourseriesname')
...

Documentation for API Endpoints

Check this if you want to use the library without using the provided client

All URIs are relative to the tvdb base url

Class	Method	HTTP request	Description
AuthenticationApi	login_post	POST /login
AuthenticationApi	refresh_token_get	GET /refresh_token
EpisodesApi	episodes_id_get	GET /episodes/{id}
LanguagesApi	languages_get	GET /languages
LanguagesApi	languages_id_get	GET /languages/{id}
MoviesApi	movies_id_get	GET /movies/{id}
MoviesApi	movieupdates_get	GET /movieupdates
SearchApi	search_series_get	GET /search/series
SearchApi	search_series_params_get	GET /search/series/params
SeriesApi	series_id_actors_get	GET /series/{id}/actors
SeriesApi	series_id_episodes_get	GET /series/{id}/episodes
SeriesApi	series_id_episodes_query_get	GET /series/{id}/episodes/query
SeriesApi	series_id_episodes_query_params_get	GET /series/{id}/episodes/query/params
SeriesApi	series_id_episodes_summary_get	GET /series/{id}/episodes/summary
SeriesApi	series_id_filter_get	GET /series/{id}/filter
SeriesApi	series_id_filter_params_get	GET /series/{id}/filter/params
SeriesApi	series_id_get	GET /series/{id}
SeriesApi	series_id_head	HEAD /series/{id}
SeriesApi	series_id_images_get	GET /series/{id}/images
SeriesApi	series_id_images_query_get	GET /series/{id}/images/query
SeriesApi	series_id_images_query_params_get	GET /series/{id}/images/query/params
UpdatesApi	updated_query_get	GET /updated/query
UpdatesApi	updated_query_params_get	GET /updated/query/params
UsersApi	user_favorites_get	GET /user/favorites
UsersApi	user_favorites_id_delete	DELETE /user/favorites/{id}
UsersApi	user_favorites_id_put	PUT /user/favorites/{id}
UsersApi	user_get	GET /user
UsersApi	user_ratings_get	GET /user/ratings
UsersApi	user_ratings_item_type_item_id_delete	DELETE /user/ratings/{itemType}/{itemId}
UsersApi	user_ratings_item_type_item_id_item_rating_put	PUT /user/ratings/{itemType}/{itemId}/{itemRating}
UsersApi	user_ratings_query_get	GET /user/ratings/query
UsersApi	user_ratings_query_params_get	GET /user/ratings/query/params

Documentation For Models

• Auth
• BasicEpisode
• Conflict
• Episode
• EpisodeDataQueryParams
• EpisodeLanguageInfo
• EpisodeRecordData
• FilterKeys
• InvalidQueryParams
• JSONErrors
• Language
• LanguageData
• Links
• Movie
• MovieArtwork
• MovieGenre
• MoviePeople
• MovieReleaseDate
• MovieRemoteId
• MovieTrailer
• MovieTranslation
• NotAuthorized
• NotFound
• Series
• SeriesActors
• SeriesActorsData
• SeriesData
• SeriesEpisodes
• SeriesEpisodesQuery
• SeriesEpisodesQueryParams
• SeriesEpisodesSummary
• SeriesImageQueryResult
• SeriesImageQueryResultRatingsInfo
• SeriesImageQueryResults
• SeriesImagesCount
• SeriesImagesCounts
• SeriesImagesQueryParam
• SeriesImagesQueryParams
• SeriesSearchResult
• SeriesSearchResults
• Token
• Update
• UpdateData
• UpdateDataQueryParams
• UpdatedMovies
• User
• UserData
• UserFavorites
• UserFavoritesData
• UserRatings
• UserRatingsData
• UserRatingsDataNoLinks
• UserRatingsDataNoLinksEmptyArray
• UserRatingsQueryParams

Documentation For Authorization

jwtToken

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header