Documentation
Comments5this wiki
Since Wikia is built on top of MediaWiki, the MediaWiki API can be used to access most of the data on our sites. In addition, the LyricWiki API gives access to LyricWiki and the Wikia Custom APIprovides access to many of our Wikia-specific features (LatestPhotos, etc.).
Contents |
MediaWiki API Documentation
Edit
The MediaWiki API is built into every wiki that runs MediaWiki (whether on Wikia or elsewhere, such as Wikipedia). It gives functionality for interacting with articles in a way that covers many use-cases.
- On MediaWiki.org: http://www.mediawiki.org/wiki/API:Main_page
- On any wiki, visit "api.php" to view raw documentation.
- On any wiki, visit "Special:ApiExplorer" to view browsable documentation.
LyricWiki API Documentation
Edit
The LyricWiki API is specific to accessing LyricWiki. It allows you to pass in an artist, song name, or album, and find the page that matches it (it's very forgiving on incorrect spelling and nicknames, etc.). For legal reasons, the API is not allowed to provide full-lyrics at the moment. It currently provides a fair-use sample (to verify that the match is correct) and a link to the page where the full lyrics can be viewed.
- LyricWiki API
- LyricWiki API/REST - REST-like API (could also be considered similar to XML-RPC)
- LyricWiki API/SOAP - SOAP API (includes links to example code in many languages).
Wikia Custom API Documentation
Edit
For Wikia's custom features that aren't found in default MediaWiki installations, most data can be accessed through the Wikia Custom API (which was code-named "Nirvana" for short).
- The Nirvana framework is used for a LOT more than just exposing data via the API. For documentation on the framework in general, see Nirvana documentation on the Dev wiki.
- TODO: the API for external requests doesn't appear to be documented.
- TODO: Create one page on here that is the intro to what Nirvana is and links out to other docs
- TODO: Beef up dev/Nirvana/JavaScript and link to it
Client Libraries
Edit
There are client libraries in many languages for these APIs. Please refer to the Client libraries page for more information & a support matrix.
- Quick Start
- Get an API Key
- Documentation