-- import "vimagination.zapto.org/tvdb"
Package tvdb is a simple interface to the TVDB database of TV shows.
var (
ErrInvalidAuth = errors.New("invalid credentials")
ErrUnknownError = errors.New("unknown error")
ErrNotFound = errors.New("not found")
)Errors.
type Actor struct {
ID uint64 `json:"id"`
SeriesID uint64 `json:"seriesId"`
Name string `json:"name"`
Role string `json:"role"`
SortOrder uint `json:"sortOrder"`
Image string `json:"image"`
ImageAuthor uint64 `json:"imageAuthor"`
ImageAdded string `json:"imageAdded"`
LastUpdated string `json:"lastUpdated"`
}Actor represents all of the information about an actor in a show.
type Auth struct {
APIKey string `json:"apikey"`
Username string `json:"username,omitempty"`
UserKey string `json:"userkey,omitempty"`
}Auth represents the information required to get a validated authentication token.
type Conn struct {
}Conn represents a connection to the TVDB database.
func Login(a Auth) (*Conn, error)Login creates a TVDB database connection using login credentials.
func Token(t string) *ConnToken creates a TVDB database connection using a pre-authorised token.
func (c *Conn) Actors(id uint64) ([]Actor, error)Actors returns information about the actors in a show, denoted by its ID.
func (c *Conn) AddFavorite(id uint64) errorAddFavorite adds a show id to the list of user favorites.
func (c *Conn) DVDSeasonEpisode(id uint64, season, episode uint64) (*SeriesEpisode, error)DVDSeasonEpisode returns the information about a particular episode in a series denoted by its DVD season and episode numbers.
func (c *Conn) DVDSeasonEpisodes(id uint64, season uint64, page uint64) ([]SeriesEpisode, error)DVDSeasonEpisodes returns a paginatied view (100 per page) of the episodes in the DVD season of a show.
func (c *Conn) Episode(id uint64) (*Episode, error)Episode returns the information about a single tv episode denoted by the episode id.
func (c *Conn) Episodes(id uint64, page uint64) ([]SeriesEpisode, error)Episodes returns a paginated view (100 per page) of the episodes in a particular series.
func (c *Conn) Favorites() ([]uint64, error)Favorites returns a list of show ids that the user has set as favorites.
func (c *Conn) Language(id uint64) (*Language, error)Language retrieves information about a specific language, denoted by its language id.
func (c *Conn) Languages() ([]Language, error)Languages returns a slice of all the languages supported by TVDB.
func (c *Conn) Ratings() ([]Rating, error)Ratings returns a list of ratings that the user has set.
func (c *Conn) RatingsByType(rit RatingItemType) ([]Rating, error)RatingsByType returns a list of ratings for a specific type.
func (c *Conn) Refresh() errorRefresh retrieves a new authentication token without having to use the login credentials. Each token only lasts 24 hours and refresh can only be used in that time-frame.
func (c *Conn) RemoveFavorite(id uint64) errorRemoveFavorite removes a show id to the list of user favorites.
func (c *Conn) RemoveRating(rit RatingItemType, id uint64) errorRemoveRating removes a user rating for a specific series, episode or banner.
func (c *Conn) Search(name string) ([]Search, error)Search searches the TVDB database for shows with the given name.
func (c *Conn) SearchIMDB(imdb string) (*Search, error)SearchIMDB searches the TVDB database for the show corrensponding to the given IMDB ID.
func (c *Conn) SearchZap2It(zapit string) (*Search, error)SearchZap2It searches the TVDB database for the show corrensponding to the given Zap2It ID.
func (c *Conn) SeasonEpisode(id uint64, season, episode uint64) (*SeriesEpisode, error)SeasonEpisode returns the information about a particular episode in a series denoted by its season and episode numbers.
func (c *Conn) SeasonEpisodes(id uint64, season uint64, page uint64) ([]SeriesEpisode, error)SeasonEpisodes returns a paginated view (100 per page) of the episodes in a season of a show.
func (c *Conn) Series(id uint64) (*Series, error)Series retrieves the information about a particular series by its ID.
func (c *Conn) SeriesEpisode(id uint64, abs uint64) (*SeriesEpisode, error)SeriesEpisode returns the information about a particular episode in a series denoted by its absolute episode number.
func (c *Conn) SeriesSummary(id uint) (*Summary, error)SeriesSummary returns the summary information about episodes for a tv show.
func (c *Conn) SetLanguage(code string)SetLanguage sets the language header used by some queries to return information in the requested language.
func (c *Conn) SetRating(rit RatingItemType, id uint64, rating uint32) errorSetRating sets a user rating for a specific series, episode or banner.
func (c *Conn) Token() stringToken returns the current authentication token.
func (c *Conn) User() (*User, error)User returns the logged in user details.
type Episode struct {
ID uint64 `json:"id"`
AiredSeason uint `json:"airedSeason"`
AiredSeasonID uint64 `json:"airedSeasonId"`
AiredEpisodeNumber uint `json:"airedEpisodeNumber"`
Name string `json:"episodeName"`
FirstAired string `json:"firstAired"`
GuestStars []string `json:"guestStars"`
Directors []string `json:"directors"`
Writers []string `json:"writers"`
Overview string `json:"overview"`
Language struct {
EpisodeName string `json:"episodeName"`
Overview string `json:"overview"`
} `json:"language"`
ProductionCode string `json:"productionCode"`
ShowURL string `json:"shorUrl"`
LastUpdated int64 `json:"lastUpdated"`
DVDDiscID string `json:"dvdDiscid"`
DVDSeason uint `json:"dvdSeason"`
DVDEpisodeNumber uint `json:"dvdEpisodeNumber"`
DVDChapter uint `json:"dvdChapter"`
AbsoluteNumber uint `json:"absoluteNumber"`
Filename string `json:"filename"`
SeriesID uint64 `json:"seriesId"`
LastUpdatedBy uint64 `json:"lastUpdatedBy"`
AirsAfterSeason uint `json:"airsAfterSeason"`
AirsBeforeSeason uint `json:"airsBeforeSeason"`
AirsBeforeEpisode uint `json:"airsBeforeEpisode"`
ThumbAuthor uint64 `json:"thumbAuthor"`
ThumbAdded string `json:"thumbAdded"`
ThumbWidth string `json:"thumbWidth"`
ThumbHeight string `json:"thumbHeight"`
IMDBID string `json:"imdbId"`
SiteRating float32 `json:"siteRating"`
SiteRatingCount uint64 `json:"siteRatingCount"`
}Episode represents the data for a single episode of a programme.
type ErrInvalidFilters []stringErrInvalidFilters is returned from query that use an unknown or invalid filter.
func (ErrInvalidFilters) Error() stringError satisfies the error interface.
func (ErrInvalidFilters) UnmarshalJSON(b []byte) errorUnmarshalJSON uses the json decoding of the error to generate an error instead of decoding.
type ErrInvalidLanguage stringErrInvalidLanguage is returned when a query requests an unknown or invalid language.
func (ErrInvalidLanguage) Error() stringError satisfies the error interface.
func (ErrInvalidLanguage) UnmarshalJSON(b []byte) errorUnmarshalJSON uses the json decoding of the error to generate an error instead of decoding.
type ErrInvalidQueryParams []stringErrInvalidQueryParams is returned when a query uses unknown or invalid params.
func (ErrInvalidQueryParams) Error() stringError satisfies the error interface.
func (ErrInvalidQueryParams) UnmarshalJSON(b []byte) errorUnmarshalJSON uses the json decoding of the error to generate an error instead of decoding.
type Language struct {
ID uint64 `json:"id"`
Abbreviation string `json:"abbreviation"`
Name string `json:"name"`
EnglishName string `json:"englishName"`
}Language contains information about a supported language.
type Rating struct {
Type string `json:"ratingType"`
ItemID uint64 `json:"ratingItemId"`
Rating float32 `json:"rating"`
}Rating represents a single rating for an item.
type RatingItemType stringRatingItemType represents the type of rating, currently one of series, episode and banner.
const (
RatingSeries RatingItemType = "series"
RatingEpisode RatingItemType = "episode"
RatingBanner RatingItemType = "banner"
)The currently available Item Types for Rating.
type Search struct {
Aliases []string `json:"aliases"`
Banner string `json:"banner"`
FirstAired string `json:"firstAired"`
ID uint64 `json:"id"`
Network string `json:"network"`
Overview string `json:"overview"`
Name string `json:"seriesName"`
Status string `json:"status"`
}Search is a representation of the data returned from a tv show search.
type Series struct {
ID uint64 `json:"id"`
Name string `json:"seriesName"`
Aliases []string `json:"aliases"`
Banner string `json:"banner"`
SeriesID string `json:"seriesId"`
Status string `json:"status"`
FirstAired string `json:"firstAired"`
Network string `json:"network"`
NetworkID string `json:"networkId"`
Runtime string `json:"runtime"`
Genre []string `json:"genre"`
Overview string `json:"overview"`
LastUpdated uint64 `json:"lastUpdated"`
AirsDayOfWeek string `json:"airsDayOfWeek"`
AirsTime string `json:"airsTime"`
Rating string `json:"rating"`
IMDBID string `json:"imdbId"`
Zap2ItID string `json:"zap2ItId"`
Added string `json:"added"`
SiteRating float32 `json:"siteRating"`
SiteRatingCount uint64 `json:"siteRatingCount"`
}Series represents all of the information about a particular show.
type SeriesEpisode struct {
AbsoluteNumber uint `json:"absoluteNumber"`
AiredEpisodeNumber uint `json:"airedEpisodeNumber"`
AiredSeason uint `json:"airedSeason"`
DVDEpisodeNumber float32 `json:"dvdEpisodeNumber"`
DVDSeason uint `json:"dvdSeason"`
Name string `json:"episodeName"`
ID uint64 `json:"id"`
Overview string `json:"overview"`
FirstAired string `json:"firstAired"`
LastUpdated uint64 `json:"lastUpdated"`
}SeriesEpisode represents all of the information about a particular episode of a show.
type Summary struct {
AiredSeasons []string `json:"airedSeasons"`
AiredEpisodes string `json:"airedEpisodes"`
DVDSeasons []string `json:"dvdSeasons"`
DVDEpisodes string `json:"dvdEpisodes"`
}Summary represents the information about episodes for a particular show.
type User struct {
Username string `json:"userName"`
Language string `json:"language"`
FavoritesDisplaymode string `json:"favoritesDisplaymode"`
}User represents the user details given by the user endpoint.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent