UDP API Definition: Difference between revisions

← Older edit

UDP API Definition (view source)

Revision as of 01:15, 6 June 2020

10,356 bytes added , 6 June 2020

m

Fix typo in return code 282 name (NOTIFYACK_SUCCESSFUL_NOTIFICATION -- was [...]_NOTIFIATION)

GrumpyBear57

1

edit

@@ Line 1: / Line 1: @@
 {{TOCright}}
 == General Information ==
 '''Author:''' [[User:Exp|Exp]] & [[User:Epoximator|Epoximator]] & [[User:Ommina|Ommina]]<br>
-'''Version:''' 0.03.126 (2009-03-07)<br>
+'''Version:''' 0.03.730 (2015-03-25)<br>
 '''Version number used for protover parameter:''' "3"
 '''IMPORTANT INFORMATION FOR ALL INTERESTED:'''
 * If you are mainly interested in notifications and private messaging, check out our [[Jabber]] and [[RSSRDF]] support first.
-* The UDP API is not an appropriate choice if you desire to download a local copy of the AniDb database.
+* The UDP API is not an appropriate choice if you desire to download a local copy of the AniDB database.
-* If you want to create a client you have to register it [http://anidb.net/perl-bin/animedb.pl?show=client here] and [[UDP_Clients|here]].
+* If you want to create a client you have to register it {{AniDBLink|client|here}} and [[UDP Clients|here]].
 ** Check out the clients that are being developed. There exists usable code in many different languages already.
-* If you have suggestions for improvements or new features use the [[UDP_API_DEV|development]] page.
+* If you have suggestions for improvements or new features use the [[UDP API DEV|development]] page.
-* Please also take a look at the [[API|API]] page.
+* Please also take a look at the [[API]] page.
 == Formats used in this Spec ==
@@ Line 30: / Line 31: @@
 ** All newlines should be replaced by &lt;br /&gt;
 * Escape scheme for returned data fields (from server): ', | and newline
-** Content newlines are encoded as &lt;br /&gt;, ' is encoded as ` and | is not allowed in data fields.
+** Content newlines are encoded as &lt;br /&gt;, ' is encoded as ` and | is encoded as /.
+** Dates are returned in unix time (number of seconds elapsed since January 1, 1970 00:00:00 UTC)
 == Basics ==
 === General ===
-The network communication is ''packet'' and ''line'' based. Each ANIDB API command is exactly one UDP packet containing one line. Results are sent as one packet but may consist out of multiple lines. A return value always starts with a 3 byte result code followed by a human redable version of the result code. Be aware that important data fields may be returned directly after the return code (see: 200,201,271,272,504).
+The network communication is ''packet'' and ''line'' based. Each AniDB API command is exactly one UDP packet containing one line. Results are sent as one packet but may consist out of multiple lines. A return value always starts with a 3 byte result code followed by a human readable version of the result code. Be aware that important data fields may be returned directly after the return code (see: 200,201,209,271,272,504).
-The meaning for all result codes can be found in this document. If there is more than one entry returned, it's one entry per line. Lines are terminated by a <tt>\n</tt> (no dos linefeed <tt>\r</tt>). The elements of a format string are seperated by a "|" character.
+The meaning for all result codes can be found in this document. If there is more than one entry returned, it's one entry per line. Lines are terminated by a <tt>\n</tt> (no dos linefeed <tt>\r</tt>). The elements of a format string are separated by a "|" character.
 <tt>{three digit return code} {str return string}\n</tt><br>
@@ Line 54: / Line 55: @@
 *** 601 ANIDB OUT OF SERVICE - TRY AGAIN LATER
 *** 602 SERVER BUSY - TRY AGAIN LATER
+*** 604 TIMEOUT - DELAY AND RESUBMIT
 ** Additional return codes for all commands that '''require login''':
 *** 501 LOGIN FIRST
@@ Line 59: / Line 61: @@
 *** 506 INVALID SESSION
-{{eyecatch|NOTE:| The '555 BANNED' message should not be expected by the client. This message is only enabled temporary to help developers understand what they are doing wrong.}}
+{{eyecatch|Note|The '555 BANNED' message should not be expected by the client. This message is only enabled temporary to help developers understand what they are doing wrong.}}<br>
-{{eyecatch|NOTE:|
+{{eyecatch|Note|
 While in daily maintenance the AniDB API will reply with
 ANIDB OUT OF SERVICE - TRY AGAIN LATER
-to all commands. If a client recieves such a return value it should wait at least 30 minutes before trying again.
+to all commands. If a client receives such a return value it should wait at least 30 minutes before trying again.}}
-}}
 === Server / UDP Connection ===
 The Client has to send data packets to:
-* '''Server:''' api.anidb.info
+* '''Server:''' api.anidb.net
 * '''Port:''' 9000/UDP
 The servername and port should not be hardcoded into a frontend but should be read from a configuration file.
 === Server Errors ===
 * At any time the API might return a fatal error of the form:
 : <tt>6xx ERROR DESCRIPTION</tt>
 * Possible codes are 600-699.
-* Occurrences of these errors (except 601) should be reported to [[User:Ommina|Ommina]].
+* Occurrences of these errors (except 601 and 602) should be reported to [[User:Ommina|Ommina]].
-{{eyecatch|NOTE:| 6XX messages do not always return the tags given with the command which caused the error!}}
+{{eyecatch|Note|6XX messages do not always return the tags given with the command which caused the error!}}
 === Connection Problems ===
@@ Line 86: / Line 88: @@
 === Local Port ===
-A client should select a fixed local port >1024 at install time and reuse it for local UDP Sockets. If the API sees too many different UDP Ports from one IP within ~1 hour it will ban the IP. (So make sure you're reusing your UDP ports also for testing/debuging!)
+A client should select a fixed local port >1024 at install time and reuse it for local UDP Sockets. If the API sees too many different UDP Ports from one IP within ~1 hour it will ban the IP. (So make sure you're reusing your UDP ports also for testing/debugging!)
 The local port may be hardcoded, however, an option to manually specify another port should be offered.
-'''Note when behind a [http://en.wikipedia.org/wiki/Network_address_translation NAT]/masquerading router:'''<br/>
+'''Note when behind a [[Wikipedia:Network address translation|NAT]]/masquerading router:'''<br>
-A session between the server and a client is identified by the ''ip and port'' used by the client. So when the port (or ip) changes within a session the client has to authenticate again. If a client is behind a nat router it can’t actually control the local port used for the connection. The router will normally ''translate'' the port to support several computers on a lan to share the internet connection. The public port (as determined by the router and seen by the server) which has been assigned to the connection will only be reserved for as long as it is in use. This means that the router will usually ''deallocate the port after a fixed timeout period'' (i.e. 5, 10 or 15 minutes). Once that happens the client will no longer be able to receive UDP messages from the server (the messages will be discarded as undeliverable by the router) and a new port will be selected once the client tries to send a message to the server (which will result in a new connection session - NOTE: this could get you banned!, see above). So in order to keep a session over a NAT router alive, the client has to ping the server within this period to prevent a timeout.
+A session between the server and a client is identified by the ''IP and port'' used by the client. So when the port (or IP) changes within a session the client has to authenticate again. If a client is behind a NAT router it can’t actually control the local port used for the connection. The router will normally ''translate'' the port to support several computers on a LAN to share the Internet connection. The public port (as determined by the router and seen by the server) which has been assigned to the connection will only be reserved for as long as it is in use. This means that the router will usually ''deallocate the port after a fixed timeout period'' (eg. five, ten or 15 minutes). Once that happens the client will no longer be able to receive UDP messages from the server (the messages will be discarded as undeliverable by the router) and a new port will be selected once the client tries to send a message to the server (which will result in a new connection session - '''Note:''' This could get you banned!, see above). So in order to keep a session over a NAT router alive, the client has to ping the server within the router's deallocation period to prevent a timeout.
-The client can decide whether it is behind a NAT router or not by adding <tt>nat=1</tt> to the AUTH command. This will cause the response to include the ip and port as seen by the server. If the port differs from the port reported by the local socket, the connection subject to NAT and the client should issue PING commands in regular intervals. Please do not send pings more often then once every 5 minutes and only on connections via NAT routers or if the user has explicitly enabled regular keepalive pings via a configuration setting (default setting should be OFF).
+The client can decide whether it is behind a NAT router or not by adding <tt>nat=1</tt> to the AUTH command. This will cause the response to include the IP and port as seen by the server. If the port differs from the port reported by the local socket, the connection subject to NAT and the client should issue PING commands in regular intervals. Please do not send pings more often than is necessary to keep NAT connections alive.
 === Flood Protection ===
 To prevent high server load the UDP API server enforces a strict flood protection policy.
 * Short Term:
-** A Client MUST NOT send more than 0.5 packets per second.
+** A Client MUST NOT send more than 0.5 packets per second (that's one packet every two seconds, not two packets a second!)
-** The server will start to enforce the limit after the first 5 packets have been recieved.
+** The server will start to enforce the limit after the first 5 packets have been received.
 * Long Term:
-** A Client MUST NOT send more than one packet every 30 seconds over an extended amount of time.
+** A Client MUST NOT send more than one packet every four seconds over an extended amount of time.
 ** ''An extended amount of time'' is not defined. Use common sense.
 Once a client exceeds a rate limit all further UDP packets from that client will be dropped without feedback until the client's packet rate is back down to acceptable levels.
-{{eyecatch|NOTE:| Dropped packets are still taken into account for the packet rate. Meaning if you continuously send packets your client will be banned forever.}}
+{{eyecatch|Note|Dropped packets are still taken into account for the packet rate. Meaning if you continuously send packets your client will be banned forever.}}
 Generally clients should be written in a way to minimize server and network load. You should always keep that in mind.
-Abusive clients may be banned completly.
+Abusive clients may be banned completely.
-{{eyecatch|NOTE:|
+{{eyecatch|Note|
-If you suddenly stop getting replies from the AniDB API or you normally don't have a noteable packetloss and from one point on you suddenly note a high packetloss percentage you have most likely entered a critical flood ratio.
+If you suddenly stop getting replies from the AniDB API or you normally don't have a notable packetloss and from one point on you suddenly note a high packetloss percentage you have most likely entered a critical flood ratio.
-If the AniDB API isn't answering at all it might either be down or you have been banned, this is normally caused by vialoating the API specs (i.e. too many connections using different ports from one ip, too many auth failures, ...) (usually lasts 30 minutes).
+If the AniDB API isn't answering at all it might either be down or you have been banned, this is normally caused by violating the API specs (i.e. too many connections using different ports from one IP, too many auth failures, ...) (usually lasts 30 minutes).
-If you're experiencing packet loss you have probably reached the rate limit and the API starts to randomly drop incoming packets from your IP. (can be solved by enforcing a delay between multiple commands when you're sending a batch)
+If you're experiencing packet loss you have probably reached the rate limit and the API starts to randomly drop incoming packets from your IP. (can be solved by enforcing a delay between multiple commands when you're sending a batch)}}
-}}
 === Anti Leech Protection ===
@@ Line 125: / Line 126: @@
 A client should locally cache FILE/EP/ANIME/GROUP/... info wherever possible for extended amounts of time.
-(I.e. if a client is used to scan a local folder with anime files and add them via API to a users mylist then it shall only ask for all files in the first run and cache the info for all files known to AniDB. If run again over the same folder it shall only check those files which were unknown to anidb at the time of the last check.)
+(I.e. if a client is used to scan a local folder with anime files and add them via API to a users MyList then it shall only ask for all files in the first run and cache the info for all files known to AniDB. If run again over the same folder it shall only check those files which were unknown to AniDB at the time of the last check.)
 Later versions of the API might enforce this by banning clients which ask for the same information more than once every week/month.
 === Tag option ===
-The api will add a user defined string at the beginning of each reply line seperated with a space, if desired.
+The API will add a user defined string at the beginning of each reply line separated with a space, if desired.
 * To enable add the <tt>tag={str usertag}</tt> option to a command.
 * A tag is only valid for the command it was send with, meaning it is not persistent. If you want to have tags in front of all reply lines you will have to append the tag option to each command you send to the server.
-* Tags are ment to enable a client to handle more than one request/reply at a time.
+* Tags are meant to enable a client to handle more than one request/reply at a time.
 Usage example:
@@ Line 142: / Line 143: @@
    byebye 203 LOGGED OUT
-{{eyecatch|NOTE:| The tag option is valid for all api commands and is thus not explicitly listed in the description of each command.}}
+{{eyecatch|Note|The tag option is valid for all api commands and is thus not explicitly listed in the description of each command.}}
 === Data Indexes (fid,aid,eid,gid,lid) ===
 * All indexes start at 1 (not 0).
 * It is possible for table entries to have id fields with a value of 0 (i.e. gid). Those are to be interpreted as "NONE" or "NULL".
 * An ID is '''never''' reused. That means after an entry is deleted no new entry will ever have that ID again.
 * Mylist IDs (lid) are globally unique, not per-user unique.
 == Authing Commands ==
-{{eyecatch|NOTE:| _ANY_ command which requires parameters may return: 505 ILLEGAL INPUT OR ACCESS DENIED
+{{eyecatch|Note|'''ANY''' command which requires parameters may return: 505 ILLEGAL INPUT OR ACCESS DENIED}}
-}}
 ----
 === AUTH: Authing to the AnimeDB ===
 '''Command String:'''
-* AUTH user={str username}&pass={str password}&protover={int4 apiversion}&client={str clientname}&clientver={int4 clientversion}[&nat=1&comp=1&enc={str encoding}&mtu{int4 mtu value}]
+* AUTH user={str username}&pass={str password}&protover={int4 apiversion}&client={str clientname}&clientver={int4 clientversion}[&nat=1&comp=1&enc={str encoding}&mtu={int4 mtu value}&imgserver=1]
 '''Possible Replies:'''
@@ Line 170: / Line 170: @@
 * 200 {str session_key} {str ip}:{int2 port} LOGIN ACCEPTED
 * 201 {str session_key} {str ip}:{int2 port} LOGIN ACCEPTED - NEW VERSION AVAILABLE
+when imgserver=1
+* 200 {str session_key} LOGIN ACCEPTED
+{str image server name}
+* 201 {str session_key} LOGIN ACCEPTED - NEW VERSION AVAILABLE
+{str image server name}
 '''Info:'''
-{{eyecatch|NOTE:| The password is the normal AniDB website password! The password listed in the profile as API Password in only used for the optional encryption feature.}}
+{{eyecatch|Note|The password is the normal AniDB website password! The password listed in the profile as API Password in only used for the optional encryption feature.}}
 * The ''session_key'' is a String containing only ''a-z,A-Z,0-9'' chars of a length of ''4-8'' characters.
 : It has to be stored by the client and needs to be sent as parameter with every command which requires the user to logged in.
@@ Line 179: / Line 184: @@
 * In case of a '''501 LOGIN FIRST''' message the client should silently resend an auth command and send the failed command again.
 * A '''502 ACCESS DENIED''' message should abort the current action on the client side and display a message to the user.
-* A '''503 CLIENT VERSION OUTDATED''' message states that the udp server has been updated and does not support your client any longer. (protover is too low). A 201 message referes to a new version of the client software.
+* A '''503 CLIENT VERSION OUTDATED''' message states that the udp server has been updated and does not support your client any longer. (protover is too low). A 201 message refers to a new version of the client software.
 * A '''506 INVALID SESSION''' means that either the session key parameter "s" was not provided with a command that requires it or the session key is no longer valid. The client should reissue an AUTH command.
-{{eyecatch|NOTE:| A frontend shall expect 501 and 502 messages to be returned on ANY command.}}
+{{eyecatch|Note|A frontend shall expect 501 and 502 messages to be returned on ANY command.}}<br>
-{{eyecatch|NOTE:| Anidb usernames are always lowercase and may only contain characters (a-z) and numbers (0-9).}}
+{{eyecatch|Note|AniDB usernames may only contain characters (a-z,A-Z), numbers (0-9), underscores (_) and hyphens (-).}}
-* The client should silently convert all entered usernames to lowercase before sending them to the API.
 * The client should send the apiversion of the AnimeDB API version it supports as value of the protover parameter.
 * The client MAY NOT send anything but the version of the API Specs the author used to write the client! (as it is stated at the top of this file @ "Version number used for protover parameter")
-: The API will compare that value to it's own version of the API and if the version of the client is older the API will decide wheter the changes were significant enough to deny the old client access to the DB.
+: The API will compare that value to it's own version of the API and if the version of the client is older the API will decide whether the changes were significant enough to deny the old client access to the DB.
-* The clientname shall be a lowercase string containing only the chars ''a-z'' of ''4-16 chars'' length which identifies the client. (i.e. mykickassclient)
+* The clientname shall be a lower-case string containing only the chars ''a-z'' of ''4-16 chars'' length which identifies the client. (i.e. mykickassclient)
 * The clientversion shall be a number starting with 1, increased on every change in the client.
-: clientname and clientversion might be used by the API to distinguish between different clients and client versions if that should ever become nessecary.
+: clientname and clientversion might be used by the API to distinguish between different clients and client versions if that should ever become necessary.
-{{eyecatch|IMPORTANT:|
+{{eyecatch|Important|
-* DO NOT use the clientname of another existing client.
+* DO NOT use the clientname of an existing client.  If you modify an existing client's code to meet your own needs, create a new client name for yourself.
-* ALWAYS increase the clientversion number if you release a new client version.
+* ALWAYS increase the clientversion number if you release a new client version.}}
-}}
 * A Login and its assigned ''session_key'' is valid until the virtual UDP connection times out or until a LOGOUT command is issued.
-* The virtual UDP connection times out if no data was recieved from the client for '''35 minutes'''.
+* The virtual UDP connection times out if no data was received from the client for '''35 minutes'''.
 * A client should issue a UPTIME command once every 30 minutes to keep the connection alive should that be required.
-* If the client does not use any of the notification/push features of the API it should NOT keep the connection alive, furthermore it should explicitly terminate the connection by issueing a LOGOUT command once it finished it's work.
+* If the client does not use any of the notification/push features of the API it should NOT keep the connection alive, furthermore it should explicitly terminate the connection by issuing a LOGOUT command once it finished it's work.
-* If it is very likely that another command will be issued shortly (within the next 20 minutes) a client may keep the current connection open, until it times out on it's own, by not sending a LOGOUT command.
+* If it is very likely that another command will be issued shortly (within the next 20 minutes) a client SHOULD keep the current connection open, by not sending a LOGOUT command.
-* The client shall notify the user if it recieved a 201 message at login.
+{{eyecatch|Important|
+* A client should NOT perform a full AUTH / command / LOGOUT cycle for each command it wants to send.  Again, if another command is likely within 20 minutes, remain logged in.}}
+* The client shall notify the user if it received a 201 message at login.
 : This means a new version of the client is available, however the old version is still supported otherwise a client banned message would have been returned.
-* The user should get a popup message on 503 and 504 messages telling him to update his client software.
+* The user should get a pop-up message on 503 and 504 messages telling him to update his client software.
-: (NOTE: 504 means that this version of the client is banned, not the user!)
+: ('''Note:''' 504 means that this version of the client is banned, not the user!)
 * The 'nat' option makes the client able to detect whether it is behind a nat router or not. When the client is behind a nat router it should keep the "connection" alive with the PING command.
-{{eyecatch|IMPORTANT:| Make sure your client handels ALL possible AUTH return codes before giving out any versions!}}
+{{eyecatch|Important|Make sure your client handles ALL possible AUTH return codes before giving out any versions!}}
 * When ''enc=x'' is defined the server will change the encoding used to x.
 **If the encoding is supported it will change right away (including the response) and be reset on logout/timeout.
 **If not supported then the argument will be silently ignored. Use ENCODING to test what works.
@@ Line 212: / Line 217: @@
 **The server will compress (instead of truncating) the datagrams when needed if this option is enabled.
 **The first two bytes of compressed datagrams will always be set to zero. (So tags should never start with that.)
-* Default [http://en.wikipedia.org/wiki/MTU_(networking) ''MTU''] is 1400. Minimum allowed is 400, maximum 1400, due [http://en.wikipedia.org/wiki/Point-to-Point_Protocol_over_Ethernet PPPoE].
+* Default [[Wikipedia:MTU (networking)|''MTU'']] is 1400. Minimum allowed is 400, maximum 1400, due [[Wikipedia:Point-to-Point Protocol over Ethernet|PPPoE]].
 ----
@@ Line 226: / Line 231: @@
 '''Info:'''
 * This command only works if you are already logged in.
-* A logout should ALWAYS be issued if the client is currently logged in and is either exiting or not expecting to send/receive any anidb api packets for the next >= 30 minutes.
+* A logout should ALWAYS be issued if the client is currently logged in and is either exiting or not expecting to send/receive any AniDB API packets for the next >= 30 minutes.
 ----
 === ENCRYPT: Start Encrypted Session ===
-Will cause all future messages from the server, except the first (the reply to the ENCRYPT command itself), to be encrypted (128 bit [http://en.wikipedia.org/wiki/Advanced_Encryption_Standard AES]). The client will also have to encrypt all future requests sent to the server. All non-encrypted messages will be discarded by the server. The encryption key is the [http://en.wikipedia.org/wiki/MD5 MD5] hash of a special ''API Password'' (defined in the users profile) concatenated with the salt string as given in the reply to the ENCRYPT message. A normal AUTH message is still necessary to authenticate and should follow the ENCRYPT command once the API has acknowledged the encryption.
+Will cause all future messages from the server, except the first (the reply to the ENCRYPT command itself), to be encrypted (128 bit [[Wikipedia:Advanced Encryption Standard|AES]]). The client will also have to encrypt all future requests sent to the server. All non-encrypted messages will be discarded by the server. The encryption key is the [[Wikipedia:MD5|MD5]] hash of a special ''UDP API Key'' (defined in the users profile) concatenated with the salt string as given in the reply to the ENCRYPT message. A normal AUTH message is still necessary to authenticate and should follow the ENCRYPT command once the API has acknowledged the encryption.
 '''Command String:'''
@@ Line 245: / Line 249: @@
 * ''user'' is the user name.
 * ''type'' is the type of encryption; 1 => 128 bit AES (only one defined).
-* ''API Password'' is the one defined in the profile settings [http://anidb.info/perl-bin/animedb.pl?show=profile page].
+* ''API Key'' is the one defined in the {{AniDBLink|profile|profile settings page}}.
 * It is not possible to disable the encryption once enabled while staying logged in.
 ** A logout (the logout message needs to be correctly encrypted) or timeout will disable the encryption.
 * In order to minimize server load, encryption should be disabled by default and should have to be enabled manually by the user in the configuration options.
-* The encryption key is md5(api_password_of_user+''salt'').
+* The encryption key is md5(api_key_of_user+''salt'').
 * Padding of the message needs to be done according to the PKCS5Padding scheme.
 == Notify Commands ==
 === Introduction ===
 Broadly speaking, notifications provide an indication to the client that some event has occurred within the AniDB database.
@@ Line 269: / Line 270: @@
 === Getting Notifications ===
 Clients that wish to receive notifications have two routes available to them.  They are by no means mutually exclusive and selecting one does not imply a client is unable to use commands from another.
@@ Line 284: / Line 284: @@
 * Use NOTIFY (no more than once every 20 minutes) to get the number of pending notifications
 * IF there are new notifications pending, use NOTIFYLIST to get a list of notification types and associated IDs.
-* Use NOTIFYGET to receive a notification, suppling the ID provided by NOTIFYLIST
+* Use NOTIFYGET to receive a notification, supplying the ID provided by NOTIFYLIST
-* Use NOTIFYACK to acknowledge a notification, suppling the ID provided by NOTIFYLIST (if desired)
+* Use NOTIFYACK to acknowledge a notification, supplying the ID provided by NOTIFYLIST (if desired)
-{{eyecatch|NOTE|The ID supplied by NOTIFYLIST will be the ID of the affected notification type.  Since, at present, only the anime type is supported, this value is always an aid.  In the future, it may represent a group or producer ID.  In these cases, the str '''type''' value will indicate what entity the ID represents.}}
+{{eyecatch|Note|The ID supplied by NOTIFYLIST will be the ID of the affected notification type.  Since, at present, only the anime type is supported, this value is always an aid.  In the future, it may represent a group or producer ID.  In these cases, the str '''type''' value will indicate what entity the ID represents.}}
 '''Method Two: Server PUSH'''
-With this method, the server takes the active role in advising the client that a new file has arrived.  The client must register with the server to receive these advisements, and will be responsible for keeping the login session from timing out, and any NAT router ports open.  The UDP packet is sent to the ip and port from which the AUTH command was recieved.
+With this method, the server takes the active role in advising the client that a new file has arrived.  The client must register with the server to receive further advice information, and will be responsible for keeping the login session from timing out, and any NAT router ports open.  The UDP packet is sent to the ip and port from which the AUTH command was received.
 This method compensates for the disadvantages of the polling method, but is more difficult to code.  Blocking sockets are no longer an option, nor can a client make any assumptions that an incoming packet will necessarily be a reply to the last command sent.  The tag option may be helpful here.
@@ Line 299: / Line 298: @@
 * PUSH to register your client session.
-* Listen for 271-274 NOTIFICATIONs ('''not 290''').
+* Listen for 720-799 NOTIFICATIONs ('''not 290''').
 * Use PUSHACK to to acknowledge the notification using the nid supplied with NOTIFICATION
 * Use NOTIFYGET to receive a notification, suppling the relid provided by NOTIFICATION (NOT the packet ID)
 * Use NOTIFYACK to acknowledge a notification, suppling the relid provided by NOTIFICATION (if desired)
 * Use UPTIME (with an interval between 30 and 35 minutes) to keep login session valid
 It is probably a good idea to use tags to separate NOTIFICATIONs from the other communication. NOTIFICATIONs will '''never''' have tags.
 === PUSH: UDP Notification Registration ===
-Register your client as an observer for anidb notification events for the current user. If you are registered for one or more event types the anidb server will send an UDP packet (format see below) on each change which affects the current user.
+Register your client as an observer for AniDB notification events for the current user. If you are registered for one or more event types the AniDB server will send an UDP packet (format see below) on each change which affects the current user.
 '''Command String:'''
@@ Line 321: / Line 318: @@
 '''Info:'''
-* A client which has registered to recieve UDP notification packets must:
+* A client which has registered to receive UDP notification packets must:
 ** Issue a PUSHACK command for each notification received with ''notify_packet_id'' provided in the notification packet.
 ** Use PING to keep the connection alive (< 30 min).
 ** Use UPTIME to ensure that the session is OK (>= 30 min).
-* Every notification generated is resent 3 times unless acknowleged. After that the client is logged out.
+* Every notification generated is resent 3 times unless acknowledged. After that the client is logged out.
-====Notification Packet Format====
+=== NOTIFY: Notifications ===
-'''New File Notify:'''
+Get number of pending notifications (and number of online buddies).
-{int4 notify_packet_id} NOTIFICATION
+'''Command String:'''
-  {int4 relid}|{int4 date}|{int4 count}|{str relname}|{int2 reltype}|{int2 priority}
+* NOTIFY [buddy=1]
-* relid is the id of the related entry (anime, group)
+'''Possible Replies:'''
-* date is the time of the event (in seconds since 1.1.1970)
+* 290 NOTIFICATION
-* count is the number of events pending for type
+: {int4 pending_file_notifications}|{int4 number_of_unread_messages}
-* relname is the name of the related entry
+when ''buddy=1''
-* reltype is: 1 = anime, 2 = group, 3 = producer
+* 290 NOTIFICATION
-* priority is: 0 = low, 1 = medium, 2 = high
+: {int4 pending_file_notifications}|{int4 number_of_unread_messages}|{int4 number_of_online_buddies}
-{{eyecatch|NOTE| Group (and producer) related file notifications are not implemented yet.}}
+'''Info:'''
+* If the client did send a NOTIFY within the last 35 minutes and it was confirmed by AniDB then receiving a 501 LOGIN FIRST message for the next NOTIFY command shows that AniDB logged the client out because it did not respond to a PUSH Notification packet.
+* There is no command to retrieve missed PUSH Notifications.
+{{eyecatch|Note|This command MUST NOT be issued more than once every 20 minutes.}}
-'''New Private Message Notify:'''
+----
+=== NOTIFYLIST: List Notification/Message IDs ===
+List id of all pending (not acknowledged) ''new private message'' and ''new file'' notifications. Buddy events cannot be acknowledged.
-{int4 notify_packet_id} NOTIFICATION
+'''Command String:'''
-  {int2 type}|{int4 date}|{int4 sent_by_uid}|{str sent_by_name}|{str subject}|{str body}|{int mid}
+* NOTIFYLIST
-* type is the type of the message (0=normal msg, 1=annonymous, 2=system msg, 3=mod msg)
+'''Possible Replies:'''
-* date is the time the message was sent (in seconds since 1.1.1970)
+*291 NOTIFYLIST
-* senderuid/sendername are the user id and username of the sender
+: {str type}|{int4 id}
-* subject is the message subject
+: {str type}|{int4 id}
-* body is message body (can be truncated)
+: ...
-* mid is message id and can be used with NOTIFYACK
-'''Buddy Event Notify:'''
+'''Info:'''
-{int4 notify_packet_id} NOTIFICATION
+* type is:
-  {int4 buddy uid}|{int2 event type}
+: M for message entries
-* Possible event types:
+: N for notification entries
-** 0 => LOGIN
+* id is the identifier for the notification/message as required by NOTIFYGET. For messages it is the actual message id, for notifications it is the id of the related type; anime, group or producer. Since only file notifications related to anime is implemented atm, it is the anime id (aid).
-** 1 => LOGOUT
+* NOTIFYLIST returns one line per entry, if no entries are available only the first line of the reply is returned.
-** 2 => ACCEPTED
+{{eyecatch|Note|This command MUST NOT be issued regularly but should only be triggered by either a push message received by the client or a reply to a NOTIFY command which tells you that there are messages/notifications waiting.}}
-** 3 => ADDED
-'''Going Down Event Notify:'''
-{int4 notify_packet_id} NOTIFICATION
-  {int4 time offline}|{int4 comment}
-* Clients with any notification on will receive the GOINGDOWN message before the API goes offline.
-* Time offline is the time in minutes the API will be down, 0 if indefinite (client can direct user to the anidb site for status updates).
-* The comment is a short explanation for the downtime.
-* Only one datagram will be sent, and the server will not listen for replies.
 ----
+=== NOTIFYGET: Get Notification/Message ===
-=== PUSHACK: UDP Notification Acknowledge ===
+Receive private message or file notification.
-Used to acknowledge notification packets (271-274). A client must be prepared to issue this command before using '''PUSH'''.
 '''Command String:'''
-* PUSHACK nid={int4 notify_packet_id}
+* NOTIFYGET type={str type}&id={int4 id}
-'''Possible Replies:'''
+'''Possible Replies:'''<br>
-* 280 PUSHACK CONFIRMED
+when type = M
-* 380 NO SUCH PACKET PENDING
+* 292 NOTIFYGET
+: {int4 id}|{int4 from_user_id}|{str from_user_name}|{int4 date}|{int4 type}|{str title}|{str body}
+* 392 NO SUCH ENTRY
+when type = N
+* 293 NOTIFYGET
+: {int4 relid}|{int4 type}|{int2 count}|{int4 date}|{str relidname}|{str fids}
+* 393 NO SUCH ENTRY
 '''Info:'''
-* See: '''PUSH'''
+* type is:
+: M for message entries
+: N for notification entries
+* id is the identifier for the notification/message as given by NOTIFYLIST (or ''relid'' from 271 NOTIFICATION and mid from 272 NOTIFICATION)
+* for message entries (M):
+: date is the time of the event (in seconds since 1.1.1970)
+: type is the type of the message (0=normal msg, 1=annonymous, 2=system msg, 3=mod msg)
+* for notification entries (N):
+: relid is the id of the related type (anime)
+: relname is the name of the related type (anime)
+: type is the notification type (0=all, 1=new, 2=group, 3=complete)
+: count is the number of events pending for this subscription
+: date is the time of the event (in seconds since 1.1.1970)
+: fids is a comma separated list with the affected file ids
 ----
-=== NOTIFY: Notifications ===
+=== NOTIFYACK: Acknowledge Notification/Message ===
-Get number of pending notifications (and number of online buddies).
+This command will mark a message read or clear a ''new file'' notification. Buddy events are not acknowledgeable.
 '''Command String:'''
-* NOTIFY [buddy=1]
+* NOTIFYACK type={str type}&id={int4 id}
-'''Possible Replies:'''
+'''Possible Replies:'''<br>
-* 290 NOTIFICATION
+when type = M
-: {int4 pending_file_notifications}|{int4 number_of_unread_messages}
+* 281 NOTIFYACK SUCCESSFUL
-when ''buddy=1''
+* 381 NO SUCH ENTRY
-* 290 NOTIFICATION
+when type = N
-: {int4 pending_file_notifications}|{int4 number_of_unread_messages}|{int4 number_of_online_buddies}
+* 282 NOTIFYACK SUCCESSFUL
+* 382 NO SUCH ENTRY
 '''Info:'''
-* If the client did send a NOTIFY within the last 35 minutes and it was confirmed by AniDB then recieving a 501 LOGIN FIRST message for the next NOTIFY command shows that AniDB logged the client out because it did not respond to a PUSH Notification packet.
+* type is:
-* There is no command to retrieve missed PUSH Notifications.
+: M for message entries
-{{eyecatch|NOTE| This command MUST NOT be issued more than once every 20 minutes.}}
+: N for notification entries
-----
+====Notification Packet Format====
+'''New File Notify:'''
-=== NOTIFYLIST: List Notification/Message IDs ===
+{int4 notify_packet_id} NOTIFICATION - NEW FILE
-List id of all pending (not acknowledged) ''new private message'' and ''new file'' notifications. Buddy events are not acknowledgeable.
+  {int4 fidlist}|{int2 reltype}|{int2 priority}
-'''Command String:'''
+* fidlist is a comma separated list of file ids
-* NOTIFYLIST
+* reltype is: 1 = anime, 2 = group, 3 = producer
+* priority is: 0 = low, 1 = medium, 2 = high
+* new file notifications are created as a batch, so it is not unusual to get several new files for a particular anime at once.  It is in this case that a comma separated list of fids will be returned
-'''Possible Replies:'''
+{{eyecatch|Note|Group (and producer) related file notifications are not implemented yet.}}
-*291 NOTIFYLIST
-: {str type}|{int4 id}
-: {str type}|{int4 id}
-: ...
-'''Info:'''
-* type is:
-: M for message entries
-: N for notification entries
-* id is the identifier for the notification/message as required by NOTIFYGET. For messages it is the actual message id, for notifications it is the id of the related type; anime, group or producer. Since only file notifications related to anime is implemented atm, it is the anime id (aid).
-* NOTIFYLIST returns one line per entry, if no entries are available only the first line of the reply is returned.
-{{eyecatch|NOTE| This command MUST NOT be issued regulary but should only be triggered by either a push message recieved by the client or a reply to a NOTIFY command which tells you that there are messages/notifications waiting.}}
-----
+'''New Private Message Notify:'''
+{int4 notify_packet_id} NOTIFICATION - NEW MESSAGE
+  {int2 type}|{int4 date}|{int4 sent_by_uid}|{str sent_by_name}|{str subject}|{str body}|{int mid}
-=== NOTIFYGET: Get Notification/Message ===
+* type is the type of the message (0=normal msg, 1=anonymous, 2=system msg, 3=mod msg)
-Receive private message or file notification.
+* date is the time the message was sent (in seconds since 1.1.1970)
+* sender uid/sender name are the user id and user name of the sender
+* subject is the message subject
+* body is message body (can be truncated)
+* mid is message id and can be used with NOTIFYACK
-'''Command String:'''
+'''Buddy Event Notify:'''
-* NOTIFYGET type={str type}&id={int4 id}
+{int4 notify_packet_id} NOTIFICATION - BUDDY
+  {int4 buddy uid}|{int2 event type}
+* Possible event types:
+** 0 => LOGIN
+** 1 => LOGOUT
+** 2 => ACCEPTED
+** 3 => ADDED
-'''Possible Replies:'''<br>
-when type = M
-* 292 NOTIFYGET
-: {int4 id}|{int4 from_user_id}|{str from_user_name}|{int4 date}|{int4 type}|{str title}|{str body}
-* 392 NO SUCH ENTRY
-when type = N
-* 293 NOTIFYGET
-: {int4 relid}|{int4 type}|{int2 count}|{int4 date}|{str relidname}|{str fids}
-* 393 NO SUCH ENTRY
-'''Info:'''
+'''Going Down Event Notify:'''
-* type is:
+{int4 notify_packet_id} NOTIFICATION - SHUTTING DOWN
-: M for message entries
+  {int4 time offline}|{int4 comment}
-: N for notification entries
-* id is the identifier for the notification/message as given by NOTIFYLIST (or ''relid'' from 271 NOTIFICATION and mid from 272 NOTIFICATION)
+* Clients with any notification on will receive the SHUTTING DOWN message before the API goes offline.
-* for message entries (M):
+* Time offline is the time in minutes the API will be down, 0 if indefinite (client can direct user to the AniDB site for status updates).
-: date is the time of the event (in seconds since 1.1.1970)
+* The comment is a short explanation for the downtime.
-: type is the type of the message (0=normal msg, 1=annonymous, 2=system msg, 3=mod msg)
+* Only one datagram will be sent, and the server will not listen for replies.
-* for notification entries (N):
-: relid is the id of the related type (anime)
-: relname is the name of the related type (anime)
-: type is the notification type (0=all, 1=new, 2=group, 3=complete)
-: count is the number of events pending for this subscription
-: date is the time of the event (in seconds since 1.1.1970)
-: fids is a comma separated list with the affected file ids
-----
-=== NOTIFYACK: Acknowledge Notification/Message ===
+=== PUSHACK: UDP Notification Acknowledge ===
-This command will mark a message read or clear a ''new file'' notification. Buddy events are not acknowledgeable.
+Used to acknowledge notification packets (720-799). A client must be prepared to issue this command before using '''PUSH'''.
 '''Command String:'''
-* NOTIFYACK type={str type}&id={int4 id}
+* PUSHACK nid={int4 notify_packet_id}
-'''Possible Replies:'''<br>
+'''Possible Replies:'''
-when type = M
+* 701 PUSHACK CONFIRMED
-* 281 NOTIFYACK SUCCESSFUL
+* 702 NO SUCH PACKET PENDING
-* 381 NO SUCH ENTRY
-when type = N
+'''Info:'''
-* 282 NOTIFYACK SUCCESSFUL
+* See: '''PUSH'''
-* 382 NO SUCH ENTRY
+== Notification Commands ==
+=== NOTIFICATIONADD: Add Anime or Group to Notify List ===
+'''Command String:'''<br>
+by anime id:
+* NOTIFICATIONADD aid={int4 aid}&type={int2 type}&priority={int2 priority}
+by group id:
+* NOTIFICATIONADD gid={int4 gid}&type={int2 type}&priority={int2 priority}
+<br>
+'''Possible Replies:'''
+* 246 NOTIFICATION ITEM ADDED
+: {int4 notification id}
+* 248 NOTIFICATION ITEM UPDATED
+: {int4 notification id}
+* 399 NO CHANGES
+<br>
+'''Info:'''
+* ''Priority'' values are 0: low, 1: medium, 2: high
+* ''Type'' values are 0: all, 1: new, 2: group, 3: complete
+=== NOTIFICATIONDEL: Remove Anime or Group from Notify List ===
+'''Command String:'''<br>
+by anime id:
+* NOTIFICATIONDEL aid={int4 aid}
+by group id:
+* NOTIFICATIONDEL gid={int4 gid}
+<br>
+'''Possible Replies:'''
+* 247 NOTIFICATION ITEM DELETED
+: {int4 notification_table}|{int4 relid}
+* 324 NO SUCH NOTIFICATION ITEM
+<br>
 '''Info:'''
-* type is:
+* ''notification_table'' values are 1: anime, 2: group
-: M for message entries
+* ''relid'' value matches the aid/gid supplied
-: N for notification entries
 == Buddy Commands ==
@@ Line 494: / Line 531: @@
 ----
 === BUDDYDEL: Remove a user from Buddy List ===
 '''Command String:'''
@@ Line 503: / Line 539: @@
 ----
 === BUDDYACCEPT: Accept user as Buddy ===
 '''Command String:'''
@@ Line 513: / Line 548: @@
 ----
 === BUDDYDENY: Deny user as Buddy ===
 '''Command String:'''
@@ Line 523: / Line 557: @@
 ----
 === BUDDYLIST: Retrieve Buddy List ===
 '''Command String:'''
@@ Line 538: / Line 571: @@
 ----
 === BUDDYSTATE: Retrieve Buddy States===
 '''Command String:'''
@@ Line 557: / Line 589: @@
 '''Command String:'''<br>
 by aid
-* ANIME aid={int4 id}&amask={hexstr}
+* ANIME aid={int4 id}[&amask={hexstr}]
 by name
-* ANIME aname={str anime name}&amask={hexstr}
+* ANIME aname={str anime name}[&amask={hexstr}]
 '''Possible Replies:'''
+If no ''amask'' is provided:
 * 230 ANIME
 : {int4 aid}|{int4 eps}|{int4 ep count}|{int4 special cnt}|{int4 rating}|{int4 votes}|{int4 tmprating}|{int4 tmpvotes}|{int4 review rating average}|{int4 reviews}|{str year}|{str type}|{str romaji}|{str kanji}|{str english}|{str other}|{str short names}|{str synonyms}|{str category list}
@@ Line 569: / Line 603: @@
 * Fields are returned in the same order they appear in the ''amask'' field list: byte 1, bit 7 first
 * Synonyms and short names are separated with '
-* Category fields are separated with ',' and ordered by weight (desc).
+* Category fields are separated with ',' and ordered by weight (desc).  ''However'', be aware that categories are no longer used nor updated internally, and category responses are only returned to avoid breaking older clients.  Use tags as a replacement.
 * By name: must be perfect match of romaji/kanji/english/other/synonym/short name.
-* NOTE: The category list is the first data to be truncated if needed. And then: synonym list, short name list. This applies for the FILE command too.
+* 'Producer id list' and 'producer name list' match the data returned by the former producer bits (but using the revised creator ids)
+* Date flags are used to indicated an unknown value (unknown month, day, year)
+* ''dateflags'' values:
+** bit0 set == Startdate, Unknown Day
+** bit1 set == Startdate, Unknown Month, Day
+** bit2 set == Enddate, Unknown Day
+** bit3 set == Enddate, Unknown Month, Day
+** bit4 set == AirDate in the Past/Anime has ended
+** bit5 set == Startdate, Unknown Year
+** bit6 set == Enddate, Unknown Year
+* '''Note:''' The character id list is the first data to be truncated if needed. And then: tag list, synonym list, short name list. This applies to the FILE command too.
 * Selecting an 'unused' or 'reserved' bit will return an "illegal input" (505) response.
 <table border="0" cellpadding="0" cellspacing="2">
-  <tr><td colspan="5" align="center">'''amask'''</td></tr>
+  <tr><td colspan="5" align="center"><b>amask</b></td></tr>
   <tr>
-   <td align="center">'''Byte 1'''</td>
+   <td align="center"><b>Byte 1</b></td>
-   <td align="center">'''Byte 2'''</td>
+   <td align="center"><b>Byte 2</b></td>
-   <td align="center">'''Byte 3'''</td>
+   <td align="center"><b>Byte 3</b></td>
-   <td align="center">'''Byte 4'''</td>
+   <td align="center"><b>Byte 4</b></td>
-   <td align="center">'''Byte 5'''</td>
+   <td align="center"><b>Byte 5</b></td>
+  <td align="center"><b>Byte 6</b></td>
+  <td align="center"><b>Byte 7</b></td>
   </tr>
   <tr>
@@ Line 587: / Line 634: @@
     <table>
      <tr>
-      <td>'''Bit'''</td>
+      <td><b>Bit</b></td>
-      <td align="right">'''Dec'''</td>
+      <td align="right"><b>Dec</b></td>
-      <td>'''Data Field'''</td>
+      <td><b>Data Field</b></td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>7</td>
       <td align="right">128</td>
@@ Line 599: / Line 646: @@
       <td>6</td>
       <td align="right">64</td>
-      <td>unused</td>
+      <td>int dateflags</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>5</td>
       <td align="right">32</td>
@@ Line 611: / Line 658: @@
       <td>str type</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>3</td>
       <td align="right">8</td>
@@ Line 621: / Line 668: @@
       <td>str related aid type</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>1</td>
       <td align="right">2</td>
-      <td>str category list</td>
+      <td><i>retired</i></td>
      </tr>
      <tr>
       <td>0</td>
       <td align="right">1</td>
-      <td>str category weight list</td>
+      <td><i>retired</i></td>
      </tr>
     </table>
@@ Line 636: / Line 683: @@
     <table>
      <tr>
-      <td>'''Bit'''</td>
+      <td><b>Bit</b></td>
-      <td align="right">'''Dec'''</td>
+      <td align="right"><b>Dec</b></td>
-      <td>'''Data Field'''</td>
+      <td><b>Data Field</b></td>
      </tr>
      <tr>
@@ Line 645: / Line 692: @@
       <td>str romaji name</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>6</td>
       <td align="right">64</td>
@@ Line 655: / Line 702: @@
       <td>str english name</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>4</td>
       <td align="right">16</td>
@@ Line 665: / Line 712: @@
       <td>str short name list</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>2</td>
       <td align="right">4</td>
@@ Line 673: / Line 720: @@
       <td>1</td>
       <td align="right">2</td>
-      <td>str producer name list</td>
+      <td><i>retired</i></td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>0</td>
       <td align="right">1</td>
-      <td>str producer id list</td>
+      <td><i>retired</i></td>
      </tr>
     </table>
@@ Line 685: / Line 732: @@
     <table>
      <tr>
-      <td>'''Bit'''</td>
+      <td><b>Bit</b></td>
-      <td align="right">'''Dec'''</td>
+      <td align="right"><b>Dec</b></td>
-      <td>'''Data Field'''</td>
+      <td><b>Data Field</b></td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>7</td>
       <td align="right">128</td>
@@ Line 697: / Line 744: @@
       <td>6</td>
       <td align="right">64</td>
-      <td>int4 normal ep count</td>
+      <td>int4 highest episode number</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>5</td>
       <td align="right">32</td>
@@ Line 707: / Line 754: @@
       <td>4</td>
       <td align="right">16</td>
-      <td>int4 air date</td>
+      <td>int air date</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>3</td>
       <td align="right">8</td>
-      <td>int4 end date</td>
+      <td>int end date</td>
      </tr>
      <tr>
@@ Line 719: / Line 766: @@
       <td>str url</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>1</td>
       <td align="right">2</td>
@@ Line 727: / Line 774: @@
       <td>0</td>
       <td align="right">1</td>
-      <td>str category id list</td>
+      <td><i>retired</i></td>
      </tr>
     </table>
@@ Line 734: / Line 781: @@
     <table>
      <tr>
-      <td>'''Bit'''</td>
+      <td><b>Bit</b></td>
-      <td align="right">'''Dec'''</td>
+      <td align="right"><b>Dec</b></td>
-      <td>'''Data Field'''</td>
+      <td><b>Data Field</b></td>
      </tr>
      <tr>
@@ Line 743: / Line 790: @@
       <td>int4 rating</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>6</td>
       <td align="right">64</td>
-      <td>int4 vote count</td>
+      <td>int vote count</td>
      </tr>
      <tr>
@@ Line 753: / Line 800: @@
       <td>int4 temp rating</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>4</td>
       <td align="right">16</td>
-      <td>int4 temp vote count</td>
+      <td>int temp vote count</td>
      </tr>
      <tr>
@@ Line 763: / Line 810: @@
       <td>int4 average review rating</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>2</td>
       <td align="right">4</td>
-      <td>int4 review count</td>
+      <td>int review count</td>
      </tr>
      <tr>
@@ Line 773: / Line 820: @@
       <td>str award list</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>0</td>
       <td align="right">1</td>
-      <td>reserved</td>
+      <td>bool is 18+ restricted</td>
      </tr>
     </table>
@@ Line 783: / Line 830: @@
     <table>
      <tr>
-      <td>'''Bit'''</td>
+      <td><b>Bit</b></td>
-      <td align="right">'''Dec'''</td>
+      <td align="right"><b>Dec</b></td>
-      <td>'''Data Field'''</td>
+      <td><b>Data Field</b></td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>7</td>
       <td align="right">128</td>
-      <td>int4 anime planet id</td>
+      <td><i>retired</i></td>
      </tr>
      <tr>
       <td>6</td>
       <td align="right">64</td>
-      <td>int4 ANN id</td>
+      <td>int ANN id</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>5</td>
       <td align="right">32</td>
-      <td>int4 allcinema id</td>
+      <td>int allcinema id</td>
      </tr>
      <tr>
       <td>4</td>
       <td align="right">16</td>
-      <td>str animenfo id</td>
+      <td>str AnimeNfo id</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>3</td>
       <td align="right">8</td>
-      <td>unused</td>
+      <td>str tag name list</td>
      </tr>
      <tr>
       <td>2</td>
       <td align="right">4</td>
-      <td>unused</td>
+      <td>int tag id list</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>1</td>
       <td align="right">2</td>
-      <td>unused</td>
+      <td>int tag weight list</td>
      </tr>
      <tr>
       <td>0</td>
       <td align="right">1</td>
-      <td>reserved</td>
+      <td>int date record updated</td>
      </tr>
     </table>
    </td>
- </tr>
+  <td>
-</table>
+   <table>
+    <tr>
-----
+     <td><b>Bit</b></td>
+     <td align="right"><b>Dec</b></td>
+     <td><b>Data Field</b></td>
+    </tr>
-=== ANIMEDESC: Retrieve Anime Description ===
+    <tr bgcolor="#eeeeee">
-'''Command String:'''<br>
+     <td>7</td>
-by aid
+     <td align="right">128</td>
-* ANIMEDESC aid={int4 id}&part={int4 partno}
+     <td>int character id list</td>
+    </tr>
-'''Possible Replies:'''
+    <tr>
-* 233 ANIMEDESC
+     <td>6</td>
-: {int4 current part}|{int4 max parts}|{str description}
+     <td align="right">64</td>
-* 330 NO SUCH ANIME
+     <td><i>retired</i></td>
-* 333 NO SUCH DESCRIPTION
+    </tr>
+    <tr bgcolor="#eeeeee">
-'''Info:'''
+     <td>5</td>
-* The maximum length of the anime description is roughly 5000 characters, but the maximum length of a UDP packet is 1400 bytes
+     <td align="right">32</td>
-* Multiple calls to ANIMEDESC may be necessary to retrieve the complete text, retrieving separate 1400 byte parts with each call
+     <td><i>retired</i></td>
-* ''part'' is zero-based
+    </tr>
-* Note: No support, at present, for retrieving descriptions by title.  ''aid'' only
+    <tr>
+     <td>4</td>
+     <td align="right">16</td>
-'''Examples:''' (html escaped code intended)
+     <td><i>retired</i></td>
-   > ANIMEDESC aid=3169&part=0&s=xxxxx
+    </tr>
-   < 233 ANIMEDESC
+    <tr bgcolor="#eeeeee">
-|1|As summer break arrives for the students, Jun Sakurada is busily studying on his own in the library, making up for time lost <cut>
+     <td>3</td>
+     <td align="right">8</td>
-----
+     <td>unused</td>
-=== EPISODE: Retrieve Episode Data ===
+    </tr>
-'''Command String:'''<br>
+    <tr>
-by eid
+     <td>2</td>
-* EPISODE eid={int4 eid}
+     <td align="right">4</td>
-by anime and episode number
+     <td>unused</td>
-* EPISODE aname={str anime name}&epno={int4 episode number}
+    </tr>
-* EPISODE aid={int4 anime id}&epno={int4 episode number}
+    <tr bgcolor="#eeeeee">
+     <td>1</td>
-'''Possible Replies:'''
+     <td align="right">2</td>
-* 240 EPISODE
+     <td>unused</td>
-: {int4 eid}|{int4 aid}|{int4 length}|{int4 rating}|{int4 votes}|{str epno}|{str eng}|{str romaji}|{str kanji}|{int4 aired}
+    </tr>
-* 340 NO SUCH EPISODE
+    <tr>
+     <td>0</td>
-'''Info:'''
+     <td align="right">1</td>
-* length is in minutes
+     <td>unused</td>
-* Returned 'epno' includes special character (only if special) and padding (only if normal). Special characters are S(special), C(credits), T(trailer), P(parody), O(other).
+    </tr>
+   </table>
-'''Examples:''' (html escaped code intended)
+   </td>
-  > EPISODE eid=1&s=xxxxx
+   <td>
-  < 240 EPISODE
+   <table>
-|1|24|400|4|01|Invasion|shinryaku|??
+     <tr>
+     <td><b>Bit</b></td>
-  > EPISODE aname=Seikai no Monshou&epno=2&s=xxxxx
+     <td align="right"><b>Dec</b></td>
-  < 240 EPISODE
+     <td><b>Data Field</b></td>
-|1|24|750|2|02|Kin of the Stars|Hoshi-tachi no Kenzoku|??????
+    </tr>
+    <tr bgcolor="#eeeeee">
-----
+     <td>7</td>
+     <td align="right">128</td>
+     <td>int4 specials count</td>
+    </tr>
+    <tr>
+     <td>6</td>
+     <td align="right">64</td>
+     <td>int4 credits count</td>
+    </tr>
+    <tr bgcolor="#eeeeee">
+     <td>5</td>
+     <td align="right">32</td>
+     <td>int4 other count</td>
+    </tr>
+    <tr>
+     <td>4</td>
+     <td align="right">16</td>
+     <td>int4 trailer count</td>
+    </tr>
+    <tr bgcolor="#eeeeee">
+     <td>3</td>
+     <td align="right">8</td>
+     <td>int4 parody count</td>
+    </tr>
+    <tr>
+     <td>2</td>
+     <td align="right">4</td>
+     <td>unused</td>
+    </tr>
+    <tr bgcolor="#eeeeee">
+     <td>1</td>
+     <td align="right">2</td>
+     <td>unused</td>
+    </tr>
+    <tr>
+     <td>0</td>
+     <td align="right">1</td>
+     <td>unused</td>
+    </tr>
+   </table>
+   </td>
+ </tr>
+</table>
-=== FILE: Retrieve File Data ===
-'''Command String:'''<br>
-by fid:
-* FILE fid={int4 id}&fmask={hexstr fmask}&amask={hexstr amask}
-by size+ed2k hash:
-* FILE size={int8 size}&ed2k={str ed2khash}&fmask={hexstr fmask}&amask={hexstr amask}
-by anime, group and epno
-* FILE aname={str anime name}&gname={str group name}&epno={int4 episode number}&fmask={hexstr fmask}&amask={hexstr amask}
-* FILE aname={str anime name}&gid={int4 group id}&epno={int4 episode number}&fmask={hexstr fmask}&amask={hexstr amask}
-* FILE aid={int4 anime id}&gname={str group name}&epno={int4 episode number}&fmask={hexstr fmask}&amask={hexstr amask}
-* FILE aid={int4 anime id}&gid={int4 group id}&epno={int4 episode number}&fmask={hexstr fmask}&amask={hexstr amask}
-'''Possible Replies:'''
+'''Related aid type (Byte 1, Bit 2):'''
-* 220 FILE
+<pre>
-: {int4 fid}|{int4 aid}|{int4 eid}|{int4 gid}|{int4 state}|{int8 size}|{str ed2k}|{str anidbfilename}
+value      meaning
-* 220 FILE
-: {int4 fid}|...(data list)
+      sequel
-* 322 MULTIPLE FILES FOUND
+      prequel
-: {int4 fid 0}|{int4 fid 1}|...|{int4 fid n}
+      same setting
-* 320 NO SUCH FILE
+      alternative setting
+      alternative version
+      music video
+      character
+      side story
+      parent story
+      summary
+      full story
+      other
+</pre>
+'''Examples:''' (note that the given amask gives the same result as the default request)
+  > ANIME aid=1&amask=b2f0e0fc000000&s=xxxxx
+  < 230 ANIME
+|1999-1999|TV Series|Space,Future,Plot Continuity,SciFi,Space Travel,Shipboard,Other Planet,Novel,Genetic Modification,Action,Romance,Military,Large Breasts,Gunfights,Adventure,Human Enhancement,Nudity|Seikai no Monshou|星界の紋章|Crest of the Stars||13|13|3|853|3225|756|110|875|11
-'''Info:'''
+----
-* fid, aid, eid, gid are the unique ids for the file, anime, ep, group entries at anidb.
-: You can use those to create links to the corresponding pages at anidb.
-* anidbfilename is the anidb filename for the file.
-: However this name does not contain all the extra information of the filenames on AniDB and might be composed slightly different.
-* fmask and amask are hexidecimal strings where each bit corresponds to a data field related to the specified file (see below). The data list received is sorted in the same order as the tables (and fmask before amask).  There is '''no''' provision to retrieve all fields.  Further, requesting a 'unusued' or 'reserved' bit will return an "illegal input" error.
-* Only the first matching file is returned when aname, gname and epno is used.
-'''State:'''
+=== ANIMEDESC: Retrieve Anime Description ===
-<pre>
+'''Command String:'''<br>
-bit / int value 	meaning
+by aid
-/ 1 		FILE_CRCOK: file matched official crc (displayed with green background in anidb)
+* ANIMEDESC aid={int4 id}&part={int4 partno}
-/ 2 		FILE_CRCERR: file DID NOT match official crc (displayed with red background in anidb)
-/ 4 		FILE_ISV2: file is version 2
+'''Possible Replies:'''
-/ 8 		FILE_ISV3: file is version 3
+* 233 ANIMEDESC
-/ 16 		FILE_ISV4: file is version 4
+: {int4 current part}|{int4 max parts}|{str description}
-/ 32 		FILE_ISV5: file is version 5
+* 330 NO SUCH ANIME
-/ 64 		FILE_UNC: file is uncensored
+* 333 NO SUCH DESCRIPTION
-/ 128		FILE_CEN: file is censored
+'''Info:'''
+* The maximum length of the anime description is roughly 5000 characters, but the maximum length of a UDP packet is 1400 bytes
+* Multiple calls to ANIMEDESC may be necessary to retrieve the complete text, retrieving separate 1400 byte parts with each call
+* ''part'' is zero-based
+* '''Note:''' No support, at present, for retrieving descriptions by title.  ''aid'' only
-examples:
-state ==== 9 ==> FILE_CRCOK+FILE_ISV3 ==> file matched official crc and is version 3
-state ==== 0 ==> - ==> file was not crc checked and is version 1
-state ==== 34 ==> FILE_CRCERR+FILE_ISV5 ==> file DID NOT match official crc and is version 5
-state ==== 1 ==> FILE_CRCOK ==> file matched official crc and is version 1
-state ==== 8 ==> FILE_ISV3 ==> file was not crc checked and is version 3
-</pre>
-<table border="0" cellpadding="0" cellspacing="2">
+'''Examples:''' (html escaped code intended)
- <tr><td colspan="4" align="center">'''fmask:'''</td></tr>
+  > ANIMEDESC aid=3169&part=0&s=xxxxx
- <tr>
+  < 233 ANIMEDESC
-  <td align="center">'''Byte 1'''</td>
+|1|As summer break arrives for the students, Jun Sakurada is busily studying on his own in the library, making up for time lost <cut>
-  <td align="center">'''Byte 2'''</td>
-  <td align="center">'''Byte 3'''</td>
+----
-  <td align="center">'''Byte 4'''</td>
+=== CALENDAR: Get Upcoming Titles ===
- </tr>
+Returns the anime ids of the 25 most recently aired / released anime, directly followed by the next 25 anime due to be aired / released, ordered by start date.
- <tr>
-  <td>
+'''Command String:'''
-   <table>
+* CALENDAR
-    <tr>
-     <td>'''Bit'''</td>
+'''Possible Replies:'''
-     <td align="right">'''Dec'''</td>
+* 297 CALENDAR
-     <td>'''Data Field'''</td>
+{int aid}|{int startdate}|{int dateflags}/n
-    </tr>
-    <tr bgcolor="#eee">
+..repeated n times
-     <td>7</td>
-     <td align="right">128</td>
+* 397 CALENDAR EMPTY
-     <td>unused</td>
-    </tr>
+'''Info:'''
-    <tr>
+* Takes no parameters (other than the session string)
-     <td>6</td>
+* Titles returned are filtered by the 'show adult' preference of the logged in user.  That is, users who have elected to hide adult content will have it hidden here as well.
-     <td align="right">64</td>
+* Do not depend on the command always returning exactly 50 titles; there may not always be 25 future titles pending, depending on the user's 'adult' preferences, and the date in relation to the relation to the current anime season.
-     <td>int4 aid</td>
+* Date flags are used to indicated an unknown value (unknown month, day, year)
-    </tr>
+* ''dateflags'' values:
-    <tr bgcolor="#eee">
+** bit0 set == Startdate, Unknown Day
-     <td>5</td>
+** bit1 set == Startdate, Unknown Month, Day
-     <td align="right">32</td>
+** bit2 set == Enddate, Unknown Day
-     <td>int4 eid</td>
+** bit3 set == Enddate, Unknown Month, Day
-    </tr>
+** bit4 set == AirDate in the Past/Anime has ended
-    <tr>
+** bit5 set == Startdate, Unknown Year
-     <td>4</td>
+** bit6 set == Enddate, Unknown Year
-     <td align="right">16</td>
-     <td>int4 gid</td>
-    </tr>
+----
-    <tr bgcolor="#eee">
+=== CHARACTER: Get Character Information ===
-     <td>3</td>
+Returns character details associated with a given character ID, including associated anime ids, episode ids, and seiyuu.
-     <td align="right">8</td>
-     <td>int4 lid</td>
+'''Command String:'''
-    </tr>
+* CHARACTER charid={int characterid}
-    <tr>
-     <td>2</td>
+'''Possible Replies:'''
-     <td align="right">4</td>
+* 235 CHARACTER
-     <td>list other episodes</td>
+: {int charid}|{str character name kanji}|{str character name transcription}|{str pic}|{anime blocks}|{int episode list}|{int last update date}|{int2 type}|{str gender}
-    </tr>
-    <tr bgcolor="#eee">
+: An 'anime block' is {int anime id},{int appearance},{int creatorid},{boolean is_main_seiyuu} repeated as many times as necessary, separated by a single quote ( ' ).
-     <td>1</td>
-     <td align="right">2</td>
+* 335 NO SUCH CHARACTER
-     <td>int2 IsDeprecated</td>
-    </tr>
+'''Info:'''
-    <tr>
+* If no seiyuu is associated with the character for a given aid, the 'creatorid' and 'is_main_seiyuu' fields will be empty, but the commas will remain.
-     <td>0</td>
+* An empty episode list is "undefined": no episode values have been added.
-     <td align="right">1</td>
+* ''appearance'' values: 0='appears in', 1='cameo appearance in', 2='main character in', 3='secondary cast in'
-     <td>int2 state</td>
+* ''type'' can be one of: (Note: this is subject to changes so don't rely on this mapping)
-    </tr>
+** 1 => 'Character'
-   </table>
+** 2 => 'Mecha'
-   </td>
+** 3 => 'Organisation'
-   <td>
+** 4 => 'Vessel'
-   <table>
+* ''gender'' can be one of: (Note: this is subject to changes so don't rely on this mapping)
-    <tr>
+** "M" => 'Male'
-     <td>'''Bit'''</td>
+** "F" => 'Female'
-     <td align="right">'''Dec'''</td>
+** "I" => 'Intersexual'
-     <td>'''Data Field'''</td>
+** "D" => 'Dimorphic'
-    </tr>
+** "-" => 'none/does not apply'
-    <tr>
+** "?" => 'unknown'
-     <td>7</td>
-     <td align="right">128</td>
+'''Example:'''
-     <td>int8 size</td>
-    </tr>
+  CHARACTER charid=488&s=DChan
-    <tr bgcolor="#eee">
+CHARACTER
-     <td>6</td>
+|ニコ・ロビン|Nico Robin|14789.jpg|4097,2,1900,1'69,2,1901,0'6199,0,1900,1'5691,0,1900,1'2644,0,,'4851,0,1900,1||1236938094
-     <td align="right">64</td>
-     <td>str ed2k</td>
+=== CREATOR: Get Creator Information ===
-    </tr>
-    <tr>
+'''Command String:'''
-     <td>5</td>
+* CREATOR creatorid={int creatorid}
-     <td align="right">32</td>
-     <td>str md5</td>
+'''Possible Replies:'''
-    </tr>
+* 245 CREATOR
-    <tr bgcolor="#eee">
+: {int creatorid}|{str creator name kanji}|{str creator name transcription}|{int type}|{str pic_name}|{str url_english}|{str url_japanese}|{str wiki_url_english}|{str wiki_url_japanese}|{int last update date}
-     <td>4</td>
-     <td align="right">16</td>
+* 345 NO SUCH CREATOR
-     <td>str sha1</td>
-    </tr>
+'''Info:'''
-    <tr>
+* ANIME AMASK byte6, bit5
-     <td>3</td>
+* ''type'' values: 1='person', 2='company', 3='collaboration'
-     <td align="right">8</td>
-     <td>str crc32</td>
+Example:
-    </tr>
-    <tr bgcolor="#eee">
+CREATOR
-     <td>2</td>
+|GAINAX|Gainax|2|10092.png||http://www.gainax.co.jp/|Gainax|Gainax|1237048093
-     <td align="right">4</td>
-     <td>unused</td>
+=== EPISODE: Retrieve Episode Data ===
-    </tr>
+'''Command String:'''<br>
-    <tr>
+by eid
-     <td>1</td>
+* EPISODE eid={int eid}
-     <td align="right">2</td>
+by anime and episode number
-     <td>unused</td>
+* EPISODE aname={str anime name}&epno={int4 episode number}
-    </tr>
+* EPISODE aid={int anime id}&epno={int4 episode number}
-    <tr bgcolor="#eee">
-     <td>0</td>
+'''Possible Replies:'''
-     <td align="right">1</td>
+* 240 EPISODE
-     <td>unused</td>
+: {int eid}|{int aid}|{int4 length}|{int4 rating}|{int votes}|{str epno}|{str eng}|{str romaji}|{str kanji}|{int aired}|{int type}
-    </tr>
+* 340 NO SUCH EPISODE
-   </table>
-  </td>
+'''Info:'''
-   <td>
+* length is in minutes
-    <table>
+* Returned 'epno' includes special character (only if special) and padding (only if normal).
-     <tr>
+** Special characters are S(special), C(credits), T(trailer), P(parody), O(other).
-      <td>'''Bit'''</td>
+* The ''type'' is the raw episode type, used to indicate numerically what the special character will be
-      <td align="right">'''Dec'''</td>
+** 1: regular episode (no prefix), 2: special ("S"), 3: credit ("C"), 4: trailer ("T"), 5: parody ("P"), 6: other ("O")
+'''Examples:''' (html escaped code intended)
+  > EPISODE eid=1&s=xxxxx
+  < 240 EPISODE
+|1|24|400|4|01|Invasion|shinryaku|??
+  > EPISODE aname=Seikai no Monshou&epno=2&s=xxxxx
+   < 240 EPISODE
+|1|24|750|2|02|Kin of the Stars|Hoshi-tachi no Kenzoku|??????|1295059229|1
+----
+=== FILE: Retrieve File Data ===
+'''Command String:'''<br>
+by fid:
+* FILE fid={int4 id}&fmask={hexstr fmask}&amask={hexstr amask}
+by size+ed2k hash:
+* FILE size={int8 size}&ed2k={str ed2khash}&fmask={hexstr fmask}&amask={hexstr amask}
+by anime, group and epno
+* FILE aname={str anime name}&gname={str group name}&epno={int4 episode number}&fmask={hexstr fmask}&amask={hexstr amask}
+* FILE aname={str anime name}&gid={int4 group id}&epno={int4 episode number}&fmask={hexstr fmask}&amask={hexstr amask}
+* FILE aid={int4 anime id}&gname={str group name}&epno={int4 episode number}&fmask={hexstr fmask}&amask={hexstr amask}
+* FILE aid={int4 anime id}&gid={int4 group id}&epno={int4 episode number}&fmask={hexstr fmask}&amask={hexstr amask}
+'''Possible Replies:'''
+* 220 FILE
+: {int4 fid}|{int4 aid}|{int4 eid}|{int4 gid}|{int4 state}|{int8 size}|{str ed2k}|{str anidbfilename}
+* 220 FILE
+: {int4 fid}|...(data list)
+* 322 MULTIPLE FILES FOUND
+: {int4 fid 0}|{int4 fid 1}|...|{int4 fid n}
+* 320 NO SUCH FILE
+'''Info:'''
+* fid, aid, eid, gid are the unique ids for the file, anime, ep, group entries at AniDB.
+: You can use those to create links to the corresponding pages at AniDB.
+* anidbfilename is the AniDB filename for the file.
+: However this name does not contain all the extra information of the filenames on AniDB and might be composed slightly different.
+* fmask and amask are hexidecimal strings where each bit corresponds to a data field related to the specified file (see below). The data list received is sorted and returned in the same order as the tables: top to bottom, left to right, with fmask preceding amask.  There is '''no''' provision to retrieve all fields.  Further, requesting a 'unusued' or 'reserved' bit will return an "illegal input" error.
+* fid is always returned as the first value, regardless of what masks are provided.
+* Only the first matching file is returned when aname, gname and epno is used.
+* "audio codec" and "audio bitrate" will return multiple values if there are multiple audio streams present in the file.  Values will be separated by a single quote.
+* For byte 1, bit 2 (other episodes): episode IDs will be followed by an integer '''percentage''' that indicate the percentage of the related episode this file covers. Typically 100%, there are cases where it will be 50, 30, or other values.  This value provides no indication where, within an episode, the file represents.  That is, 50% could mean the file covers the first half of the episode, the second half, or some 50% range in between.
+'''State:'''
+<pre>
+bit / int value 	meaning
+/ 1 		FILE_CRCOK: file matched official CRC (displayed with green background in AniDB)
+/ 2 		FILE_CRCERR: file DID NOT match official CRC (displayed with red background in AniDB)
+/ 4 		FILE_ISV2: file is version 2
+/ 8 		FILE_ISV3: file is version 3
+/ 16 		FILE_ISV4: file is version 4
+/ 32 		FILE_ISV5: file is version 5
+/ 64 		FILE_UNC: file is uncensored
+/ 128		FILE_CEN: file is censored
+examples:
+state ==== 9 ==> FILE_CRCOK+FILE_ISV3 ==> file matched official CRC and is version 3
+state ==== 0 ==> - ==> file was not crc checked and is version 1
+state ==== 34 ==> FILE_CRCERR+FILE_ISV5 ==> file DID NOT match official CRC and is version 5
+state ==== 1 ==> FILE_CRCOK ==> file matched official CRC and is version 1
+state ==== 8 ==> FILE_ISV3 ==> file was not CRC checked and is version 3
+</pre>
+<table border="0" cellpadding="0" cellspacing="2">
+ <tr><td colspan="4" align="center">'''fmask:'''</td></tr>
+ <tr>
+  <td align="center">'''Byte 1'''</td>
+  <td align="center">'''Byte 2'''</td>
+  <td align="center">'''Byte 3'''</td>
+  <td align="center">'''Byte 4'''</td>
+  <td align="center">'''Byte 5'''</td>
+ </tr>
+ <tr>
+   <td>
+    <table>
+     <tr>
+      <td>'''Bit'''</td>
+      <td align="right">'''Dec'''</td>
       <td>'''Data Field'''</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>7</td>
       <td align="right">128</td>
-      <td>str quality</td>
+      <td>unused</td>
      </tr>
      <tr>
       <td>6</td>
       <td align="right">64</td>
-      <td>str source</td>
+      <td>int4 aid</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>5</td>
       <td align="right">32</td>
-      <td>str audio codec</td>
+      <td>int4 eid</td>
      </tr>
      <tr>
       <td>4</td>
       <td align="right">16</td>
-      <td>int4 audio bitrate</td>
+      <td>int4 gid</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>3</td>
       <td align="right">8</td>
-      <td>str video codec</td>
+      <td>int4 mylist id</td>
      </tr>
      <tr>
       <td>2</td>
       <td align="right">4</td>
-      <td>int4 video bitrate</td>
+      <td>list other episodes</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>1</td>
       <td align="right">2</td>
-      <td>str video resolution</td>
+      <td>int2 IsDeprecated</td>
      </tr>
      <tr>
       <td>0</td>
       <td align="right">1</td>
-      <td>str file type (extension)</td>
+      <td>int2 state</td>
      </tr>
     </table>
@@ Line 1,103: / Line 1,266: @@
       <td>7</td>
       <td align="right">128</td>
-      <td>str dub language</td>
+      <td>int8 size</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>6</td>
       <td align="right">64</td>
-      <td>str sub language</td>
+      <td>str ed2k</td>
      </tr>
      <tr>
       <td>5</td>
       <td align="right">32</td>
-      <td>int4 length in seconds</td>
+      <td>str md5</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>4</td>
       <td align="right">16</td>
-      <td>str description</td>
+      <td>str sha1</td>
      </tr>
      <tr>
       <td>3</td>
       <td align="right">8</td>
-      <td>int4 release date</td>
+      <td>str crc32</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>2</td>
       <td align="right">4</td>
@@ Line 1,133: / Line 1,296: @@
       <td>1</td>
       <td align="right">2</td>
-      <td>unused</td>
+      <td>video colour depth</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>0</td>
       <td align="right">1</td>
-      <td>str anidb file name</td>
+      <td>reserved</td>
      </tr>
     </table>
    </td>
- </tr>
-</table>
-<table border="0" cellpadding="0" cellspacing="2">
- <tr><td colspan="4" align="center">'''amask:'''</td></tr>
- <tr>
-  <td align="center">'''Byte 1'''</td>
-  <td align="center">'''Byte 2'''</td>
-  <td align="center">'''Byte 3'''</td>
-  <td align="center">'''Byte 4'''</td>
- </tr>
- <tr>
    <td>
     <table>
@@ Line 1,162: / Line 1,312: @@
       <td>'''Data Field'''</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>7</td>
       <td align="right">128</td>
-      <td>int4 anime total episodes</td>
+      <td>str quality</td>
      </tr>
      <tr>
       <td>6</td>
       <td align="right">64</td>
-      <td>int4 highest episode number</td>
+      <td>str source</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>5</td>
       <td align="right">32</td>
-      <td>str year</td>
+      <td>str audio codec list</td>
      </tr>
      <tr>
       <td>4</td>
       <td align="right">16</td>
-      <td>str type</td>
+      <td>int4 audio bitrate list</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>3</td>
       <td align="right">8</td>
-      <td>str related aid list</td>
+      <td>str video codec</td>
      </tr>
      <tr>
       <td>2</td>
       <td align="right">4</td>
-      <td>str related aid type</td>
+      <td>int4 video bitrate</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>1</td>
       <td align="right">2</td>
-      <td>str category list</td>
+      <td>str video resolution</td>
      </tr>
      <tr>
       <td>0</td>
       <td align="right">1</td>
-      <td>reserved</td>
+      <td>str file type (extension)</td>
      </tr>
     </table>
@@ Line 1,214: / Line 1,364: @@
       <td>7</td>
       <td align="right">128</td>
-      <td>str romaji name</td>
+      <td>str dub language</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>6</td>
       <td align="right">64</td>
-      <td>str kanji name</td>
+      <td>str sub language</td>
      </tr>
      <tr>
       <td>5</td>
       <td align="right">32</td>
-      <td>str english name</td>
+      <td>int4 length in seconds</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>4</td>
       <td align="right">16</td>
-      <td>str other name</td>
+      <td>str description</td>
      </tr>
      <tr>
       <td>3</td>
       <td align="right">8</td>
-      <td>str short name list</td>
+      <td>int4 aired date</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>2</td>
       <td align="right">4</td>
-      <td>str synonym list</td>
+      <td>unused</td>
      </tr>
      <tr>
       <td>1</td>
       <td align="right">2</td>
-      <td>str producer name list</td>
+      <td>unused</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>0</td>
       <td align="right">1</td>
-      <td>str producer id list</td>
+      <td>str anidb file name</td>
      </tr>
     </table>
@@ Line 1,260: / Line 1,410: @@
       <td>'''Data Field'''</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>7</td>
       <td align="right">128</td>
-      <td>str epno</td>
+      <td>int4 mylist state</td>
      </tr>
      <tr>
       <td>6</td>
       <td align="right">64</td>
-      <td>str ep name</td>
+      <td>int4 mylist filestate</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>5</td>
       <td align="right">32</td>
-      <td>str ep romaji name</td>
+      <td>int4 mylist viewed</td>
      </tr>
      <tr>
       <td>4</td>
       <td align="right">16</td>
-      <td>str ep kanji name</td>
+      <td>int4 mylist viewdate</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>3</td>
       <td align="right">8</td>
-      <td>int4 episode rating</td>
+      <td>str mylist storage</td>
      </tr>
      <tr>
       <td>2</td>
       <td align="right">4</td>
-      <td>int4 episode vote count</td>
+      <td>str mylist source</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr bgcolor="#eeeeee">
       <td>1</td>
       <td align="right">2</td>
-      <td>unused</td>
+      <td>str mylist other</td>
      </tr>
      <tr>
@@ Line 1,302: / Line 1,452: @@
     </table>
    </td>
+ </tr>
+</table>
+<table border="0" cellpadding="0" cellspacing="2">
+ <tr><td colspan="4" align="center">'''amask:'''</td></tr>
+ <tr>
+  <td align="center">'''Byte 1'''</td>
+  <td align="center">'''Byte 2'''</td>
+  <td align="center">'''Byte 3'''</td>
+  <td align="center">'''Byte 4'''</td>
+ </tr>
+ <tr>
    <td>
     <table>
@@ Line 1,309: / Line 1,471: @@
       <td>'''Data Field'''</td>
      </tr>
-     <tr>
+     <tr bgcolor="#eeeeee">
       <td>7</td>
       <td align="right">128</td>
-      <td>str group name</td>
+      <td>int4 anime total episodes</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr>
       <td>6</td>
       <td align="right">64</td>
-      <td>str group short name</td>
+      <td>int4 highest episode number</td>
      </tr>
-     <tr>
+     <tr bgcolor="#eeeeee">
       <td>5</td>
       <td align="right">32</td>
-      <td>unused</td>
+      <td>str year</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr>
       <td>4</td>
       <td align="right">16</td>
-      <td>unused</td>
+      <td>str type</td>
      </tr>
-     <tr>
+     <tr bgcolor="#eeeeee">
       <td>3</td>
       <td align="right">8</td>
-      <td>unused</td>
+      <td>str related aid list</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr>
       <td>2</td>
       <td align="right">4</td>
-      <td>unused</td>
+      <td>str related aid type</td>
      </tr>
-     <tr>
+     <tr bgcolor="#eeeeee">
       <td>1</td>
       <td align="right">2</td>
-      <td>unused</td>
+      <td>str category list</td>
      </tr>
-     <tr bgcolor="#eee">
+     <tr>
       <td>0</td>
       <td align="right">1</td>
-      <td>int date aid record updated</td>
+      <td>reserved</td>
      </tr>
     </table>
    </td>
- </tr>
+  <td>
-</table>
+   <table>
+    <tr>
-'''Examples:''' (html escaped code intended)
+     <td>'''Bit'''</td>
-<pre>
+     <td align="right">'''Dec'''</td>
-> FILE size=177747474&ed2k=70cd93fd3981cc80a8ea6a646ff805c9&fmask=7FF8FEF8&amask=C000F0C0&s=xxxxx
+     <td>'''Data Field'''</td>
-< 220 FILE
+    </tr>
-|4688|69260|4243|0||0|1|177747474|70cd93fd3981cc80a8ea6a646ff805c9|b2a7c7d591333e20495de3571b235c28|7af9b962c17ff729baeee67533e5219526cd5095|a200fe73|high|DTV|Vorbis (Ogg Vorbis)|104|H264/AVC|800|704x400|japanese|english'english'english|1560||1175472000|26|26|01|The Wings to the Sky|Sora he no Tsubasa|????|#nanoha-DamagedGoodz|Nanoha-DGz
+    <tr>
-</pre>
+     <td>7</td>
+     <td align="right">128</td>
+     <td>str romaji name</td>
-----
+    </tr>
+    <tr bgcolor="#eeeeee">
-=== FILE: Retrieve File Data (deprecated) ===
+     <td>6</td>
-'''Command String:'''<br>
+     <td align="right">64</td>
-by fid:
+     <td>str kanji name</td>
-* FILE fid={int4 id}[&fcode={int4}&acode={int4}]
+    </tr>
-by size+ed2k hash:
+    <tr>
-* FILE size={int8 size}&ed2k={str ed2khash}[&fcode={int4}&acode={int4}]
+     <td>5</td>
-by anime, group and epno
+     <td align="right">32</td>
-* FILE aname={str anime name}&gname={str group name}&epno={int4 episode number}[&fcode={int4}&acode={int4}]
+     <td>str english name</td>
-* FILE aname={str anime name}&gid={int4 group id}&epno={int4 episode number}[&fcode={int4}&acode={int4}]
+    </tr>
-* FILE aid={int4 anime id}&gname={str group name}&epno={int4 episode number}[&fcode={int4}&acode={int4}]
+    <tr bgcolor="#eeeeee">
-* FILE aid={int4 anime id}&gid={int4 group id}&epno={int4 episode number}[&fcode={int4}&acode={int4}]
+     <td>4</td>
+     <td align="right">16</td>
-'''Possible Replies:'''
+     <td>str other name</td>
-* 220 FILE
+    </tr>
-: {int4 fid}|{int4 aid}|{int4 eid}|{int4 gid}|{int4 state}|{int8 size}|{str ed2k}|{str anidbfilename}
+    <tr>
-* 220 FILE
+     <td>3</td>
-: {int4 fid}|...(data list)
+     <td align="right">8</td>
-* 322 MULTIPLE FILES FOUND
+     <td>str short name list</td>
-: {int4 fid 0}|{int4 fid 1}|...|{int4 fid n}
+    </tr>
-* 320 NO SUCH FILE
+    <tr bgcolor="#eeeeee">
+     <td>2</td>
-'''Info:'''
+     <td align="right">4</td>
-* fid, aid, eid, gid are the unique ids for the file, anime, ep, group entries at anidb.
+     <td>str synonym list</td>
-: You can use those to create links to the corresponding pages at anidb.
+    </tr>
-* anidbfilename is the anidb filename for the file.
+    <tr>
-: However this name does not contain all the extra information of the filenames on AniDB and might be composed slightly different.
+     <td>1</td>
-* fcode and acode is integers where each bit corresponds to a data field related to the specified file (se below). The data list received is sorted in the same order as the tables (and fcode before acode). {f|a}code=-1 means retrieve all fields.
+     <td align="right">2</td>
-* Only the first matching file is returned when aname, gname and epno is used.
+     <td><i>retired</i></td>
+    </tr>
-'''State:'''
+    <tr bgcolor="#eeeeee">
-<pre>
+     <td>0</td>
-bit / int value 	meaning
+     <td align="right">1</td>
-/ 1 		FILE_CRCOK: file matched official crc (displayed with green background in anidb)
+     <td><i>retired</i></td>
-/ 2 		FILE_CRCERR: file DID NOT match official crc (displayed with red background in anidb)
+    </tr>
-/ 4 		FILE_ISV2: file is version 2
+   </table>
-/ 8 		FILE_ISV3: file is version 3
+  </td>
-/ 16 		FILE_ISV4: file is version 4
+  <td>
-/ 32 		FILE_ISV5: file is version 5
+   <table>
-/ 64 		FILE_UNC: file is uncensored
+    <tr>
-/ 128		FILE_CEN: file is censored
+     <td>'''Bit'''</td>
+     <td align="right">'''Dec'''</td>
-examples:
+     <td>'''Data Field'''</td>
-state ==== 9 ==> FILE_CRCOK+FILE_ISV3 ==> file matched official crc and is version 3
+    </tr>
-state ==== 0 ==> - ==> file was not crc checked and is version 1
+    <tr bgcolor="#eeeeee">
-state ==== 34 ==> FILE_CRCERR+FILE_ISV5 ==> file DID NOT match official crc and is version 5
+     <td>7</td>
-state ==== 1 ==> FILE_CRCOK ==> file matched official crc and is version 1
+     <td align="right">128</td>
-state ==== 8 ==> FILE_ISV3 ==> file was not crc checked and is version 3
+     <td>str epno</td>
-</pre>
+    </tr>
+    <tr>
-'''fcode:'''
+     <td>6</td>
-{| cellpadding="0" align="center"
+     <td align="right">64</td>
-! width="40"|Bit
+     <td>str ep name</td>
-! width="80"|Decimal
+    </tr>
-! width="160"|Data field
+    <tr bgcolor="#eeeeee">
-! width="50"|-
+     <td>5</td>
-! width="40"|Bit
+     <td align="right">32</td>
-! width="120"|Decimal
+     <td>str ep romaji name</td>
-! width="160"|Data field
+    </tr>
-|- style="background-color: #eee;"
+    <tr>
-|0 ||1 	|| not used || 			|| 16 || 65536 || str dub language
+     <td>4</td>
-|-
+     <td align="right">16</td>
-|1 ||2 	|| int4 aid || 			|| 17 || 131072 || str sub language
+     <td>str ep kanji name</td>
-|- style="background-color: #eee;"
+    </tr>
-|2 ||4 	|| int4 eid || 			|| 18 || 262144 || str quality
+    <tr bgcolor="#eeeeee">
-|-
+     <td>3</td>
-|3 ||8 	|| int4 gid ||  			|| 19 || 524288 || str source
+     <td align="right">8</td>
-|- style="background-color: #eee;"
+     <td>int4 episode rating</td>
-|4 ||16 	|| int4 lid || 			|| 20 || 1048576 || str audio codec
+    </tr>
-|-
+    <tr>
-|5 ||32 	|| not used || 			|| 21 || 2097152 || int4 audio bitrate
+     <td>2</td>
-|- style="background-color: #eee;"
+     <td align="right">4</td>
-|6 ||64 	|| not used || 			|| 22 || 4194304 || str video codec
+     <td>int4 episode vote count</td>
-|-
+    </tr>
-|7 ||128 	|| not used ||			|| 23 || 8388608 || int4 video bitrate
+    <tr bgcolor="#eeeeee">
-|- style="background-color: #eee;"
+     <td>1</td>
-|8 ||256 	|| int2 state ||			|| 24 || 16777216 || str video resolution
+     <td align="right">2</td>
-|-
+     <td>unused</td>
-|9 ||512 	|| int8 size ||			|| 25 || 33554432 || str file type (extension)
+    </tr>
-|- style="background-color: #eee;"
+    <tr>
-|10 ||1024	|| str ed2k ||			|| 26 || 67108864 || int4 length in seconds
+     <td>0</td>
-|-
+     <td align="right">1</td>
-|11 ||2048	|| str md5 ||			|| 27 || 134217728 || str description
+     <td>unused</td>
-|- style="background-color: #eee;"
+    </tr>
-|12 ||4096	|| str sha1 || 			|| 28 || 268435456 || not used
+   </table>
-|-
+  </td>
-|13 ||8192	|| str crc32 ||			|| 29 || 536870912 || not used
+  <td>
-|- style="background-color: #eee;"
+   <table>
-|14 ||16384	|| not used ||			|| 30 || 1073741824 || str anidb file name
+    <tr>
-|-
+     <td>'''Bit'''</td>
-|15 ||32768	|| not used ||			|| 31 || -2147483648 || not used
+     <td align="right">'''Dec'''</td>
-|}
+     <td>'''Data Field'''</td>
-'''acode:'''
+    </tr>
-{| cellpadding="0" align="center"
+    <tr>
-! width="40"|Bit
+     <td>7</td>
-! width="80"|Decimal
+     <td align="right">128</td>
-! width="160"|Data field
+     <td>str group name</td>
-! width="50"|-
+    </tr>
-! width="40"|Bit
+    <tr bgcolor="#eeeeee">
-! width="120"|Decimal
+     <td>6</td>
-! width="160"|Data field
+     <td align="right">64</td>
-|- style="background-color: #eee;"
+     <td>str group short name</td>
-|0 ||1 	|| str group name || 		|| 16 || 65536 || int4 anime total episodes
+    </tr>
-|-
+    <tr>
-|1 ||2 	|| str group short name ||	|| 17 || 131072 || int4 last episode nr (highest, not special)
+     <td>5</td>
-|- style="background-color: #eee;"
+     <td align="right">32</td>
-|2 ||4 	|| not used || 			|| 18 || 262144 || str year
+     <td>unused</td>
-|-
+    </tr>
-|3 ||8 	|| not used ||  			|| 19 || 524288 || str type
+    <tr bgcolor="#eeeeee">
-|- style="background-color: #eee;"
+     <td>4</td>
-|4 ||16 	|| not used || 			|| 20 || 1048576 || str romaji name
+     <td align="right">16</td>
-|-
+     <td>unused</td>
-|5 ||32 	|| not used || 			|| 21 || 2097152 || str kanji name
+    </tr>
-|- style="background-color: #eee;"
+    <tr>
-|6 ||64 	|| not used || 			|| 22 || 4194304 || str english name
+     <td>3</td>
-|-
+     <td align="right">8</td>
-|7 ||128 	|| not used ||			|| 23 || 8388608 || str other name
+     <td>unused</td>
-|- style="background-color: #eee;"
+    </tr>
-|8 ||256 	|| str epno ||			|| 24 || 16777216 || str short name list
+    <tr bgcolor="#eeeeee">
-|-
+     <td>2</td>
-|9 ||512 	|| str ep name ||			|| 25 || 33554432 || str synonym list
+     <td align="right">4</td>
-|- style="background-color: #eee;"
+     <td>unused</td>
-|10 ||1024	|| str ep romaji name ||	|| 26 || 67108864 || str category list
+    </tr>
-|-
+    <tr>
-|11 ||2048	|| str ep kanji name ||		|| 27 || 134217728 || str related aid list
+     <td>1</td>
-|- style="background-color: #eee;"
+     <td align="right">2</td>
-|12 ||4096	|| not used || 			|| 28 || 268435456 || str producer name list
+     <td>unused</td>
-|-
+    </tr>
-|13 ||8192	|| not used ||			|| 29 || 536870912 || str producer id list
+    <tr bgcolor="#eeeeee">
-|- style="background-color: #eee;"
+     <td>0</td>
-|14 ||16384	|| not used ||			|| 30 || 1073741824 || not used
+     <td align="right">1</td>
-|-
+     <td>int4 date aid record updated</td>
-|15 ||32768	|| not used ||			|| 31 || -2147483648 || not used
+    </tr>
-|}
+   </table>
-'''Examples:''' (html escaped code intended)
+   </td>
-<pre>
+  </tr>
-> FILE fid=15201&s=xxxxx
+</table>
-< 220 FILE
-|74|445|41|1|242772540|a53c401ed95eaa502ba85acde773040c|Ai yori Aoshi - 1 - Relation - [Zhentarim DivX].ogm
-> FILE fid=15201&fcode=33554432&acode=1049346
-< 220 FILE
-|ogm|zx|01|Relation|Ai yori Aoshi
-> FILE aname=narutaru&gname=triad&amp;amp;aone&epno=2&s=xxxxx
-< t001 220 FILE
-|782|8772|380|1|171298816|2c8a3b53d94d8579b9b81941c549e108|Narutaru - 02 - Catastrophe During the Daytime - [Triad & AonE].avi
-</pre>
-----
-=== GROUP: Retrieve Group Data ===
-'''Command String:'''<br>
-by gid
-* GROUP gid={int4 gid}
-by name/shortname
-* GROUP gname={str group name}
-'''Possible Replies:'''
-* 250 GROUP
-: {int4 gid}|{int4 rating}|{int4 votes}|{int4 acount}|{int fcount}|{str name}|{str short}|{str irc channel}|{str irc server}|{str url}
-* 350 NO SUCH GROUP
-'''Examples:'''
-  > GROUP gid=1&s=xxxxx
-  < 250 GROUP
-|851|665|109|1004|Zhentarim DivX|zx|#zhentarim|irc.deltaanime.net|http://www.zhentarim.net/
-  > GROUP gname=a-l&s=xxxxx
-  < 250 GROUP
-|840|453|53|534|Anime-Legion|A-L|#anime-legion|irc.irchighway.net|http://www.anime-legion.net
-----
-=== PRODUCER: Retrieve Producer Data ===
-'''Command String:'''<br>
-by id
-* PRODUCER pid={int4 producer id}
-by name
-* PRODUCER pname={str producer name/short name/other name}
-'''Possible Replies:'''
-* 245 PRODUCER
-: {int4 id}|{str name}|{str short name}|{str other name}|{str type}|{str picture name}|{str home page url}
-* 345 NO SUCH PRODUCER
-'''Example:'''
-  > PRODUCER pid=1
-  < 245 PRODUCER
-|GAINAX||ガイナックス|Company|1088.gif|http://www.gainax.co.jp/
-----
-=== GROUPSTATUS: Get Completed Episode ===
-Returns a list of group names and ranges of episodes released by the group for a given anime.
-'''Command String:'''
-* GROUPSTATUS aid={int animeid}[&state={int completion_state}]
-'''Possible Replies:'''
-* 225 Group Status
-: {int group id}|{str group name}|{int completion state}|{int last episode number}|{int rating}|{int votes}|{str episode range}\n
-: {int group id}|{str group name}|{int completion state}|{int last episode number}|{int rating}|{int votes}|{str episode range}\n
-: ... (repeated)
-* 325 No Groups Found
-* 330 Anime Not Found
-'''Info:'''
-* The seven fields will be repeated as necessary, one for each group, separated by a new line character
-* Groups will be filtered by the languages selected in the user's profile
-* If ''state'' is not supplied, groups with a completion state of 'ongoing', 'finished', or 'complete' are returned
-* Groups are returned in order of descending episode count
-* If there are more groups to return than can be stored in a UDP packet, additional groups will be silently discarded
-* ''state'' values: 1=ongoing, 2=stalled, 3=complete, 4=dropped, 5=finished, 6=specials_only
-== Mylist Commands ==
-=== MYLIST: Retrieve Mylist Data ===
-'''Command String:'''<br>
-by lid: (mylist id)
-* MYLIST lid={int4 lid}
-by fid:
-* MYLIST fid={int4 fid}
-by size+ed2k hash:
-* MYLIST size={int4 size}&ed2k={str ed2khash}
-by anime + group + epno
-* MYLIST aname={str anime name}[&gname={str group name}&epno={int4 episode number}]
-* MYLIST aname={str anime name}[&gid={int4 group id}&epno={int4 episode number}]
-* MYLIST aid={int4 anime id}[&gname={str group name}&epno={int4 episode number}]
-* MYLIST aid={int4 anime id}[&gid={int4 group id}&epno={int4 episode number}]
-'''Possible Replies:'''
-* 221 MYLIST
-: {int4 lid}|{int4 fid}|{int4 eid}|{int4 aid}|{int4 gid}|{int4 date}|{int2 state}|{int4 viewdate}|{str storage}|{str source}|{str other}|{int2 filestate}
-* 312 MULTIPLE MYLIST ENTRIES
-: {str anime title}|{int episodes}|{str eps with state unknown}|{str eps with state on hhd}|{str eps with state on cd}|{str eps with state deleted}|{str watched eps}|{str group 1 short name}|{str eps for group 1}|...|{str group N short name}|{str eps for group N}
-* 321 NO SUCH ENTRY
-'''Info:'''
-* The state field provides information about the location and sharing state of a file in mylist.
-* If files are added after hashing, a client should specify the state as 1 (on hdd) (if the user doesn't explicitly select something else).
-* eps is a list of episodes, e.g. "1-12,14-16,T1"
-'''States:'''
-- unknown - state is unknown or the user doesn't want to provide this information
-- on hdd - the file is stored on hdd (but is not shared)
-- on cd - the file is stored on cd
-- deleted - the file has been deleted or is not available for other reasons (i.e. reencoded)
-'''Filestates:''' (for normal files, ie. not generic)
-  => normal/original
-   => corrupted version/invalid crc
-   => self edited
-  => self ripped
-  => on dvd
-  => on vhs
-  => on tv
-  => in theaters
-=> streamed
-=> other
-'''Example:'''
+'''Examples:''' (html escaped code intended)
-   > MYLIST aname=gits sac&s=xxxxx
+   > FILE size=177747474&ed2k=70cd93fd3981cc80a8ea6a646ff805c9&fmask=7FF8FEF8&amask=C000F0C0&s=xxxxx
-   < 322 MULTIPLE FILES FOUND
+   < 220 FILE
-   Koukaku Kidoutai STAND ALONE COMPLEX|26||1-26|1-26,S2-S27|||V-A|S2-S27|LMF|20-26|KAA|1-26|AonE|1-19|Anime-MX|1-3,9-20
+|4688|69260|4243|0||0|1|177747474|70cd93fd3981cc80a8ea6a646ff805c9|b2a7c7d591333e20495de3571b235c28|7af9b962c17ff729baeee67533e5219526cd5095|a200fe73|high|DTV|Vorbis (Ogg Vorbis)|104|H264/AVC|800|704x400|japanese|english'english'english|1560||1175472000|26|26|01|The Wings to the Sky|Sora he no Tsubasa|????|#nanoha-DamagedGoodz|Nanoha-DGz
 ----
-=== MYLISTADD: Add file to mylist ===
+=== GROUP: Retrieve Group Data ===
+'''Command String:'''<br>
+by gid
+* GROUP gid={int gid}
+by name/shortname
+* GROUP gname={str group name}
-The command string for MYLISTADD is made of up two blocks: a 'fileinfo' block, which limits the command to a specific file, or an 'animeinfo'/'groupinfo'/'episodeinfo' block, which can be used to specify a range of files, including generics.  Additionally, a number of optional parameters can be included with either set.
+'''Possible Replies:'''
+* 250 GROUP
+: {int gid}|{int4 rating}|{int votes}|{int4 acount}|{int fcount}|{str name}|{str short}|{str irc channel}|{str irc server}|{str url}|{str picname}|{int4 foundeddate}|{int4 disbandeddate}|{int2 dateflags}|{int4 lastreleasedate}|{int4 lastactivitydate}|{list grouprelations}
+* 350 NO SUCH GROUP
+'''Info:'''
+* Requires login
+* ''gname'' is an exact match of either a group name or short name
+* As either name and short names are unique if there is a result from GROUP request by name that will be the only match
+* ''dateflags'' values:
+** bit0 set == Foundeddate, Unknown Day
+** bit1 set == Foundeddate, Unknown Month, Day
+** bit2 set == Disbandeddate, Unknown Day
+** bit3 set == Disbandeddate, Unknown Month, Day
+** bit5 set == Foundeddate, Unknown Year
+** bit6 set == Disbandeddate, Unknown Year
+* ''releasedate'' and ''activitydate'' are distinct.  ''releasedate'' is the date a file was actually released by the group, where ''activitydate'' is the date of a file being added to AniDB.  As such, lastrelease may very well be much older than lastactivity.
+* ''groupreleations'' is a list of apostrophe-separated pairs, where each pair consists of {int4 othergroupid},{int2 relationtype}
+** relationtype:
+*** 1 => "Participant in"
+*** 2 => "Parent of"
+*** 4 => "Merged from"
+*** 5 => "Now known as"
+*** 6 => "Other"
-'''Adding a single file to the MyList with the 'fileinfo' block'''
+'''Example:'''
+  > GROUP gid=7091&s=bunny
+  < 250 GROUP
+|832|1445|43|566|Frostii|Frostii|#frostii|irc.rizon.net|<nowiki>http://frostii.com</nowiki>|15844.jpg|1228089600|0|1|1301875200|1304222640|7255,1'3097,4'748,4'8106,1'8159,2'8402,1'8696,1'9022,1
-* MYLISTADD fid={int4 fid}
+----
-'''or'''
-* MYLISTADD size={int4 size}&ed2k={str ed2khash}
-'''or'''
-* MYLISTADD lid={int4 lid}&edit=1  (valid for edit only)
+=== GROUPSTATUS: Get Completed Episode ===
+Returns a list of group names and ranges of episodes released by the group for a given anime.
-'''Adding one or more files to the MyList with the 'animeinfo'/'groupinfo'/'episodeinfo' block'''
+'''Command String:'''
+* GROUPSTATUS aid={int animeid}[&state={int completion_state}]
-Here, you have a number of options, depending on what data you have available.  In brief, 'animeinfo' represents a choice between anime id and anime name.  'groupinfo' represents a choice between group id, group name, and generic=1.  'episodeinfo' represents a range of one or more episodes.
+'''Possible Replies:'''
+* 225 GROUPSTATUS
+: {int group id}|{str group name}|{int completion state}|{int last episode number}|{int rating}|{int votes}|{str episode range}\n
+: {int group id}|{str group name}|{int completion state}|{int last episode number}|{int rating}|{int votes}|{str episode range}\n
+: ... (repeated)
-* MYLISTADD aid={int4 aid}&gid={int gid}&epno={int4 episode number}
+* 325 NO SUCH GROUPS FOUND
-'''or'''
+* 330 NO SUCH ANIME
-* MYLISTADD aid={int4 aid}&gname={str group_name}&epno={int4 episode number}
-'''or'''
-* MYLISTADD aid={int4 aid}&generic=1&epno={int4 episode number}
-'''or'''
-* MYLISTADD aname={str anime_name}&gid={int gid}&epno={int4 episode number}
-'''or'''
-* MYLISTADD aname={str anime_name}&gname={str group_name}&epno={int4 episode number}
-'''or'''
-* MYLISTADD aname={str anime_name}&generic=1&epno={int4 episode number}
+'''Info:'''
+* The seven fields will be repeated as necessary, one for each group, separated by a new line character
+* Groups will be filtered by the languages selected in the user's profile
+* If ''state'' is not supplied, groups with a completion state of <i>'ongoing'</i>, <i>'finished'</i>, or <i>'complete'</i> are returned
+* Groups are returned in order of descending episode count
+* If there are more groups to return than can be stored in a UDP packet, additional groups will be silently discarded
+* ''state'' values:
+#ongoing
+#stalled
+#complete
+#dropped
+#finished
+#specials only
-Each command listed can have, in addition, a number of optional components to provide further MyList details.  Append these as desired.
+'''Example:'''
+  > GROUP GROUPSTATUS aid=8692&s=vLl1N
+  < 225 GROUPSTATUS
+|Coalgirls|3|25|839|12|1-25
+|Hadena Subs|3|25|374|1|1-25
+|ChaosBlades|3|25|0|0|1-25
+  [truncated]
-* &state={int2 state}
+=== UPDATED: Get List of Updated Anime IDs ===
-* &viewed={boolean viewed}
+Returns a list of AniDB anime ids of anime that have been updated in in a given time frame, ordered by descending age (oldest to newest change).
-* &viewdate={int4 viewdate}
-* &source={str source}
-* &storage={str storage}
-* &other={str other}
+'''Command String:'''
+* UPDATED entity=1&[age={int4 id}|time={int4 date}]
-Finally, edit=1 can be included to edit a mylist entry instead of creating a new one.  When editing, optional values that are not supplied retain their original value.  That is, they are ''not'' replaced with default or empty values.  Only values supplied are updated.
+'''Possible Replies:'''
+* 243 UPDATED
+{int entity}|{int total count}|{int last update date}|{list aid}
-'''Possible Replies:'''
+* 343 NO UPDATES
-* 320 NO SUCH FILE
-* 330 NO SUCH ANIME
-* 350 NO SUCH GROUP
-when edit=0 and adding by fid, size/ed2k
-* 210 MYLIST ENTRY ADDED
-: {int4 mylist id of new entry}
-when edit=0 and adding by aname, aid
-* 210 MYLIST ENTRY ADDED
-: {int4 number of entries added}
-* 310 FILE ALREADY IN MYLIST
-* 322 MULTIPLE FILES FOUND
-: {int4 fid 1}|{int4 fid 2}|...|{int4 fid n}
-when edit=1
-* 311 MYLIST ENTRY EDITED
-* 311 MYLIST ENTRY EDITED
-: {int4 number of entries edited}
-* 411 NO SUCH MYLIST ENTRY
 '''Info:'''
-* All data except lid/fid/size+hash/generic is optional.
+* ''entity'' is always 1
-* Viewed should be 0 for unwatched files and 1 for watched files.
+* Either ''age'' OR ''time'' can be specified, but not both
-* if viewdate is not specified, the current time will be used. The field will be disregarded if viewed=0.
+* ''age'' is specified in days.
-* Other is the only field which may contain newlines, but they have to be stored as &lt;br /&gt;
+** eg: age=30 requests a list of aid values of anime that have changed in the past 30 days
-* For state values refer to: '''MYLIST'''
+* ''time'' is specified in unix time.
-* If you want to change an existing entry and already know its mylist id (lid) please use the lid-version of this command. It put less load on the server.
+** eg: time=1264982400 requests a list of aid values of anime that have changed since 2010-02-01
-* epno=0 means all eps (default), negative numbers means upto. (-12 -> upto 12)
+* A maximum of 200 values will be returned
-* group is optional only when edit=1, meaning you can't add every file for an anime
+* ''count'' specifies the total number of items found for the given time period.  In short, if this value is great than 200, you have not retrieved all applicable ids.
+* ''last update date'' will contain the AniDB update time of the ''last'' aid to appear on the list
+* A given list value will appear only once.  If there have been multiple changes to an entity, its age will reflect the most recent change.
-----
+'''An anime will be considered updated if:'''
+* A change is made to the anime record itself
+* An ''main'' or ''official'' anime title is added, edited, or deleted (not ''short'' or ''synonym'')
+* An episode for the anime is added, or deleted (but NOT edited!)
+* An episode title is added, edited, or deleted
+* An anime relation is added, or deleted
-=== MYLISTDEL: Remove file from mylist ===
+== MyList Commands ==
+=== MYLIST: Retrieve MyList Data ===
 '''Command String:'''<br>
 by lid: (mylist id)
-* MYLISTDEL lid={int4 lid}
+* MYLIST lid={int4 lid}
 by fid:
-* MYLISTDEL fid={int4 fid}
+* MYLIST fid={int4 fid}
 by size+ed2k hash:
-* MYLISTDEL size={int4 size}&ed2k={str ed2k hash}
+* MYLIST size={int4 size}&ed2k={str ed2khash}
 by anime + group + epno
-* MYLISTDEL aname={str anime name}[&gname={str group name}&epno={int4 episode number}]
+* MYLIST aname={str anime name}[&gname={str group name}&epno={int4 episode number}]
-* MYLISTDEL aname={str anime name}[&gid={int4 group id}&epno={int4 episode number}]
+* MYLIST aname={str anime name}[&gid={int4 group id}&epno={int4 episode number}]
-* MYLISTDEL aid={int4 anime id}[&gname={str group name}&epno={int4 episode number}]
+* MYLIST aid={int4 anime id}[&gname={str group name}&epno={int4 episode number}]
-* MYLISTDEL aid={int4 anime id}[&gid={int4 group id}&epno={int4 episode number}]
+* MYLIST aid={int4 anime id}[&gid={int4 group id}&epno={int4 episode number}]
 '''Possible Replies:'''
-* 211 MYLIST ENTRY DELETED
+* 221 MYLIST
-: {int4 number of entries}
+: {int4 lid}|{int4 fid}|{int4 eid}|{int4 aid}|{int4 gid}|{int4 date}|{int2 state}|{int4 viewdate}|{str storage}|{str source}|{str other}|{int2 filestate}
-* 411 NO SUCH MYLIST ENTRY
+* 312 MULTIPLE MYLIST ENTRIES
+: {str anime title}|{int episodes}|{str eps with state unknown}|{str eps with state on hhd}|{str eps with state on cd}|{str eps with state deleted}|{str watched eps}|{str group 1 short name}|{str eps for group 1}|...|{str group N short name}|{str eps for group N}
+* 321 NO SUCH ENTRY
 '''Info:'''
-* group is optional
+* The state field provides information about the location and sharing state of a file in MyList.
-* command will delete all enties found
+* If files are added after hashing, a client should specify the state as 1 (on HDD) (if the user doesn't explicitly select something else).
+* eps is a list of episodes, e.g. "1-12,14-16,T1"
-----
+'''States:'''
+- unknown - state is unknown or the user doesn't want to provide this information
+- internal storage - the file is stored on hdd (but is not shared)
+- external storage - the file is stored on cd/dvd/...
+- deleted - the file has been deleted or is not available for other reasons (i.e. reencoded)
+- remote storage - the file is stored on NAS/cloud/...
-=== MYLISTSTATS : Retrieve mylist stats ===
+'''Filestates:''' (for normal files, i.e. not generic)
-'''Command String:'''
+   => normal/original
-* MYLISTSTATS
+   => corrupted version/invalid crc
-'''Possible Replies:'''
+   => self edited
-* 222 MYLIST STATS
+  => self ripped
-{animes}|{eps}|{files}|{size of files}|{added animes}|{added eps}|{added files}|{added groups}|{leech %}|{glory %}|{viewed % of db}|{mylist % of db}|{viewed % of mylist}|{number of viewed eps}|{votes}|{reviews}
+  => on dvd
+  => on vhs
+  => on tv
+  => in theaters
+  => streamed
+=> other
-'''Info:'''
+'''Example:'''
-* All fields are int
+  > MYLIST aname=gits sac&s=xxxxx
+  < 322 MULTIPLE FILES FOUND
+  Koukaku Kidoutai STAND ALONE COMPLEX|26||1-26|1-26,S2-S27|||V-A|S2-S27|LMF|20-26|KAA|1-26|AonE|1-19|Anime-MX|1-3,9-20
 ----
-=== VOTE: Vote for specified anime/episode/group ===
+=== MYLISTADD: Add file to MyList ===
-'''Command String:'''<br>
+The command string for MYLISTADD is made of up two blocks: a 'fileinfo' block, which limits the command to a specific file, or an 'animeinfo'/'groupinfo'/'episodeinfo' block, which can be used to specify a range of files, including generics.  Additionally, a number of optional parameters can be included with either set.
-by id
-* VOTE type={int2 type}&id={int4 id}[&value={int4 vote value}&epno={int4 episode number}]
-by name
-* VOTE type={int2 type}&name={string name}[&value={int4 vote value}&epno={int4 episode number}]
-'''Possible Replies:'''
+'''Adding a single file to the MyList with the 'fileinfo' block'''
-* 260 VOTED
-: {str aname/ename/gname}
-* 261 VOTE FOUND
-: {str aname/ename/gname}|{vote value}
-* 262 VOTE UPDATED
-: {str aname/ename/gname}|{old vote value}
-* 263 VOTE REVOKED
-: {str aname/ename/gname}|{revoked vote value}
-* 360 NO SUCH VOTE
-* 361 INVALID VOTE TYPE
-* 362 INVALID VOTE VALUE
-* 363 PERMVOTE NOT ALLOWED
-: {str aname}
-* 364 ALREADY PERMVOTED
-: {str aname/ename/gname}
-'''Info:'''
+* MYLISTADD fid={int4 fid}
-* type: 1=anime, 2=anime tmpvote, 3=group
+'''or'''
-* for episode voting add epno on type=1
+* MYLISTADD size={int4 size}&ed2k={str ed2khash}
-* value: negative number means revoke, 0 means retrieve (default), 100-1000 are valid vote values, rest is illegal
+'''or'''
-* votes will be updated automatically (no questions asked)
+* MYLISTADD lid={int4 lid}&edit=1  (valid for edit only)
-* tmpvoting when there exist a perm vote is not possible
-----
+'''Adding one or more files to the MyList with the 'animeinfo'/'groupinfo'/'episodeinfo' block'''
-=== RANDOM: Get a random anime ===
-'''Command String:'''
-* RANDOMANIME type={int4 type}
-'''Possible Replies:'''
+Here, you have a number of options, depending on what data you have available.  In brief, 'animeinfo' represents a choice between anime id and anime name.  'groupinfo' represents a choice between group id, group name, and generic=1.  'episodeinfo' represents a range of one or more episodes.
-* 230 ANIME ... (see ANIME)
-'''Info:'''
+* MYLISTADD aid={int4 aid}&gid={int gid}&epno={int4 episode number}
-* type: 0=from db, 1=watched, 2=unwatched, 3=all mylist
+'''or'''
+* MYLISTADD aid={int4 aid}&gname={str group_name}&epno={int4 episode number}
+'''or'''
+* MYLISTADD aid={int4 aid}&generic=1&epno={int4 episode number}
+'''or'''
+* MYLISTADD aname={str anime_name}&gid={int gid}&epno={int4 episode number}
+'''or'''
+* MYLISTADD aname={str anime_name}&gname={str group_name}&epno={int4 episode number}
+'''or'''
+* MYLISTADD aname={str anime_name}&generic=1&epno={int4 episode number}
-== Misc Commands ==
+Each command listed can have, in addition, a number of optional components to provide further MyList details.  Append these as desired.
-=== MYLISTEXPORT: Schedule a MyList Export ===
+* &state={int2 state}
-Queues a [http://anidb.net/perl-bin/animedb.pl?show=export MyList Export] by the AniDb Servers.  As with a manual export request, exports are only done during periods when server load is low.  As a result, exports may take up to 24 hours.  The client submitting the request will receive an AniDb message when the export is ready to be collected.
+* &viewed={boolean viewed}
+* &viewdate={int4 viewdate}
+* &source={str source}
+* &storage={str storage}
+* &other={str other}
-Only one export can be in the queue at a time.
+Finally, edit=1 can be included to edit a MyList entry instead of creating a new one.  When editing, optional values that are not supplied retain their original value.  That is, they are ''not'' replaced with default or empty values.  Only values supplied are updated.
-'''Command String:'''
-* MYLISTEXPORT [template={str template_name}|cancel=1]
 '''Possible Replies:'''
-* 217 Export Queued
+* 320 NO SUCH FILE
-* 218 Export Cancelled
+* 330 NO SUCH ANIME
-* 317 No Such Template
+* 350 NO SUCH GROUP
-* 318 Export Already In Queue
+when edit=0 and adding by fid, size/ed2k
-* 319 No Export In Queue or Export In Progress
+* 210 MYLIST ENTRY ADDED
+: {int4 mylist id of new entry}
-'''Info:'''
+when edit=0 and adding by aname, aid
-* ''template_name'' must match an available export template on the [http://anidb.net/perl-bin/animedb.pl?show=export MyList Export] page.
+* 210 MYLIST ENTRY ADDED
-* ''cancel'' will cancel any pending export request, queued either through UDP or the web server.
+: {int4 number of entries added}
-* Clients can subscribe the message notifications if they wish to be notified when an export is complete.
+* 310 FILE ALREADY IN MYLIST
+: {int4 lid}|{int4 fid}|{int4 eid}|{int4 aid}|{int4 gid}|{int4 date}|{int2 state}|{int4 viewdate}|{str storage}|{str source}|{str other}|{int2 filestate}
+* 322 MULTIPLE FILES FOUND
+: {int4 fid 1}|{int4 fid 2}|...|{int4 fid n}
+when edit=1
+* 311 MYLIST ENTRY EDITED
+* 311 MYLIST ENTRY EDITED
+: {int4 number of entries edited}
+* 411 NO SUCH MYLIST ENTRY
+'''Info:'''
+* All data except lid/fid/size+hash/generic is optional.
+* Viewed should be 0 for unwatched files and 1 for watched files.
+* If viewdate is not specified, the current time will be used. The field will be disregarded if viewed=0.
+* Other is the only field which may contain newlines, but they have to be stored as &lt;br /&gt;
+* For state values refer to: '''MYLIST'''
+* If you want to change an existing entry and already know its MyList id (lid) please use the lid-version of this command. It put less load on the server.
+* epno=0 means all eps (default), negative numbers means upto. (-12 -> upto 12)
+* group is optional only when edit=1, meaning you can't add every file for an anime
+* If the file already exists (response code 310), the ''current'' record will be returned, in the same format as the MYLIST response.
 ----
-=== PING: Ping Command ===
+=== MYLISTDEL: Remove file from MyList ===
-'''Command String:'''
+'''Command String:'''<br>
-* PING [nat=1]
+by lid: (mylist id)
+* MYLISTDEL lid={int4 lid}
+by fid:
+* MYLISTDEL fid={int4 fid}
+by size+ed2k hash:
+* MYLISTDEL size={int4 size}&ed2k={str ed2k hash}
+by anime + group + epno
+* MYLISTDEL aname={str anime name}[&gname={str group name}&epno={int4 episode number}]
+* MYLISTDEL aname={str anime name}[&gid={int4 group id}&epno={int4 episode number}]
+* MYLISTDEL aid={int4 anime id}[&gname={str group name}&epno={int4 episode number}]
+* MYLISTDEL aid={int4 anime id}[&gid={int4 group id}&epno={int4 episode number}]
+'''Possible Replies:'''
+* 211 MYLIST ENTRY DELETED
+: {int4 number of entries}
+* 411 NO SUCH MYLIST ENTRY
+'''Info:'''
+* group is optional
+* command will delete all enties found
+----
+=== MYLISTSTATS : Retrieve MyList stats ===
+'''Command String:'''
+* MYLISTSTATS
 '''Possible Replies:'''
-* 300 PONG
+* 222 MYLIST STATS
-: {int4 port} ''(when nat=1)''
+{animes}|{eps}|{files}|{size of files}|{added animes}|{added eps}|{added files}|{added groups}|{leech %}|{glory %}|{viewed % of db}|{mylist % of db}|{viewed % of mylist}|{number of viewed eps}|{votes}|{reviews}|{viewed length in minutes}
 '''Info:'''
-* This command does not require a session.
+* All fields are int
-* May be used by a frontend to determine if the API is still available.
+----
+=== VOTE: Vote for specified anime/episode/group ===
+'''Command String:'''<br>
+by id
+* VOTE type={int2 type}&id={int4 id}[&value={int4 vote value}&epno={int4 episode number}]
+* VOTE type={int2 type}&id={int4 id}[&value={int4 vote value}&epno={str episode number}]
+by name
+* VOTE type={int2 type}&name={string name}[&value={int4 vote value}&epno={int4 episode number}]
+* VOTE type={int2 type}&name={string name}[&value={int4 vote value}&epno={str episode number}]
+'''Possible Replies:'''
+* 260 VOTED
+: {str entity name}|{vote value}|{vote type}|{entity id}
+* 261 VOTE FOUND
+: {str entity name}|{vote value}|{vote type}|{entity id}
+* 262 VOTE UPDATED
+: {str entity name}|{old vote value}|{vote type}|{entity id}
+* 263 VOTE REVOKED
+: {str entity name}|{revoked vote value}|{vote type}|{entity id}
+* 360 NO SUCH VOTE
+: {str entity name}|0|{vote type}|{entity id}
+* 361 INVALID VOTE TYPE
+* 362 INVALID VOTE VALUE
+* 363 PERMVOTE NOT ALLOWED
+: {str aname}|{vote value}|{type}|{entity id}
+* 364 ALREADY PERMVOTED
+: {str entity name}|{existing vote value}|{vote type}|{entity id}
+'''Example:'''
+  VOTE type=1&id=5101&value=950
+VOTED
+  Clannad|950|1|5101
+  VOTE type=1&id=5101&value=950&epno=S2
+VOTED
+  Another World: Tomoyo Arc|950|1|91981
+  VOTE type=6&id=91981&value=950
+VOTED
+  Another World: Tomoyo Arc|950|1|91981
+'''Info:'''
+* Type: 1=anime, 2=anime tmpvote, 3=group, 6=episode
+* Entity: anime, episode, or group
+* For episode voting add epno on type=1, or specify type=6 if eid is known
+* Value: negative number means revoke, 0 means retrieve (default), 100-1000 are valid vote values, rest is illegal
+* Votes will be updated automatically (no questions asked)
+* Tmpvoting when there exist a perm vote is not possible
+----
+=== RANDOM: Get a random anime ===
+'''Command String:'''
+* RANDOMANIME type={int4 type}
+'''Possible Replies:'''
+* 230 ANIME ... (see ANIME)
+'''Info:'''
+* type: 0=from db, 1=watched, 2=unwatched, 3=all mylist
+== Misc Commands ==
+=== MYLISTEXPORT: Schedule a MyList Export ===
+Queues a {{AniDBLink|export|MyList Export}} by the AniDB Servers.  As with a manual export request, exports are only done during periods when server load is low. As a result, exports may take up to 24 hours. The client submitting the request will receive an AniDB message when the export is ready to be collected.
+Only one export can be in the queue at a time.
+'''Command String:'''
+* MYLISTEXPORT [template={str template_name}|cancel=1]
+'''Possible Replies:'''
+* 217 EXPORT QUEUED
+* 218 EXPORT CANCELLED
+* 317 EXPORT NO SUCH TEMPLATE
+* 318 EXPORT ALREADY IN QUEUE
+* 319 EXPORT NO EXPORT QUEUED OR IS PROCESSING
+'''Info:'''
+* ''template_name'' must match an available export template on the {{AniDBLink|export|MyList Export}} page.
+* ''cancel'' will cancel any pending export request, queued either through UDP or the web server.
+* Clients can subscribe the message notifications if they wish to be notified when an export is complete.
+----
+=== PING: Ping Command ===
+'''Command String:'''
+* PING [nat=1]
+'''Possible Replies:'''
+* 300 PONG
+: {int4 port} ''(when nat=1)''
+'''Info:'''
+* This command does not require a session.
+* May be used by a frontend to determine if the API is still available.
 * May be executed even if not yet logged in.
-* The option <tt>nat=1</tt> provides an easy way to determine if the router has changed the outgoing port. ([http://tracker.anidb.info/view.php?id=587 587])
+* The option <tt>nat=1</tt> provides an easy way to determine if the router has changed the outgoing port. ({{t|587}})
 ----
 === VERSION: Retrieve Server Version ===
 '''Command String:'''
 * VERSION
 '''Possible Replies:'''
 * 998 VERSION
 : {str server version}
 '''Info:'''
 * This command does not require a session.
 ----
+=== UPTIME: Retrieve Server Uptime ===
-=== UPTIME: Retrieve Server Uptime ===
+'''Command String:'''
-'''Command String:'''
+* UPTIME
-* UPTIME
+'''Possible Replies:'''
-'''Possible Replies:'''
+* 208 UPTIME
-* 208 UPTIME
+: {int4 udpserver uptime in milliseconds}
-: {int4 udpserver uptime in milliseconds}
+'''Info:'''
-'''Info:'''
+* This command is the preferred way to check that the session is OK.
-* This command is the preferred way to check that the session is OK.
+----
+=== ENCODING: Change Encoding for Session ===
+Sets preferred [[Wikipedia:Character encoding|encoding]] per session. The preferred way to do this is to use the '''enc''' argument for AUTH. This command is mostly for testing.
+'''Command String:'''
+* ENCODING name={str encoding name}
+'''Possible Replies:'''
+* 219 ENCODING CHANGED
+* 519 ENCODING NOT SUPPORTED
+'''Info:'''
+* This command does not require a session.
+* Supported encodings: http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html
+* Default: ASCII.
+* Resets to default on logout.
 ----
-=== ENCODING: Change Encoding for Session ===
-Sets preferred [http://en.wikipedia.org/wiki/Character_encoding encoding] per session. The preferred way to do this is to use the '''enc''' argument for AUTH. This command is mostly for testing.
-'''Command String:'''
-* ENCODING name={str encoding name}
-'''Possible Replies:'''
-* 219 ENCODING CHANGED
-* 519 ENCODING NOT SUPPORTED
-'''Info:'''
-* This command does not require a session.
-* Supported encodings: http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html
-* Default: ASCII.
-* Resets to default on logout.
-----
 === SENDMSG: Send Message ===
 '''Command String:'''
@@ Line 1,876: / Line 2,087: @@
 '''Note:'''
 * This command allows you to send an AniDB message.
-{{eyecatch|IMPORTANT:|
+{{eyecatch|Important|
-title must not be longer than 50 chars.
+title must not be longer than 50 chars.<br>
 body must not be longer than 900 chars.
 }}
 ----
 === USER: Retrieve User UID ===
 '''Command String:'''
-* USER user={str user name}
+* USER [user={str user name}|uid={int user id}]
 '''Possible Replies:'''
 * 394 NO SUCH USER
 * 295 USER
-: {int4 uid}
+: {int4 uid}|{str username}
-'''Info:'''
-* The client should the check length (3-10) and case (lower) of ''user'' before sending.
 ----
-=== STATS [<span style="color:red">disabled</span>] ===
+=== STATS [{{colour|red|disabled}}] ===
 '''Command String:'''
 * STATS
@@ Line 1,905: / Line 2,113: @@
 ----
+=== TOP [{{colour|red|disabled}}] ===
-=== TOP [<span style="color:red">disabled</span>] ===
 '''Command String:'''
 * TOP
@@ Line 1,942: / Line 2,149: @@
 == Return Codes ==
-Note: The names below do _not_ necessarily reflect the actual code strings returned by the server.
+{{eyecatch|Note|While the names below '''are''' the actual code strings returned by the server, clients are nonetheless encouraged to work with the numeric codes instead. }}
-<pre>
-	// POSITIVE 2XX
-	LOGIN_ACCEPTED				=200, //a
-	LOGIN_ACCEPTED_NEW_VER			=201, //a
-	LOGGED_OUT				=203, //a
-	RESOURCE				=205, //d
-	STATS					=206, //b
-	TOP					=207, //b
-	UPTIME					=208, //b
-	ENCRYPTION_ENABLED			=209, //c
-	MYLIST_ENTRY_ADDED			=210, //a
-	MYLIST_ENTRY_DELETED			=211, //a
-	ADDED_FILE				=214, //e
-	ADDED_STREAM				=215, //e
-	ENCODING_CHANGED			=219, //c
-	FILE					=220, //a
-	MYLIST					=221, //a
-	MYLIST_STATS				=222, //b
-	ANIME					=230, //b
-	ANIME_BEST_MATCH			=231, //b
-	RANDOMANIME				=232, //b
-        ANIME_DESCRIPTION                       =233, //b
-	EPISODE					=240, //b
-	PRODUCER				=245, //b
-	GROUP					=250, //b
-	BUDDY_LIST				=253, //c
-	BUDDY_STATE				=254, //c
-	BUDDY_ADDED				=255, //c
-	BUDDY_DELETED				=256, //c
-	BUDDY_ACCEPTED				=257, //c
-	BUDDY_DENIED				=258, //c
-	VOTED					=260, //b
-	VOTE_FOUND				=261, //b
-	VOTE_UPDATED				=262, //b
-	VOTE_REVOKED				=263, //b
-	NOTIFICATION_ENABLED			=270, //a
-	NOTIFICATION_NOTIFY			=271, //a
-	NOTIFICATION_MESSAGE			=272, //a
-	NOTIFICATION_BUDDY			=273, //c
-	NOTIFICATION_SHUTDOWN			=274, //c
-	PUSHACK_CONFIRMED			=280, //a
-	NOTIFYACK_SUCCESSFUL_M			=281, //a
-	NOTIFYACK_SUCCESSFUL_N			=282, //a
-	NOTIFICATION				=290, //a
-	NOTIFYLIST				=291, //a
-	NOTIFYGET_MESSAGE			=292, //a
-	NOTIFYGET_NOTIFY			=293, //a
-	SENDMSG_SUCCESSFUL			=294, //a
-	USER					=295, //d
-	// AFFIRMATIVE/NEGATIVE 3XX
-	PONG					=300, //a
-	AUTHPONG				=301, //c
-	NO_SUCH_RESOURCE			=305, //d
-	API_PASSWORD_NOT_DEFINED		=309, //c
- 	FILE_ALREADY_IN_MYLIST			=310, //a
-	MYLIST_ENTRY_EDITED			=311, //a
-	MULTIPLE_MYLIST_ENTRIES			=312, //e
-	SIZE_HASH_EXISTS			=314, //c
-	INVALID_DATA				=315, //c
-	STREAMNOID_USED				=316, //c
-	NO_SUCH_FILE				=320, //a
-	NO_SUCH_ENTRY				=321, //a
-	MULTIPLE_FILES_FOUND			=322, //b
-	NO_SUCH_ANIME				=330, //b
-        NO_SUCH_ANIME_DESCRIPTION               =333, //b
-	NO_SUCH_EPISODE				=340, //b
-	NO_SUCH_PRODUCER			=345, //b
-	NO_SUCH_GROUP				=350, //b
-	BUDDY_ALREADY_ADDED			=355, //c
-	NO_SUCH_BUDDY				=356, //c
-	BUDDY_ALREADY_ACCEPTED			=357, //c
-	BUDDY_ALREADY_DENIED			=358, //c
-	NO_SUCH_VOTE				=360, //b
-	INVALID_VOTE_TYPE			=361, //b
-	INVALID_VOTE_VALUE			=362, //b
-	PERMVOTE_NOT_ALLOWED			=363, //b
-	ALREADY_PERMVOTED			=364, //b
-	NOTIFICATION_DISABLED			=370, //a
-	NO_SUCH_PACKET_PENDING			=380, //a
-	NO_SUCH_ENTRY_M				=381, //a
-	NO_SUCH_ENTRY_N				=382, //a
-	NO_SUCH_MESSAGE				=392, //a
-	NO_SUCH_NOTIFY				=393, //a
-	NO_SUCH_USER				=394, //a
-	// NEGATIVE 4XX
-	NOT_LOGGED_IN				=403, //a
-	NO_SUCH_MYLIST_FILE			=410, //a
-	NO_SUCH_MYLIST_ENTRY			=411, //a
-	// CLIENT SIDE FAILURE 5XX
-	LOGIN_FAILED				=500, //a
-	LOGIN_FIRST				=501, //a
-	ACCESS_DENIED				=502, //a
-	CLIENT_VERSION_OUTDATED			=503, //a
-	CLIENT_BANNED				=504, //a
-	ILLEGAL_INPUT_OR_ACCESS_DENIED		=505, //a
-	INVALID_SESSION				=506, //a
-	NO_SUCH_ENCRYPTION_TYPE			=509, //c
-	ENCODING_NOT_SUPPORTED			=519, //c
-	BANNED					=555, //a
-	UNKNOWN_COMMAND				=598, //a
-	// SERVER SIDE FAILURE 6XX
-	INTERNAL_SERVER_ERROR			=600, //a
-	ANIDB_OUT_OF_SERVICE			=601, //a
-	SERVER_BUSY				=602, //d
-	API_VIOLATION				=666, //a
-</pre>
-== Changelog ==
 <pre>
-.03b - 23.07.2006
+LOGIN_ACCEPTED                           = 200
-BUDDY*, PRODUCER, ENCRYPT, ENCODING, USER, VERSION commands added
+LOGIN_ACCEPTED_NEW_VERSION               = 201
-AUTH, NOTIFY, ANIME, FILE commands extended
+LOGGED_OUT                               = 203
-STATS and TOP commands disabled due performance issues
+RESOURCE                                 = 205
-several fixes
+STATS                                    = 206
+TOP                                      = 207
+UPTIME                                   = 208
+ENCRYPTION_ENABLED                       = 209
+MYLIST_ENTRY_ADDED                       = 210
+MYLIST_ENTRY_DELETED                     = 211
+ADDED_FILE                               = 214
+ADDED_STREAM                             = 215
+EXPORT_QUEUED                            = 217
+EXPORT_CANCELLED                         = 218
+ENCODING_CHANGED                         = 219
+FILE                                     = 220
+MYLIST                                   = 221
+MYLIST_STATS                             = 222
+WISHLIST                                 = 223
+NOTIFICATION                             = 224
+GROUP_STATUS                             = 225
+WISHLIST_ENTRY_ADDED                     = 226
+WISHLIST_ENTRY_DELETED                   = 227
+WISHLIST_ENTRY_UPDATED                   = 228
+MULTIPLE_WISHLIST                        = 229
+ANIME                                    = 230
+ANIME_BEST_MATCH                         = 231
+RANDOM_ANIME                             = 232
+ANIME_DESCRIPTION                        = 233
+REVIEW                                   = 234
+CHARACTER                                = 235
+SONG                                     = 236
+ANIMETAG                                 = 237
+CHARACTERTAG                             = 238
+EPISODE                                  = 240
+UPDATED                                  = 243
+TITLE                                    = 244
+CREATOR                                  = 245
+NOTIFICATION_ENTRY_ADDED                 = 246
+NOTIFICATION_ENTRY_DELETED               = 247
+NOTIFICATION_ENTRY_UPDATE                = 248
+MULTIPLE_NOTIFICATION                    = 249
+GROUP                                    = 250
+CATEGORY                                 = 251
+BUDDY_LIST                               = 253
+BUDDY_STATE                              = 254
+BUDDY_ADDED                              = 255
+BUDDY_DELETED                            = 256
+BUDDY_ACCEPTED                           = 257
+BUDDY_DENIED                             = 258
+VOTED                                    = 260
+VOTE_FOUND                               = 261
+VOTE_UPDATED                             = 262
+VOTE_REVOKED                             = 263
+HOT_ANIME                                = 265
+RANDOM_RECOMMENDATION                    = 266
+RANDOM_SIMILAR                           = 267
+NOTIFICATION_ENABLED                     = 270
+NOTIFYACK_SUCCESSFUL_MESSAGE             = 281
+NOTIFYACK_SUCCESSFUL_NOTIFICATION        = 282
+NOTIFICATION_STATE                       = 290
+NOTIFYLIST                               = 291
+NOTIFYGET_MESSAGE                        = 292
+NOTIFYGET_NOTIFY                         = 293
+SENDMESSAGE_SUCCESSFUL                   = 294
+USER_ID                                  = 295
+CALENDAR                                 = 297
-.03 - 13.01.2006
+PONG                                     = 300
-ANIME, EPISODE, GROUP, STATS, TOP, UPTIME, MYLISTSTATS, VOTE and RANDOM commands added
+AUTHPONG                                 = 301
-it is now possible to use html escaped code in mylist fields, and '='
+NO_SUCH_RESOURCE                         = 305
-updated epno in default file name (for new specials)
+API_PASSWORD_NOT_DEFINED                 = 309
-... (a lot of stuff already forgotten)
+FILE_ALREADY_IN_MYLIST                   = 310
+MYLIST_ENTRY_EDITED                      = 311
+MULTIPLE_MYLIST_ENTRIES                  = 312
+WATCHED                                  = 313
+SIZE_HASH_EXISTS                         = 314
+INVALID_DATA                             = 315
+STREAMNOID_USED                          = 316
+EXPORT_NO_SUCH_TEMPLATE                  = 317
+EXPORT_ALREADY_IN_QUEUE                  = 318
+EXPORT_NO_EXPORT_QUEUED_OR_IS_PROCESSING = 319
+NO_SUCH_FILE                             = 320
+NO_SUCH_ENTRY                            = 321
+MULTIPLE_FILES_FOUND                     = 322
+NO_SUCH_WISHLIST                         = 323
+NO_SUCH_NOTIFICATION                     = 324
+NO_GROUPS_FOUND                          = 325
+NO_SUCH_ANIME                            = 330
+NO_SUCH_DESCRIPTION                      = 333
+NO_SUCH_REVIEW                           = 334
+NO_SUCH_CHARACTER                        = 335
+NO_SUCH_SONG                             = 336
+NO_SUCH_ANIMETAG                         = 337
+NO_SUCH_CHARACTERTAG                     = 338
+NO_SUCH_EPISODE                          = 340
+NO_SUCH_UPDATES                          = 343
+NO_SUCH_TITLES                           = 344
+NO_SUCH_CREATOR                          = 345
+NO_SUCH_GROUP                            = 350
+NO_SUCH_CATEGORY                         = 351
+BUDDY_ALREADY_ADDED                      = 355
+NO_SUCH_BUDDY                            = 356
+BUDDY_ALREADY_ACCEPTED                   = 357
+BUDDY_ALREADY_DENIED                     = 358
+NO_SUCH_VOTE                             = 360
+INVALID_VOTE_TYPE                        = 361
+INVALID_VOTE_VALUE                       = 362
+PERMVOTE_NOT_ALLOWED                     = 363
+ALREADY_PERMVOTED                        = 364
+HOT_ANIME_EMPTY                          = 365
+RANDOM_RECOMMENDATION_EMPTY              = 366
+RANDOM_SIMILAR_EMPTY                     = 367
+NOTIFICATION_DISABLED                    = 370
+NO_SUCH_ENTRY_MESSAGE                    = 381
+NO_SUCH_ENTRY_NOTIFICATION               = 382
+NO_SUCH_MESSAGE                          = 392
+NO_SUCH_NOTIFY                           = 393
+NO_SUCH_USER                             = 394
+CALENDAR_EMPTY                           = 397
+NO_CHANGES                               = 399
-.02c - 10.10.2004
+NOT_LOGGED_IN                            = 403
-LOGOUT now requires the session string too
+NO_SUCH_MYLIST_FILE                      = 410
-Note on 6xx server errors and tags added
+NO_SUCH_MYLIST_ENTRY                     = 411
+MYLIST_UNAVAILABLE                       = 412
-.02b - 14.08.2004
+LOGIN_FAILED                             = 500
-INVALID SESSION changed to 506 INVALID SESSION
+LOGIN_FIRST                              = 501
-BUGFIX: 200 message on AUTH did not contain a session key
+ACCESS_DENIED                            = 502
-BUGFIX: 1 internal bug fixed
+CLIENT_VERSION_OUTDATED                  = 503
+CLIENT_BANNED                            = 504
+ILLEGAL_INPUT_OR_ACCESS_DENIED           = 505
+INVALID_SESSION                          = 506
+NO_SUCH_ENCRYPTION_TYPE                  = 509
+ENCODING_NOT_SUPPORTED                   = 519
+BANNED                                   = 555
+UNKNOWN_COMMAND                          = 598
-.02 - 13.08.2004
+INTERNAL_SERVER_ERROR                    = 600
-new session key needs to be send with each command
+ANIDB_OUT_OF_SERVICE                     = 601
-random udp ports no longer required
+SERVER_BUSY                              = 602
-FILE, MYLIST, MYLISTDEL, MYLISTADD commands added
+NO_DATA                                  = 603
-Some textparts of return values changed
+TIMEOUT - DELAY AND RESUBMIT             = 604
-additional documentation added
+API_VIOLATION                            = 666
-check the caching section!
-.01b - 12.08.2004
+PUSHACK_CONFIRMED                        = 701
-added NOTIFYLIST, NOTIFYGET, NOTIFYACK, SENDMSG commands
+NO_SUCH_PACKET_PENDING                   = 702
-.01 - 10.08.2004
+VERSION                                  = 998</pre>
-initial version
-</pre>
 [[Category:Development]]
 [[Category:UDP]]
 [[Category:API]]