Action Item #797

closed API is changing to v4

Added by Hammel over 3 years ago. Updated about 2 years ago.

Target version:
Start date:
16 Nov 2020
Due date:
% Done:


Estimated time:
01 - Critical


The license model is changing. I'll need to pick how uses will be able to access the database.
The v4 API is available now with documentation and known issues. The old db APIs will be deprecated at the end of March 2021.
I'll need to create a new key for v4, under TheTVDB dashboard under API keys.
v4 API is NOT backward compatible.

Related issues

Related to VideoLib - Feature #341: Need About dialogClosedHammel05 Jun 2014

Actions #1

Updated by Hammel about 3 years ago

  • Priority changed from Urgent to Immediate
  • Severity changed from 02 - High to 05 - Very Low
Actions #2

Updated by Hammel about 2 years ago

  • Severity changed from 05 - Very Low to 01 - Critical
Actions #3

Updated by Hammel about 2 years ago

  • Status changed from New to In Progress
  • % Done changed from 0 to 10

After logging in at, go to Dashboard->Account->API Keys and get a V4 API key.

However, it seems you can't get access to the API without subscribing now. And a subscription is 11.99/year. So I need to find a replacement for

The most likely candidate is, which now has TV shows. But it risks being put behind a paywall too. An alternative is OMDBApi, which is just an API for this kind of purpose. I can be a patreon for it, which seems like a good idea since that's how you get the poster API. However, it's not as complete as I'd like. Southpark isn't listed, though the X-Files is. And it's not clear if I'll get significant data for episodes.

After looking at the it seems the API is still free to logged in users and the TV collections are much better than before. So I'll switch everything over to that and drop

Actions #4

Updated by Hammel about 2 years ago

I need to update the attribution for It needs to go in an About or Credits dialog, not on the front page and it needs to use an official logo.

Actions #5

Updated by Hammel about 2 years ago

Actions #6

Updated by Hammel about 2 years ago

  • Status changed from In Progress to Closed
  • % Done changed from 10 to 100

I've made the updates and tested them. Everything is working as well as before, though I found a number of bugs that hadn't been reported previously.

All changes committed and pushed.

Closing issue.


Also available in: Atom PDF