MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/API

Main module

Status: All features shown on this page should be working, but the API is still in active development, and may change at any time. Subscribe to the mediawiki-api-announce mailing list for notice of updates.

Erroneous requests: When erroneous requests are sent to the API, a HTTP header will be sent with the key "MediaWiki-API-Error" and then both the value of the header and the error code sent back will be set to the same value. For more information see https://www.mediawiki.org/wiki/API:Errors_and_warnings.

The ApiSandbox extension is installed on this wiki. It adds a graphical interface to interact with the MediaWiki API. It is helpful for new users, as it allows debugging API requests without any external tools. See Special:ApiSandbox.

Parameters:
action

Which action to perform.

One value: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, antispoof, block, cirrus-config-dump, cirrus-mapping-dump, cirrus-settings-dump, clearhasmsg, compare, contributiontracking, createaccount, delete, echomarkread, edit, editmassmessagelist, emailuser, expandtemplates, featuredfeed, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, flickrblacklist, flowthank, globalblock, help, imagerotate, import, jsonconfig, languagesearch, login, logout, massmessage, mobileview, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, revisiondelete, rollback, rsd, scribunto-console, setnotificationtimestamp, sitematrix, templatedata, thank, titleblacklist, tokens, transcodereset, ulslocalization, unblock, undelete, upload, userdailycontribs, userrights, watch, zeroconfig
Default: help
format

The format of the output.

One value: dbg, dbgfm, dump, dumpfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, wddx, wddxfm, xml, xmlfm, yaml, yamlfm
Default: jsonfm
maxlag

Maximum lag can be used when MediaWiki is installed on a database replicated cluster. To save actions causing any more site replication lag, this parameter can make the client wait until the replication lag is less than the specified value. In case of excessive lag, error code "maxlag" is returned with a message like "Waiting for $host: $lag seconds lagged".
See https://www.mediawiki.org/wiki/Manual:Maxlag_parameter for more information.

smaxage

Set the s-maxage header to this many seconds. Errors are never cached.

Default: 0
maxage

Set the max-age header to this many seconds. Errors are never cached.

Default: 0
assert

Verify the user is logged in if set to "user", or has the bot userright if "bot".

One value: user, bot
requestid

Any value given here will be included in the response. May be used to distinguish requests.

servedby

Include the hostname that served the request in the results.

curtimestamp

Include the current timestamp in the result.

origin

When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). This must match one of the origins in the Origin: header exactly, so it has to be set to something like http://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin: header, a 403 response will be returned. If this parameter matches the Origin: header and the origin is whitelisted, an Access-Control-Allow-Origin header will be set.

uselang

Language to use for message translations. A list of codes may be fetched from action=query&meta=siteinfo&siprop=languages, or specify "user" to use the current user's language preference.

Default: en
Examples:
Help for the main module
api.php?action=help
All help in one page
api.php?action=help&recursivesubmodules=1
Permissions:
writeapi
Use of the write API
Granted to: all, user, bot
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
Granted to: bot, sysop

Credits

API developers:

  • Roan Kattouw (lead developer Sep 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (creator, lead developer Sep 2006–Sep 2007)
  • Brad Jorsch (lead developer 2013–present)

Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org or file a bug report at https://bugzilla.wikimedia.org/.