From 1ff074a56239fbd8e847010ba21e00067103afac Mon Sep 17 00:00:00 2001
From: Yorhel
+ This document describes the public API of VNDB and is intended to be read by
+ programmers. The API allows programs and websites to access (parts of) the VNDB
+ database without actually visiting a page on the website.
+
+
+ This command is used to fetch data from the database. It accepts 3 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), and lastly a filter expression. +
++ get type flags filters ++
+ Type and flags are unescaped strings. The only type currently accepted is 'vn'. + 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 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 two members: 'num', which + is an integer indicating the number of results returned, 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, "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. +
+ + + +:SUB:get vn +Returned object members: +(the respective info flag is indicated within the parentheses)
+-- cgit v1.2.3