MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

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

Main module

Source: MediaWiki
License: GPL-2.0+

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.

Parameters:

action: Which action to perform.; One of the following values: aggregategroups, ask, askargs, block, browsebysubject, checktoken, clearhasmsg, compare, createaccount, delete, echomarkread, echomarkseen, edit, emailuser, expandtemplates, ext.srf.slideshow.show, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, flickrblacklist, flow, flow-parsoid-utils, flowthank, geocode, groupreview, help, imagerotate, import, languagesearch, login, logout, managetags, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, revisiondelete, rollback, rsd, searchtranslations, setnotificationtimestamp, sfautocomplete, sfautoedit, smwinfo, stashedit, tag, thank, tokens, transcodereset, translatesandbox, translateuser, translationaids, translationreview, translationstash, ttmserver, ulslocalization, unblock, undelete, upload, userrights, watch; Default: help
format: The format of the output.; One of the following values: dbg, dbgfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, 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.; Type: integer
smaxage: Set the s-maxage HTTP cache control header to this many seconds. Errors are never cached.; Type: integer; Default: 0
maxage: Set the max-age HTTP cache control header to this many seconds. Errors are never cached.; Type: integer; Default: 0
assert: Verify the user is logged in if set to user, or has the bot user right if bot.; One of the following values: 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.; Type: boolean (details)
curtimestamp: Include the current timestamp in the result.; Type: boolean (details)
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 https://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 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

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

action=aggregategroups

(main | aggregategroups)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Translate
License: GPL-2.0+

Manage aggregate message groups.

You can add and remove aggregate messagegroups and associate or dissociate message groups from them (one at a time).

Parameters:

do: What to do with aggregate message group.; This parameter is required.; One of the following values: associate, dissociate, remove, add, update
aggregategroup: Aggregate message group ID.
group: Message group ID.
groupname: Aggregate message group name.
groupdescription: Aggregate message group description.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Associate a group: api.php?action=aggregategroups&do=associate&group=groupId&aggregategroup=aggregateGroupId

action=ask

(main | ask)

This module requires read rights.
Source: Semantic MediaWiki
License: GPL-2.0+

API module to query SMW by providing a query in the ask language.

Parameter:

query: The query string in ask-language; This parameter is required.

Example:

: api.php?action=ask&query=[[Modification%20date::%2B]]|%3FModification%20date|sort%3DModification%20date|order%3Ddesc

action=askargs

(main | askargs)

This module requires read rights.
Source: Semantic MediaWiki
License: GPL-2.0+

API module to query SMW by providing a query specified as a list of conditions, printouts and parameters.

Parameters:

conditions: The query conditions, i.e. the requirements for a subject to be included; This parameter is required.; Separate values with |. Maximum number of values is 50 (500 for bots).
printouts: The query printouts, i.e. the properties to show per subject; Separate values with |. Maximum number of values is 50 (500 for bots).; Default: (empty)
parameters: The query parameters, i.e. all non-condition and non-printout arguments; Separate values with |. Maximum number of values is 50 (500 for bots).; Default: (empty)

Example:

: api.php?action=askargs&conditions=Modification%20date::%2B&printouts=Modification%20date&parameters=|sort%3DModification%20date|order%3Ddesc

action=block

(main | block)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Block a user.

https://www.mediawiki.org/wiki/API:Block

Parameters:

user: Username, IP address, or IP range to block.; This parameter is required.
expiry: Expiry time. May be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). If set to infinite, indefinite, or never, the block will never expire.; Default: never
reason: Reason for block.; Default: (empty)
anononly: Block anonymous users only (i.e. disable anonymous edits for this IP address).; Type: boolean (details)
nocreate: Prevent account creation.; Type: boolean (details)
autoblock: Automatically block the last used IP address, and any subsequent IP addresses they try to login from.; Type: boolean (details)
noemail: Prevent user from sending email through the wiki. (Requires the blockemail right).; Type: boolean (details)
hidename: Hide the username from the block log. (Requires the hideuser right).; Type: boolean (details)
allowusertalk: Allow the user to edit their own talk page (depends on $wgBlockAllowsUTEdit).; Type: boolean (details)
reblock: If the user is already blocked, overwrite the existing block.; Type: boolean (details)
watchuser: Watch the user's or IP address's user and talk pages.; Type: boolean (details)
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Examples:

Block IP address 192.0.2.5 for three days with reason First strike.: api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC
Block user Vandal indefinitely with reason Vandalism, and prevent new account creation and email sending.: api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC

action=browsebysubject

(main | browsebysubject)

This module requires read rights.
Source: Semantic MediaWiki
License: GPL-2.0+

API module to query a subject.

Parameters:

subject: The subject to be queried; This parameter is required.
subobject: A particular subobject id for the related subject; Default: (empty)

Example:

: api.php?action=browsebysubject&subject=Main_Page

action=checktoken

(main | checktoken)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Check the validity of a token from action=query&meta=tokens.

Parameters:

type: Type of token being tested.; This parameter is required.; One of the following values: csrf, patrol, rollback, userrights, watch
token: Token to test.; This parameter is required.
maxtokenage: Maximum allowed age of the token, in seconds.; Type: integer

Example:

Test the validity of a csrf token.: api.php?action=checktoken&type=csrf&token=123ABC

action=clearhasmsg

(main | clearhasmsg)

This module requires read rights.
This module requires write rights.
Source: MediaWiki
License: GPL-2.0+

Clears the hasmsg flag for the current user.

https://www.mediawiki.org/wiki/API:ClearHasMsg

Example:

Clear the hasmsg flag for the current user.: api.php?action=clearhasmsg

action=compare

(main | compare)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Get the difference between 2 pages.

A revision number, a page title, or a page ID for both "from" and "to" must be passed.

Parameters:

fromtitle: First title to compare.
fromid: First page ID to compare.; Type: integer
fromrev: First revision to compare.; Type: integer
totitle: Second title to compare.
toid: Second page ID to compare.; Type: integer
torev: Second revision to compare.; Type: integer

Example:

Create a diff between revision 1 and 2.: api.php?action=compare&fromrev=1&torev=2

action=createaccount

(main | createaccount)

This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Create a new user account.

https://www.mediawiki.org/wiki/API:Account_creation

Parameters:

name: Username.; This parameter is required.; Type: user name
password: Password (ignored if mailpassword is set).
domain: Domain for external authentication (optional).
token: Account creation token obtained in first request.
email: Email address of user (optional).
realname: Real name of user (optional).
mailpassword: If set to any value, a random password will be emailed to the user.; Type: boolean (details)
reason: Optional reason for creating the account to be put in the logs.
language: Language code to set as default for the user (optional, defaults to content language).

Examples:

Create user testuser with password test123.: api.php?action=createaccount&name=testuser&password=test123
Create user testmailuser and email a randomly-generated password.: api.php?action=createaccount&name=testmailuser&mailpassword=true&reason=MyReason

action=delete

(main | delete)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Delete a page.

https://www.mediawiki.org/wiki/API:Delete

Parameters:

title: Title of the page to delete. Cannot be used together with pageid.
pageid: Page ID of the page to delete. Cannot be used together with title.; Type: integer
reason: Reason for the deletion. If not set, an automatically generated reason will be used.
watch: Deprecated.; Add the page to the current user's watchlist.; Type: boolean (details)
watchlist: Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.; One of the following values: watch, unwatch, preferences, nochange; Default: preferences
unwatch: Deprecated.; Remove the page from the current user's watchlist.; Type: boolean (details)
oldimage: The name of the old image to delete as provided by action=query&prop=imageinfo&iiprop=archivename.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Examples:

Delete Main Page.: api.php?action=delete&title=Main%20Page&token=123ABC
Delete Main Page with the reason Preparing for move.: api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move

action=echomarkread

(main | echomarkread)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Echo
License: MIT

Mark notifications as read for the current user.

https://www.mediawiki.org/wiki/Echo_(Notifications)/API

Parameters:

list: A list of notification IDs to mark as read.; Separate values with |. Maximum number of values is 50 (500 for bots).
all: If set, marks all of a user's notifications as read.; Type: boolean (details)
sections: A list of sections to mark as read.; Values (separate with |): alert, message
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Examples:

Mark notification 8 as read: api.php?action=echomarkread&list=8
Mark all notifications as read: api.php?action=echomarkread&all=true

action=echomarkseen

(main | echomarkseen)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Echo
License: MIT

Mark notifications as seen for the current user.

https://www.mediawiki.org/wiki/Echo_(Notifications)/API

Parameters:

token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.
type: Type of notifications to mark as seen: 'alert', 'message' or 'all'.; This parameter is required.; One of the following values: alert, message, all

Example:

Mark notifications of all types as seen: api.php?action=echomarkseen&type=all

action=edit

(main | edit)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Create and edit pages.

https://www.mediawiki.org/wiki/API:Edit

Parameters:

title

Title of the page to edit. Cannot be used together with pageid.

pageid

Page ID of the page to edit. Cannot be used together with title.

Type: integer

section

Section number. 0 for the top section, new for a new section.

sectiontitle

The title for a new section.

text

Page content.

summary

Edit summary. Also section title when section=new and sectiontitle is not set.

tags

Change tags to apply to the revision.

Values (separate with |):

minor

Minor edit.

Type: boolean (details)

notminor

Non-minor edit.

Type: boolean (details)

bot

Mark this edit as bot.

Type: boolean (details)

basetimestamp

Timestamp of the base revision, used to detect edit conflicts. May be obtained through action=query&prop=revisions&rvprop=timestamp.

Type: timestamp (allowed formats)

starttimestamp

Timestamp when the editing process began, used to detect edit conflicts. An appropriate value may be obtained using curtimestamp when beginning the edit process (e.g. when loading the page content to edit).

Type: timestamp (allowed formats)

recreate

Override any errors about the page having been deleted in the meantime.

Type: boolean (details)

createonly

Don't edit the page if it exists already.

Type: boolean (details)

nocreate

Throw an error if the page doesn't exist.

Type: boolean (details)

watch

Deprecated.

Add the page to the current user's watchlist.

Type: boolean (details)

unwatch

Deprecated.

Remove the page from the current user's watchlist.

Type: boolean (details)

watchlist

Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.

One of the following values: watch, unwatch, preferences, nochange

Default: preferences

md5

The MD5 hash of the text parameter, or the prependtext and appendtext parameters concatenated. If set, the edit won't be done unless the hash is correct.

prependtext

Add this text to the beginning of the page. Overrides text.

appendtext

Add this text to the end of the page. Overrides text.

Use section=new to append a new section, rather than this parameter.

undo

Undo this revision. Overrides text, prependtext and appendtext.

Type: integer

undoafter

Undo all revisions from undo to this one. If not set, just undo one revision.

Type: integer

redirect

Automatically resolve redirects.

Type: boolean (details)

contentformat

Content serialization format used for the input text.

One of the following values: text/x-wiki, text/javascript, application/json, text/css, text/plain

contentmodel

Content model of the new content.

One of the following values: wikitext, javascript, json, css, text, JsonSchema, Campaign, flow-board

token

A "csrf" token retrieved from action=query&meta=tokens

The token should always be sent as the last parameter, or at least after the text parameter.

This parameter is required.

Examples:

Edit a page.: api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&basetimestamp=2007-08-24T12:34:54Z&token=123ABC
Prepend __NOTOC__ to a page.: api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%0A&basetimestamp=2007-08-24T12:34:54Z&token=123ABC
Undo revisions 13579 through 13585 with autosummary.: api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=2007-08-24T12:34:54Z&token=123ABC

action=emailuser

(main | emailuser)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Email a user.

https://www.mediawiki.org/wiki/API:Email

Parameters:

target: User to send email to.; This parameter is required.
subject: Subject header.
text: Mail body.; This parameter is required.
ccme: Send a copy of this mail to me.; Type: boolean (details)
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Send an email to user WikiSysop with the text Content.: api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC

action=expandtemplates

(main | expandtemplates)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Expands all templates in wikitext.

https://www.mediawiki.org/wiki/API:Parsing_wikitext#expandtemplates

Parameters:

title

Title of page.

Default: API

text

Wikitext to convert.

This parameter is required.

revid

Revision ID, for {{REVISIONID}} and similar variables.

Type: integer

prop

Which pieces of information to get.

Note that if no values are selected, the result will contain the wikitext, but the output will be in a deprecated format.

wikitext: The expanded wikitext.
categories: Any categories present in the input that are not represented in the wikitext output.
properties: Page properties defined by expanded magic words in the wikitext.
volatile: Whether the output is volatile and should not be reused elsewhere within the page.
ttl: The maximum time after which caches of the result should be invalidated.
modules: Any ResourceLoader modules that parser functions have requested be added to the output. Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules.
jsconfigvars: Gives the JavaScript configuration variables specific to the page.
encodedjsconfigvars: Gives the JavaScript configuration variables specific to the page as a JSON string.
parsetree: The XML parse tree of the input.

Values (separate with |): wikitext, categories, properties, volatile, ttl, modules, jsconfigvars, encodedjsconfigvars, parsetree

includecomments

Whether to include HTML comments in the output.

Type: boolean (details)

generatexml

Deprecated.

Generate XML parse tree (replaced by prop=parsetree).

Type: boolean (details)

Example:

Expand the wikitext {{Project:Sandbox}}.: api.php?action=expandtemplates&text={{Project:Sandbox}}

action=ext.srf.slideshow.show

(main | ext.srf.slideshow.show)

This module requires read rights.
Source: Semantic Result Formats
License: GPL-2.0+

API module used by the SlideShow result printer to retrieve formatted results. This module is should not be called directly.

http://semantic-mediawiki.org/wiki/Help:Slideshow_format

Parameters:

pageid: Id of the page (subject) to be displayed; This parameter is required.; Type: integer
template: Template to use for formatting; This parameter is required.
printouts: Printouts to send to the template; Default: []

action=feedcontributions

(main | feedcontributions)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Returns a user contributions feed.

Parameters:

feedformat: The format of the feed.; One of the following values: rss, atom; Default: rss
user: What users to get the contributions for.; This parameter is required.; Type: user name
namespace: Which namespace to filter the contributions by.; One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 460, 461, 170, 171, 2300, 2301, 2302, 2303, 102, 103, 108, 109, 710, 711, 420, 421, 106, 107, 2600, 1198, 1199, 104, 105
year: From year (and earlier).; Type: integer
month: From month (and earlier).; Type: integer
tagfilter: Filter contributions that have these tags.; Values (separate with |):; Default: (empty)
deletedonly: Show only deleted contributions.; Type: boolean (details)
toponly: Only show edits that are latest revisions.; Type: boolean (details)
newonly: Only show edits that are page creations.; Type: boolean (details)
showsizediff: Show the size difference between revisions.; Type: boolean (details)

Example:

Return contributions for user Example.: api.php?action=feedcontributions&user=Example

action=feedrecentchanges

(main | feedrecentchanges)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Returns a recent changes feed.

Parameters:

feedformat: The format of the feed.; One of the following values: rss, atom; Default: rss
namespace: Namespace to limit the results to.; One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 460, 461, 170, 171, 2300, 2301, 2302, 2303, 102, 103, 108, 109, 710, 711, 420, 421, 106, 107, 2600, 1198, 1199, 104, 105
invert: All namespaces but the selected one.; Type: boolean (details)
associated: Include associated (talk or main) namespace.; Type: boolean (details)
days: Days to limit the results to.; The value must be no less than 1.; Type: integer; Default: 7
limit: Maximum number of results to return.; The value must be between 1 and 50.; Type: integer; Default: 50
from: Show changes since then.; Type: timestamp (allowed formats)
hideminor: Hide minor changes.; Type: boolean (details)
hidebots: Hide changes made by bots.; Type: boolean (details)
hideanons: Hide changes made by anonymous users.; Type: boolean (details)
hideliu: Hide changes made by registered users.; Type: boolean (details)
hidepatrolled: Hide patrolled changes.; Type: boolean (details)
hidemyself: Hide changes made by the current user.; Type: boolean (details)
tagfilter: Filter by tag.
target: Show only changes on pages linked from this page.
showlinkedto: Show changes on pages linked to the selected page instead.; Type: boolean (details)

Examples:

Show recent changes.: api.php?action=feedrecentchanges
Show recent changes for 30 days.: api.php?action=feedrecentchanges&days=30

action=feedwatchlist

(main | feedwatchlist)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Returns a watchlist feed.

https://www.mediawiki.org/wiki/API:Watchlist_feed

Parameters:

feedformat

The format of the feed.

One of the following values: rss, atom

Default: rss

hours

List pages modified within this many hours from now.

The value must be between 1 and 72.

Type: integer

Default: 24

linktosections

Link directly to changed sections if possible.

Type: boolean (details)

allrev

Include multiple revisions of the same page within given timeframe.

Type: boolean (details)

wlowner

Used along with token to access a different user's watchlist.

Type: user name

wltoken

A security token (available in the user's preferences) to allow access to another user's watchlist.

wlshow

Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set show=minor|!anon.

Values (separate with |): minor, !minor, bot, !bot, anon, !anon, patrolled, !patrolled, unread, !unread

wltype

Which types of changes to show:

edit: Regular page edits.
external: External changes.
new: Page creations.
log: Log entries.

Values (separate with |): edit, external, new, log

Default: edit|new|log

wlexcludeuser

Don't list changes by this user.

Type: user name

Examples:

Show the watchlist feed.: api.php?action=feedwatchlist
Show all changes to watched pages in the past 6 hours.: api.php?action=feedwatchlist&allrev=&hours=6

action=filerevert

(main | filerevert)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Revert a file to an old version.

Parameters:

filename: Target filename, without the File: prefix.; This parameter is required.
comment: Upload comment.; Default: (empty)
archivename: Archive name of the revision to revert to.; This parameter is required.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Revert Wiki.png to the version of 2011-03-05T15:27:40Z.: api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=123ABC

action=flickrblacklist

(main | flickrblacklist)

This module requires read rights.
Source: Upload Wizard
License: GPL-2.0+

Validate a Flickr URL by using the user ID (NSID) for blacklisting.

When used with the list option, returns all blacklisted IDs.

Parameters:

url: The Flickr URL to be tested.
list: When set, the complete blacklist is returned. Cannot be used together with url.; Type: boolean (details)

Examples:

Check a URL against the blacklist: api.php?action=flickrblacklist&url=http%3A//farm1.staticflickr.com/44/147426941_98baf36fd1_o.jpg
Return the entire blacklist: api.php?action=flickrblacklist&list=

action=flow

(main | flow)

This module requires read rights.
Source: Flow
License: GPL-2.0+

Allows actions to be taken on Flow pages.

https://www.mediawiki.org/wiki/Extension:Flow/API

Parameters:

submodule: The Flow submodule to invoke.; This parameter is required.; One of the following values: close-open-topic, edit-header, edit-post, edit-title, edit-topic-summary, lock-topic, moderate-post, moderate-topic, new-topic, reply, undo-edit-header, undo-edit-post, undo-edit-topic-summary, view-header, view-post, view-post-history, view-topic, view-topic-history, view-topic-summary, view-topiclist
page: The page to take the action on.; This parameter is required.; Default: Topic:Flow-enabled_page
token: An edit token; Default: (empty)

Example:

Edit the description of "Talk:Sandbox": api.php?action=flow&submodule=edit-header&page=Talk:Sandbox&ehprev_revision=???&ehcontent=Nice%20to&20meet%20you

submodule=close-open-topic (cot)

(main | flow | close-open-topic)

This module is deprecated.
This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Flow
License: GPL-2.0+

Deprecated in favor of action=flow&submodule=lock-topic.

https://www.mediawiki.org/wiki/Extension:Flow/API#lock-topic

Parameters:

cotmoderationState: State to put topic in, either "lock" or "unlock".; This parameter is required.; One of the following values: lock, unlock, close, reopen
cotreason: Reason for locking or unlocking the topic.; This parameter is required.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Lock Topic:S2tycnas4hcucw8w: api.php?action=flow&submodule=lock-topic&page=Topic:S2tycnas4hcucw8w&cotmoderationState=lock&cotreason=Ahhhh

submodule=edit-header (eh)

(main | flow | edit-header)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Flow
License: GPL-2.0+

Edits a board description.

https://www.mediawiki.org/wiki/Extension:Flow/API#edit-header

Parameters:

ehprev_revision: Revision ID of the current description revision, to check for edit conflicts.
ehcontent: Content for description.; This parameter is required.
ehformat: Format of the description (wikitext|html); This parameter is required.; One of the following values: html, wikitext; Default: wikitext
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Edit the description of Talk:Sandbox: api.php?action=flow&submodule=edit-header&page=Talk:Sandbox&ehprev_revision=???&ehcontent=Nice%20to&20meet%20you&ehformat=wikitext

submodule=edit-post (ep)

(main | flow | edit-post)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Flow
License: GPL-2.0+

Edits a post's content.

https://www.mediawiki.org/wiki/Extension:Flow/API#edit-post

Parameters:

eppostId: Post ID.; This parameter is required.
epprev_revision: Revision ID of the current post revision, to check for edit conflicts.; This parameter is required.
epcontent: Content for post.; This parameter is required.
epformat: Format of the post content (wikitext|html); This parameter is required.; One of the following values: html, wikitext; Default: wikitext
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Edit a post in Topic:S2tycnas4hcucw8w: api.php?action=flow&submodule=edit-post&page=Topic:S2tycnas4hcucw8w&eppostId=???&epprev_revision=???&epcontent=Nice%20to&20meet%20you&epformat=wikitext

submodule=edit-title (et)

(main | flow | edit-title)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Flow
License: GPL-2.0+

Edits a topic's title.

https://www.mediawiki.org/wiki/Extension:Flow/API#edit-title

Parameters:

etprev_revision: Revision ID of the current title revision, to check for edit conflicts.; This parameter is required.
etcontent: Content for title.; This parameter is required.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Edit the title of Topic:S2tycnas4hcucw8w: api.php?action=flow&submodule=edit-title&page=Topic:S2tycnas4hcucw8w&etprev_revision=???&ehtcontent=Nice%20to&20meet%20you

submodule=edit-topic-summary (ets)

(main | flow | edit-topic-summary)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Flow
License: GPL-2.0+

Edits a topic summary's content.

https://www.mediawiki.org/wiki/Extension:Flow/API#edit-topic-summary

Parameters:

etsprev_revision: Revision ID of the current topic summary revision, if any, to check for edit conflicts.
etssummary: Content for the summary.; This parameter is required.
etsformat: Format of the summary (wikitext|html); This parameter is required.; One of the following values: html, wikitext; Default: wikitext
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Edit the summary of Topic:S2tycnas4hcucw8w: api.php?action=flow&submodule=edit-topic-summary&page=Topic:S2tycnas4hcucw8w&wetsprev_revision=???&etssummary=Nice%20to&20meet%20you&etsformat=wikitext

submodule=lock-topic (cot)

(main | flow | lock-topic)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Flow
License: GPL-2.0+

Lock or unlock a Flow topic.

https://www.mediawiki.org/wiki/Extension:Flow/API#lock-topic

Parameters:

cotmoderationState: State to put topic in, either lock or unlock.; This parameter is required.; One of the following values: lock, unlock, close, reopen
cotreason: Reason for locking or unlocking the topic. Note, the on-wiki Flow client uses "Marked as resolved" here, and puts optional additional information in the summary.; This parameter is required.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Lock Topic:S2tycnas4hcucw8w: api.php?action=flow&submodule=lock-topic&page=Topic:S2tycnas4hcucw8w&cotmoderationState=lock&cotreason=Ahhhh

submodule=moderate-post (mp)

(main | flow | moderate-post)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Flow
License: GPL-2.0+

Moderates a Flow post.

https://www.mediawiki.org/wiki/Extension:Flow/API#moderate-post

Parameters:

mpmoderationState: What level to moderate at.; This parameter is required.; One of the following values: Can be empty, or delete, hide, suppress, restore, unhide, undelete, unsuppress
mpreason: Reason for moderation.; This parameter is required.
mppostId: ID of the post to moderate.; This parameter is required.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Delete a post on topic Topic:S2tycnas4hcucw8w: api.php?action=flow&submodule=moderate-post&page=Topic:S2tycnas4hcucw8w&mppostId=050f30e34c87beebcd54080027630f57&mpmoderationState=delete&mpreason=Ahhhh

submodule=moderate-topic (mt)

(main | flow | moderate-topic)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Flow
License: GPL-2.0+

Moderates a Flow topic.

https://www.mediawiki.org/wiki/Extension:Flow/API#moderate-topic

Parameters:

mtmoderationState: What level to moderate at.; This parameter is required.; One of the following values: Can be empty, or delete, hide, suppress, restore, unhide, undelete, unsuppress
mtreason: Reason for moderation.; This parameter is required.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Delete the topic Topic:S2tycnas4hcucw8w: api.php?action=flow&submodule=moderate-topic&page=Topic:S2tycnas4hcucw8w&mtmoderationState=delete&mtreason=Ahhhh

submodule=new-topic (nt)

(main | flow | new-topic)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Flow
License: GPL-2.0+

Creates a new Flow topic on the given workflow.

https://www.mediawiki.org/wiki/Extension:Flow/API#new-topic

Parameters:

nttopic: Text for new topic title.; This parameter is required.
ntcontent: Content for the topic's initial reply.; This parameter is required.
ntformat: Format of the new topic's initial reply (wikitext|html); This parameter is required.; One of the following values: html, wikitext; Default: wikitext
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Create a new topic on Talk:Sandbox: api.php?action=flow&submodule=new-topic&page=Talk:Sandbox&nttopic=Hi&ntcontent=Nice%20to&20meet%20you&ntformat=wikitext

submodule=reply (rep)

(main | flow | reply)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Flow
License: GPL-2.0+

Replies to a post.

https://www.mediawiki.org/wiki/Extension:Flow/API#reply

Parameters:

repreplyTo: Post ID to reply to.; This parameter is required.
repcontent: Content for new post.; This parameter is required.
repformat: Format of the new post (wikitext|html); This parameter is required.; One of the following values: html, wikitext; Default: wikitext
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Reply to a post on Topic:S2tycnas4hcucw8w: api.php?action=flow&submodule=reply&page=Topic:S2tycnas4hcucw8w&repreplyTo=050e554490c2b269143b080027630f57&repcontent=Nice%20to&20meet%20you&repformat=wikitext

submodule=undo-edit-header (ueh)

(main | flow | undo-edit-header)

This module requires read rights.
Source: Flow
License: GPL-2.0+

Retrieve information necessary to undo description edits.

https://www.mediawiki.org/wiki/Extension:Flow/API#undo-edit-header

Parameters:

uehstartId: Revision id to start undo at.; This parameter is required.
uehendId: Revision id to end undo at.; This parameter is required.

Example:

Fetch information about undoing a description edit at Talk:Sandbox: api.php?action=flow&submodule=undo-edit-header&page=Talk:Sandbox&uehstartId=???&uehendId=???

submodule=undo-edit-post (uep)

(main | flow | undo-edit-post)

This module requires read rights.
Source: Flow
License: GPL-2.0+

Retrieve information necesary to undo post edit.

https://www.mediawiki.org/wiki/Extension:Flow/API#undo-edit-post

Parameters:

uepstartId: Revision id to start undo at.; This parameter is required.
uependId: Revision id to end undo at.; This parameter is required.

Example:

Fetch information about undoing a post edit in a specific topic.: api.php?action=flow&submodule=undo-edit-post&page=Topic:S2tycnas4hcucw8w&uaepostId=???&uaestartId=???&uaeendId=???

submodule=undo-edit-topic-summary (uets)

(main | flow | undo-edit-topic-summary)

This module requires read rights.
Source: Flow
License: GPL-2.0+

Retrieve information necessary to undo topic summary edits.

https://www.mediawiki.org/wiki/Extension:Flow/API#undo-edit-topic-summary

Parameters:

uetsstartId: Revision id to start undo at.; This parameter is required.
uetsendId: Revision id to end undo at.; This parameter is required.

Example:

Fetch information about undoing a topic summary edit in a specific topic: api.php?action=flow&submodule=undo-edit-topic-summary&page=Topic:S2tycnas4hcucw8w&uetsstartId=???&uetsendId=???

submodule=view-header (vh)

(main | flow | view-header)

This module requires read rights.
Source: Flow
License: GPL-2.0+

View a board description.

https://www.mediawiki.org/wiki/Extension:Flow/API#view-header

Parameters:

vhformat: Format to return the content in.; One of the following values: html, wikitext, fixed-html; Default: wikitext
vhrevId: Load this revision, instead of the most recent.

Example:

Fetch the description of Talk:Sandbox as wikitext: api.php?action=flow&submodule=view-header&page=Talk:Sandbox&vhformat=wikitext&revId=

submodule=view-post (vp)

(main | flow | view-post)

This module requires read rights.
Source: Flow
License: GPL-2.0+

View a post.

https://www.mediawiki.org/wiki/Extension:Flow/API#view-post

Parameters:

vppostId: ID of the post to view.; This parameter is required.
vpformat: Format to return the content in.; One of the following values: html, wikitext, fixed-html; Default: wikitext

Example:

Fetch the content of a post on Topic:S2tycnas4hcucw8w as wikitext: api.php?action=flow&submodule=view-post&page=Topic:S2tycnas4hcucw8w&vppostId=???&vpformat=wikitext

submodule=view-post-history (vph)

(main | flow | view-post-history)

This module requires read rights.
Source: Flow
License: GPL-2.0+

View the revision history of a post.

https://www.mediawiki.org/wiki/Extension:Flow/API#view-post-history

Parameters:

vphpostId: ID of the post for which to view revision history.; This parameter is required.
vphformat: Format to return the content in.; One of the following values: html, wikitext, fixed-html; Default: wikitext

Example:

Fetch the revisions of a post on Topic:S2tycnas4hcucw8w as wikitext: api.php?action=flow&submodule=view-post-history&page=Topic:S2tycnas4hcucw8w&vphpostId=???&vphformat=wikitext

submodule=view-topic (vt)

(main | flow | view-topic)

This module requires read rights.
Source: Flow
License: GPL-2.0+

View a topic.

https://www.mediawiki.org/wiki/Extension:Flow/API#view-topic

Parameter:

vtformat: (no description); One of the following values: html, wikitext, fixed-html; Default: wikitext

Example:

View Topic:S2tycnas4hcucw8w: api.php?action=flow&submodule=view-topic&page=Topic:S2tycnas4hcucw8w

submodule=view-topic-history (vth)

(main | flow | view-topic-history)

This module requires read rights.
Source: Flow
License: GPL-2.0+

View the revision history of a topic.

https://www.mediawiki.org/wiki/Extension:Flow/API#view-topic-history

Parameter:

vthformat: Format to return the content in.; One of the following values: html, wikitext, fixed-html; Default: wikitext

Example:

View the revisions of the posts on Topic:S2tycnas4hcucw8w as wikitext: api.php?action=flow&submodule=view-topic-history&page=Topic:S2tycnas4hcucw8w&vthformat=wikitext

submodule=view-topic-summary (vts)

(main | flow | view-topic-summary)

This module requires read rights.
Source: Flow
License: GPL-2.0+

View a topic summary.

https://www.mediawiki.org/wiki/Extension:Flow/API#view-topic-summary

Parameters:

vtsformat: Format to return the content in.; One of the following values: html, wikitext, fixed-html; Default: wikitext
vtsrevId: Load this revision, instead of the most recent.

Example:

View the summary for Topic:S2tycnas4hcucw8w as wikitext: api.php?action=flow&submodule=view-topic-summary&page=Topic:S2tycnas4hcucw8w&vtsformat=wikitext&revId=

submodule=view-topiclist (vtl)

(main | flow | view-topiclist)

This module requires read rights.
Source: Flow
License: GPL-2.0+

View a list of topics.

https://www.mediawiki.org/wiki/Extension:Flow/API#view-topiclist

Parameters:

vtloffset-dir: Direction to order the topics.; One of the following values: fwd, rev; Default: fwd
vtlsortby: Sorting option of the topics, either updated (ordered by topic update time), or newest (ordered by topic creation time).; One of the following values: newest, updated, user; Default: user
vtlsavesortby: Save sortby option to user preferences, if set.; Type: boolean (details)
vtloffset-id: Offset value (in UUID format) to start fetching topics at; used only with newest ordering
vtloffset: Offset value (as a topic update timestamp, in TS_MW format (YYYYMMDDHHMMSS)), to start fetching topics at; used only with updated ordering
vtlinclude-offset: Includes the offset item in the results as well; Type: boolean (details)
vtllimit: Number of topics to fetch.; No more than 100 (100 for bots) allowed.; Type: integer or max; Default: 10
vtltoconly: Whether to respond with only the information required for the TOC; Type: boolean (details)
vtlformat: (no description); One of the following values: html, wikitext, fixed-html; Default: wikitext

Example:

List topics on Talk:Sandbox: api.php?action=flow&submodule=view-topiclist&page=Talk:Sandbox

action=flow-parsoid-utils

(main | flow-parsoid-utils)

This module requires read rights.
Source: Flow
License: GPL-2.0+

Convert text between wikitext and HTML.

Parameters:

from: Format to convert content from.; This parameter is required.; One of the following values: html, wikitext
to: Format to convert content to.; This parameter is required.; One of the following values: html, wikitext
content: Content to be converted.; This parameter is required.
title: Title of the page. Cannot be used together with pageid.
pageid: ID of the page. Cannot be used together with title.; Type: integer

Example:

Convert wikitext '''lorem''' ''blah'' to HTML: api.php?action=flow-parsoid-utils&from=wikitext&to=html&content='''lorem'''+''blah''&title=Main_Page

action=flowthank

(main | flowthank)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Thanks
License: MIT

Send a public thank-you notification for a Flow comment.

Parameters:

postid: The UUID of the post to thank for.; This parameter is required.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Send thanks for the comment with UUID xyz789: api.php?action=flowthank&postid=xyz789&token=123ABC

action=geocode

(main | geocode)

This module requires read rights.
Source: Maps
License: See link

API module for geocoding.

Parameters:

locations: The locations to geocode; This parameter is required.; Separate values with |. Maximum number of values is 50 (500 for bots).
service: The geocoding service to use; One of the following values: google, geocoderus
props: (no description); Values (separate with |): lat, lon, alt; Default: lat|lon

Examples:

: api.php?action=geocode&locations=new york
: api.php?action=geocode&locations=new york|brussels|london
: api.php?action=geocode&locations=new york&service=geonames

action=groupreview

(main | groupreview)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Translate
License: GPL-2.0+

Set message group workflow states.

Parameters:

group: Message group.; This parameter is required.
language: Language code.; Default: en
state: The new state for the group.; This parameter is required.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Mark group "group-Example" as ready for German: api.php?action=groupreview&group=page-Example&language=de&state=ready&token=foo

action=help

(main | help)

Source: MediaWiki
License: GPL-2.0+

Display help for the specified modules.

Parameters:

modules: Modules to display help for (values of the action and format parameters, or main). Can specify submodules with a +.; Separate values with |. Maximum number of values is 50 (500 for bots).; Default: main
submodules: Include help for submodules of the named module.; Type: boolean (details)
recursivesubmodules: Include help for submodules recursively.; Type: boolean (details)
wrap: Wrap the output in a standard API response structure.; Type: boolean (details)
toc: Include a table of contents in the HTML output.; Type: boolean (details)

Examples:

Help for the main module.: api.php?action=help
All help in one page.: api.php?action=help&recursivesubmodules=1
Help for the help module itself.: api.php?action=help&modules=help
Help for two query submodules.: api.php?action=help&modules=query+info|query+categorymembers

action=imagerotate

(main | imagerotate)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Rotate one or more images.

Parameters:

rotation

Degrees to rotate image clockwise.

This parameter is required.

One of the following values: 90, 180, 270

continue

When more results are available, use this to continue.

titles

A list of titles to work on.

Separate values with |. Maximum number of values is 50 (500 for bots).

pageids

A list of page IDs to work on.

Type: list of integers

Separate values with |. Maximum number of values is 50 (500 for bots).

revids

A list of revision IDs to work on.

Type: list of integers

Separate values with |. Maximum number of values is 50 (500 for bots).

generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

One of the following values: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, messagecollection, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw

redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

Type: boolean (details)

converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan, iu, kk, ku, shi, sr, tg, uz, zh.

Type: boolean (details)

token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

Examples:

Rotate File:Example.png by 90 degrees.: api.php?action=imagerotate&titles=File:Example.jpg&rotation=90&token=123ABC
Rotate all images in Category:Flip by 180 degrees.: api.php?action=imagerotate&generator=categorymembers&gcmtitle=Category:Flip&gcmtype=file&rotation=180&token=123ABC

action=import

(main | import)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Import a page from another wiki, or from an XML file.

Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when sending a file for the xml parameter.

https://www.mediawiki.org/wiki/API:Import

Parameters:

summary: Import summary.
xml: Uploaded XML file.; Must be posted as a file upload using multipart/form-data.
interwikisource: For interwiki imports: wiki to import from.; One of the following values:
interwikipage: For interwiki imports: page to import.
fullhistory: For interwiki imports: import the full history, not just the current version.; Type: boolean (details)
templates: For interwiki imports: import all included templates as well.; Type: boolean (details)
namespace: Import to this namespace. Cannot be used together with rootpage.; One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 460, 461, 170, 171, 2300, 2301, 2302, 2303, 102, 103, 108, 109, 710, 711, 420, 421, 106, 107, 2600, 1198, 1199, 104, 105
rootpage: Import as subpage of this page. Cannot be used together with namespace.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Import meta:Help:ParserFunctions to namespace 100 with full history.: api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory=&token=123ABC

action=languagesearch

(main | languagesearch)

This module requires read rights.
Source: UniversalLanguageSelector
License: GPL-2.0+

Search for language names in any script.

Parameters:

search: Search string.; This parameter is required.
typos: Number of spelling mistakes allowed in the search string.; Type: integer; Default: 1

Examples:

Search for "Te": api.php?action=languagesearch&search=Te
Search for "ഫി": api.php?action=languagesearch&search=ഫി
Search for "ഫി", allowing one typo: api.php?action=languagesearch&search=ഫി&typos=1

(main | login)

This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

In the event of a successful log-in, the needed cookies will be included in the HTTP response headers. In the event of a failed log-in, further attempts may be throttled to limit automated password guessing attacks.

https://www.mediawiki.org/wiki/API:Login

Parameters:

lgname: User name.
lgpassword: Password.
lgdomain: Domain (optional).
lgtoken: Login token obtained in first request.

Examples:

Retrieve a login token.: api.php?action=login&lgname=user&lgpassword=password
Log in.: api.php?action=login&lgname=user&lgpassword=password&lgtoken=123ABC

action=logout

(main | logout)

Source: MediaWiki
License: GPL-2.0+

Log out and clear session data.

https://www.mediawiki.org/wiki/API:Logout

Example:

Log the current user out.: api.php?action=logout

action=managetags

(main | managetags)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Perform management tasks relating to change tags.

https://www.mediawiki.org/wiki/API:Tag_management

Parameters:

operation

Which operation to perform:

create: Create a new change tag for manual use.
delete: Remove a change tag from the database, including removing the tag from all revisions, recent change entries and log entries on which it is used.
activate: Activate a change tag, allowing users to apply it manually.
deactivate: Deactivate a change tag, preventing users from applying it manually.

This parameter is required.

One of the following values: create, delete, activate, deactivate

tag

Tag to create, delete, activate or deactivate. For tag creation, the tag must not exist. For tag deletion, the tag must exist. For tag activation, the tag must exist and not be in use by an extension. For tag deactivation, the tag must be currently active and manually defined.

This parameter is required.

reason

An optional reason for creating, deleting, activating or deactivating the tag.

ignorewarnings

Whether to ignore any warnings that are issued during the operation.

Type: boolean (details)

token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

Examples:

Create a tag named spam with the reason For use in edit patrolling: api.php?action=managetags&operation=create&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC
Delete the vandlaism tag with the reason Misspelt: api.php?action=managetags&operation=delete&tag=vandlaism&reason=Misspelt&token=123ABC
Activate a tag named spam with the reason For use in edit patrolling: api.php?action=managetags&operation=activate&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC
Deactivate a tag named spam with the reason No longer required: api.php?action=managetags&operation=deactivate&tag=spam&reason=No+longer+required&token=123ABC

action=move

(main | move)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Move a page.

https://www.mediawiki.org/wiki/API:Move

Parameters:

from: Title of the page to rename. Cannot be used together with fromid.
fromid: Page ID of the page to rename. Cannot be used together with from.; Type: integer
to: Title to rename the page to.; This parameter is required.
reason: Reason for the rename.; Default: (empty)
movetalk: Rename the talk page, if it exists.; Type: boolean (details)
movesubpages: Rename subpages, if applicable.; Type: boolean (details)
noredirect: Don't create a redirect.; Type: boolean (details)
watch: Deprecated.; Add the page and the redirect to the current user's watchlist.; Type: boolean (details)
unwatch: Deprecated.; Remove the page and the redirect from the current user's watchlist.; Type: boolean (details)
watchlist: Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.; One of the following values: watch, unwatch, preferences, nochange; Default: preferences
ignorewarnings: Ignore any warnings.; Type: boolean (details)
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Move Badtitle to Goodtitle without leaving a redirect.: api.php?action=move&from=Badtitle&to=Goodtitle&token=123ABC&reason=Misspelled%20title&movetalk=&noredirect=

action=opensearch

(main | opensearch)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Search the wiki using the OpenSearch protocol.

https://www.mediawiki.org/wiki/API:Opensearch

Parameters:

search

Search string.

limit

Maximum number of results to return.

No more than 100 (100 for bots) allowed.

Type: integer or max

Default: 10

namespace

Namespaces to search.

Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 460, 461, 170, 171, 2300, 2301, 2302, 2303, 102, 103, 108, 109, 710, 711, 420, 421, 106, 107, 2600, 1198, 1199, 104, 105

Maximum number of values is 50 (500 for bots).

Default: 0

suggest

Do nothing if $wgEnableOpenSearchSuggest is false.

Type: boolean (details)

redirects

How to handle redirects:

return: Return the redirect itself.
resolve: Return the target page. May return fewer than limit results.

For historical reasons, the default is "return" for format=json and "resolve" for other formats.

One of the following values: return, resolve

format

The format of the output.

One of the following values: json, jsonfm, xml, xmlfm

Default: json

warningsaserror

If warnings are raised with format=json, return an API error instead of ignoring them.

Type: boolean (details)

Example:

Find pages beginning with Te.: api.php?action=opensearch&search=Te

action=options

(main | options)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Change preferences of the current user.

Only options which are registered in core or in one of installed extensions, or options with keys prefixed with userjs- (intended to be used by user scripts), can be set.

https://www.mediawiki.org/wiki/API:Options

Parameters:

reset: Resets preferences to the site defaults.; Type: boolean (details)
resetkinds: List of types of options to reset when the reset option is set.; Values (separate with |): registered, registered-multiselect, registered-checkmatrix, userjs, special, unused, all; Default: all
change: List of changes, formatted name=value (e.g. skin=vector). Value cannot contain pipe characters. If no value is given (not even an equals sign), e.g., optionname|otheroption|..., the option will be reset to its default value.; Separate values with |. Maximum number of values is 50 (500 for bots).
optionname: The name of the option that should be set to the value given by optionvalue.
optionvalue: The value for the option specified by optionname, can contain pipe characters.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Examples:

Reset all preferences.: api.php?action=options&reset=&token=123ABC
Change skin and hideminor preferences.: api.php?action=options&change=skin=vector|hideminor=1&token=123ABC
Reset all preferences, then set skin and nickname.: api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC

action=paraminfo

(main | paraminfo)

Source: MediaWiki
License: GPL-2.0+

Obtain information about API modules.

https://www.mediawiki.org/wiki/API:Parameter_information

Parameters:

modules: List of module names (values of the action and format parameters, or main). Can specify submodules with a +.; Separate values with |. Maximum number of values is 50 (500 for bots).
helpformat: Format of help strings.; One of the following values: html, wikitext, raw, none; Default: none
querymodules: Deprecated.; List of query module names (value of prop, meta or list parameter). Use modules=query+foo instead of querymodules=foo.; Values (separate with |): allcampaigns, allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allmessages, allpages, allredirects, alltransclusions, allusers, backlinks, blocks, categories, categoryinfo, categorymembers, contributors, deletedrevisions, deletedrevs, duplicatefiles, embeddedin, extlinks, exturlusage, filearchive, filerepoinfo, fileusage, flowinfo, gadgetcategories, gadgets, globalusage, imageinfo, images, imageusage, info, iwbacklinks, iwlinks, langbacklinks, langlinks, languagestats, links, linkshere, logevents, messagecollection, messagegroups, messagegroupstats, messagetranslations, notifications, pagepropnames, pageprops, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, siteinfo, stashimageinfo, tags, templates, tokens, transcludedin, transcodestatus, usercontribs, userinfo, users, videoinfo, watchlist, watchlistraw; Maximum number of values is 50 (500 for bots).
mainmodule: Deprecated.; Get information about the main (top-level) module as well. Use modules=main instead.
pagesetmodule: Deprecated.; Get information about the pageset module (providing titles= and friends) as well.
formatmodules: Deprecated.; List of format module names (value of format parameter). Use modules instead.; Values (separate with |): dbg, dbgfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, xml, xmlfm, yaml, yamlfm

Example:

Show info for action=parse, format=jsonfm, action=query&list=allpages, and action=query&meta=siteinfo.: api.php?action=paraminfo&modules=parse|phpfm|query+allpages|query+siteinfo

action=parse

(main | parse)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Parses content and returns parser output.

See the various prop-modules of action=query to get information from the current version of a page.

There are several ways to specify the text to parse:

Specify a page or revision, using page, pageid, or oldid.
Specify content explicitly, using text, title, and contentmodel.
Specify only a summary to parse. prop should be given an empty value.

https://www.mediawiki.org/wiki/API:Parsing_wikitext#parse

Parameters:

title

Title of page the text belongs to. If omitted, contentmodel must be specified, and API will be used as the title.

text

Text to parse. Use title or contentmodel to control the content model.

summary

Summary to parse.

page

Parse the content of this page. Cannot be used together with text and title.

pageid

Parse the content of this page. Overrides page.

Type: integer

redirects

If page or pageid is set to a redirect, resolve it.

Type: boolean (details)

oldid

Parse the content of this revision. Overrides page and pageid.

Type: integer

prop

Which pieces of information to get:

text: Gives the parsed text of the wikitext.
langlinks: Gives the language links in the parsed wikitext.
categories: Gives the categories in the parsed wikitext.
categorieshtml: Gives the HTML version of the categories.
links: Gives the internal links in the parsed wikitext.
templates: Gives the templates in the parsed wikitext.
images: Gives the images in the parsed wikitext.
externallinks: Gives the external links in the parsed wikitext.
sections: Gives the sections in the parsed wikitext.
revid: Adds the revision ID of the parsed page.
displaytitle: Adds the title of the parsed wikitext.
headitems: Gives items to put in the <head> of the page.
headhtml: Gives parsed <head> of the page.
modules: Gives the ResourceLoader modules used on the page. Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules.
jsconfigvars: Gives the JavaScript configuration variables specific to the page.
encodedjsconfigvars: Gives the JavaScript configuration variables specific to the page as a JSON string.
indicators: Gives the HTML of page status indicators used on the page.
iwlinks: Gives interwiki links in the parsed wikitext.
wikitext: Gives the original wikitext that was parsed.
properties: Gives various properties defined in the parsed wikitext.
limitreportdata: Gives the limit report in a structured way. Gives no data, when disablelimitreport is set.
limitreporthtml: Gives the HTML version of the limit report. Gives no data, when disablelimitreport is set.
parsetree: The XML parse tree of revision content (requires content model wikitext)

Values (separate with |): text, langlinks, categories, categorieshtml, links, templates, images, externallinks, sections, revid, displaytitle, headitems, headhtml, modules, jsconfigvars, encodedjsconfigvars, indicators, iwlinks, wikitext, properties, limitreportdata, limitreporthtml, parsetree

pst

Do a pre-save transform on the input before parsing it. Only valid when used with text.

Type: boolean (details)

onlypst

Do a pre-save transform (PST) on the input, but don't parse it. Returns the same wikitext, after a PST has been applied. Only valid when used with text.

Type: boolean (details)

effectivelanglinks

Includes language links supplied by extensions (for use with prop=langlinks).

Type: boolean (details)

section

Only retrieve the content of this section number or when new generate a new section.

new section is only honored when specifying text.

sectiontitle

New section title when section is new.

Unlike page editing, this does not fall back to summary when omitted or empty.

disablepp

Deprecated.

Use disablelimitreport instead.

Type: boolean (details)

disablelimitreport

Omit the limit report ("NewPP limit report") from the parser output.

Type: boolean (details)

disableeditsection

Omit edit section links from the parser output.

Type: boolean (details)

disabletidy

Do not run HTML cleanup (e.g. tidy) on the parser output.

Type: boolean (details)

generatexml

Deprecated.

Generate XML parse tree (requires content model wikitext; replaced by prop=parsetree).

Type: boolean (details)

preview

Parse in preview mode.

Type: boolean (details)

sectionpreview

Parse in section preview mode (enables preview mode too).

Type: boolean (details)

disabletoc

Omit table of contents in output.

Type: boolean (details)

contentformat

Content serialization format used for the input text. Only valid when used with text.

One of the following values: text/x-wiki, text/javascript, application/json, text/css, text/plain

contentmodel

Content model of the input text. If omitted, title must be specified, and default will be the model of the specified title. Only valid when used with text.

One of the following values: wikitext, javascript, json, css, text, JsonSchema, Campaign, flow-board

Examples:

Parse a page.: api.php?action=parse&page=Project:Sandbox
Parse wikitext.: api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext
Parse wikitext, specifying the page title.: api.php?action=parse&text={{PAGENAME}}&title=Test
Parse a summary.: api.php?action=parse&summary=Some+[[link]]&prop=

action=patrol

(main | patrol)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Patrol a page or revision.

https://www.mediawiki.org/wiki/API:Patrol

Parameters:

rcid: Recentchanges ID to patrol.; Type: integer
revid: Revision ID to patrol.; Type: integer
token: A "patrol" token retrieved from action=query&meta=tokens; This parameter is required.

Examples:

Patrol a recent change.: api.php?action=patrol&token=123ABC&rcid=230672766
Patrol a revision.: api.php?action=patrol&token=123ABC&revid=230672766

action=protect

(main | protect)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Change the protection level of a page.

https://www.mediawiki.org/wiki/API:Protect

Parameters:

title

Title of the page to (un)protect. Cannot be used together with pageid.

pageid

ID of the page to (un)protect. Cannot be used together with title.

Type: integer

protections

List of protection levels, formatted action=level (e.g. edit=sysop).

Note: Any actions not listed will have restrictions removed.

This parameter is required.

Separate values with |. Maximum number of values is 50 (500 for bots).

expiry

Expiry timestamps. If only one timestamp is set, it'll be used for all protections. Use infinite, indefinite, infinity, or never, for a never-expiring protection.

Separate values with |. Maximum number of values is 50 (500 for bots).

Default: infinite

reason

Reason for (un)protecting.

Default: (empty)

cascade

Enable cascading protection (i.e. protect transcluded templates and images used in this page). Ignored if none of the given protection levels support cascading.

Type: boolean (details)

watch

Deprecated.

If set, add the page being (un)protected to the current user's watchlist.

Type: boolean (details)

watchlist

Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.

One of the following values: watch, unwatch, preferences, nochange

Default: preferences

token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

Examples:

Protect a page.: api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never
Unprotect a page by setting restrictions to all.: api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=all|move=all&reason=Lifting%20restrictions
Unprotect a page by setting no restrictions.: api.php?action=protect&title=Main%20Page&token=123ABC&protections=&reason=Lifting%20restrictions

action=purge

(main | purge)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Purge the cache for the given titles.

Requires a POST request if the user is not logged in.

https://www.mediawiki.org/wiki/API:Purge

Parameters:

forcelinkupdate

Update the links tables.

Type: boolean (details)

forcerecursivelinkupdate

Update the links table, and update the links tables for any page that uses this page as a template.

Type: boolean (details)

continue

When more results are available, use this to continue.

titles

A list of titles to work on.

Separate values with |. Maximum number of values is 50 (500 for bots).

pageids

A list of page IDs to work on.

Type: list of integers

Separate values with |. Maximum number of values is 50 (500 for bots).

revids

A list of revision IDs to work on.

Type: list of integers

Separate values with |. Maximum number of values is 50 (500 for bots).

generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

Type: boolean (details)

converttitles

Type: boolean (details)

Examples:

Purge the Main Page and the API page.: api.php?action=purge&titles=Main_Page|API
Purge the first 10 pages in the main namespace.: api.php?action=purge&generator=allpages&gapnamespace=0&gaplimit=10

action=query

(main | query)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Fetch data from and about MediaWiki.

All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites.

Parameters:

prop

Which properties to get for the queried pages.

Values (separate with |): categories, categoryinfo, contributors, deletedrevisions, duplicatefiles, extlinks, fileusage, flowinfo, globalusage, imageinfo, images, info, iwlinks, langlinks, links, linkshere, pageprops, redirects, revisions, stashimageinfo, templates, transcludedin, transcodestatus, videoinfo

list

Which lists to get.

Values (separate with |): allcampaigns, allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, alltransclusions, allusers, backlinks, blocks, categorymembers, deletedrevs, embeddedin, exturlusage, filearchive, gadgetcategories, gadgets, imageusage, iwbacklinks, langbacklinks, logevents, messagecollection, pagepropnames, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, search, tags, usercontribs, users, watchlist, watchlistraw

meta

Which metadata to get.

Values (separate with |): allmessages, filerepoinfo, languagestats, messagegroups, messagegroupstats, messagetranslations, notifications, siteinfo, tokens, userinfo

indexpageids

Include an additional pageids section listing all returned page IDs.

Type: boolean (details)

export

Export the current revisions of all given or generated pages.

Type: boolean (details)

exportnowrap

Return the export XML without wrapping it in an XML result (same format as Special:Export). Can only be used with export.

Type: boolean (details)

iwurl

Whether to get the full URL if the title is an interwiki link.

Type: boolean (details)

continue

When more results are available, use this to continue.

rawcontinue

Return raw query-continue data for continuation.

Type: boolean (details)

titles

A list of titles to work on.

Separate values with |. Maximum number of values is 50 (500 for bots).

pageids

A list of page IDs to work on.

Type: list of integers

Separate values with |. Maximum number of values is 50 (500 for bots).

revids

A list of revision IDs to work on.

Type: list of integers

Separate values with |. Maximum number of values is 50 (500 for bots).

generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

Type: boolean (details)

converttitles

Type: boolean (details)

Examples:

Fetch site info and revisions of Main Page.: api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment&continue=
Fetch revisions of pages beginning with API/.: api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue=

prop=categories (cl)

(main | query | categories)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

List all categories the pages belong to.

https://www.mediawiki.org/wiki/API:Categories

Parameters:

clprop

Which additional properties to get for each category:

sortkey: Adds the sortkey (hexadecimal string) and sortkey prefix (human-readable part) for the category.
timestamp: Adds timestamp of when the category was added.
hidden: Tags categories that are hidden with __HIDDENCAT__.

Values (separate with |): sortkey, timestamp, hidden

clshow

Which kind of categories to show.

Values (separate with |): hidden, !hidden

cllimit

How many categories to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

clcontinue

When more results are available, use this to continue.

clcategories

Only list these categories. Useful for checking whether a certain page is in a certain category.

Separate values with |. Maximum number of values is 50 (500 for bots).

cldir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

Examples:

Get a list of categories the page Albert Einstein belongs to.: api.php?action=query&prop=categories&titles=Albert%20Einstein
Get information about all categories used in the page Albert Einstein.: api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info

prop=categoryinfo (ci)

(main | query | categoryinfo)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Returns information about the given categories.

https://www.mediawiki.org/wiki/API:Categoryinfo

Parameter:

cicontinue: When more results are available, use this to continue.

Example:

Get information about Category:Foo and Category:Bar.: api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar

prop=contributors (pc)

(main | query | contributors)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Get the list of logged-in contributors and the count of anonymous contributors to a page.

https://www.mediawiki.org/wiki/API:Contributors

Parameters:

pcgroup: Only include users in the given groups. Does not include implicit or auto-promoted groups like *, user, or autoconfirmed.; Values (separate with |): bot, sysop, bureaucrat, upwizcampeditors, oversight, flow-bot, translator, smwadministrator
pcexcludegroup: Exclude users in the given groups. Does not include implicit or auto-promoted groups like *, user, or autoconfirmed.; Values (separate with |): bot, sysop, bureaucrat, upwizcampeditors, oversight, flow-bot, translator, smwadministrator
pcrights: Only include users having the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.; Values (separate with |): apihighlimits, applychangetags, autoconfirmed, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmywatchlist, editsemiprotected, editusercssjs, editusercss, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, passwordreset, patrol, patrolmarks, protect, proxyunbannable, purge, read, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi, nuke, gadgets-edit, gadgets-definition-edit, renameuser, replacetext, geocode, viewedittab, editrestrictedfields, createclass, upwizcampaigns, confirmaccount, requestips, lookupcredentials, flow-hide, flow-lock, flow-delete, flow-suppress, flow-edit-post, flow-create-board, translate, translate-import, translate-manage, translate-messagereview, translate-groupreview, translate-sandboxmanage, collectionsaveasuserpage, collectionsaveascommunitypage, transcode-reset, transcode-status, openid-converter-access, openid-dashboard-access, openid-dashboard-admin, openid-login-with-openid, openid-create-account-with-openid, openid-create-account-without-openid, masseditregex, interwiki, smw-admin, pagetranslation; Maximum number of values is 50 (500 for bots).
pcexcluderights: Exclude users having the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.; Values (separate with |): apihighlimits, applychangetags, autoconfirmed, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmywatchlist, editsemiprotected, editusercssjs, editusercss, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, passwordreset, patrol, patrolmarks, protect, proxyunbannable, purge, read, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi, nuke, gadgets-edit, gadgets-definition-edit, renameuser, replacetext, geocode, viewedittab, editrestrictedfields, createclass, upwizcampaigns, confirmaccount, requestips, lookupcredentials, flow-hide, flow-lock, flow-delete, flow-suppress, flow-edit-post, flow-create-board, translate, translate-import, translate-manage, translate-messagereview, translate-groupreview, translate-sandboxmanage, collectionsaveasuserpage, collectionsaveascommunitypage, transcode-reset, transcode-status, openid-converter-access, openid-dashboard-access, openid-dashboard-admin, openid-login-with-openid, openid-create-account-with-openid, openid-create-account-without-openid, masseditregex, interwiki, smw-admin, pagetranslation; Maximum number of values is 50 (500 for bots).
pclimit: How many contributors to return.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10
pccontinue: When more results are available, use this to continue.

Example:

Show contributors to the page Main Page.: api.php?action=query&prop=contributors&titles=Main_Page

prop=deletedrevisions (drv)

(main | query | deletedrevisions)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Get deleted revision information.

May be used in several ways:

Get deleted revisions for a set of pages, by setting titles or pageids. Ordered by title and timestamp.
Get data about a set of deleted revisions by setting their IDs with revids. Ordered by revision ID.

https://www.mediawiki.org/wiki/API:Deletedrevisions

Parameters:

drvprop

Which properties to get for each revision:

ids: The ID of the revision.
flags: Revision flags (minor).
timestamp: The timestamp of the revision.
user: User that made the revision.
userid: User ID of the revision creator.
size: Length (bytes) of the revision.
sha1: SHA-1 (base 16) of the revision.
contentmodel: Content model ID of the revision.
comment: Comment by the user for the revision.
parsedcomment: Parsed comment by the user for the revision.
content: Text of the revision.
tags: Tags for the revision.
parsetree: The XML parse tree of revision content (requires content model wikitext).

Values (separate with |): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree

Default: ids|timestamp|flags|comment|user

drvlimit

Limit how many revisions will be returned.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

drvexpandtemplates

Expand templates in revision content (requires drvprop=content).

Type: boolean (details)

drvgeneratexml

Deprecated.

Generate XML parse tree for revision content (requires drvprop=content; replaced by drvprop=parsetree).

Type: boolean (details)

drvparse

Parse revision content (requires drvprop=content). For performance reasons, if this option is used, drvlimit is enforced to 1.

Type: boolean (details)

drvsection

Only retrieve the content of this section number.

drvdiffto

Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

drvdifftotext

Text to diff each revision to. Only diffs a limited number of revisions. Overrides drvdiffto. If drvsection is set, only that section will be diffed against this text.

drvcontentformat

Serialization format used for drvdifftotext and expected for output of content.

One of the following values: text/x-wiki, text/javascript, application/json, text/css, text/plain

drvstart

The timestamp to start enumerating from. Ignored when processing a list of revision IDs.

Type: timestamp (allowed formats)

drvend

The timestamp to stop enumerating at. Ignored when processing a list of revision IDs.

Type: timestamp (allowed formats)

drvdir

In which direction to enumerate:

newer: List oldest first. Note: drvstart has to be before drvend.
older: List newest first (default). Note: drvstart has to be later than drvend.

One of the following values: newer, older

Default: older

drvtag

Only list revisions tagged with this tag.

drvuser

Only list revisions by this user.

Type: user name

drvexcludeuser

Don't list revisions by this user.

Type: user name

drvcontinue

When more results are available, use this to continue.

Examples:

List the deleted revisions of the pages Main Page and Talk:Main Page, with content.: api.php?action=query&prop=deletedrevisions&titles=Main%20Page|Talk:Main%20Page&drvprop=user|comment|content
List the information for deleted revision 123456.: api.php?action=query&prop=deletedrevisions&revids=123456

prop=duplicatefiles (df)

(main | query | duplicatefiles)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

List all files that are duplicates of the given files based on hash values.

https://www.mediawiki.org/wiki/API:Duplicatefiles

Parameters:

dflimit: How many duplicate files to return.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10
dfcontinue: When more results are available, use this to continue.
dfdir: The direction in which to list.; One of the following values: ascending, descending; Default: ascending
dflocalonly: Look only for files in the local repository.; Type: boolean (details)

Examples:

Look for duplicates of File:Albert Einstein Head.jpg.: api.php?action=query&titles=File:Albert_Einstein_Head.jpg&prop=duplicatefiles
Look for duplicates of all files.: api.php?action=query&generator=allimages&prop=duplicatefiles

prop=extlinks (el)

(main | query | extlinks)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Returns all external URLs (not interwikis) from the given pages.

https://www.mediawiki.org/wiki/API:Extlinks

Parameters:

ellimit: How many links to return.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10
eloffset: When more results are available, use this to continue.; Type: integer
elprotocol: Protocol of the URL. If empty and elquery is set, the protocol is http. Leave both this and elquery empty to list all external links.; One of the following values: Can be empty, or bitcoin, ftp, ftps, geo, git, gopher, http, https, irc, ircs, magnet, mailto, mms, news, nntp, redis, sftp, sip, sips, sms, ssh, svn, tel, telnet, urn, worldwind, xmpp; Default: (empty)
elquery: Search string without protocol. Useful for checking whether a certain page contains a certain external url.
elexpandurl: Expand protocol-relative URLs with the canonical protocol.; Type: boolean (details)

Example:

Get a list of external links on Main Page.: api.php?action=query&prop=extlinks&titles=Main%20Page

prop=fileusage (fu)

(main | query | fileusage)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Find all pages that use the given files.

https://www.mediawiki.org/wiki/API:Fileusage

Parameters:

fuprop

Which properties to get:

pageid: Page ID of each page.
title: Title of each page.
redirect: Flag if the page is a redirect.

Values (separate with |): pageid, title, redirect

Default: pageid|title|redirect

funamespace

Only include pages in these namespaces.

Maximum number of values is 50 (500 for bots).

fushow

Show only items that meet these criteria:

redirect: Only show redirects.
!redirect: Only show non-redirects.

Values (separate with |): redirect, !redirect

fulimit

How many to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

fucontinue

When more results are available, use this to continue.

Examples:

Get a list of pages using File:Example.jpg.: api.php?action=query&prop=fileusage&titles=File%3AExample.jpg
Get information about pages using File:Example.jpg.: api.php?action=query&generator=fileusage&titles=File%3AExample.jpg&prop=info

prop=flowinfo (fli)

(main | query | flowinfo)

This module is deprecated.
This module requires read rights.
Source: Flow
License: GPL-2.0+

Get basic Flow information about a page.

https://www.mediawiki.org/wiki/Extension:Flow/API#action.3Dquery.26prop.3Dflowinfo

Example:

Fetch Flow information about Talk:Sandbox, Main Page, and Talk:Flow: api.php?action=query&prop=flowinfo&titles=Talk:Sandbox|Main_Page|Talk:Flow

prop=globalusage (gu)

(main | query | globalusage)

This module requires read rights.
Source: Global Usage
License: MIT

Returns global image usage for a certain image.

Parameters:

guprop

Which properties to return:

url: Adds url.
pageid: Adds page ID.
namespace: Adds namespace ID.

Values (separate with |): url, pageid, namespace

Default: url

gulimit

How many links to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

gucontinue

When more results are available, use this to continue.

gufilterlocal

Filter local usage of the file.

Type: boolean (details)

Example:

Get usage of File:Example.jpg: api.php?action=query&prop=globalusage&titles=File:Example.jpg

prop=imageinfo (ii)

(main | query | imageinfo)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Returns file information and upload history.

https://www.mediawiki.org/wiki/API:Imageinfo

Parameters:

iiprop

Which file information to get:

timestamp: Adds timestamp for the uploaded version.
user: Adds the user who uploaded each file version.
userid: Add the ID of the user that uploaded each file version.
comment: Comment on the version.
parsedcomment: Parse the comment on the version.
canonicaltitle: Adds the canonical title of the file.
url: Gives URL to the file and the description page.
size: Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions: Alias for size.
sha1: Adds SHA-1 hash for the file.
mime: Adds MIME type of the file.
thumbmime: Adds MIME type of the image thumbnail (requires url and param iiurlwidth).
mediatype: Adds the media type of the file.
metadata: Lists Exif metadata for the version of the file.
commonmetadata: Lists file format generic metadata for the version of the file.
extmetadata: Lists formatted metadata combined from multiple sources. Results are HTML formatted.
archivename: Adds the filename of the archive version for non-latest versions.
bitdepth: Adds the bit depth of the version.
uploadwarning: Used by the Special:Upload page to get information about an existing file. Not intended for use outside MediaWiki core.

Values (separate with |): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, thumbmime, mediatype, metadata, commonmetadata, extmetadata, archivename, bitdepth, uploadwarning

Default: timestamp|user

iilimit

How many file revisions to return per file.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 1

iistart

Timestamp to start listing from.

Type: timestamp (allowed formats)

iiend

Timestamp to stop listing at.

Type: timestamp (allowed formats)

iiurlwidth

If iiprop=url is set, a URL to an image scaled to this width will be returned. For performance reasons if this option is used, no more than 50 scaled images will be returned.

Type: integer

Default: -1

iiurlheight

Similar to iiurlwidth.

Type: integer

Default: -1

iimetadataversion

Version of metadata to use. If latest is specified, use latest version. Defaults to 1 for backwards compatibility.

Default: 1

iiextmetadatalanguage

What language to fetch extmetadata in. This affects both which translation to fetch, if multiple are available, as well as how things like numbers and various values are formatted.

Default: en

iiextmetadatamultilang

If translations for extmetadata property are available, fetch all of them.

Type: boolean (details)

iiextmetadatafilter

If specified and non-empty, only these keys will be returned for iiprop=extmetadata.

Separate values with |. Maximum number of values is 50 (500 for bots).

iiurlparam

A handler specific parameter string. For example, PDFs might use page15-100px. iiurlwidth must be used and be consistent with iiurlparam.

Default: (empty)

iicontinue

When more results are available, use this to continue.

iilocalonly

Look only for files in the local repository.

Type: boolean (details)

Examples:

Fetch information about the current version of File:Albert Einstein Head.jpg.: api.php?action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo
Fetch information about versions of File:Test.jpg from 2008 and later.: api.php?action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&iiend=2007-12-31T23:59:59Z&iiprop=timestamp|user|url

prop=images (im)

(main | query | images)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Returns all files contained on the given pages.

https://www.mediawiki.org/wiki/API:Images

Parameters:

imlimit: How many files to return.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10
imcontinue: When more results are available, use this to continue.
imimages: Only list these files. Useful for checking whether a certain page has a certain file.; Separate values with |. Maximum number of values is 50 (500 for bots).
imdir: The direction in which to list.; One of the following values: ascending, descending; Default: ascending

Examples:

Get a list of files used in the Main Page.: api.php?action=query&prop=images&titles=Main%20Page
Get information about all files used in the Main Page.: api.php?action=query&generator=images&titles=Main%20Page&prop=info

prop=info (in)

(main | query | info)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Get basic page information.

https://www.mediawiki.org/wiki/API:Info

Parameters:

inprop

Which additional properties to get:

protection: List the protection level of each page.
talkid: The page ID of the talk page for each non-talk page.
watched: List the watched status of each page.
watchers: The number of watchers, if allowed.
notificationtimestamp: The watchlist notification timestamp of each page.
subjectid: The page ID of the parent page for each talk page.
url: Gives a full URL, an edit URL, and the canonical URL for each page.
readable: Whether the user can read this page.
preload: Gives the text returned by EditFormPreloadText.
displaytitle: Gives the manner in which the page title is actually displayed.

Values (separate with |): protection, talkid, watched, watchers, notificationtimestamp, subjectid, url, readable, preload, displaytitle

intestactions

Test whether the current user can perform certain actions on the page.

Separate values with |. Maximum number of values is 50 (500 for bots).

intoken

Deprecated.

Use action=query&meta=tokens instead.

Values (separate with |): edit, delete, protect, move, block, unblock, email, import, watch

incontinue

When more results are available, use this to continue.

Examples:

Get information about the page Main Page.: api.php?action=query&prop=info&titles=Main%20Page
Get general and protection information about the page Main Page.: api.php?action=query&prop=info&inprop=protection&titles=Main%20Page

prop=iwlinks (iw)

(main | query | iwlinks)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Returns all interwiki links from the given pages.

https://www.mediawiki.org/wiki/API:Iwlinks

Parameters:

iwprop

Which additional properties to get for each interlanguage link:

url: Adds the full URL.

Values (separate with |): url

iwprefix

Only return interwiki links with this prefix.

iwtitle

Interwiki link to search for. Must be used with iwprefix.

iwdir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

iwlimit

How many interwiki links to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

iwcontinue

When more results are available, use this to continue.

iwurl

Deprecated.

Whether to get the full URL (cannot be used with iwprop).

Type: boolean (details)

Example:

Get interwiki links from the page Main Page.: api.php?action=query&prop=iwlinks&titles=Main%20Page

prop=langlinks (ll)

(main | query | langlinks)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Returns all interlanguage links from the given pages.

https://www.mediawiki.org/wiki/API:Langlinks

Parameters:

llprop

Which additional properties to get for each interlanguage link:

url: Adds the full URL.
langname: Adds the localised language name (best effort). Use llinlanguagecode to control the language.
autonym: Adds the native language name.

Values (separate with |): url, langname, autonym

lllang

Only return language links with this language code.

lltitle

Link to search for. Must be used with lllang.

lldir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

llinlanguagecode

Language code for localised language names.

Default: en

lllimit

How many langlinks to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

llcontinue

When more results are available, use this to continue.

llurl

Deprecated.

Whether to get the full URL (cannot be used with llprop).

Type: boolean (details)

Example:

Get interlanguage links from the page Main Page.: api.php?action=query&prop=langlinks&titles=Main%20Page&redirects=

prop=links (pl)

(main | query | links)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Returns all links from the given pages.

https://www.mediawiki.org/wiki/API:Links

Parameters:

plnamespace: Show links in these namespaces only.; Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 460, 461, 170, 171, 2300, 2301, 2302, 2303, 102, 103, 108, 109, 710, 711, 420, 421, 106, 107, 2600, 1198, 1199, 104, 105; Maximum number of values is 50 (500 for bots).
pllimit: How many links to return.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10
plcontinue: When more results are available, use this to continue.
pltitles: Only list links to these titles. Useful for checking whether a certain page links to a certain title.; Separate values with |. Maximum number of values is 50 (500 for bots).
pldir: The direction in which to list.; One of the following values: ascending, descending; Default: ascending

Examples:

Get links from the page Main Page: api.php?action=query&prop=links&titles=Main%20Page
Get information about the link pages in the page Main Page.: api.php?action=query&generator=links&titles=Main%20Page&prop=info
Get links from the page Main Page in the User and Template namespaces.: api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10

prop=linkshere (lh)

(main | query | linkshere)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Find all pages that link to the given pages.

https://www.mediawiki.org/wiki/API:Linkshere

Parameters:

lhprop

Which properties to get:

pageid: Page ID of each page.
title: Title of each page.
redirect: Flag if the page is a redirect.

Values (separate with |): pageid, title, redirect

Default: pageid|title|redirect

lhnamespace

Only include pages in these namespaces.

Maximum number of values is 50 (500 for bots).

lhshow

Show only items that meet these criteria:

redirect: Only show redirects.
!redirect: Only show non-redirects.

Values (separate with |): redirect, !redirect

lhlimit

How many to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

lhcontinue

When more results are available, use this to continue.

Examples:

Get a list of pages linking to the Main Page.: api.php?action=query&prop=linkshere&titles=Main%20Page
Get information about pages linking to the Main Page.: api.php?action=query&generator=linkshere&titles=Main%20Page&prop=info

prop=pageprops (pp)

(main | query | pageprops)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Get various properties defined in the page content.

https://www.mediawiki.org/wiki/API:Pageprops

Parameters:

ppcontinue: When more results are available, use this to continue.
ppprop: Only list these props. Useful for checking whether a certain page uses a certain page prop.; Separate values with |. Maximum number of values is 50 (500 for bots).

Example:

Get properties for the pages Main Page and MediaWiki.: api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki

prop=redirects (rd)

(main | query | redirects)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Returns all redirects to the given pages.

https://www.mediawiki.org/wiki/API:Redirects

Parameters:

rdprop

Which properties to get:

pageid: Page ID of each redirect.
title: Title of each redirect.
fragment: Fragment of each redirect, if any.

Values (separate with |): pageid, title, fragment

Default: pageid|title

rdnamespace

Only include pages in these namespaces.

Maximum number of values is 50 (500 for bots).

rdshow

Show only items that meet these criteria:

fragment: Only show redirects with a fragment.
!fragment: Only show redirects without a fragment.

Values (separate with |): fragment, !fragment

rdlimit

How many redirects to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

rdcontinue

When more results are available, use this to continue.

Examples:

Get a list of redirects to the Main Page.: api.php?action=query&prop=redirects&titles=Main%20Page
Get information about all redirects to the Main Page.: api.php?action=query&generator=redirects&titles=Main%20Page&prop=info

prop=revisions (rv)

(main | query | revisions)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Get revision information.

May be used in several ways:

Get data about a set of pages (last revision), by setting titles or pageids.
Get revisions for one given page, by using titles or pageids with start, end, or limit.
Get data about a set of revisions by setting their IDs with revids.

https://www.mediawiki.org/wiki/API:Revisions

Parameters:

rvprop

Which properties to get for each revision:

ids: The ID of the revision.
flags: Revision flags (minor).
timestamp: The timestamp of the revision.
user: User that made the revision.
userid: User ID of the revision creator.
size: Length (bytes) of the revision.
sha1: SHA-1 (base 16) of the revision.
contentmodel: Content model ID of the revision.
comment: Comment by the user for the revision.
parsedcomment: Parsed comment by the user for the revision.
content: Text of the revision.
tags: Tags for the revision.
parsetree: The XML parse tree of revision content (requires content model wikitext).

Values (separate with |): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree

Default: ids|timestamp|flags|comment|user

rvlimit

Limit how many revisions will be returned.

May only be used with a single page (mode #2).

No more than 500 (5,000 for bots) allowed.

Type: integer or max

rvexpandtemplates

Expand templates in revision content (requires rvprop=content).

Type: boolean (details)

rvgeneratexml

Deprecated.

Generate XML parse tree for revision content (requires rvprop=content; replaced by rvprop=parsetree).

Type: boolean (details)

rvparse

Parse revision content (requires rvprop=content). For performance reasons, if this option is used, rvlimit is enforced to 1.

Type: boolean (details)

rvsection

Only retrieve the content of this section number.

rvdiffto

Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

rvdifftotext

Text to diff each revision to. Only diffs a limited number of revisions. Overrides rvdiffto. If rvsection is set, only that section will be diffed against this text.

rvcontentformat

Serialization format used for rvdifftotext and expected for output of content.

One of the following values: text/x-wiki, text/javascript, application/json, text/css, text/plain

rvstartid

From which revision ID to start enumeration.

May only be used with a single page (mode #2).

Type: integer

rvendid

Stop revision enumeration on this revision ID.

May only be used with a single page (mode #2).

Type: integer

rvstart

From which revision timestamp to start enumeration.

May only be used with a single page (mode #2).

Type: timestamp (allowed formats)

rvend

Enumerate up to this timestamp.

May only be used with a single page (mode #2).

Type: timestamp (allowed formats)

rvdir

In which direction to enumerate:

newer: List oldest first. Note: rvstart has to be before rvend.
older: List newest first (default). Note: rvstart has to be later than rvend.

May only be used with a single page (mode #2).

One of the following values: newer, older

Default: older

rvuser

Only include revisions made by user.

May only be used with a single page (mode #2).

Type: user name

rvexcludeuser

Exclude revisions made by user.

May only be used with a single page (mode #2).

Type: user name

rvtag

Only list revisions tagged with this tag.

rvtoken

Deprecated.

Which tokens to obtain for each revision.

Values (separate with |): rollback

rvcontinue

When more results are available, use this to continue.

Examples:

Get data with content for the last revision of titles API and Main Page.: api.php?action=query&prop=revisions&titles=API|Main%20Page&rvprop=timestamp|user|comment|content
Get last 5 revisions of the Main Page.: api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment
Get first 5 revisions of the Main Page.: api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer
Get first 5 revisions of the Main Page made after 2006-05-01.: api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z
Get first 5 revisions of the Main Page that were not made by anonymous user 127.0.0.1.: api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1
Get first 5 revisions of the Main Page that were made by the user MediaWiki default.: api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvuser=MediaWiki%20default

prop=stashimageinfo (sii)

(main | query | stashimageinfo)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Returns file information for stashed files.

https://www.mediawiki.org/wiki/API:Stashimageinfo

Parameters:

siifilekey

Key that identifies a previous upload that was stashed temporarily.

Separate values with |. Maximum number of values is 50 (500 for bots).

siisessionkey

Deprecated.

Alias for siifilekey, for backward compatibility.

Separate values with |. Maximum number of values is 50 (500 for bots).

siiprop

Which file information to get:

timestamp: Adds timestamp for the uploaded version.
canonicaltitle: Adds the canonical title of the file.
url: Gives URL to the file and the description page.
size: Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions: Alias for size.
sha1: Adds SHA-1 hash for the file.
mime: Adds MIME type of the file.
thumbmime: Adds MIME type of the image thumbnail (requires url and param siiurlwidth).
metadata: Lists Exif metadata for the version of the file.
commonmetadata: Lists file format generic metadata for the version of the file.
extmetadata: Lists formatted metadata combined from multiple sources. Results are HTML formatted.
bitdepth: Adds the bit depth of the version.

Values (separate with |): timestamp, canonicaltitle, url, size, dimensions, sha1, mime, thumbmime, metadata, commonmetadata, extmetadata, bitdepth

Default: timestamp|url

siiurlwidth

If siiprop=url is set, a URL to an image scaled to this width will be returned. For performance reasons if this option is used, no more than 50 scaled images will be returned.

Type: integer

Default: -1

siiurlheight

Similar to siiurlwidth.

Type: integer

Default: -1

siiurlparam

A handler specific parameter string. For example, PDFs might use page15-100px. siiurlwidth must be used and be consistent with siiurlparam.

Default: (empty)

Examples:

Returns information for a stashed file.: api.php?action=query&prop=stashimageinfo&siifilekey=124sd34rsdf567
Returns thumbnails for two stashed files.: api.php?action=query&prop=stashimageinfo&siifilekey=b34edoe3|bceffd4&siiurlwidth=120&siiprop=url

prop=templates (tl)

(main | query | templates)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Returns all pages transcluded on the given pages.

https://www.mediawiki.org/wiki/API:Templates

Parameters:

tlnamespace: Show templates in this namespaces only.; Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 460, 461, 170, 171, 2300, 2301, 2302, 2303, 102, 103, 108, 109, 710, 711, 420, 421, 106, 107, 2600, 1198, 1199, 104, 105; Maximum number of values is 50 (500 for bots).
tllimit: How many templates to return.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10
tlcontinue: When more results are available, use this to continue.
tltemplates: Only list these templates. Useful for checking whether a certain page uses a certain template.; Separate values with |. Maximum number of values is 50 (500 for bots).
tldir: The direction in which to list.; One of the following values: ascending, descending; Default: ascending

Examples:

Get the templates used on the page Main Page.: api.php?action=query&prop=templates&titles=Main%20Page
Get information about the template pages used on Main Page.: api.php?action=query&generator=templates&titles=Main%20Page&prop=info
Get pages in the User and Template namespaces that are transcluded on the page Main Page.: api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10

prop=transcludedin (ti)

(main | query | transcludedin)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Find all pages that transclude the given pages.

https://www.mediawiki.org/wiki/API:Transcludedin

Parameters:

tiprop

Which properties to get:

pageid: Page ID of each page.
title: Title of each page.
redirect: Flag if the page is a redirect.

Values (separate with |): pageid, title, redirect

Default: pageid|title|redirect

tinamespace

Only include pages in these namespaces.

Maximum number of values is 50 (500 for bots).

tishow

Show only items that meet these criteria:

redirect: Only show redirects.
!redirect: Only show non-redirects.

Values (separate with |): redirect, !redirect

tilimit

How many to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

ticontinue

When more results are available, use this to continue.

Examples:

Get a list of pages transcluding Main Page.: api.php?action=query&prop=transcludedin&titles=Main%20Page
Get information about pages transcluding Main Page.: api.php?action=query&generator=transcludedin&titles=Main%20Page&prop=info

prop=transcodestatus

(main | query | transcodestatus)

This module requires read rights.
Source: TimedMediaHandler
License: GPL-2.0+

Get transcode status for a given file page.

Example:

Get transcode status for File:Clip.webm: api.php?action=query&prop=transcodestatus&titles=File:Clip.webm

prop=videoinfo (vi)

(main | query | videoinfo)

This module requires read rights.
Source: TimedMediaHandler
License: GPL-2.0+

Extends imageinfo to include video source (derivatives) information

https://www.mediawiki.org/wiki/API:Imageinfo

Parameters:

viprop

What video information to get:

timestamp: Adds timestamp for the uploaded version.
user: Adds the user who uploaded the video version.
userid: Add the user ID that uploaded the video version.
comment: Comment on the version.
parsedcomment: Parse the comment on the version.
canonicaltitle: Adds the canonical title of the video file.
url: Gives URL to the video and the description page.
size: Adds the size of the video in bytes, its height and its width. Page count and duration are added if applicable.
dimensions: Alias for size.
sha1: Adds SHA-1 hash for the video.
mime: Adds MIME type of the video.
thumbmime: Adds MIME type of the video thumbnail (requires url and param viurlwidth).
mediatype: Adds the media type of the video.
metadata: Lists Exif metadata for the version of the video.
commonmetadata: Lists file format generic metadata for the version of the video.
extmetadata: Lists formatted metadata combined from multiple sources. Results are HTML formatted.
archivename: Adds the filename of the archive version for non-latest versions.
bitdepth: Adds the bit depth of the version.
uploadwarning: Used by the Special:Upload page to get information about an existing file. Not intended for use outside MediaWiki core.
derivatives: Adds an array of the different format and quality versions of an audio or video file that are available.

Default: timestamp|user

vilimit

How many file revisions to return per file.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 1

vistart

Timestamp to start listing from.

Type: timestamp (allowed formats)

viend

Timestamp to stop listing at.

Type: timestamp (allowed formats)

viurlwidth

If viprop=url is set, a URL to an image scaled to this width will be returned. For performance reasons if this option is used, no more than 50 scaled images will be returned.

Type: integer

Default: -1

viurlheight

Similar to viurlwidth.

Type: integer

Default: -1

viurlparam

A handler specific parameter string. For example, PDFs might use page15-100px. viurlwidth must be used and be consistent with viurlparam.

Default: (empty)

vicontinue

When more results are available, use this to continue.

Example:

Fetch information about File:Folgers.ogv: api.php?action=query&titles=File:Folgers.ogv&prop=videoinfo

list=allcampaigns (uwc)

(main | query | allcampaigns)

This module requires read rights.
Source: Upload Wizard
License: GPL-2.0+

Enumerate all UploadWizard campaigns.

https://www.mediawiki.org/wiki/Extension:UploadWizard/API

Parameters:

uwcenabledonly: Only list campaigns that are enabled.; Type: boolean (details)
uwclimit: Number of campaigns to return.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 50
uwccontinue: When more results are available, use this to continue.

Example:

Enumerate enabled campaigns: api.php?action=query&list=allcampaigns&uwcenabledonly=

list=allcategories (ac)

(main | query | allcategories)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Enumerate all categories.

https://www.mediawiki.org/wiki/API:Allcategories

Parameters:

acfrom

The category to start enumerating from.

accontinue

When more results are available, use this to continue.

acto

The category to stop enumerating at.

acprefix

Search for all category titles that begin with this value.

acdir

Direction to sort in.

One of the following values: ascending, descending

Default: ascending

acmin

Only return categories with at least this many members.

Type: integer

acmax

Only return categories with at most this many members.

Type: integer

aclimit

How many categories to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

acprop

Which properties to get:

size: Adds number of pages in the category.
hidden: Tags categories that are hidden with __HIDDENCAT__.

Values (separate with |): size, hidden

Default: (empty)

Examples:

List categories with information on the number of pages in each.: api.php?action=query&list=allcategories&acprop=size
Retrieve info about the category page itself for categories beginning List.: api.php?action=query&generator=allcategories&gacprefix=List&prop=info

list=alldeletedrevisions (adr)

(main | query | alldeletedrevisions)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

List all deleted revisions by a user or in a namespace.

https://www.mediawiki.org/wiki/API:Alldeletedrevisions

Parameters:

adrprop

Which properties to get for each revision:

ids: The ID of the revision.
flags: Revision flags (minor).
timestamp: The timestamp of the revision.
user: User that made the revision.
userid: User ID of the revision creator.
size: Length (bytes) of the revision.
sha1: SHA-1 (base 16) of the revision.
contentmodel: Content model ID of the revision.
comment: Comment by the user for the revision.
parsedcomment: Parsed comment by the user for the revision.
content: Text of the revision.
tags: Tags for the revision.
parsetree: The XML parse tree of revision content (requires content model wikitext).

Values (separate with |): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree

Default: ids|timestamp|flags|comment|user

adrlimit

Limit how many revisions will be returned.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

adrexpandtemplates

Expand templates in revision content (requires adrprop=content).

Type: boolean (details)

adrgeneratexml

Deprecated.

Generate XML parse tree for revision content (requires adrprop=content; replaced by adrprop=parsetree).

Type: boolean (details)

adrparse

Parse revision content (requires adrprop=content). For performance reasons, if this option is used, adrlimit is enforced to 1.

Type: boolean (details)

adrsection

Only retrieve the content of this section number.

adrdiffto

Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

adrdifftotext

Text to diff each revision to. Only diffs a limited number of revisions. Overrides adrdiffto. If adrsection is set, only that section will be diffed against this text.

adrcontentformat

Serialization format used for adrdifftotext and expected for output of content.

One of the following values: text/x-wiki, text/javascript, application/json, text/css, text/plain

adruser

Only list revisions by this user.

Type: user name

adrnamespace

Only list pages in this namespace.

Maximum number of values is 50 (500 for bots).

adrstart

The timestamp to start enumerating from.

May only be used with adruser.

Type: timestamp (allowed formats)

adrend

The timestamp to stop enumerating at.

May only be used with adruser.

Type: timestamp (allowed formats)

adrdir

In which direction to enumerate:

newer: List oldest first. Note: adrstart has to be before adrend.
older: List newest first (default). Note: adrstart has to be later than adrend.

One of the following values: newer, older

Default: older

adrfrom

Start listing at this title.

Cannot be used with adruser.

adrto

Stop listing at this title.

Cannot be used with adruser.

adrprefix

Search for all page titles that begin with this value.

Cannot be used with adruser.

adrexcludeuser

Don't list revisions by this user.

Cannot be used with adruser.

Type: user name

adrtag

Only list revisions tagged with this tag.

adrcontinue

When more results are available, use this to continue.

adrgeneratetitles

When being used as a generator, generate titles rather than revision IDs.

Type: boolean (details)

Examples:

List the last 50 deleted contributions by user Example.: api.php?action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50
List the first 50 deleted revisions in the main namespace.: api.php?action=query&list=alldeletedrevisions&adrdir=newer&adrlimit=50

list=allfileusages (af)

(main | query | allfileusages)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

List all file usages, including non-existing.

https://www.mediawiki.org/wiki/API:Allfileusages

Parameters:

afcontinue

When more results are available, use this to continue.

affrom

The title of the file to start enumerating from.

afto

The title of the file to stop enumerating at.

afprefix

Search for all file titles that begin with this value.

afunique

Only show distinct file titles. Cannot be used with afprop=ids. When used as a generator, yields target pages instead of source pages.

Type: boolean (details)

afprop

Which pieces of information to include:

ids: Adds the page IDs of the using pages (cannot be used with afunique).
title: Adds the title of the file.

Values (separate with |): ids, title

Default: title

aflimit

How many total items to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

afdir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

Examples:

List file titles, including missing ones, with page IDs they are from, starting at B.: api.php?action=query&list=allfileusages&affrom=B&afprop=ids|title
List unique file titles.: api.php?action=query&list=allfileusages&afunique=&affrom=B
Gets all file titles, marking the missing ones.: api.php?action=query&generator=allfileusages&gafunique=&gaffrom=B
Gets pages containing the files.: api.php?action=query&generator=allfileusages&gaffrom=B

list=allimages (ai)

(main | query | allimages)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Enumerate all images sequentially.

https://www.mediawiki.org/wiki/API:Allimages

Parameters:

aisort

Property to sort by.

One of the following values: name, timestamp

Default: name

aidir

The direction in which to list.

One of the following values: ascending, descending, newer, older

Default: ascending

aifrom

The image title to start enumerating from. Can only be used with aisort=name.

aito

The image title to stop enumerating at. Can only be used with aisort=name.

aicontinue

When more results are available, use this to continue.

aistart

The timestamp to start enumerating from. Can only be used with aisort=timestamp.

Type: timestamp (allowed formats)

aiend

The timestamp to end enumerating. Can only be used with aisort=timestamp.

Type: timestamp (allowed formats)

aiprop

Which file information to get:

timestamp: Adds timestamp for the uploaded version.
user: Adds the user who uploaded each file version.
userid: Add the ID of the user that uploaded each file version.
comment: Comment on the version.
parsedcomment: Parse the comment on the version.
canonicaltitle: Adds the canonical title of the file.
url: Gives URL to the file and the description page.
size: Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions: Alias for size.
sha1: Adds SHA-1 hash for the file.
mime: Adds MIME type of the file.
mediatype: Adds the media type of the file.
metadata: Lists Exif metadata for the version of the file.
commonmetadata: Lists file format generic metadata for the version of the file.
extmetadata: Lists formatted metadata combined from multiple sources. Results are HTML formatted.
bitdepth: Adds the bit depth of the version.

Values (separate with |): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, mediatype, metadata, commonmetadata, extmetadata, bitdepth

Default: timestamp|url

aiprefix

Search for all image titles that begin with this value. Can only be used with aisort=name.

aiminsize

Limit to images with at least this many bytes.

Type: integer

aimaxsize

Limit to images with at most this many bytes.

Type: integer

aisha1

SHA1 hash of image. Overrides aisha1base36.

aisha1base36

SHA1 hash of image in base 36 (used in MediaWiki).

aiuser

Only return files uploaded by this user. Can only be used with aisort=timestamp. Cannot be used together with aifilterbots.

Type: user name

aifilterbots

How to filter files uploaded by bots. Can only be used with aisort=timestamp. Cannot be used together with aiuser.

One of the following values: all, bots, nobots

Default: all

aimime

What MIME types to search for, e.g. image/jpeg.

Separate values with |. Maximum number of values is 50 (500 for bots).

ailimit

How many images in total to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

Examples:

Show a list of files starting at the letter B.: api.php?action=query&list=allimages&aifrom=B
Show a list of recently uploaded files, similar to Special:NewFiles.: api.php?action=query&list=allimages&aiprop=user|timestamp|url&aisort=timestamp&aidir=older
Show a list of files with MIME type image/png or image/gif: api.php?action=query&list=allimages&aimime=image/png|image/gif
Show info about 4 files starting at the letter T.: api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo

list=alllinks (al)

(main | query | alllinks)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Enumerate all links that point to a given namespace.

https://www.mediawiki.org/wiki/API:Alllinks

Parameters:

alcontinue

When more results are available, use this to continue.

alfrom

The title of the link to start enumerating from.

alto

The title of the link to stop enumerating at.

alprefix

Search for all linked titles that begin with this value.

alunique

Only show distinct linked titles. Cannot be used with alprop=ids. When used as a generator, yields target pages instead of source pages.

Type: boolean (details)

alprop

Which pieces of information to include:

ids: Adds the page ID of the linking page (cannot be used with alunique).
title: Adds the title of the link.

Values (separate with |): ids, title

Default: title

alnamespace

The namespace to enumerate.

One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 460, 461, 170, 171, 2300, 2301, 2302, 2303, 102, 103, 108, 109, 710, 711, 420, 421, 106, 107, 2600, 1198, 1199, 104, 105

Default: 0

allimit

How many total items to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

aldir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

Examples:

List linked titles, including missing ones, with page IDs they are from, starting at B.: api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title
List unique linked titles.: api.php?action=query&list=alllinks&alunique=&alfrom=B
Gets all linked titles, marking the missing ones.: api.php?action=query&generator=alllinks&galunique=&galfrom=B
Gets pages containing the links.: api.php?action=query&generator=alllinks&galfrom=B

list=allpages (ap)

(main | query | allpages)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Enumerate all pages sequentially in a given namespace.

https://www.mediawiki.org/wiki/API:Allpages

Parameters:

apfrom

The page title to start enumerating from.

apcontinue

When more results are available, use this to continue.

apto

The page title to stop enumerating at.

apprefix

Search for all page titles that begin with this value.

apnamespace

The namespace to enumerate.

Default: 0

apfilterredir

Which pages to list.

One of the following values: all, redirects, nonredirects

Default: all

apminsize

Limit to pages with at least this many bytes.

Type: integer

apmaxsize

Limit to pages with at most this many bytes.

Type: integer

apprtype

Limit to protected pages only.

Values (separate with |): edit, move, upload

apprlevel

Filter protections based on protection level (must be used with apprtype= parameter).

Values (separate with |): Can be empty, or autoconfirmed, sysop

apprfiltercascade

Filter protections based on cascadingness (ignored when apprtype isn't set).

One of the following values: cascading, noncascading, all

Default: all

aplimit

How many total pages to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

apdir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

apfilterlanglinks

Filter based on whether a page has langlinks. Note that this may not consider langlinks added by extensions.

One of the following values: withlanglinks, withoutlanglinks, all

Default: all

apprexpiry

Which protection expiry to filter the page on:

indefinite: Get only pages with indefinite protection expiry.
definite: Get only pages with a definite (specific) protection expiry.
all: Get pages with any protections expiry.

One of the following values: indefinite, definite, all

Default: all

Examples:

Show a list of pages starting at the letter B.: api.php?action=query&list=allpages&apfrom=B
Show info about 4 pages starting at the letter T.: api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info
Show content of first 2 non-redirect pages beginning at Re.: api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content

list=allredirects (ar)

(main | query | allredirects)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

List all redirects to a namespace.

https://www.mediawiki.org/wiki/API:Allredirects

Parameters:

arcontinue

When more results are available, use this to continue.

arfrom

The title of the redirect to start enumerating from.

arto

The title of the redirect to stop enumerating at.

arprefix

Search for all target pages that begin with this value.

arunique

Only show distinct target pages. Cannot be used with arprop=ids|fragment|interwiki. When used as a generator, yields target pages instead of source pages.

Type: boolean (details)

arprop

Which pieces of information to include:

ids: Adds the page ID of the redirecting page (cannot be used with arunique).
title: Adds the title of the redirect.
fragment: Adds the fragment from the redirect, if any (cannot be used with arunique).
interwiki: Adds the interwiki prefix from the redirect, if any (cannot be used with arunique).

Values (separate with |): ids, title, fragment, interwiki

Default: title

arnamespace

The namespace to enumerate.

Default: 0

arlimit

How many total items to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

ardir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

Examples:

List target pages, including missing ones, with page IDs they are from, starting at B.: api.php?action=query&list=allredirects&arfrom=B&arprop=ids|title
List unique target pages.: api.php?action=query&list=allredirects&arunique=&arfrom=B
Gets all target pages, marking the missing ones.: api.php?action=query&generator=allredirects&garunique=&garfrom=B
Gets pages containing the redirects.: api.php?action=query&generator=allredirects&garfrom=B

list=alltransclusions (at)

(main | query | alltransclusions)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

List all transclusions (pages embedded using {{x}}), including non-existing.

https://www.mediawiki.org/wiki/API:Alltransclusions

Parameters:

atcontinue

When more results are available, use this to continue.

atfrom

The title of the transclusion to start enumerating from.

atto

The title of the transclusion to stop enumerating at.

atprefix

Search for all transcluded titles that begin with this value.

atunique

Only show distinct transcluded titles. Cannot be used with atprop=ids. When used as a generator, yields target pages instead of source pages.

Type: boolean (details)

atprop

Which pieces of information to include:

ids: Adds the page ID of the transcluding page (cannot be used with atunique).
title: Adds the title of the transclusion.

Values (separate with |): ids, title

Default: title

atnamespace

The namespace to enumerate.

Default: 10

atlimit

How many total items to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

atdir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

Examples:

List transcluded titles, including missing ones, with page IDs they are from, starting at B.: api.php?action=query&list=alltransclusions&atfrom=B&atprop=ids|title
List unique transcluded titles.: api.php?action=query&list=alltransclusions&atunique=&atfrom=B
Gets all transcluded titles, marking the missing ones.: api.php?action=query&generator=alltransclusions&gatunique=&gatfrom=B
Gets pages containing the transclusions.: api.php?action=query&generator=alltransclusions&gatfrom=B

list=allusers (au)

(main | query | allusers)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Enumerate all registered users.

https://www.mediawiki.org/wiki/API:Allusers

Parameters:

aufrom

The user name to start enumerating from.

auto

The user name to stop enumerating at.

auprefix

Search for all users that begin with this value.

audir

Direction to sort in.

One of the following values: ascending, descending

Default: ascending

augroup

Only include users in the given groups.

Values (separate with |): bot, sysop, bureaucrat, upwizcampeditors, oversight, flow-bot, translator, smwadministrator

auexcludegroup

Exclude users in the given groups.

Values (separate with |): bot, sysop, bureaucrat, upwizcampeditors, oversight, flow-bot, translator, smwadministrator

aurights

Only include users with the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.

Values (separate with |): apihighlimits, applychangetags, autoconfirmed, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmywatchlist, editsemiprotected, editusercssjs, editusercss, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, passwordreset, patrol, patrolmarks, protect, proxyunbannable, purge, read, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi, nuke, gadgets-edit, gadgets-definition-edit, renameuser, replacetext, geocode, viewedittab, editrestrictedfields, createclass, upwizcampaigns, confirmaccount, requestips, lookupcredentials, flow-hide, flow-lock, flow-delete, flow-suppress, flow-edit-post, flow-create-board, translate, translate-import, translate-manage, translate-messagereview, translate-groupreview, translate-sandboxmanage, collectionsaveasuserpage, collectionsaveascommunitypage, transcode-reset, transcode-status, openid-converter-access, openid-dashboard-access, openid-dashboard-admin, openid-login-with-openid, openid-create-account-with-openid, openid-create-account-without-openid, masseditregex, interwiki, smw-admin, pagetranslation

Maximum number of values is 50 (500 for bots).

auprop

Which pieces of information to include:

blockinfo: Adds the information about a current block on the user.
groups: Lists groups that the user is in. This uses more server resources and may return fewer results than the limit.
implicitgroups: Lists all the groups the user is automatically in.
rights: Lists rights that the user has.
editcount: Adds the edit count of the user.
registration: Adds the timestamp of when the user registered if available (may be blank).

Values (separate with |): blockinfo, groups, implicitgroups, rights, editcount, registration

aulimit

How many total user names to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

auwitheditsonly

Only list users who have made edits.

Type: boolean (details)

auactiveusers

Only list users active in the last 30 days.

Type: boolean (details)

Example:

List users starting at Y.: api.php?action=query&list=allusers&aufrom=Y

list=backlinks (bl)

(main | query | backlinks)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Find all pages that link to the given page.

https://www.mediawiki.org/wiki/API:Backlinks

Parameters:

bltitle: Title to search. Cannot be used together with blpageid.
blpageid: Page ID to search. Cannot be used together with bltitle.; Type: integer
blcontinue: When more results are available, use this to continue.
blnamespace: The namespace to enumerate.; Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 460, 461, 170, 171, 2300, 2301, 2302, 2303, 102, 103, 108, 109, 710, 711, 420, 421, 106, 107, 2600, 1198, 1199, 104, 105; Maximum number of values is 50 (500 for bots).
bldir: The direction in which to list.; One of the following values: ascending, descending; Default: ascending
blfilterredir: How to filter for redirects. If set to nonredirects when blredirect is enabled, this is only applied to the second level.; One of the following values: all, redirects, nonredirects; Default: all
bllimit: How many total pages to return. If blredirect is enabled, the limit applies to each level separately (which means up to 2 * bllimit results may be returned).; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10
blredirect: If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.; Type: boolean (details)

Examples:

Show links to Main page.: api.php?action=query&list=backlinks&bltitle=Main%20Page
Get information about pages linking to Main page.: api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info

list=blocks (bk)

(main | query | blocks)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

List all blocked users and IP addresses.

https://www.mediawiki.org/wiki/API:Blocks

Parameters:

bkstart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)

bkend

The timestamp to stop enumerating at.

Type: timestamp (allowed formats)

bkdir

In which direction to enumerate:

newer: List oldest first. Note: bkstart has to be before bkend.
older: List newest first (default). Note: bkstart has to be later than bkend.

One of the following values: newer, older

Default: older

bkids

List of block IDs to list (optional).

Type: list of integers

Separate values with |. Maximum number of values is 50 (500 for bots).

bkusers

List of users to search for (optional).

Separate values with |. Maximum number of values is 50 (500 for bots).

bkip

Get all blocks applying to this IP or CIDR range, including range blocks. Cannot be used together with bkusers. CIDR ranges broader than IPv4/16 or IPv6/19 are not accepted.

bklimit

The maximum number of blocks to list.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

bkprop

Which properties to get:

id: Adds the ID of the block.
user: Adds the username of the blocked user.
userid: Adds the user ID of the blocked user.
by: Adds the username of the blocking user.
byid: Adds the user ID of the blocking user.
timestamp: Adds the timestamp of when the block was given.
expiry: Adds the timestamp of when the block expires.
reason: Adds the reason given for the block.
range: Adds the range of IP addresses affected by the block.
flags: Tags the ban with (autoblock, anononly, etc.).

Values (separate with |): id, user, userid, by, byid, timestamp, expiry, reason, range, flags

bkshow

Show only items that meet these criteria. For example, to see only indefinite blocks on IP addresses, set bkshow=ip|!temp.

Values (separate with |): account, !account, temp, !temp, ip, !ip, range, !range

bkcontinue

When more results are available, use this to continue.

Examples:

List blocks.: api.php?action=query&list=blocks
List blocks of users Alice and Bob.: api.php?action=query&list=blocks&bkusers=Alice|Bob

list=categorymembers (cm)

(main | query | categorymembers)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

List all pages in a given category.

https://www.mediawiki.org/wiki/API:Categorymembers

Parameters:

cmtitle

Which category to enumerate (required). Must include the Class: prefix. Cannot be used together with cmpageid.

cmpageid

Page ID of the category to enumerate. Cannot be used together with cmtitle.

Type: integer

cmprop

Which pieces of information to include:

ids: Adds the page ID.
title: Adds the title and namespace ID of the page.
sortkey: Adds the sortkey used for sorting in the category (hexadecimal string).
sortkeyprefix: Adds the sortkey prefix used for sorting in the category (human-readable part of the sortkey).
type: Adds the type that the page has been categorised as (page, subcat or file).
timestamp: Adds the timestamp of when the page was included.

Values (separate with |): ids, title, sortkey, sortkeyprefix, type, timestamp

Default: ids|title

cmnamespace

Only include pages in these namespaces. Note that cmtype=subcat or cmtype=file may be used instead of cmnamespace=14 or 6.

Maximum number of values is 50 (500 for bots).

cmtype

Which type of category members to include. Ignored when cmsort=timestamp is set.

Values (separate with |): page, subcat, file

Default: page|subcat|file

cmcontinue

When more results are available, use this to continue.

cmlimit

The maximum number of pages to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

cmsort

Property to sort by.

One of the following values: sortkey, timestamp

Default: sortkey

cmdir

In which direction to sort.

One of the following values: asc, desc, ascending, descending, newer, older

Default: ascending

cmstart

Timestamp to start listing from. Can only be used with cmsort=timestamp.

Type: timestamp (allowed formats)

cmend

Timestamp to end listing at. Can only be used with cmsort=timestamp.

Type: timestamp (allowed formats)

cmstarthexsortkey

Sortkey to start listing from, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.

cmendhexsortkey

Sortkey to end listing at, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.

cmstartsortkeyprefix

Sortkey prefix to start listing from. Can only be used with cmsort=sortkey. Overrides cmstarthexsortkey.

cmendsortkeyprefix

Sortkey prefix to end listing before (not at; if this value occurs it will not be included!). Can only be used with cmsort=sortkey. Overrides cmendhexsortkey.

cmstartsortkey

Deprecated.

Use cmstarthexsortkey instead.

cmendsortkey

Deprecated.

Use cmendhexsortkey instead.

Examples:

Get first 10 pages in Category:Physics.: api.php?action=query&list=categorymembers&cmtitle=Category:Physics
Get page info about first 10 pages in Category:Physics.: api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info

list=deletedrevs (dr)

(main | query | deletedrevs)

This module is deprecated.
This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

List deleted revisions.

Operates in three modes:

List deleted revisions for the given titles, sorted by timestamp.
List deleted contributions for the given user, sorted by timestamp (no titles specified).
List all deleted revisions in the given namespace, sorted by title and timestamp (no titles specified, druser not set).

Certain parameters only apply to some modes and are ignored in others.

https://www.mediawiki.org/wiki/API:Deletedrevs

Parameters:

drstart

The timestamp to start enumerating from.

Modes: 1, 2

Type: timestamp (allowed formats)

drend

The timestamp to stop enumerating at.

Modes: 1, 2

Type: timestamp (allowed formats)

drdir

In which direction to enumerate:

newer: List oldest first. Note: drstart has to be before drend.
older: List newest first (default). Note: drstart has to be later than drend.

Modes: 1, 3

One of the following values: newer, older

Default: older

drfrom

Start listing at this title.

Mode: 3

drto

Stop listing at this title.

Mode: 3

drprefix

Search for all page titles that begin with this value.

Mode: 3

drunique

List only one revision for each page.

Mode: 3

Type: boolean (details)

drnamespace

Only list pages in this namespace.

Mode: 3

Default: 0

drtag

Only list revisions tagged with this tag.

druser

Only list revisions by this user.

Type: user name

drexcludeuser

Don't list revisions by this user.

Type: user name

drprop

Which properties to get:

revid: Adds the revision ID of the deleted revision.
parentid: Adds the revision ID of the previous revision to the page.
user: Adds the user who made the revision.
userid: Adds the ID of the user who made the revision.
comment: Adds the comment of the revision.
parsedcomment: Adds the parsed comment of the revision.
minor: Tags if the revision is minor.
len: Adds the length (bytes) of the revision.
sha1: Adds the SHA-1 (base 16) of the revision.
content: Adds the content of the revision.
token: Deprecated. Gives the edit token.
tags: Tags for the revision.

Values (separate with |): revid, parentid, user, userid, comment, parsedcomment, minor, len, sha1, content, token, tags

Default: user|comment

drlimit

The maximum amount of revisions to list.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

drcontinue

When more results are available, use this to continue.

Examples:

List the last deleted revisions of the pages Main Page and Talk:Main Page, with content (mode 1).: api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content
List the last 50 deleted contributions by Bob (mode 2).: api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50
List the first 50 deleted revisions in the main namespace (mode 3).: api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50
List the first 50 deleted pages in the Talk namespace (mode 3).: api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique=

list=embeddedin (ei)

(main | query | embeddedin)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Find all pages that embed (transclude) the given title.

https://www.mediawiki.org/wiki/API:Embeddedin

Parameters:

eititle: Title to search. Cannot be used together with eipageid.
eipageid: Page ID to search. Cannot be used together with eititle.; Type: integer
eicontinue: When more results are available, use this to continue.
einamespace: The namespace to enumerate.; Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 460, 461, 170, 171, 2300, 2301, 2302, 2303, 102, 103, 108, 109, 710, 711, 420, 421, 106, 107, 2600, 1198, 1199, 104, 105; Maximum number of values is 50 (500 for bots).
eidir: The direction in which to list.; One of the following values: ascending, descending; Default: ascending
eifilterredir: How to filter for redirects.; One of the following values: all, redirects, nonredirects; Default: all
eilimit: How many total pages to return.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10

Examples:

Show pages transcluding Template:Stub.: api.php?action=query&list=embeddedin&eititle=Template:Stub
Get information about pages transcluding Template:Stub.: api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info

list=exturlusage (eu)

(main | query | exturlusage)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Enumerate pages that contain a given URL.

https://www.mediawiki.org/wiki/API:Exturlusage

Parameters:

euprop

Which pieces of information to include:

ids: Adds the ID of page.
title: Adds the title and namespace ID of the page.
url: Adds the URL used in the page.

Values (separate with |): ids, title, url

Default: ids|title|url

euoffset

When more results are available, use this to continue.

Type: integer

euprotocol

Protocol of the URL. If empty and euquery is set, the protocol is http. Leave both this and euquery empty to list all external links.

One of the following values: Can be empty, or bitcoin, ftp, ftps, geo, git, gopher, http, https, irc, ircs, magnet, mailto, mms, news, nntp, redis, sftp, sip, sips, sms, ssh, svn, tel, telnet, urn, worldwind, xmpp

Default: (empty)

euquery

Search string without protocol. See Special:LinkSearch. Leave empty to list all external links.

eunamespace

The page namespaces to enumerate.

Maximum number of values is 50 (500 for bots).

eulimit

How many pages to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

euexpandurl

Expand protocol-relative URLs with the canonical protocol.

Type: boolean (details)

Example:

Show pages linking to http://www.mediawiki.org.: api.php?action=query&list=exturlusage&euquery=www.mediawiki.org

list=filearchive (fa)

(main | query | filearchive)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Enumerate all deleted files sequentially.

https://www.mediawiki.org/wiki/API:Filearchive

Parameters:

fafrom

The image title to start enumerating from.

fato

The image title to stop enumerating at.

faprefix

Search for all image titles that begin with this value.

fadir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

fasha1

SHA1 hash of image. Overrides fasha1base36.

fasha1base36

SHA1 hash of image in base 36 (used in MediaWiki).

faprop

Which image information to get:

sha1: Adds SHA-1 hash for the image.
timestamp: Adds timestamp for the uploaded version.
user: Adds user who uploaded the image version.
size: Adds the size of the image in bytes and the height, width and page count (if applicable).
dimensions: Alias for size.
description: Adds description of the image version.
parseddescription: Parse the description of the version.
mime: Adds MIME of the image.
mediatype: Adds the media type of the image.
metadata: Lists Exif metadata for the version of the image.
bitdepth: Adds the bit depth of the version.
archivename: Adds the filename of the archive version for non-latest versions.

Values (separate with |): sha1, timestamp, user, size, dimensions, description, parseddescription, mime, mediatype, metadata, bitdepth, archivename

Default: timestamp

falimit

How many images to return in total.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

facontinue

When more results are available, use this to continue.

Example:

Show a list of all deleted files.: api.php?action=query&list=filearchive

list=gadgetcategories (gc)

(main | query | gadgetcategories)

This module requires read rights.
Source: Gadgets
License: GPL-2.0+

Returns a list of gadget categories.

Parameters:

gcprop

What gadget category information to get:

name: Internal category name.
title: Category title.
members: Number of gadgets in category.

Values (separate with |): name, title, members

Default: name

gcnames

Names of categories to retrieve.

Separate values with |. Maximum number of values is 50 (500 for bots).

Examples:

Get a list of existing gadget categories: api.php?action=query&list=gadgetcategories
Get all information about categories named "foo" and "bar": api.php?action=query&list=gadgetcategories&gcnames=foo|bar&gcprop=name|title|members

list=gadgets (ga)

(main | query | gadgets)

This module requires read rights.
Source: Gadgets
License: GPL-2.0+

Returns a list of gadgets used on this wiki.

Parameters:

gaprop

What gadget information to get:

id: Internal gadget ID.
metadata: The gadget metadata.
desc: Gadget description transformed into HTML (can be slow, use only if really needed).

Values (separate with |): id, metadata, desc

Default: id|metadata

gacategories

Gadgets from what categories to retrieve.

Separate values with |. Maximum number of values is 50 (500 for bots).

gaids

IDs of gadgets to retrieve.

Separate values with |. Maximum number of values is 50 (500 for bots).

gaallowedonly

List only gadgets allowed to current user.

Type: boolean (details)

gaenabledonly

List only gadgets enabled by current user.

Type: boolean (details)

Examples:

Get a list of gadgets along with their descriptions: api.php?action=query&list=gadgets&gaprop=id|desc
Get a list of gadgets with all possible properties: api.php?action=query&list=gadgets&gaprop=id|metadata|desc
Get a list of gadgets belonging to category "foo": api.php?action=query&list=gadgets&gacategories=foo
Get information about gadgets "foo" and "bar": api.php?action=query&list=gadgets&gaids=foo|bar&gaprop=id|desc|metadata
Get a list of gadgets enabled by current user: api.php?action=query&list=gadgets&gaenabledonly

list=imageusage (iu)

(main | query | imageusage)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Find all pages that use the given image title.

https://www.mediawiki.org/wiki/API:Imageusage

Parameters:

iutitle: Title to search. Cannot be used together with iupageid.
iupageid: Page ID to search. Cannot be used together with iutitle.; Type: integer
iucontinue: When more results are available, use this to continue.
iunamespace: The namespace to enumerate.; Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 460, 461, 170, 171, 2300, 2301, 2302, 2303, 102, 103, 108, 109, 710, 711, 420, 421, 106, 107, 2600, 1198, 1199, 104, 105; Maximum number of values is 50 (500 for bots).
iudir: The direction in which to list.; One of the following values: ascending, descending; Default: ascending
iufilterredir: How to filter for redirects. If set to nonredirects when iuredirect is enabled, this is only applied to the second level.; One of the following values: all, redirects, nonredirects; Default: all
iulimit: How many total pages to return. If iuredirect is enabled, the limit applies to each level separately (which means up to 2 * iulimit results may be returned).; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10
iuredirect: If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.; Type: boolean (details)

Examples:

Show pages using File:Albert Einstein Head.jpg.: api.php?action=query&list=imageusage&iutitle=File:Albert%20Einstein%20Head.jpg
Get information about pages using File:Albert Einstein Head.jpg.: api.php?action=query&generator=imageusage&giutitle=File:Albert%20Einstein%20Head.jpg&prop=info

list=iwbacklinks (iwbl)

(main | query | iwbacklinks)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Find all pages that link to the given interwiki link.

Can be used to find all links with a prefix, or all links to a title (with a given prefix). Using neither parameter is effectively "all interwiki links".

https://www.mediawiki.org/wiki/API:Iwbacklinks

Parameters:

iwblprefix

Prefix for the interwiki.

iwbltitle

Interwiki link to search for. Must be used with iwblblprefix.

iwblcontinue

When more results are available, use this to continue.

iwbllimit

How many total pages to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

iwblprop

Which properties to get:

iwprefix: Adds the prefix of the interwiki.
iwtitle: Adds the title of the interwiki.

Values (separate with |): iwprefix, iwtitle

Default: (empty)

iwbldir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

Examples:

Get pages linking to wikibooks:Test.: api.php?action=query&list=iwbacklinks&iwbltitle=Test&iwblprefix=wikibooks
Get information about pages linking to wikibooks:Test.: api.php?action=query&generator=iwbacklinks&giwbltitle=Test&giwblprefix=wikibooks&prop=info

list=langbacklinks (lbl)

(main | query | langbacklinks)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Find all pages that link to the given language link.

Can be used to find all links with a language code, or all links to a title (with a given language). Using neither parameter is effectively "all language links".

Note that this may not consider language links added by extensions.

https://www.mediawiki.org/wiki/API:Langbacklinks

Parameters:

lbllang

Language for the language link.

lbltitle

Language link to search for. Must be used with lbllang.

lblcontinue

When more results are available, use this to continue.

lbllimit

How many total pages to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

lblprop

Which properties to get:

lllang: Adds the language code of the language link.
lltitle: Adds the title of the language link.

Values (separate with |): lllang, lltitle

Default: (empty)

lbldir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

Examples:

Get pages linking to fr:Test.: api.php?action=query&list=langbacklinks&lbltitle=Test&lbllang=fr
Get information about pages linking to fr:Test.: api.php?action=query&generator=langbacklinks&glbltitle=Test&glbllang=fr&prop=info

list=logevents (le)

(main | query | logevents)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Get events from logs.

https://www.mediawiki.org/wiki/API:Logevents

Parameters:

leprop

Which properties to get:

ids: Adds the ID of the log event.
title: Adds the title of the page for the log event.
type: Adds the type of log event.
user: Adds the user responsible for the log event.
userid: Adds the user ID who was responsible for the log event.
timestamp: Adds the timestamp for the log event.
comment: Adds the comment of the log event.
parsedcomment: Adds the parsed comment of the log event.
details: Lists additional details about the log event.
tags: Lists tags for the log event.

Values (separate with |): ids, title, type, user, userid, timestamp, comment, parsedcomment, details, tags

letype

Filter log entries to only this type.

One of the following values: Can be empty, or renameuser, block, protect, rights, delete, upload, move, import, patrol, merge, suppress, tag, managetags, contentmodel, thanks, translationreview, translatorsandbox, newusers, interwiki, pagetranslation

leaction

Filter log actions to only this action. Overrides letype. In the list of possible values, values with the asterisk wildcard such as action/* can have different strings after the slash (/).

One of the following values: protect/modify, protect/protect, protect/unprotect, renameuser/renameuser, block/block, block/reblock, block/unblock, contentmodel/change, delete/delete, delete/event, delete/restore, delete/revision, import/interwiki, import/upload, managetags/activate, managetags/create, managetags/deactivate, managetags/delete, merge/merge, move/move, move/move_redir, patrol/patrol, protect/move_prot, rights/autopromote, rights/rights, suppress/block, suppress/delete, suppress/event, suppress/reblock, suppress/revision, tag/update, upload/overwrite, upload/revert, upload/upload, delete/flow-delete-post, delete/flow-delete-topic, suppress/flow-suppress-post, suppress/flow-suppress-topic, lock/flow-lock-topic, delete/flow-restore-post, suppress/flow-restore-post, delete/flow-restore-topic, suppress/flow-restore-topic, import/lqt-to-flow-topic, thanks/*, translationreview/message, translationreview/group, translatorsandbox/promoted, translatorsandbox/rejected, newusers/tsbpromoted, newusers/newusers, newusers/create, newusers/create2, newusers/byemail, newusers/autocreate, interwiki/*, pagetranslation/mark, pagetranslation/unmark, pagetranslation/moveok, pagetranslation/movenok, pagetranslation/deletelok, pagetranslation/deletefok, pagetranslation/deletelnok, pagetranslation/deletefnok, pagetranslation/encourage, pagetranslation/discourage, pagetranslation/prioritylanguages, pagetranslation/associate, pagetranslation/dissociate

lestart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)

leend

The timestamp to end enumerating.

Type: timestamp (allowed formats)

ledir

In which direction to enumerate:

newer: List oldest first. Note: lestart has to be before leend.
older: List newest first (default). Note: lestart has to be later than leend.

One of the following values: newer, older

Default: older

leuser

Filter entries to those made by the given user.

letitle

Filter entries to those related to a page.

lenamespace

Filter entries to those in the given namespace.

leprefix

Filter entries that start with this prefix.

letag

Only list event entries tagged with this tag.

lelimit

How many total event entries to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

lecontinue

When more results are available, use this to continue.

Example:

List recent log events.: api.php?action=query&list=logevents

list=messagecollection (mc)

(main | query | messagecollection)

This module requires read rights.
This module can be used as a generator.
Source: Translate
License: GPL-2.0+

Query MessageCollection about translations.

Parameters:

mcgroup

Message group.

This parameter is required.

mclanguage

Language code.

Default: en

mclimit

How many messages to show (after filtering).

No more than 5,000 (5,000 for bots) allowed.

Type: integer or max

Default: 500

mcoffset

When more results are available, use this to continue.

Default: (empty)

mcfilter

Message collection filters. Use ! to negate condition. For example !fuzzy means list only all non-fuzzy messages. Filters are applied in the order given.

fuzzy: Messages with fuzzy tag.
optional: Messages which should be translated only if changes are necessary.
ignored: Messages which are never translated.
hastranslation: Messages which have a translation regardless if it is fuzzy or not.
translated: Messages which have a translation which is not fuzzy.
changed: Messages which have been translated or changed since last export.
reviewer:N: Messages where the user number N is among reviewers.
last-translator:N: Messages where the user number N is the last translator.

Separate values with |. Maximum number of values is 50 (500 for bots).

Default: !optional|!ignored

mcprop

Which properties to get:

definition: Message definition.
translation: Current translation (without !!FUZZY!! string if any, use the tags to check for outdated or broken translations).
tags: Message tags, like optional, ignored and fuzzy.
properties: Message properties, like status, revision, last-translator. Can vary between messages.
revision: Deprecated! Use mcprop=properties.

Values (separate with |): definition, translation, tags, revision, properties

Default: definition|translation

Examples:

List of supported languages: api.php?action=query&meta=siteinfo&siprop=languages
List of non-optional message definitions for the group "page-Example": api.php?action=query&list=messagecollection&mcgroup=page-Example
List of optional messages in Finnish with tags for the group "page-Example": api.php?action=query&list=messagecollection&mcgroup=page-Example&mclanguage=fi&mcprop=definition|translation|tags&mcfilter=optional
More information about latest translation revisions for the group "page-Example": api.php?action=query&generator=messagecollection&gmcgroup=page-Example&gmclanguage=nl&prop=revisions

list=pagepropnames (ppn)

(main | query | pagepropnames)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

List all page property names in use on the wiki.

https://www.mediawiki.org/wiki/API:Pagepropnames

Parameters:

ppncontinue: When more results are available, use this to continue.
ppnlimit: The maximum number of names to return.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10

Example:

Get first 10 property names.: api.php?action=query&list=pagepropnames

list=pageswithprop (pwp)

(main | query | pageswithprop)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

List all pages using a given page property.

https://www.mediawiki.org/wiki/API:Pageswithprop

Parameters:

pwppropname

Page prop for which to enumerate pages.

This parameter is required.

pwpprop

Which pieces of information to include:

ids: Adds the page ID.
title: Adds the title and namespace ID of the page.
value: Adds the value of the page prop.

Values (separate with |): ids, title, value

Default: ids|title

pwpcontinue

When more results are available, use this to continue.

pwplimit

The maximum number of pages to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

pwpdir

In which direction to sort.

One of the following values: ascending, descending

Default: ascending

Examples:

List the first 10 pages using {{DISPLAYTITLE:}}.: api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value
Get additional information about the first 10 pages using __NOTOC__.: api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info

list=prefixsearch (ps)

(main | query | prefixsearch)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Perform a prefix search for page titles.

https://www.mediawiki.org/wiki/API:Prefixsearch

Parameters:

pssearch: Search string.; This parameter is required.
psnamespace: Namespaces to search.; Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 460, 461, 170, 171, 2300, 2301, 2302, 2303, 102, 103, 108, 109, 710, 711, 420, 421, 106, 107, 2600, 1198, 1199, 104, 105; Maximum number of values is 50 (500 for bots).; Default: 0
pslimit: Maximum number of results to return.; No more than 100 (200 for bots) allowed.; Type: integer or max; Default: 10
psoffset: Number of results to skip.; Type: integer; Default: 0

Example:

Search for page titles beginning with meaning.: api.php?action=query&list=prefixsearch&pssearch=meaning

list=protectedtitles (pt)

(main | query | protectedtitles)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

List all titles protected from creation.

https://www.mediawiki.org/wiki/API:Protectedtitles

Parameters:

ptnamespace

Only list titles in these namespaces.

Maximum number of values is 50 (500 for bots).

ptlevel

Only list titles with these protection levels.

Values (separate with |): autoconfirmed, sysop

ptlimit

How many total pages to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

ptdir

In which direction to enumerate:

newer: List oldest first. Note: ptstart has to be before ptend.
older: List newest first (default). Note: ptstart has to be later than ptend.

One of the following values: newer, older

Default: older

ptstart

Start listing at this protection timestamp.

Type: timestamp (allowed formats)

ptend

Stop listing at this protection timestamp.

Type: timestamp (allowed formats)

ptprop

Which properties to get:

timestamp: Adds the timestamp of when protection was added.
user: Adds the user that added the protection.
userid: Adds the user ID that added the protection.
comment: Adds the comment for the protection.
parsedcomment: Adds the parsed comment for the protection.
expiry: Adds the timestamp of when the protection will be lifted.
level: Adds the protection level.

Values (separate with |): timestamp, user, userid, comment, parsedcomment, expiry, level

Default: timestamp|level

ptcontinue

When more results are available, use this to continue.

Examples:

List protected titles.: api.php?action=query&list=protectedtitles
Find links to protected titles in the main namespace.: api.php?action=query&generator=protectedtitles&gptnamespace=0&prop=linkshere

list=querypage (qp)

(main | query | querypage)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Get a list provided by a QueryPage-based special page.

https://www.mediawiki.org/wiki/API:Querypage

Parameters:

qppage: The name of the special page. Note, this is case sensitive.; This parameter is required.; One of the following values: Ancientpages, BrokenRedirects, Deadendpages, DoubleRedirects, ListDuplicatedFiles, Listredirects, Lonelypages, Longpages, MediaStatistics, Mostcategories, Mostimages, Mostinterwikis, Mostlinkedcategories, Mostlinkedtemplates, Mostlinked, Mostrevisions, Fewestrevisions, Shortpages, Uncategorizedcategories, Uncategorizedpages, Uncategorizedimages, Uncategorizedtemplates, Unusedcategories, Unusedimages, Wantedcategories, Wantedfiles, Wantedpages, Wantedtemplates, Unwatchedpages, Unusedtemplates, Withoutinterwiki, ListAllExternalLinks
qpoffset: When more results are available, use this to continue.; Type: integer; Default: 0
qplimit: Number of results to return.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10

Example:

Return results from Special:Ancientpages.: api.php?action=query&list=querypage&qppage=Ancientpages

list=random (rn)

(main | query | random)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Get a set of random pages.

Pages are listed in a fixed sequence, only the starting point is random. This means that if, for example, Main Page is the first random page in the list, List of fictional monkeys will always be second, List of people on stamps of Vanuatu third, etc.

https://www.mediawiki.org/wiki/API:Random

Parameters:

rnnamespace: Return pages in these namespaces only.; Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 460, 461, 170, 171, 2300, 2301, 2302, 2303, 102, 103, 108, 109, 710, 711, 420, 421, 106, 107, 2600, 1198, 1199, 104, 105; Maximum number of values is 50 (500 for bots).
rnfilterredir: How to filter for redirects.; One of the following values: all, redirects, nonredirects; Default: nonredirects
rnredirect: Deprecated.; Use rnfilterredir=redirects instead.; Type: boolean (details)
rnlimit: Limit how many random pages will be returned.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 1
rncontinue: When more results are available, use this to continue.

Examples:

Return two random pages from the main namespace.: api.php?action=query&list=random&rnnamespace=0&rnlimit=2
Return page info about two random pages from the main namespace.: api.php?action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info

list=recentchanges (rc)

(main | query | recentchanges)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Enumerate recent changes.

https://www.mediawiki.org/wiki/API:Recentchanges

Parameters:

rcstart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)

rcend

The timestamp to end enumerating.

Type: timestamp (allowed formats)

rcdir

In which direction to enumerate:

newer: List oldest first. Note: rcstart has to be before rcend.
older: List newest first (default). Note: rcstart has to be later than rcend.

One of the following values: newer, older

Default: older

rcnamespace

Filter changes to only these namespaces.

Maximum number of values is 50 (500 for bots).

rcuser

Only list changes by this user.

Type: user name

rcexcludeuser

Don't list changes by this user.

Type: user name

rctag

Only list changes tagged with this tag.

rcprop

Include additional pieces of information:

user: Adds the user responsible for the edit and tags if they are an IP.
userid: Adds the user ID responsible for the edit.
comment: Adds the comment for the edit.
parsedcomment: Adds the parsed comment for the edit.
flags: Adds flags for the edit.
timestamp: Adds timestamp of the edit.
title: Adds the page title of the edit.
ids: Adds the page ID, recent changes ID and the new and old revision ID.
sizes: Adds the new and old page length in bytes.
redirect: Tags edit if page is a redirect.
patrolled: Tags patrollable edits as being patrolled or unpatrolled.
loginfo: Adds log information (log ID, log type, etc) to log entries.
tags: Lists tags for the entry.
sha1: Adds the content checksum for entries associated with a revision.

Values (separate with |): user, userid, comment, parsedcomment, flags, timestamp, title, ids, sizes, redirect, patrolled, loginfo, tags, sha1

Default: title|timestamp|ids

rctoken

Deprecated.

Use action=query&meta=tokens instead.

Values (separate with |): patrol

rcshow

Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set rcshow=minor|!anon.

Values (separate with |): minor, !minor, bot, !bot, anon, !anon, redirect, !redirect, patrolled, !patrolled, unpatrolled

rclimit

How many total changes to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

rctype

Which types of changes to show.

Values (separate with |): edit, external, new, log

Default: edit|new|log

rctoponly

Only list changes which are the latest revision.

Type: boolean (details)

rccontinue

When more results are available, use this to continue.

Examples:

List recent changes.: api.php?action=query&list=recentchanges
Get page info about recent unpatrolled changes.: api.php?action=query&generator=recentchanges&grcshow=!patrolled&prop=info

list=search (sr)

(main | query | search)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Perform a full text search.

https://www.mediawiki.org/wiki/API:Search

Parameters:

srsearch

Search for page titles or content matching this value. You can use the search string to invoke special search features, depending on what the wiki's search backend implements.

This parameter is required.

srnamespace

Search only within these namespaces.

Maximum number of values is 50 (500 for bots).

Default: 0

srwhat

Which type of search to perform.

One of the following values: title, text, nearmatch

srinfo

Which metadata to return.

Values (separate with |): totalhits, suggestion, rewrittenquery

Default: totalhits|suggestion|rewrittenquery

srprop

Which properties to return:

size: Adds the size of the page in bytes.
wordcount: Adds the word count of the page.
timestamp: Adds the timestamp of when the page was last edited.
snippet: Adds a parsed snippet of the page.
titlesnippet: Adds a parsed snippet of the page title.
redirecttitle: Adds the title of the matching redirect.
redirectsnippet: Adds a parsed snippet of the redirect title.
sectiontitle: Adds the title of the matching section.
sectionsnippet: Adds a parsed snippet of the matching section title.
isfilematch: Adds a boolean indicating if the search matched file content.
categorysnippet: Adds a parsed snippet of the matching category.
score: Deprecated and ignored.
hasrelated: Deprecated and ignored.

Values (separate with |): size, wordcount, timestamp, snippet, titlesnippet, redirecttitle, redirectsnippet, sectiontitle, sectionsnippet, isfilematch, categorysnippet, score, hasrelated

Default: size|wordcount|timestamp|snippet

sroffset

When more results are available, use this to continue.

Type: integer

Default: 0

srlimit

How many total pages to return.

No more than 50 (500 for bots) allowed.

Type: integer or max

Default: 10

srinterwiki

Include interwiki results in the search, if available.

Type: boolean (details)

srenablerewrites

Enable internal query rewriting. Some search backends can rewrite the query into one its thinks gives better results, such as correcting spelling errors.

Type: boolean (details)

Examples:

Search for meaning.: api.php?action=query&list=search&srsearch=meaning
Search texts for meaning.: api.php?action=query&list=search&srwhat=text&srsearch=meaning
Get page info about the pages returned for a search for meaning.: api.php?action=query&generator=search&gsrsearch=meaning&prop=info

list=tags (tg)

(main | query | tags)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

List change tags.

https://www.mediawiki.org/wiki/API:Tags

Parameters:

tgcontinue

When more results are available, use this to continue.

tglimit

The maximum number of tags to list.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

tgprop

Which properties to get:

name: Adds name of tag.
displayname: Adds system message for the tag.
description: Adds description of the tag.
hitcount: Adds the number of revisions and log entries that have this tag.
defined: Indicate whether the tag is defined.
source: Gets the sources of the tag, which may include extension for extension-defined tags and manual for tags that may be applied manually by users.
active: Whether the tag is still being applied.

Values (separate with |): name, displayname, description, hitcount, defined, source, active

Default: name

Example:

List available tags.: api.php?action=query&list=tags&tgprop=displayname|description|hitcount|defined

list=usercontribs (uc)

(main | query | usercontribs)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Get all edits by a user.

https://www.mediawiki.org/wiki/API:Usercontribs

Parameters:

uclimit

The maximum number of contributions to return.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

ucstart

The start timestamp to return from.

Type: timestamp (allowed formats)

ucend

The end timestamp to return to.

Type: timestamp (allowed formats)

uccontinue

When more results are available, use this to continue.

ucuser

The users to retrieve contributions for.

Separate values with |. Maximum number of values is 50 (500 for bots).

ucuserprefix

Retrieve contributions for all users whose names begin with this value. Overrides ucuser.

ucdir

In which direction to enumerate:

newer: List oldest first. Note: ucstart has to be before ucend.
older: List newest first (default). Note: ucstart has to be later than ucend.

One of the following values: newer, older

Default: older

ucnamespace

Only list contributions in these namespaces.

Maximum number of values is 50 (500 for bots).

ucprop

Include additional pieces of information:

ids: Adds the page ID and revision ID.
title: Adds the title and namespace ID of the page.
timestamp: Adds the timestamp of the edit.
comment: Adds the comment of the edit.
parsedcomment: Adds the parsed comment of the edit.
size: Adds the new size of the edit.
sizediff: Adds the size delta of the edit against its parent.
flags: Adds flags of the edit.
patrolled: Tags patrolled edits.
tags: Lists tags for the edit.

Values (separate with |): ids, title, timestamp, comment, parsedcomment, size, sizediff, flags, patrolled, tags

ucshow

Show only items that meet these criteria, e.g. non minor edits only: ucshow=!minor.

If ucshow=patrolled or ucshow=!patrolled is set, revisions older than $wgRCMaxAge (7776000 seconds) won't be shown.

Values (separate with |): minor, !minor, patrolled, !patrolled, top, !top, new, !new

uctag

Only list revisions tagged with this tag.

uctoponly

Deprecated.

Only list changes which are the latest revision.

Type: boolean (details)

Examples:

Show contributions of user Example.: api.php?action=query&list=usercontribs&ucuser=Example
Show contributions from all IP addresses with prefix 192.0.2..: api.php?action=query&list=usercontribs&ucuserprefix=192.0.2.

list=users (us)

(main | query | users)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Get information about a list of users.

https://www.mediawiki.org/wiki/API:Users

Parameters:

usprop

Which pieces of information to include:

blockinfo: Tags if the user is blocked, by whom, and for what reason.
groups: Lists all the groups each user belongs to.
implicitgroups: Lists all the groups a user is automatically a member of.
rights: Lists all the rights each user has.
editcount: Adds the user's edit count.
registration: Adds the user's registration timestamp.
emailable: Tags if the user can and wants to receive email through Special:Emailuser.
gender: Tags the gender of the user. Returns "male", "female", or "unknown".

Values (separate with |): blockinfo, groups, implicitgroups, rights, editcount, registration, emailable, gender

ususers

A list of users to obtain information for.

Separate values with |. Maximum number of values is 50 (500 for bots).

ustoken

Deprecated.

Use action=query&meta=tokens instead.

Values (separate with |): userrights

Example:

Return information for user Example.: api.php?action=query&list=users&ususers=Example&usprop=groups|editcount|gender

list=watchlist (wl)

(main | query | watchlist)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Get recent changes to pages in the current user's watchlist.

https://www.mediawiki.org/wiki/API:Watchlist

Parameters:

wlallrev

Include multiple revisions of the same page within given timeframe.

Type: boolean (details)

wlstart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)

wlend

The timestamp to end enumerating.

Type: timestamp (allowed formats)

wlnamespace

Filter changes to only the given namespaces.

Maximum number of values is 50 (500 for bots).

wluser

Only list changes by this user.

Type: user name

wlexcludeuser

Don't list changes by this user.

Type: user name

wldir

In which direction to enumerate:

newer: List oldest first. Note: wlstart has to be before wlend.
older: List newest first (default). Note: wlstart has to be later than wlend.

One of the following values: newer, older

Default: older

wllimit

How many total results to return per request.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

wlprop

Which additional properties to get:

ids: Adds revision IDs and page IDs.
title: Adds title of the page.
flags: Adds flags for the edit.
user: Adds the user who made the edit.
userid: Adds user ID of whoever made the edit.
comment: Adds comment of the edit.
parsedcomment: Adds parsed comment of the edit.
timestamp: Adds timestamp of the edit.
patrol: Tags edits that are patrolled.
sizes: Adds the old and new lengths of the page.
notificationtimestamp: Adds timestamp of when the user was last notified about the edit.
loginfo: Adds log information where appropriate.

Values (separate with |): ids, title, flags, user, userid, comment, parsedcomment, timestamp, patrol, sizes, notificationtimestamp, loginfo

Default: ids|title|flags

wlshow

Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set wlshow=minor|!anon.

Values (separate with |): minor, !minor, bot, !bot, anon, !anon, patrolled, !patrolled, unread, !unread

wltype

Which types of changes to show:

edit: Regular page edits.
external: External changes.
new: Page creations.
log: Log entries.

Values (separate with |): edit, external, new, log

Default: edit|new|log

wlowner

Used along with wltoken to access a different user's watchlist.

Type: user name

wltoken

A security token (available in the user's preferences) to allow access to another user's watchlist.

wlcontinue

When more results are available, use this to continue.

Examples:

List the top revision for recently changed pages on the current user's watchlist.: api.php?action=query&list=watchlist
Fetch additional information about the top revision for recently changed pages on the current user's watchlist.: api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment
Fetch information about all recent changes to pages on the current user's watchlist.: api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment
Fetch page info for recently changed pages on the current user's watchlist.: api.php?action=query&generator=watchlist&prop=info
Fetch revision info for recent changes to pages on the current user's watchlist.: api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user
List the top revision for recently changed pages on the watchlist of user Example.: api.php?action=query&list=watchlist&wlowner=Example&wltoken=123ABC

list=watchlistraw (wr)

(main | query | watchlistraw)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0+

Get all pages on the current user's watchlist.

https://www.mediawiki.org/wiki/API:Watchlistraw

Parameters:

wrcontinue

When more results are available, use this to continue.

wrnamespace

Only list pages in the given namespaces.

Maximum number of values is 50 (500 for bots).

wrlimit

How many total results to return per request.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

Default: 10

wrprop

Which additional properties to get:

changed: Adds timestamp of when the user was last notified about the edit.

Values (separate with |): changed

wrshow

Only list items that meet these criteria.

Values (separate with |): changed, !changed

wrowner

Used along with wrtoken to access a different user's watchlist.

Type: user name

wrtoken

A security token (available in the user's preferences) to allow access to another user's watchlist.

wrdir

In which direction to enumerate:

newer: List oldest first. Note: wrstart has to be before wrend.
older: List newest first (default). Note: wrstart has to be later than wrend.

One of the following values: ascending, descending

Default: ascending

wrfromtitle

Title (with namespace prefix) to begin enumerating from.

wrtotitle

Title (with namespace prefix) to stop enumerating at.

Examples:

List pages on the current user's watchlist.: api.php?action=query&list=watchlistraw
Fetch page info for pages on the current user's watchlist.: api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=info

meta=allmessages (am)

(main | query | allmessages)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Return messages from this site.

https://www.mediawiki.org/wiki/API:Allmessages

Parameters:

ammessages: Which messages to output. * (default) means all messages.; Separate values with |. Maximum number of values is 50 (500 for bots).; Default: *
amprop: Which properties to get.; Values (separate with |): default
amenableparser: Set to enable parser, will preprocess the wikitext of message (substitute magic words, handle templates, etc.).; Type: boolean (details)
amnocontent: If set, do not include the content of the messages in the output.; Type: boolean (details)
amincludelocal: Also include local messages, i.e. messages that don't exist in the software but do exist as a MediaWiki: page. This lists all MediaWiki: pages, so it will also list those that aren't really messages such as Common.js.; Type: boolean (details)
amargs: Arguments to be substituted into message.; Separate values with |. Maximum number of values is 50 (500 for bots).
amfilter: Return only messages with names that contain this string.
amcustomised: Return only messages in this customisation state.; One of the following values: all, modified, unmodified; Default: all
amlang: Return messages in this language.
amfrom: Return messages starting at this message.
amto: Return messages ending at this message.
amtitle: Page name to use as context when parsing message (for amenableparser option).
amprefix: Return messages with this prefix.

Examples:

Show messages starting with ipb-.: api.php?action=query&meta=allmessages&amprefix=ipb-
Show messages august and mainpage in German.: api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de

meta=filerepoinfo (fri)

(main | query | filerepoinfo)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Return meta information about image repositories configured on the wiki.

https://www.mediawiki.org/wiki/API:Filerepoinfo

Parameter:

friprop

Which repository properties to get (there may be more available on some wikis):

apiurl: URL to the repository API - helpful for getting image info from the host.
name: The key of the repository - used in e.g. $wgForeignFileRepos and imageinfo return values.
displayname: The human-readable name of the repository wiki.
rooturl: Root URL for image paths.
local: Whether that repository is the local one or not.

Values (separate with |): name, displayname, rootUrl, local, url, thumbUrl, initialCapital, scriptDirUrl, fetchDescription, descriptionCacheExpiry, apiurl, scriptExtension, favicon, canUpload

Example:

Get information about file repositories.: api.php?action=query&meta=filerepoinfo&friprop=apiurl|name|displayname

meta=languagestats (ls)

(main | query | languagestats)

This module requires read rights.
Source: Translate
License: GPL-2.0+

Query language stats.

Parameters:

lsoffset: When more results are available, use this to continue.; Default: 0
lstimelimit: Maximum time to spend calculating missing statistics. If zero, only the cached results from the beginning are returned.; The value must be between 0 and 10.; Type: integer; Default: 8
lslanguage: Language code.; This parameter is required.

Example:

List of translation completion statistics for Finnish: api.php?action=query&meta=languagestats&lslanguage=fi

meta=messagegroups (mg)

(main | query | messagegroups)

This module requires read rights.
Source: Translate
License: GPL-2.0+

Return information about message groups.

Note that the uselang parameter affects the output of language dependent parts.

Parameters:

mgdepth

When using the tree format, limit the depth to this many levels. Value 0 means that no subgroups are shown. If the limit is reached, the output includes a "groupcount" value, which states the number of direct children.

Type: integer

Default: 100

mgfilter

Only return messages with IDs that match one or more of the inputs given (case-insensitive, separated by pipes, * wildcard).

Separate values with |. Maximum number of values is 50 (500 for bots).

Default: (empty)

mgformat

In the tree format message groups can exist in multiple places in the tree.

One of the following values: flat, tree

Default: flat

mgiconsize

Preferred size of rasterised group icon.

Type: integer

Default: 64

mgprop

What translation-related information to get:

id: Include ID of the group.
label: Include label of the group.
description: Include description of the group.
class: Include class name of the group.
namespace: Include namespace of the group. Not all groups belong to a single namespace.
exists: Include self-calculated existence property of the group.
icon: Include URLs to icon of the group.
priority: Include priority status like discouraged.
prioritylangs: Include preferred languages. If not set, this returns false.
priorityforce: Include priority status - is the priority languages setting forced.
workflowstates: Include the workflow states for the message group.

Values (separate with |): id, label, description, class, namespace, exists, icon, priority, prioritylangs, priorityforce, workflowstates

Default: id|label|description|class|exists

mgroot

When using the tree format, instead of starting from top level start from the given message group, which must be an aggregate message group. When using flat format only the specified group is returned.

Default: (empty)

Example:

Show message groups: api.php?action=query&meta=messagegroups

meta=messagegroupstats (mgs)

(main | query | messagegroupstats)

This module requires read rights.
Source: Translate
License: GPL-2.0+

Query message group stats.

Parameters:

mgsoffset: When more results are available, use this to continue.; Default: 0
mgstimelimit: Maximum time to spend calculating missing statistics. If zero, only the cached results from the beginning are returned.; The value must be between 0 and 10.; Type: integer; Default: 8
mgsgroup: Message group ID.; This parameter is required.

Example:

List of translation completion statistics for the group "page-Example": api.php?action=query&meta=messagegroupstats&mgsgroup=page-Example

meta=messagetranslations (mt)

(main | query | messagetranslations)

This module requires read rights.
Source: Translate
License: GPL-2.0+

Query all translations for a single message.

Parameters:

mttitle: Full title of a known message.; This parameter is required.
mtoffset: When more results are available, use this to continue.; Type: integer; Default: 0

Example:

List of translations in the wiki for "MediaWiki:January": api.php?action=query&meta=messagetranslations&mttitle=MediaWiki:January

meta=notifications (not)

(main | query | notifications)

This module requires read rights.
Source: Echo
License: MIT

Get notifications waiting for the current user.

https://www.mediawiki.org/wiki/Echo_(Notifications)/API

Parameters:

notprop: Details to request.; Values (separate with |): list, count, index; Default: list
notsections: The notification sections to query (i.e. some combination of 'alert' and 'message').; Values (separate with |): alert, message; Default: alert|message
notgroupbysection: Whether to group the result by section. Each section is fetched separately if set.; Type: boolean (details)
notformat: If specified, notifications will be returned formatted this way.; One of the following values: text, flyout, html
notlimit: The maximum number of notifications to return.; No more than 50 (500 for bots) allowed.; Type: integer or max; Default: 20
notindex: If specified, a list of notification IDs, in order, will be returned.; Type: boolean (details)
notcontinue: When more results are available, use this to continue.
notalertcontinue: When more alert results are available, use this to continue.
notalertunreadfirst: Whether to show unread message notifications first.; Type: boolean (details)
notmessagecontinue: When more message results are available, use this to continue.
notmessageunreadfirst: Whether to show unread alert notifications first.; Type: boolean (details)

Examples:

List notifications: api.php?action=query&meta=notifications
List notifications, grouped by section, with counts: api.php?action=query&meta=notifications&notprop=count&notsections=alert|message&notgroupbysection=1

meta=siteinfo (si)

(main | query | siteinfo)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Return general information about the site.

https://www.mediawiki.org/wiki/API:Siteinfo

Parameters:

siprop

Which information to get:

general: Overall system information.
namespaces: List of registered namespaces and their canonical names.
namespacealiases: List of registered namespace aliases.
specialpagealiases: List of special page aliases.
magicwords: List of magic words and their aliases.
interwikimap: Returns interwiki map (optionally filtered, optionally localised by using siinlanguagecode).
dbrepllag: Returns database server with the highest replication lag.
statistics: Returns site statistics.
usergroups: Returns user groups and the associated permissions.
libraries: Returns libraries installed on the wiki.
extensions: Returns extensions installed on the wiki.
fileextensions: Returns list of file extensions allowed to be uploaded.
rightsinfo: Returns wiki rights (license) information if available.
restrictions: Returns information on available restriction (protection) types.
languages: Returns a list of languages MediaWiki supports (optionally localised by using siinlanguagecode).
skins: Returns a list of all enabled skins (optionally localised by using siinlanguagecode, otherwise in the content language).
extensiontags: Returns a list of parser extension tags.
functionhooks: Returns a list of parser function hooks.
showhooks: Returns a list of all subscribed hooks (contents of $wgHooks).
variables: Returns a list of variable IDs.
protocols: Returns a list of protocols that are allowed in external links.
defaultoptions: Returns the default values for user preferences.

Values (separate with |): general, namespaces, namespacealiases, specialpagealiases, magicwords, interwikimap, dbrepllag, statistics, usergroups, libraries, extensions, fileextensions, rightsinfo, restrictions, languages, skins, extensiontags, functionhooks, showhooks, variables, protocols, defaultoptions

Default: general

sifilteriw

Return only local or only nonlocal entries of the interwiki map.

One of the following values: local, !local

sishowalldb

List all database servers, not just the one lagging the most.

Type: boolean (details)

sinumberingroup

Lists the number of users in user groups.

Type: boolean (details)

siinlanguagecode

Language code for localised language names (best effort) and skin names.

Examples:

Fetch site information.: api.php?action=query&meta=siteinfo&siprop=general|namespaces|namespacealiases|statistics
Fetch a list of local interwiki prefixes.: api.php?action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local
Check the current replication lag.: api.php?action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb=

meta=tokens

(main | query | tokens)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Gets tokens for data-modifying actions.

https://www.mediawiki.org/wiki/API:Tokens

Parameter:

type: Types of token to request.; Values (separate with |): csrf, patrol, rollback, userrights, watch; Default: csrf

Examples:

Retrieve a csrf token (the default).: api.php?action=query&meta=tokens
Retrieve a watch token and a patrol token.: api.php?action=query&meta=tokens&type=watch|patrol

meta=userinfo (ui)

(main | query | userinfo)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Get information about the current user.

https://www.mediawiki.org/wiki/API:Userinfo

Parameter:

uiprop

Which pieces of information to include:

blockinfo: Tags if the current user is blocked, by whom, and for what reason.
hasmsg: Adds a tag messages if the current user has pending messages.
groups: Lists all the groups the current user belongs to.
implicitgroups: Lists all the groups the current user is automatically a member of.
rights: Lists all the rights the current user has.
changeablegroups: Lists the groups the current user can add to and remove from.
options: Lists all preferences the current user has set.
preferencestoken: Deprecated. Get a token to change current user's preferences.
editcount: Adds the current user's edit count.
ratelimits: Lists all rate limits applying to the current user.
email: Adds the user's email address and email authentication date.
realname: Adds the user's real name.
acceptlang: Echoes the Accept-Language header sent by the client in a structured format.
registrationdate: Adds the user's registration date.
unreadcount: Adds the count of unread pages on the user's watchlist (maximum 999; returns 1000+ if more).

Values (separate with |): blockinfo, hasmsg, groups, implicitgroups, rights, changeablegroups, options, preferencestoken, editcount, ratelimits, email, realname, acceptlang, registrationdate, unreadcount

Examples:

Get information about the current user.: api.php?action=query&meta=userinfo
Get additional information about the current user.: api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg

action=revisiondelete

(main | revisiondelete)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Delete and undelete revisions.

https://www.mediawiki.org/wiki/API:Revisiondelete

Parameters:

type: Type of revision deletion being performed.; This parameter is required.; One of the following values: revision, archive, oldimage, filearchive, logging
target: Page title for the revision deletion, if required for the type.
ids: Identifiers for the revisions to be deleted.; This parameter is required.; Separate values with |. Maximum number of values is 50 (500 for bots).
hide: What to hide for each revision.; Values (separate with |): content, comment, user
show: What to unhide for each revision.; Values (separate with |): content, comment, user
suppress: Whether to suppress data from administrators as well as others.; One of the following values: yes, no, nochange; Default: nochange
reason: Reason for the deletion or undeletion.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Examples:

Hide content for revision 12345 on the page Main Page.: api.php?action=revisiondelete&target=Main%20Page&type=revision&ids=12345&hide=content&token=123ABC
Hide all data on log entry 67890 with the reason BLP violation.: api.php?action=revisiondelete&type=logging&ids=67890&hide=content|comment|user&reason=BLP%20violation&token=123ABC

action=rollback

(main | rollback)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Undo the last edit to the page.

If the last user who edited the page made multiple edits in a row, they will all be rolled back.

https://www.mediawiki.org/wiki/API:Rollback

Parameters:

title

Title of the page to roll back. Cannot be used together with pageid.

pageid

Page ID of the page to roll back. Cannot be used together with title.

Type: integer

user

Name of the user whose edits are to be rolled back.

This parameter is required.

summary

Custom edit summary. If empty, default summary will be used.

Default: (empty)

markbot

Mark the reverted edits and the revert as bot edits.

Type: boolean (details)

watchlist

Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.

One of the following values: watch, unwatch, preferences, nochange

Default: preferences

token

A "rollback" token retrieved from action=query&meta=tokens

For compatibility, the token used in the web UI is also accepted.

This parameter is required.

Examples:

Roll back the last edits to page Main Page by user Example.: api.php?action=rollback&title=Main%20Page&user=Example&token=123ABC
Roll back the last edits to page Main Page by IP user 192.0.2.5 with summary Reverting vandalism, and mark those edits and the revert as bot edits.: api.php?action=rollback&title=Main%20Page&user=192.0.2.5&token=123ABC&summary=Reverting%20vandalism&markbot=1

action=rsd

(main | rsd)

Source: MediaWiki
License: GPL-2.0+

Export an RSD (Really Simple Discovery) schema.

Example:

Export the RSD schema.: api.php?action=rsd

action=searchtranslations

(main | searchtranslations)

This module requires read rights.
Source: Translate
License: GPL-2.0+

Search translations.

Parameters:

service: Which of the available translation services to use.; One of the following values:; Default: TTMServer
query: The string to search for.; This parameter is required.
sourcelanguage: The language code of the source text.; Default: en
language: The language code to search string for.; Default: (empty)
group: The group id to search string in.; Default: (empty)
filter: Message translation status filter.; One of the following values: Can be empty, or translated, fuzzy, untranslated; Default: (empty)
match: Match any/all search words.; Default: (empty)
case: Case (in)sensitive search.; Default: 0
offset: Offset for the translations.; Type: integer; Default: 0
limit: Size of the result.; The value must be between 1 and 50.; Type: integer; Default: 25

Examples:

Show translations for the language.: api.php?action=searchtranslations&language=fr&query=aide
Show untranslated messages matching the query in the source language.: api.php?action=searchtranslations&language=fr&query=edit&filter=untranslated

action=setnotificationtimestamp

(main | setnotificationtimestamp)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Update the notification timestamp for watched pages.

This affects the highlighting of changed pages in the watchlist and history, and the sending of email when the "Email me when a page or a file on my watchlist is changed" preference is enabled.

https://www.mediawiki.org/wiki/API:SetNotificationTimestamp

Parameters:

entirewatchlist

Work on all watched pages.

Type: boolean (details)

timestamp

Timestamp to which to set the notification timestamp.

Type: timestamp (allowed formats)

torevid

Revision to set the notification timestamp to (one page only).

Type: integer

newerthanrevid

Revision to set the notification timestamp newer than (one page only).

Type: integer

continue

When more results are available, use this to continue.

titles

A list of titles to work on.

Separate values with |. Maximum number of values is 50 (500 for bots).

pageids

A list of page IDs to work on.

Type: list of integers

Separate values with |. Maximum number of values is 50 (500 for bots).

revids

A list of revision IDs to work on.

Type: list of integers

Separate values with |. Maximum number of values is 50 (500 for bots).

generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

Type: boolean (details)

converttitles

Type: boolean (details)

token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

Examples:

Reset the notification status for the entire watchlist.: api.php?action=setnotificationtimestamp&entirewatchlist=&token=123ABC
Reset the notification status for Main page.: api.php?action=setnotificationtimestamp&titles=Main_page&token=123ABC
Set the notification timestamp for Main page so all edits since 1 January 2012 are unviewed.: api.php?action=setnotificationtimestamp&titles=Main_page&timestamp=2012-01-01T00:00:00Z&token=123ABC
Reset the notification status for pages in the User namespace.: api.php?action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC

action=sfautocomplete

(main | sfautocomplete)

This module requires read rights.
Source: Semantic Forms
License: GPL-2.0+

Autocompletion call used by the Semantic Forms extension (http://www.mediawiki.org/Extension:Semantic_Forms)

Parameters:

limit: (no description); No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10
substr: Search substring
property: Semantic property for which to search values
category: Category for which to search values
concept: Concept for which to search values
cargo_table: (no description)
cargo_field: (no description)
field_is_array: (no description)
namespace: Namespace for which to search values
external_url: Alias for external URL from which to get values
baseprop: A previous property in the form to check against
base_cargo_table: (no description)
base_cargo_field: (no description)
basevalue: The value to check for the previous property

Examples:

: api.php?action=sfautocomplete&substr=te
: api.php?action=sfautocomplete&substr=te&property=Has_author
: api.php?action=sfautocomplete&substr=te&category=Authors

action=sfautoedit

(main | sfautoedit)

This module requires read rights.
This module requires write rights.
Source: Semantic Forms
License: GPL-2.0+

This module is used to remotely create or edit pages using Semantic Forms.

Add "template-name[field-name]=field-value" to the query string parameter, to set the value for a specific field. To set values for more than one field use "&", or rather its URL encoded version "%26": "template-name[field-name-1]=field-value-1%26template-name[field-name-2]=field-value-2". See the first example below.

In addition to the query parameter, any parameter in the URL of the form "template-name[field-name]=field-value" will be treated as part of the query. See the second example.

Parameters:

form: The form to use.
target: The target page.
query: The query string.
preload: The name of a page to preload

Example:

With query parameter: api.php?action=sfautoedit&form=form-name&target=page-name&query=template-name[field-name-1]=field-value-1%26template-name[field-name-2]=field-value-2: api.php?Without query parameter: api.php?action=sfautoedit&form=form-name&target=page-name&template-name[field-name-1]=field-value-1&template-name[field-name-2]=field-value-2

action=smwinfo

(main | smwinfo)

This module requires read rights.
Source: Semantic MediaWiki
License: GPL-2.0+

API module get info about this SMW install.

Parameter:

info: The info to provide.; Values (separate with |): propcount, errorcount, usedpropcount, declaredpropcount, proppagecount, querycount, querysize, formatcount, conceptcount, subobjectcount; Default: propcount|usedpropcount|declaredpropcount

Example:

: api.php?action=smwinfo&info=proppagecount|propcount

action=stashedit

(main | stashedit)

This module is internal or unstable. Its operation may change without notice.
This module requires read rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Prepare an edit in shared cache.

This is intended to be used via AJAX from the edit form to improve the performance of the page save.

Parameters:

title: Title of the page being edited.; This parameter is required.
section: Section number. 0 for the top section, new for a new section.
sectiontitle: The title for a new section.
text: Page content.; This parameter is required.
contentmodel: Content model of the new content.; This parameter is required.; One of the following values: wikitext, javascript, json, css, text, JsonSchema, Campaign, flow-board
contentformat: Content serialization format used for the input text.; This parameter is required.; One of the following values: text/x-wiki, text/javascript, application/json, text/css, text/plain
baserevid: Revision ID of the base revision.; This parameter is required.; Type: integer
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

action=tag

(main | tag)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Add or remove change tags from individual revisions or log entries.

https://www.mediawiki.org/wiki/API:Tag

Parameters:

rcid: One or more recent changes IDs from which to add or remove the tag.; Type: list of integers; Separate values with |. Maximum number of values is 50 (500 for bots).
revid: One or more revision IDs from which to add or remove the tag.; Type: list of integers; Separate values with |. Maximum number of values is 50 (500 for bots).
logid: One or more log entry IDs from which to add or remove the tag.; Type: list of integers; Separate values with |. Maximum number of values is 50 (500 for bots).
add: Tags to add. Only manually defined tags can be added.; Values (separate with |):
remove: Tags to remove. Only tags that are either manually defined or completely undefined can be removed.; Separate values with |. Maximum number of values is 50 (500 for bots).
reason: Reason for the change.; Default: (empty)
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Examples:

Add the vandalism tag to revision ID 123 without specifying a reason: api.php?action=tag&revid=123&add=vandalism&token=123ABC
Remove the spam tag from log entry ID 123 with the reason Wrongly applied: api.php?action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC

action=thank

(main | thank)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Thanks
License: MIT

Send a thank-you notification to an editor.

https://www.mediawiki.org/wiki/Extension:Thanks#API_Documentation

Parameters:

rev: Revision ID to thank someone for.; This parameter is required.; The value must be no less than 1.; Type: integer
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.
source: A short string describing the source of the request, for example, "diff" or "history".

Example:

Send thanks for revision ID 456, with the source being a diff page: api.php?action=thank&revid=456&source=diff&token=123ABC

action=tokens

(main | tokens)

This module is deprecated.
This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Get tokens for data-modifying actions.

This module is deprecated in favor of action=query&meta=tokens.

Parameter:

type: Types of token to request.; Values (separate with |): block, delete, edit, email, import, move, options, patrol, protect, unblock, watch; Default: edit

Examples:

Retrieve an edit token (the default).: api.php?action=tokens
Retrieve an email token and a move token.: api.php?action=tokens&type=email|move

action=transcodereset

(main | transcodereset)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: TimedMediaHandler
License: GPL-2.0+

Users with the 'transcode-reset' right can reset and re-run a transcode job.

Parameters:

title: The media file title.; This parameter is required.
transcodekey: The transcode key you wish to reset. Fetch from action=query&prop=transcodestatus.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Examples:

Reset all transcodes for File:Clip.webm: api.php?action=transcodereset&title=File:Clip.webm&token=123ABC
Reset the '360_560kbs.webm' transcode key for File:Clip.webm: api.php?action=transcodereset&title=File:Clip.webm&transcodekey=360_560kbs.webm&token=123ABC

action=translatesandbox

(main | translatesandbox)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Translate
License: GPL-2.0+

Signup and manage sandboxed users.

Parameters:

do: What to do.; This parameter is required.; One of the following values: create, delete, promote, remind
userid: User IDs of the users being managed. Use 0 for creations.; Type: list of integers; Separate values with |. Maximum number of values is 50 (500 for bots).; Default: 0
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.
username: Username when creating user.
password: Password when creating user.
email: Email when creating user.

action=translateuser

(main | translateuser)

This module requires read rights.
Source: Translate
License: GPL-2.0+

Translation related information about the user.

Example:

Show information about the user: api.php?action=translateuser

action=translationaids

(main | translationaids)

This module requires read rights.
Source: Translate
License: GPL-2.0+

Query all translations aids.

Parameters:

title: Full title of a known message.; This parameter is required.
group: Message group the message belongs to. If empty then primary group is used.
prop: Which translation helpers to include.; Values (separate with |): definition, translation, inotherlanguages, documentation, mt, definitiondiff, ttmserver, support, gettext, insertables; Default: definition|translation|inotherlanguages|documentation|mt|definitiondiff|ttmserver|support|gettext|insertables

Example:

Show aids for MediaWiki:January/fi: api.php?action=translationaids&title=MediaWiki:January/fi

action=translationreview

(main | translationreview)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Translate
License: GPL-2.0+

Mark translations reviewed.

Parameters:

revision: The revision number to review.; This parameter is required.; Type: integer
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Review revision 1: api.php?action=translationreview&revision=1&token=foo

action=translationstash

(main | translationstash)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Translate
License: GPL-2.0+

Add translations to stash.

Parameters:

subaction: Action.; This parameter is required.; One of the following values: add, query
title: Title of the translation unit page.
translation: Translation made by the user.
metadata: JSON object.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.
username: Optionally the user whose stash to get. Only privileged users can do this.

Examples:

Add a translation to the stash for MediaWiki:Jan/fi: api.php?action=translationstash&subaction=add&title=MediaWiki:Jan/fi&translation=tammikuu&metadata={}
Query the stash: api.php?action=translationstash&subaction=query

action=ttmserver

(main | ttmserver)

This module requires read rights.
Source: Translate
License: GPL-2.0+

Query suggestions from translation memories.

Parameters:

service: Which of the available translation services to use.; One of the following values:; Default: TTMServer
sourcelanguage: The language code of the source text.; This parameter is required.
targetlanguage: The language code of the suggestion.; This parameter is required.
text: The text to find suggestions for.; This parameter is required.

Example:

Get suggestions for translating "Help" from English to Finnish: api.php?action=ttmserver&sourcelanguage=en&targetlanguage=fi&text=Help

action=ulslocalization

(main | ulslocalization)

This module is internal or unstable. Its operation may change without notice.
This module requires read rights.
Source: UniversalLanguageSelector
License: GPL-2.0+

Get the localization of ULS in the given language.

Parameter:

language: Language code.; This parameter is required.

Examples:

Get Tamil localization: api.php?action=ulslocalization&language=ta
Get Hindi localization: api.php?action=ulslocalization&language=hi

action=unblock

(main | unblock)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Unblock a user.

https://www.mediawiki.org/wiki/API:Block

Parameters:

id: ID of the block to unblock (obtained through list=blocks). Cannot be used together with user.; Type: integer
user: Username, IP address or IP range to unblock. Cannot be used together with id.
reason: Reason for unblock.; Default: (empty)
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Examples:

Unblock block ID #105.: api.php?action=unblock&id=105
Unblock user Bob with reason Sorry Bob.: api.php?action=unblock&user=Bob&reason=Sorry%20Bob

action=undelete

(main | undelete)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Restore revisions of a deleted page.

A list of deleted revisions (including timestamps) can be retrieved through list=deletedrevs, and a list of deleted file IDs can be retrieved through list=filearchive.

https://www.mediawiki.org/wiki/API:Undelete

Parameters:

title: Title of the page to restore.; This parameter is required.
reason: Reason for restoring.; Default: (empty)
timestamps: Timestamps of the revisions to restore. If both timestamps and fileids are empty, all will be restored.; Type: list of timestamps (allowed formats); Separate values with |. Maximum number of values is 50 (500 for bots).
fileids: IDs of the file revisions to restore. If both timestamps and fileids are empty, all will be restored.; Type: list of integers; Separate values with |. Maximum number of values is 50 (500 for bots).
watchlist: Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.; One of the following values: watch, unwatch, preferences, nochange; Default: preferences
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Examples:

Undelete page Main Page.: api.php?action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page
Undelete two revisions of page Main Page.: api.php?action=undelete&title=Main%20Page&token=123ABC&timestamps=2007-07-03T22:00:45Z|2007-07-02T19:48:56Z

action=upload

(main | upload)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Upload a file, or get the status of pending uploads.

Several methods are available:

Upload file contents directly, using the file parameter.
Upload the file in pieces, using the filesize, chunk, and offset parameters.
Have the MediaWiki server fetch a file from a URL, using the url parameter.
Complete an earlier upload that failed due to warnings, using the filekey parameter.

Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when sending the file.

https://www.mediawiki.org/wiki/API:Upload

Parameters:

filename: Target filename.
comment: Upload comment. Also used as the initial page text for new files if text is not specified.; Default: (empty)
text: Initial page text for new files.
watch: Deprecated.; Watch the page.; Type: boolean (details)
watchlist: Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.; One of the following values: watch, preferences, nochange; Default: preferences
ignorewarnings: Ignore any warnings.; Type: boolean (details)
file: File contents.; Must be posted as a file upload using multipart/form-data.
url: URL to fetch the file from.
filekey: Key that identifies a previous upload that was stashed temporarily.
sessionkey: Deprecated.; Same as filekey, maintained for backward compatibility.
stash: If set, the server will stash the file temporarily instead of adding it to the repository.; Type: boolean (details)
filesize: Filesize of entire upload.; The value must be between 0 and 52,428,800.; Type: integer
offset: Offset of chunk in bytes.; The value must be no less than 0.; Type: integer
chunk: Chunk contents.; Must be posted as a file upload using multipart/form-data.
async: Make potentially large file operations asynchronous when possible.; Type: boolean (details)
asyncdownload: Make fetching a URL asynchronous.; Type: boolean (details)
leavemessage: If asyncdownload is used, leave a message on the user talk page if finished.; Type: boolean (details)
statuskey: Fetch the upload status for this file key (upload by URL).
checkstatus: Only fetch the upload status for the given file key.; Type: boolean (details)
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Examples:

Upload from a URL.: api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png&token=123ABC
Complete an upload that failed due to warnings.: api.php?action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1&token=123ABC

action=userrights

(main | userrights)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Change a user's group membership.

https://www.mediawiki.org/wiki/API:User_group_membership

Parameters:

user

User name.

userid

User ID.

Type: integer

add

Add the user to these groups.

Values (separate with |): bot, sysop, bureaucrat, upwizcampeditors, oversight, flow-bot, translator, smwadministrator

remove

Remove the user from these groups.

Values (separate with |): bot, sysop, bureaucrat, upwizcampeditors, oversight, flow-bot, translator, smwadministrator

reason

Reason for the change.

Default: (empty)

token

A "userrights" token retrieved from action=query&meta=tokens

For compatibility, the token used in the web UI is also accepted.

This parameter is required.

Examples:

Add user FooBot to group bot, and remove from groups sysop and bureaucrat.: api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC
Add the user with ID 123 to group bot, and remove from groups sysop and bureaucrat.: api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC

action=watch

(main | watch)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0+

Add or remove pages from the current user's watchlist.

https://www.mediawiki.org/wiki/API:Watch

Parameters:

title

Deprecated.

The page to (un)watch. Use titles instead.

unwatch

If set the page will be unwatched rather than watched.

Type: boolean (details)

continue

When more results are available, use this to continue.

titles

A list of titles to work on.

Separate values with |. Maximum number of values is 50 (500 for bots).

pageids

A list of page IDs to work on.

Type: list of integers

Separate values with |. Maximum number of values is 50 (500 for bots).

revids

A list of revision IDs to work on.

Type: list of integers

Separate values with |. Maximum number of values is 50 (500 for bots).

generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

Type: boolean (details)

converttitles

Type: boolean (details)

token

A "watch" token retrieved from action=query&meta=tokens

This parameter is required.

Examples:

Watch the page Main Page.: api.php?action=watch&titles=Main_Page&token=123ABC
Unwatch the page Main Page.: api.php?action=watch&titles=Main_Page&unwatch=&token=123ABC
Watch the first few pages in the main namespace.: api.php?action=watch&generator=allpages&gapnamespace=0&token=123ABC

format=dbg

(main | dbg)

This module is deprecated.
This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Output data in PHP's var_export() format.

https://www.mediawiki.org/wiki/API:Data_formats

Example:

Return the query result in the DBG format.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbg

format=dbgfm

(main | dbgfm)

This module is deprecated.
This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Output data in PHP's var_export() format (pretty-print in HTML).

https://www.mediawiki.org/wiki/API:Data_formats

Example:

Return the query result in the DBG format.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbgfm

format=json

(main | json)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Output data in JSON format.

https://www.mediawiki.org/wiki/API:Data_formats

Parameters:

callback

If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

utf8

If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.

Type: boolean (details)

ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

Type: boolean (details)

formatversion

Output formatting:

1: Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2: Experimental modern format. Details may change!
latest: Use the latest format (currently 2), may change without warning.

One of the following values: 1, 2, latest

Default: 1

Example:

Return the query result in the JSON format.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=json

format=jsonfm

(main | jsonfm)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Output data in JSON format (pretty-print in HTML).

https://www.mediawiki.org/wiki/API:Data_formats

Parameters:

callback

If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

utf8

If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.

Type: boolean (details)

ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

Type: boolean (details)

formatversion

Output formatting:

1: Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2: Experimental modern format. Details may change!
latest: Use the latest format (currently 2), may change without warning.

One of the following values: 1, 2, latest

Default: 1

Example:

Return the query result in the JSON format.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=jsonfm

format=none

(main | none)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Output nothing.

https://www.mediawiki.org/wiki/API:Data_formats

Example:

Return the query result in the NONE format.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=none

format=php

(main | php)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Output data in serialized PHP format.

https://www.mediawiki.org/wiki/API:Data_formats

Parameter:

formatversion

Output formatting:

1: Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2: Experimental modern format. Details may change!
latest: Use the latest format (currently 2), may change without warning.

One of the following values: 1, 2, latest

Default: 1

Example:

Return the query result in the PHP format.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=php

format=phpfm

(main | phpfm)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Output data in serialized PHP format (pretty-print in HTML).

https://www.mediawiki.org/wiki/API:Data_formats

Parameter:

formatversion

Output formatting:

1: Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2: Experimental modern format. Details may change!
latest: Use the latest format (currently 2), may change without warning.

One of the following values: 1, 2, latest

Default: 1

Example:

Return the query result in the PHP format.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=phpfm

format=rawfm

(main | rawfm)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Output data with the debugging elements in JSON format (pretty-print in HTML).

https://www.mediawiki.org/wiki/API:Data_formats

Example:

Return the query result in the RAW format.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=rawfm

format=txt

(main | txt)

This module is deprecated.
This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Output data in PHP's print_r() format.

https://www.mediawiki.org/wiki/API:Data_formats

Example:

Return the query result in the TXT format.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=txt

format=txtfm

(main | txtfm)

This module is deprecated.
This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Output data in PHP's print_r() format (pretty-print in HTML).

https://www.mediawiki.org/wiki/API:Data_formats

Example:

Return the query result in the TXT format.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=txtfm

format=xml

(main | xml)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Output data in XML format.

https://www.mediawiki.org/wiki/API:Data_formats

Parameters:

xslt: If specified, adds the named page as an XSL stylesheet. The value must be a title in the MediaWiki namespace ending in .xsl.
includexmlnamespace: If specified, adds an XML namespace.; Type: boolean (details)

Example:

Return the query result in the XML format.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=xml

format=xmlfm

(main | xmlfm)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Output data in XML format (pretty-print in HTML).

https://www.mediawiki.org/wiki/API:Data_formats

Parameters:

xslt: If specified, adds the named page as an XSL stylesheet. The value must be a title in the MediaWiki namespace ending in .xsl.
includexmlnamespace: If specified, adds an XML namespace.; Type: boolean (details)

Example:

Return the query result in the XML format.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=xmlfm

format=yaml

(main | yaml)

This module is deprecated.
This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Output data in YAML format.

https://www.mediawiki.org/wiki/API:Data_formats

Parameters:

callback

If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

utf8

If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.

Type: boolean (details)

ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

Type: boolean (details)

formatversion

Output formatting:

1: Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2: Experimental modern format. Details may change!
latest: Use the latest format (currently 2), may change without warning.

One of the following values: 1, 2, latest

Default: 1

Example:

Return the query result in the YAML format.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=yaml

format=yamlfm

(main | yamlfm)

This module is deprecated.
This module requires read rights.
Source: MediaWiki
License: GPL-2.0+

Output data in YAML format (pretty-print in HTML).

https://www.mediawiki.org/wiki/API:Data_formats

Parameters:

callback

If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

utf8

If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.

Type: boolean (details)

ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

Type: boolean (details)

formatversion

Output formatting:

1: Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2: Experimental modern format. Details may change!
latest: Use the latest format (currently 2), may change without warning.

One of the following values: 1, 2, latest

Default: 1

Example:

Return the query result in the YAML format.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=yamlfm

Data types

Some parameter types in API requests need further explanation:

boolean

Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.

timestamp

Timestamps may be specified in several formats. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.

ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)
ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)
MediaWiki format, 20010115145600
Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)
EXIF format, 2001:01:15 14:56:00
RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00
RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00
C ctime format, Mon Jan 15 14:56:00 2001
Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)
The string now

Credits

API developers:

Yuri Astrakhan (creator, lead developer Sep 2006–Sep 2007)
Roan Kattouw (lead developer Sep 2007–2009)
Victor Vasiliev
Bryan Tong Minh
Sam Reed
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/.

Retrieved from "https://terms.tdwg.org/wiki/Special:ApiHelp"

MediaWiki API help

Main module

action=aggregategroups

action=ask

action=askargs

action=block

action=browsebysubject

action=checktoken

action=clearhasmsg

action=compare

action=createaccount

action=delete

action=echomarkread

action=echomarkseen

action=edit

action=emailuser

action=expandtemplates

action=ext.srf.slideshow.show

action=feedcontributions

action=feedrecentchanges

action=feedwatchlist

action=filerevert

action=flickrblacklist

action=flow

submodule=close-open-topic (cot)

submodule=edit-header (eh)

submodule=edit-post (ep)

submodule=edit-title (et)

submodule=edit-topic-summary (ets)

submodule=lock-topic (cot)

submodule=moderate-post (mp)

submodule=moderate-topic (mt)

submodule=new-topic (nt)

submodule=reply (rep)

submodule=undo-edit-header (ueh)

submodule=undo-edit-post (uep)

submodule=undo-edit-topic-summary (uets)

submodule=view-header (vh)

submodule=view-post (vp)

submodule=view-post-history (vph)

submodule=view-topic (vt)

submodule=view-topic-history (vth)

submodule=view-topic-summary (vts)

submodule=view-topiclist (vtl)

action=flow-parsoid-utils

action=flowthank

action=geocode

action=groupreview

action=help

action=imagerotate

action=import

action=languagesearch

action=login (lg)

action=logout

action=managetags

action=move

action=opensearch

action=options

action=paraminfo

action=parse

action=patrol

action=protect

action=purge

action=query

prop=categories (cl)

prop=categoryinfo (ci)

prop=contributors (pc)

prop=deletedrevisions (drv)

prop=duplicatefiles (df)

prop=extlinks (el)

prop=fileusage (fu)

prop=flowinfo (fli)

prop=globalusage (gu)

prop=imageinfo (ii)

prop=images (im)

prop=info (in)

prop=iwlinks (iw)

prop=langlinks (ll)

prop=links (pl)

prop=linkshere (lh)