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, an 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 API: Errors and warnings.
- action
Which action to perform.
- One value: block, checktoken, clearhasmsg, compare, createaccount, delete, edit, emailuser, expandtemplates, fancycaptchareload, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, flowthank, help, imagerotate, import, login, logout, managetags, mobileview, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, revisiondelete, rollback, rsd, setnotificationtimestamp, stashedit, tag, thank, tokens, unblock, undelete, upload, userrights, watch
- 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 Manual: Maxlag parameter for more information.- smaxage
Set the
s-maxageheader to this many seconds. Errors are never cached.- Default: 0
- maxage
Set the
max-ageheader 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
Originheader exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match theOriginheader, a 403 response will be returned. If this parameter matches theOriginheader and the origin is whitelisted, anAccess-Control-Allow-Originheader will be set.- uselang
Language to use for message translations. A list of codes may be fetched from action=query&meta=siteinfo with siprop=languages, or specify user to use the current user's language preference, or specify content to use this wiki's content language.
- Default: user
- Help for the main module.
- api.php?action=help
- All help in one page.
- api.php?action=help&recursivesubmodules=1
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://phabricator.wikimedia.org/.