API:GetSeries

From TvDBwiki
Jump to: navigation, search

This interface allows you to find the id of a series based on its name.

Contents

Location

<mirrorpath>/api/GetSeries.php?seriesname=<seriesname> <mirrorpath>/api/GetSeries.php?seriesname=<seriesname>&language=<language>


Parameters

<seriesname>

This is the string you want to search for. If there is an exact match for the parameter, it will be the first result returned.

<language>

This is the abbreviation for the language you want to search in. If omitted, it will default to en (English). This may also be set to all, which will search ALL translations for <seriesname>.

Avaliable Languages

<user>

This is a users account Identifier. If given it will use the language their account is set to. The account ID can be found by going to http://thetvdb.com/?tab=userinfo

Returned Variables

Variables are only returned if their value isn't null so you may not always see the exact same variables returned in every search.

<seriesid> and <id>

Returns an unsigned integer. Both values are exactly the same and always returned. <seriesid> is preferred, <id> is only included to be backwards compatible with the old API and is deprecated.

<language>

Returns a two digit string indicating the language. Avaliable Languages

<SeriesName>

Returns a string with the series name for the language indicated

<AliasNames>

Returns a pipe "|" delimited list of alias names if the series has any other names in that language.

<banner>

Returns the relative path to the highest rated banner for this series. Append <mirrorpath> to the start of it to get the absolute path.

<Overview>

Returns the overview for the series

<FirstAired>

Returns the first aired date for the series in the "YYYY-MM-DD" format.

<IMDB_ID>

Returns the IMDB id for the series if known.

<zap2it_id>

Returns the zap2it ID if known.

<Network>

Returns the Network name if known.

Example Results

<?xml version="1.0" encoding="UTF-8" ?>
<Data>
 <Series>
  <seriesid>78901</seriesid>
  <language>en</language>
  <SeriesName>Supernatural</SeriesName>
  <banner>graphical/78901-g4.jpg</banner>
  <Overview>Dean and Sam Winchester are two brothers with a special talent. Well-versed...</Overview>
  <FirstAired>2005-09-13</FirstAired>
  <IMDB_ID>tt0460681</IMDB_ID>
  <zap2it_id>EP00754231</zap2it_id>
  <id>78901</id>
 </Series>
 <Series>
  <seriesid>79426</seriesid>
  <language>en</language>
  <SeriesName>Supernatural Science</SeriesName>
  <banner>graphical/z79426-g.jpg</banner>
  <Overview>Even hardheaded skeptics have to concede that there’s something inherently...</Overview>
  <FirstAired>2006-11-09</FirstAired>
  <zap2it_id>EP00359360</zap2it_id>
  <id>79426</id>
 </Series>
 <Series>
  <seriesid>154401</seriesid>
  <language>en</language>
  <SeriesName>5th Dimension - Secrets of the Supernatural</SeriesName>
  <banner>graphical/154401-g.jpg</banner>
  <Overview>Does life end in death? Or does the soul wander from body to body? Are there...</Overview>
  <id>154401</id>
  </Series>
 <Series>
 <seriesid>197001</seriesid>
  <language>en</language>
  <SeriesName>Supernatural the Animation</SeriesName>
  <banner>graphical/197001-g2.jpg</banner>
  <Overview>Supernatural the Animation will not only remake the best episodes from the ...</Overview>
  <FirstAired>2011-02-23</FirstAired>
  <IMDB_ID>tt1679482</IMDB_ID>
  <id>197001</id>
 </Series>
 <Series>
  <seriesid>79432</seriesid>
  <language>en</language>
  <SeriesName>Supernatural The Unseen Powers of Animals</SeriesName>
  <banner>graphical/z79432-g.jpg</banner>
  <Overview>When science fiction becomes science fact. This groundbreaking series unravels...</Overview>
  <FirstAired>1999-03-30</FirstAired>
  <id>79432</id>
 </Series>
 <Series>
  <seriesid>74143</seriesid>
  <language>en</language>
  <SeriesName>The Supernatural (1977)</SeriesName>
  <FirstAired>1977-06-01</FirstAired>
  <IMDB_ID>tt0396375</IMDB_ID>
  <id>74143</id>
 </Series>
</Data>
Personal tools