Skip to content

tvdb_api_client: an unofficial API for the TVDB

build lint tests license codecov readthedocs pypi downloads build automation: yam Lint: ruff

tvdb_api_client is an unofficial API for the TVDB.

In a nutshell

Installation

uv is an extremely fast Python package installer. You can use it to install tvdb_api_client and try it out:

$ uv pip install tvdb_api_client

Usage

Initialise the client and fetch data:

from tvdb_api_client import TheTVDBClient

client = TheTVDBClient(api_key="your-api-key")

# Get a TV series by its TVDB id
series = client.get_series_by_id(81189)  # Breaking Bad

# Get all episodes for a TV series
episodes = client.get_episodes_by_series(81189)

Once the client has been initialised, you can use it to:

  • get a TV series by its TVDB id
  • get all episodes for a TV series by its TVDB id
  • access raw API responses for custom processing