HTTP API Definition: Difference between revisions

From AniDB
Jump to navigation Jump to search
Line 28: Line 28:
<code><pre>
<code><pre>
<?xml version="1.0" encoding="utf-8" ?>
<?xml version="1.0" encoding="utf-8" ?>
<anime aid="1">
<anime id="1">
   <url>http://anidb.net/a1</url>
   <url>http://anidb.net/a1</url>
   <titles>
   <titles>
Line 39: Line 39:
   </titles>
   </titles>
   <type>TV Series</type>
   <type>TV Series</type>
   <episodes>13</episodes>
   <episodecount>13</episodecount>
   <date>
   <date>
       <!-- note: dates can also be YYYY-MM-?? and YYYY-??-?? -->
       <!-- note: dates can also be YYYY-MM-?? and YYYY-??-?? -->
Line 61: Line 61:
       <relation type="summary" aid="1623">Seikai no Monshou Movie</type>
       <relation type="summary" aid="1623">Seikai no Monshou Movie</type>
   </relations>
   </relations>
   <rating>
   <ratings>
       <permanent votecount="2333">8.54</permanent>
       <rating type="permanent" count="2333">8.54</rating>
       <temporary votecount="82">7.61</temporary>
       <rating type="temporary" count="82">7.61</rating>
       <review reviewcount="9">9.01</review>
       <rating type="review" count="9">9.01</rating>
   </rating>
   </ratings>
   <images>
   <images>
       <image size="full">http://img5.anidb.net/pics/anime/440.jpg</image>
       <image size="full">http://img5.anidb.net/pics/anime/440.jpg</image>

Revision as of 19:57, 11 April 2008

Early Draft

Anime Data

Allows retrieval of non-file or episode related information for a specific anime by AID (AniDB anime id).

Access

Base URL: TBA

Parameters:

  • client={string} [required]
    • client identification string, needs to be a registered client identifier, see:
  • clientver={integer} [required]
    • client version number, needs to be valid client version number for the given client identification string.
  • aid={integer} [required]
    • AniDB anime id of the anime you want to retrieve data for.


Example: URL: http://.../animedb.pl?show=xmlapi&client=clientname&clienver=13&aid=1832


Data

<?xml version="1.0" encoding="utf-8" ?>
<anime id="1">
   <url>http://anidb.net/a1</url>
   <titles>
      <!-- should we include all titles or are official+main title enough? -->
      <title type="main" lang="x-jat">Seikai no Monshou</title>
      <title type="official" lang="ja">星界の紋章</title>
      <title type="official" lang="en">Crest of the Stars</title>
      <title type="official" lang="fr">Crest of the Stars</title>
      <title type="official" lang="pl">Crest of the Stars</title>
   </titles>
   <type>TV Series</type>
   <episodecount>13</episodecount>
   <date>
      <!-- note: dates can also be YYYY-MM-?? and YYYY-??-?? -->
      <from>1999-01-03</from>
      <till>1999-03-28</from>
   </date>
   <categories>
      <category id="233" weight="6">Dynamic::Plot Continuity</category>
      <category id="4" weight="4">Elements::Action</category>
      ...
   <categories>
   <producers>
      <producer id="34" type="Financial Production">Bandai Visual</producer>
      <producer id="108" type="Music Production">BeSTACK</producer>
      ...
   </producers>
   <relations>
      <!-- relations are always listed with official transcription title -->
      <relation type="sequel" aid="4">Seikai no Senki</type>
      <relation type="prequel" aid="6">Seikai no Danshou</type>
      <relation type="summary" aid="1623">Seikai no Monshou Movie</type>
   </relations>
   <ratings>
      <rating type="permanent" count="2333">8.54</rating>
      <rating type="temporary" count="82">7.61</rating>
      <rating type="review" count="9">9.01</rating>
   </ratings>
   <images>
      <image size="full">http://img5.anidb.net/pics/anime/440.jpg</image>
      <image size="small">http://img5.anidb.net/pics/anime/thumbs/150/440.jpg-thumb.jpg</image>
      <image size="tiny">http://img5.anidb.net/pics/anime/thumbs/50/440.jpg-thumb.jpg</image>
   </images>
   <description>
Jinto Lin's life changes forever when the Humankind Empire Abh takes over his home planet of Martine without firing a single shot. He is soon sent off to study the Abh language and culture and to prepare himself for his future as a nobleman - a future he never dreamed of. Or wanted.

Now, Jinto is entering the next phase of his training, and he is about to meet his first Abh, the lovely Lafiel. But Jinto is about to learn that she is more than she appears to be. And together they will have to fight for their very lives.
   </description>
</anime>