From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png

Release status:Extension status stable

2015-03-16 ApiSandbox screenshot.png
ImplementationTemplate:Extension#type Special page
DescriptionTemplate:Extension#description MediaWiki API playground
Author(s)Template:Extension#username Max Semenik (MaxSemtalk)
MediaWikiTemplate:Extension#mediawiki 1.25–1.26
LicenseTemplate:Extension#license WTFPL 2.0
ExampleTemplate:Extension#example Special:ApiSandbox
Hooks usedTemplate:Extension#hook

Translate the ApiSandbox extension if it is available at translatewiki.net

Check usage and version matrix.


Open tasks · Report a bug

ApiSandbox lets developers experiment with the MediaWiki API in a browser form. It is based on a GSoC proposal by Salil P. A..


On a wiki with ApiSandbox installed, go to Special:ApiSandbox. Choose action, format and other parameters. The sandbox displays interactive help for every request parameter. Then click the "Make request" button. ApiSandbox makes the request to api.php on your behalf and displays the result below in the format you chose. You can copy the request URL (and POST data, if needed) for reuse.

You can preload ApiSandbox form parameters by putting the query string to api.php in the URL fragment, for example the query /w/api.php?action=languagesearch&search=Maratih&typos=1 becomes Special:ApiSandbox#action=languagesearch&format=json&search=Maratih&typos=1.

Note that, despite it being called a sandbox, any write requests performed with this extension will modify the wiki.


  • Download and place the file(s) in a directory called ApiSandbox in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'ApiSandbox' );
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.