Public Database API

1. Introduction

This document describes the public API of VNDB and is intended to be read by programmers. This API allows programs and websites to access (parts of) the VNDB database without actually visiting the website.

In addition to this real-time API, we also provide some information in the form of database dumps.

Usage terms

This service is free for non-commercial use. The API is provided on a best-effort basis, no guarantees are made about the stability or applicability of this service.

Design goals

  • Simple in implementation of both client and server. "Simple" here means that it shouldn't take much code to write a secure and full implementation and that client applications shouldn't require huge dependency trees just to use this API.
  • Powerful: Not as powerful as raw SQL, but not as rigid as commonly used REST or RPC protocols.
  • High-level: common applications need to perform only few actions to get what they want.
  • Fast: minimal bandwidth overhead and simple and customizable queries.

Design overview

  • TCP-based, all communication between the client and the server is done using one TCP connection. This connection stays alive until it is explicitely closed by either the client or the server.
  • Request/response, client sends a request and server replies with a response.
  • Session-based: clients are required to login before issuing commands to the server. A session is created by issuing the 'login' command, this session stays valid for the lifetime of the TCP connection.
  • Everything sent between the client and the server is encoded in UTF-8.

Limits

The following limits are enforced by the server, in order to limit the server resources and prevent abuse of this service.

  • 10 connections per IP. All connections that are opened after reaching this limit will be immediately closed.
  • 200 commands per 10 minutes per ip. Server will reply with a 'throttled' error (type="cmd") when reaching this limit.
  • 1 second of SQL time per minute per ip. SQL time is the total time taken to run the database queries for each command. This depends on both the command (filters and get flags) and server load, and is thus not very predictable. Server will reply with a 'throttled' error with type="sql" upon reaching this limit.
  • Each command returns at most 25 results, with the exception of get votelist/vnlist/wishlist, which returns at most 100 results.

These limits may sound strict, but in practice you won't have to worry much about it. As long as your application properly waits when the server replies with a "throttle" error, everything will be handled automatically. In the event that your application does require more resources, don't hesitate to ask.

Connection info:

Host
api.vndb.org
Port (plain tcp)
19534 ('VN')
Port (TLS)
19535
For improved security, make sure to verify that the certificate is valid for 'api.vndb.org' and is signed by a trusted root (in particular, by Let's Encrypt).

2. Request/response syntax

The VNDB API uses the JSON format for data in various places, this document assumes you are familiar with it. See JSON.org for a quick overview and RFC 4627 for the glory details.

The words object, array, value, string, number and integer refer to the JSON data types. In addition the following definitions are used in this document:

request or command
Message sent from the client to the server.
response
Message sent from the server to the client.
whitespace
Any sequence of the following characters: space, tab, line feed and carriage return. (hexadecimal: 20, 09, 0A, 0D, respectively). This is in line with the definition of whitespace in the JSON specification.
date
A string signifying a date (in particular: release date). The following formats are used: "yyyy" (when day and month are unknown), "yyyy-mm" (when day is unknown) "yyyy-mm-dd", and "tba" (To Be Announced). If the year is not known and the date is not "tba", the special value null is used.

Message format

A message is formatted as a command or response name, followed by any number of arguments, followed by the End Of Transmission character (04 in hexadecimal). Arguments are separated by one or more whitespace characters, and any sequence of whitespace characters is allowed before and after the message.

The command or response name is an unescaped string containing only lowercase alphabetical ASCII characters, and indicates what kind of command or response this message contains.

An argument can either be an unescaped string (not containing whitespace), any JSON value, or a filter string. The following two examples demonstrate a 'login' command, with an object as argument. Both messages are equivalent, as the whitespace is ignored. '0x04' is used to indicate the End Of Transmission character.

login {"protocol":1,"username":"ayo"}0x04
login {
 "protocol" : 1,
 "username" : "ayo"
}
0x04

The 0x04 byte will be ommitted in the other examples in this document. It is however still required.

Filter string syntax

ome commands accept a filter string as argument. This argument is formatted similar to boolean expressions in most programming languages. A filter consists of one or more expressions, separated by the boolean operators "and" or "or" (lowercase). Each filter expression can be surrounded by parentheses to indicate precedence, the filter argument itself must be surrounded by parentheses.

An expression consists of a field name, followed by an operator and a value. The field name must consist entirely of lowercase alphanumeric characters and can also contain an underscore. The operator must be one of the following characters: =, !=, <, <=, >, >= or ~. The value can be any valid JSON value. Whitespace characters are allowed, but not required, between all expressions, field names, operators and values.

The following two filters are equivalent:

 (title~"osananajimi"or(id=2))
 (
   id = 2
   or
   title ~ "osananajimi"
 )

More complex filters are also possible:

 ((platforms = ["win", "ps2"] or languages = "ja") and released > "2009-01-10")

See the individual commands for more details.

3. The 'login' command

 login {"protocol":1,"client":"test","clientver":0.1,"username":"ayo","password":"hi-mi-tsu!"}

Every client is required to login before issuing other commands. The login command accepts a JSON object as argument. This object has the following members:

protocol
An integer that indicates which protocol version the client implements. Must be 1.
client
A string identifying the client application. Between the 3 and 50 characters, must contain only alphanumeric ASCII characters, space, underscore and hyphens. When writing a client, think of a funny (unique) name and hardcode it into your application.
clientver
A number or string indicating the software version of the client.
username
(optional) String containing the username of the person using the client.
password
(optional) String, password of that user in plain text.

The server replies with either 'ok' (no arguments), or 'error' (see below). Note that logging in using a username and password is optional, but some commands are only available when logged in. It is strongly recommended to connect with TLS when logging in with a username and password.

4. The 'dbstats' command

This command gives the global database statistics that are visible in the main menu of the site. The command is simply:

 dbstats

And the response has the following format:

 dbstats stats

Where stats is a JSON object with integer values. Example response:

 dbstats {"users":49084,
          "threads":3998,
          "tags":1627,
          "releases":28071,
          "producers":3456,
          "chars":14046,
          "posts":52470,
          "vn":13051,
          "traits":1272}

5. The 'get' command

This command is used to fetch data from the database. It accepts 4 arguments: the type of data to fetch (e.g. visual novels or producers), what part of that data to fetch (e.g. only the VN titles, or the descriptions and relations as well), a filter expression, and lastly some options.

 get type flags filters options

type and flags are unescaped strings. The accepted values for type are documented below. flags is a comma-separated list of flags indicating what info to fetch. The filters, available flags and their meaning are documented separately for each type. The last options argument is optional, and influences the behaviour of the returned results. When present, options should be a JSON object with the following members (all are optional):

page
integer, used for pagination. Page 1 (the default) returns the first 10 results (1-10), page 2 returns the following 10 (11-20), etc. (The actual number of results per page can be set with the "results" option below).
results
integer, maximum number of results to return. Also affects the "page" option above. For example: with "page" set to 2 and "results" set to 5, the second five results (that is, results 6-10) will be returned. Default: 10.
sort
string, the field to order the results by. The accepted field names differ per type, the default sort field is the ID of the database entry.
reverse
boolean, default false. Set to true to reverse the order of the results.

The following example will fetch basic information and information about the related anime of the visual novel with id = 17:

 get vn basic,anime (id = 17)

The server will reply with a 'results' message, this message is followed by a JSON object describing the results. This object has three members: 'num', which is an integer indicating the number of results returned, 'more', which is true when there are more results available (i.e. increasing the page option described above will give new results) and 'items', which contains the results as an array of objects. For example, the server could reply to the previous command with the following message:

 results {"num":1, "more":false, "items":[{
   "id": 17, "title": "Ever17 -the out of infinity-", "original": null,
   "released": "2002-08-29", "languages": ["en","ja","ru","zh"],
   "platforms": ["drc","ps2","psp","win"],"anime": []
 }]}

Note that the actual result from the server can (and likely will) be formatted differently and that the order of the members may not be the same. What each member means and what possible values they can have differs per type and is documented below.

5.1. get vn

The following members are returned from a 'get vn' command:

Member Flag Type null? Description
id - integer no Visual novel ID
title basic string no Main title
original basic string yes Original/official title.
released basic date (string) yes Date of the first release.
languages basic array of strings no Can be an empty array when nothing has been released yet.
orig_lang basic array of strings no Language(s) of the first release. Can be an empty array.
platforms basic array of strings no Can be an empty array when unknown or nothing has been released yet.
aliases details string yes Aliases, separated by newlines.
length details integer yes Length of the game, 1-5
description details string yes Description of the VN. Can include formatting codes as described in d9#3.
links details object no Contains the following members:
"wikipedia", string, name of the related article on the English Wikipedia.
"encubed", string, the URL-encoded tag used on encubed.
"renai", string, the name part of the url on renai.us.
All members can be null when no links are available or known to us.
image details string yes HTTP link to the VN image.
image_nsfw details boolean no Whether the VN image is flagged as NSFW or not.
anime anime array of objects no (Possibly empty) list of anime related to the VN, each object has the following members:
"id", integer, AniDB ID
"ann_id", integer, AnimeNewsNetwork ID
"nfo_id", string, AnimeNfo ID
"title_romaji", string
"title_kanji", string
"year", integer, year in which the anime was aired
"type", string
All members except the "id" can be null. Note that this data is courtesy of AniDB, and may not reflect the latest state of their information due to caching.
relations relations array of objects no (Possibly empty) list of related visual novels, each object has the following members:
"id", integer
"relation", string, relation to the VN
"title", string, (romaji) title
"original", string, original/official title, can be null
"official", boolean.
tags tags array of arrays no (Possibly empty) list of tags linked to this VN. Each tag is represented as an array with three elements:
tag id (integer),
score (number between 0 and 3),
spoiler level (integer, 0=none, 1=minor, 2=major)
Only tags with a positive score are included. Note that this list may be relatively large - more than 50 tags for a VN is quite possible.
General information for each tag is available in the tags dump. Keep in mind that it is possible that a tag has only recently been added and is not available in the dump yet, though this doesn't happen often.
popularity stats number no Between 0 (unpopular) and 100 (most popular).
rating stats number no Bayesian rating, between 1 and 10.
votecount stats integer no Number of votes.
screens screens array of objects no (Possibly empty) list of screenshots, each object has the following members:
"image", string, URL of the full-size screenshot
"rid", integer, release ID
"nsfw", boolean
"height", integer, height of the full-size screenshot
"width", integer, width of the full-size screenshot
staff staff array of objects no (Possibly empty) list of staff related to the VN, each object has the following members:
"sid", integer, staff ID
"aid", integer, alias ID
"name", string
"original", string, possibly null
"role", string
"note", string, possibly null

Sorting is possible on the following fields: id, title, released, popularity, rating, votecount.

'get vn' accepts the following filter expressions:

Field Value Operators Notes
id integer
array of integers
= != > >= < <=
= !=
When you need to fetch info about multiple VNs, it is recommended to do so in one command using an array of integers as value. e.g. (id = [7,11,17]).
title string = != ~
original null
string
= !=
= != ~
firstchar null
= !=
= !=
Filter by the first character of the title, similar to the VN browser interface. The character must either be a lowercase 'a' to 'z', or null to match all titles not starting with an alphabetic character.
released null
date (string)
= !=
= != > >= < <=
Note that matching on partial dates (released = "2009") doesn't do what you want, use ranges instead, e.g. (released > "2008" and released <= "2009").
platforms null
string
array of strings

= !=
languages null
string
array of strings

= !=
orig_lang string
array of strings
= !=
search string ~ This is not an actual field, but performs a search on the titles of the visual novel and its releases. Note that the algorithm of this search may change and that it can use a different algorithm than the search function on the website.
tags int
array of ints
= != Find VNs by tag. When providing an array of ints, the '=' filter will return VNs that are linked to any (not all) of the given tags, the '!=' filter will return VNs that are not linked to any of the given tags. You can combine multiple tags filters with 'and' and 'or' to get the exact behavior you need.
This filter may used cached data, it may take up to 24 hours before a VN will have its tag updated with respect to this filter.
VNs that are linked to childs of the given tag are also included.
Be warned that this filter ignores spoiler settings, fetch the tags associated with the returned VN to verify the spoiler level.

5.2. get release

Returned members:

Member Flag Type null? Description
id - integer no Release ID
title basic string no Release title (romaji)
original basic string yes Original/official title of the release.
released basic date (string) yes Release date
type basic string no "complete", "partial" or "trial"
patch basic boolean no
freeware basic boolean no
doujin basic boolean no
languages basic array of strings no
website details string yes Official website URL
notes details string yes Random notes, can contain formatting codes as described in d9#3
minage details integer yes Age rating, 0 = all ages.
gtin details string yes JAN/UPC/EAN code. This is actually an integer, but formatted as a string to avoid an overflow on 32bit platforms.
catalog details string yes Catalog number.
platforms details array of strings no Empty array when platform is unknown.
media details array of objects no Objects have the following two members:
"medium", string
"qty", integer, the quantity. null when it is not applicable for the medium.
An empty array is returned when the media are unknown.
resolution details string yes
voiced details integer yes 1 = Not voiced, 2 = Only ero scenes voiced, 3 = Partially voiced, 4 = Fully voiced
animation details array of integers no The array has two integer members, the first one indicating the story animations, the second the ero scene animations. Both members can be null if unknown or not applicable.

When not null, the number indicates the following: 1 = No animations, 2 = Simple animations, 3 = Some fully animated scenes, 4 = All scenes fully animated.
vn vn array of objects no Array of visual novels linked to this release. Objects have the following members: id, title and original. These are the same as the members of the "get vn" command.
producers producers array of objects no (Possibly empty) list of producers involved in this release. Objects have the following members:
"id", integer
"developer", boolean,
"publisher", boolean,
"name", string, romaji name
"original", string, official/original name, can be null
"type", string, producer type

Sorting is possible on the 'id', 'title' and 'released' fields.

Accepted filters:

Field Value Operators Notes
id integer
array of integers
= != > >= < <=
= !=
vn integer
array of integers
= != Find releases linked to the given visual novel ID.
producer integer = Find releases linked to the given producer ID.
title string = != ~
original null
string
= !=
= != ~
released null
date (string)
= !=
= != > >= < <=
Note about released filter for the vn type also applies here.
patch boolean =
freeware boolean =
doujin boolean =
type string = !=
gtin int = != Value can also be escaped as a string (if you risk an integer overflow otherwise)
catalog string = !=
languages string
array of strings
= !=
platforms string
array of strings
= !=

5.3. get producer

Returned members:

Member Flag Type null? Description
id - integer no Producer ID
name basic string no (romaji) producer name
original basic string yes Original/official name
type basic string no Producer type
language basic string no Primary language
links details object no External links, object has the following members:
"homepage", official homepage,
"wikipedia", title of the related article on the English wikipedia.
Both values can be null.
aliases details string yes List of alternative names, separated by a newline
description details string yes Description/notes of the producer, can contain formatting codes as described in d9#3
relations relations array of objects no (possibly empty) list of related producers, each object has the following members:
"id", integer, producer ID,
"relation", string, relation to the current producer,
"name", string,
"original", string, can be null

Sorting is possible on the 'id' and 'name' fields.

The following filters are recognised:

Field Value Operators Notes
id integer
array of integers
= != > >= < <=
= !=
name string = != ~
original null
string
= !=
= != ~
type string = !=
language string
array of strings
= !=
search string ~ Not an actual field. Performs a search on the name, original and aliases fields.

5.4. get character

Returned members:

Member Flag Type null? Description
id - integer no Character ID
name basic string no (romaji) name
original basic string yes Original (kana/kanji) name
gender basic string yes "m" (male), "f" (female) or "b" (both)
bloodt basic string yes Blood type, "a", "b", "ab" or "o"
birthday basic array no Array of two numbers: day of the month (1-31) and the month (1-12). Either can be null.
aliases details string yes Alternative names, separated with a newline.
description details string yes Description/notes, can contain formatting codes as described in d9#3. May also include [spoiler] tags!
image details string yes HTTP link to the character image. Always (supposed to be) SFW.
bust meas integer yes cm
waist meas integer yes cm
hip meas integer yes cm
height meas integer yes cm
weight meas integer yes kg
traits traits array of arrays no (Possibly empty) list of traits linked to this character. Each trait is represented as an array of two elements: The trait id (integer) and the spoiler level (integer, 0-2). General information for each trait is available in the traits dump.
vns vns array of arrays no List of VNs linked to this character. Each VN is an array of 4 elements: VN id, release ID (0 = "all releases"), spoiler level (0-2) and the role (string).
Available roles: "main", "primary", "side" and "appears".
voiced voiced array of objects no List of voice actresses (staff) that voiced this character, per VN. Each staff/VN is represented as a object with the following members:
"id", integer, staff ID
"aid", integer, the staff alias ID being used
"vid", integer, VN id
"note", string
The same voice actor may be listed multiple times if this entry is character to multiple visual novels. Similarly, the same visual novel may be listed multiple times if this character has multiple voice actors in the same VN.

Sorting is possible on the 'id' and 'name' fields.

The following filters are recognised:

Field Value Operators Notes
id integer
array of integers
= != > >= < <=
= !=
name string = != ~
original null
string
= !=
= != ~
search string ~ Not an actual field. Performs a search on the name, original and aliases fields.
vn integer
array of integers
= Find characters linked to the given visual novel ID(s). Note that this may also include characters that are normally hidden by spoiler settings.
traits int
array of ints
= != Find chars by traits. When providing an array of ints, the '=' filter will return chars that are linked to any (not all) of the given traits, the '!=' filter will return chars that are not linked to any of the given traits. You can combine multiple trait filters with 'and' and 'or' to get the exact behavior you need.
This filter may use cached data, it may take up to 24 hours before a char entry will have its traits updated with respect to this filter.
Chars that are linked to childs of the given trait are also included.
Be warned that this filter ignores spoiler settings, fetch the traits associated with the returned char to verify the spoiler level.

5.5. get staff

Unlike other database entries, staff have more than one unique identifier.

There is the main 'staff ID', which uniquely identifies a person and is what the staff pages on the site represent.

Additionally, every staff name and alias also has its own unique identifier, which is referenced from other database entries to identify which alias was used. This identifier is generally hidden on the site and aliases do not have their own page, but the IDs are exposed in this API in order to facilitate linking between VNs/characters and staff.

Returned members:

Member Flag Type null? Description
id - integer no Staff ID
name basic string no Primary (romaji) staff name
original basic string yes Primary original name
gender basic string yes
language basic string no Primary language
links details object no External links, object has the following members:
"homepage", official homepage,
"wikipedia", title of the related article on the English wikipedia.
"twitter", name of the twitter account.
"anidb", AniDB creator ID.
All values can be null.
description details string yes Description/notes of the staff, can contain formatting codes as described in d9#3
aliases aliases array of arrays no List of names and aliases. Each name is represented as an array with the following elements: Alias ID, name (romaji) and the original name.
This list also includes the "primary" name.
main_alias aliases integer no ID of the alias that is the "primary" name of the entry
vns vns array of objects no List of visual novels that this staff entry has been credited in (excluding character voicing). Each vn is represented as an object with the following members:
"id", integer, visual novel id
"aid", integer, alias ID of this staff entry
"role", string
"note", string, may be null if unset
The same VN entry may appear multiple times if the staff has been credited for multiple roles.
voiced voiced array of objects no List of characters that this staff entry has voiced. Each object has the following members:
"id", integer, visual novel id
"aid", integer, alias ID of this staff entry
"cid", integer, character ID
"note", string, may be null if unset
The same VN entry may appear multiple times if the staff has been credited for multiple characters. Similarly, the same character may appear multiple times if it has been linked to multiple VNs.

Sorting is possible on the 'id' field.

The following filters are recognised:

Field Value Operators Notes
id integer
array of integers
= != > >= < <=
= !=
aid integer
array of integers
=
=
search string ~ Searched through all aliases, both the romanized and original names.

5.6. get user

Returned members:

Member Flag Type null? Description
id basic integer no User ID
username basic string no

The returned list is always sorted on the 'id' field.

The following filters are recognised:

Field Value Operators Notes
id integer
array of integers
= The special value '0' is recognized as the currently logged in user.
username string
array of strings
= != ~
=

5.7. get votelist

Returned members:

Member Flag Type null? Description
uid basic integer no User ID
vn basic integer no Visual Novel ID
vote basic integer no In the range of 10 (lowest) to 100 (highest). These are displayed on the site as a fractional number between 1 and 10.
added basic integer no Unix timestamp of when this vote has been added.

The returned list is always sorted on the 'vn' field.

The following filters are recognised:

Field Value Operators Notes
uid integer = The special value '0' is recognized as the currently logged in user.
vn integer
array of integers
= != > < >= <=
= !=
Visual novel ID.

Note: It's possible that a user has voted on a VN that has been deleted. The vote is still included this list, but a 'get vn' command on its id will not return anything.

Note#2: This command will not return any results for users who have their vote list hidden from the public in their preferences, except when the user itself has logged into the API.

5.8. get vnlist

Returned members:

Member Flag Type null? Description
uid basic integer no User ID
vn basic integer no Visual Novel ID
status basic integer no 0=Unknown, 1=playing, 2=finished, 3=stalled, 4=dropped.
added basic integer no Unix timestamp of when this item has been added.
notes basic string yes User-set notes

The returned list is always sorted on the 'vn' field.

The following filters are recognised:

Field Value Operators Notes
uid integer = The special value '0' is recognized as the currently logged in user.
vn integer
array of integers
= != > < >= <=
= !=
Visual novel ID.

The notes mentioned under 'get votelist' also apply here.

5.9. get wishlist

Returned members:

Member Flag Type null? Description
uid basic integer no User ID
vn basic integer no Visual Novel ID
priority basic integer no 0=high, 1=medium, 2=low, 3=blacklist.
added basic integer no Unix timestamp of when this item has been added.

The returned list is always sorted on the 'vn' field.

The following filters are recognised:

Field Value Operators Notes
uid integer = The special value '0' is recognized as the currently logged in user.
vn integer
array of integers
= != > < >= <=
= !=
Visual novel ID.

The notes mentioned under 'get votelist' also apply here.

6. The 'set' command

The set command can be used to modify stuff in the database. It can only be used when logged in as a user. The command has the following syntax:

 set type id fields

Here, type is similar to the type argument to the 'get' command, id is the (integer) identifier of the database entry to change, and fields is an object with the fields to set or modify. If the fields object is not present, the set command works as a 'delete'. The interpretation of the id and fields arguments depend on the type, and are documented in the sections below.

But before that, let me present some examples to get a feel on what the previous paragraph meant. The following example adds a '10' vote on v17, or changes the vote to a 10 if a previous vote was already present:

 set votelist 17 {"vote":100}

And here's how to remove the previous vote:

 set votelist 17

'set' replies with a simple 'ok' on success, or with an 'error' (see below) on failure. Note that, due to my laziness, no error is currently returned if the identifier does not exist. So voting on a VN that does not exist will return an 'ok', but no vote is actually added. This behaviour may change in the future. Note that this API doesn't care whether the VN has been deleted or not, so you can manage votes and stuff for deleted VNs (Which isn't very helpful, because 'get vn' won't return a thing for deleted VNs).

6.1. set votelist

This command facilitates adding, removing and modifying votes. The identifier argument is the visual novel ID, and the following fields are recognized:

Field Type Description
vote integer Same as the 'vote' member returned by 'get votelist', in the range 10 to 100. This field has no default; it must always be present.

The 'added' member returned by 'get votelist' is, as its name implies, only set when the vote is added. Changing an existing vote will not update the 'added' field.

6.2. set vnlist

This command facilitates adding, removing and modifying your VN list. The identifier argument is the visual novel ID, and the following fields are recognized:

Field Type Description
status integer Same as the 'status' member returned by 'get vnlist'. Default: 0
notes string Same as the 'notes' member returned by 'get vnlist'. An empty string is considered equivalent to 'null'. A newline is currently not allowed because the web interface won't handle them well. Default: null.

Sames notes about the 'added' member for 'set votelist' applies here.

Also note that, when removing a vnlist item, any releases associated with the VN will be removed from the users' list as well. The release list functionality is not currently exposed to the API, so this will only be visible when the web interface is used.

6.3. set wishlist

This command facilitates adding, removing and modifying VNs from your wishlist. The identifier argument is the visual novel ID, and the following fields are recognized:

Field Type Description
priority integer Same as the 'priority' member returned by 'get wishlist'.

Sames notes about the 'added' member for 'set votelist' applies here.

7. The 'error' response

Every command to the server can receive an 'error' response, this response has one argument: a JSON object containing at least a member named "id", which identifies the error, and a "msg", which contains a human readable message explaining what went wrong. Other members are also possible, depending on the value of "id". Example error message:

 error {"id":"parse", "msg":"Invalid command or argument"}

Note that the value of "msg" is not directly linked to the error identifier: the message explains what went wrong in more detail, there are several different messages for the same id. The following error identifiers are currently defined:

parse
Syntax error, unknown command or invalid argument type.
missing
A JSON object argument is missing a required member. The name of which is given in the additional "field" member.
badarg
A JSON value is of the wrong type or in the wrong format. The name of the incorrect field is given in a "field" member.
needlogin
Need to be logged in to issue this command.
throttled
You have used too many server resources within a short time, and need to wait a bit before sending the next command. The type of throttle is given in the "type" member, and the "minwait" and "fullwait" members tell you how long you need to wait before sending the next command and when you can start bursting again (this is the recommended waiting time), respectively. Both values are in seconds, with a precision of 0.1 seconds.
auth
(login) Incorrect username/password combination.
loggedin
(login) Already logged in. Only one successful login command can be issues on one connection.
gettype
(get) Unknown type argument to the 'get' command.
getinfo
(get) Unknown info flag to the 'get' command. The name of the unrecognised flag is given in an additional "flag" member.
filter
(get) Unknown filter field or invalid combination of field/operator/argument type. Includes three additional members: "field", "op" and "value" of the incorrect expression.
settype
(set) Unknown type argument to the 'set' command.

8. Change Log

This section lists the changes made in each version of the VNDB code. Check out the announcements board for more information about updates.

2018-02-07

  • The 'aliases' member for "get producer" is now uses newline as separation rather than a comma

2017-08-14

  • Add 'uid' field to "get votelist/vnlist/wishlist" commands
  • Add 'vn' filter to the same commands
  • The 'uid' filter for these commands is now optional, making it possible to find all list entries for a particular VN

2017-06-21

  • Add "resolution", "voiced", "animation" members to "get release" command
  • Add "platforms" filter to "get release" command
  • Accept arrays for the "vn" filter to the "get release" command
  • Add "search" filter to "get staff"

2017-05-22

  • Add "vns" and "voiced" flags to "get staff" command
  • Add "voiced" flag to "get character" command

2017-04-28

  • Add "get staff" command
  • Add "staff" flag to "get vn" command

2.27

  • Add "username" filter to "get user"
  • Add "traits" filter to "get character"

2.25

  • Add "tags" filter to "get vn"
  • Increased connection limit per IP from 5 to 10
  • Increased command limit from 100 to 200 commands per 10 minutes
  • Added support for TLS
  • Added "screens" flag and member to "get vn"
  • Added "vns" flag and member to "get character"
  • Allow sorting "get vn" on popularity, rating and votecount
  • Added basic "get user" command
  • Added "official" field to "get vn relations"

2.23

  • Added new 'dbstats' command
  • Added new 'get' types: character, votelist, vnlist and wishlist
  • Added 'set' command, with types: votelist, vnlist and wishlist
  • New error id: 'settype'
  • Added "tags" flag and member to "get vn"
  • Added "stats" flag to "get vn"
  • Added "firstchar" filter to "get vn"
  • Added "vn" filter to "get character"

2.15

  • Fixed a bug with the server not allowing extra whitespace after a "get .. " command
  • Allow non-numbers as "clientver" for the login command
  • Added "image_nsfw" member to "get vn"
  • Added "results" option to the "get .. {}"
  • Increased the maximum number of results for the "get .." command to 25
  • Added "orig_lang" member and filter to the "get vn .." command
  • Throttle the commands and sqltime per IP instead of per user
  • Removed the limit on the number of open sessions per user
  • Allow the API to be used without logging in with a username/password

2.12

  • Added "image" member to "get vn"
  • A few minor fixes in some error messages
  • Switched to a different (and faster) search algorithm for "get vn .. (search ~ ..)"