MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

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

action=query

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.

categories
List all categories the pages belong to.
categoryinfo
Returns information about the given categories.
contributors
Get the list of logged-in contributors and the count of anonymous contributors to a page.
deletedrevisions
Get deleted revision information.
duplicatefiles
List all files that are duplicates of the given files based on hash values.
extlinks
Returns all external URLs (not interwikis) from the given pages.
fileusage
Find all pages that use the given files.
imageinfo
Returns file information and upload history.
images
Returns all files contained on the given pages.
info
Get basic page information.
iwlinks
Returns all interwiki links from the given pages.
langlinks
Returns all interlanguage links from the given pages.
links
Returns all links from the given pages.
linkshere
Find all pages that link to the given pages.
pageimages
Returns information about images on the page, such as thumbnail and presence of photos.
pageprops
Get various page properties defined in the page content.
redirects
Returns all redirects to the given pages.
revisions
Get revision information.
stashimageinfo
Returns file information for stashed files.
templates
Returns all pages transcluded on the given pages.
transcludedin
Find all pages that transclude the given pages.
Values (separate with | or alternative): categories, categoryinfo, contributors, deletedrevisions, duplicatefiles, extlinks, fileusage, imageinfo, images, info, iwlinks, langlinks, links, linkshere, pageimages, pageprops, redirects, revisions, stashimageinfo, templates, transcludedin
list

Which lists to get.

allcategories
Enumerate all categories.
alldeletedrevisions
List all deleted revisions by a user or in a namespace.
allfileusages
List all file usages, including non-existing.
allimages
Enumerate all images sequentially.
alllinks
Enumerate all links that point to a given namespace.
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
List all redirects to a namespace.
allrevisions
List all revisions.
alltransclusions
List all transclusions (pages embedded using {{x}}), including non-existing.
allusers
Enumerate all registered users.
backlinks
Find all pages that link to the given page.
blocks
List all blocked users and IP addresses.
categorymembers
List all pages in a given category.
embeddedin
Find all pages that embed (transclude) the given title.
exturlusage
Enumerate pages that contain a given URL.
filearchive
Enumerate all deleted files sequentially.
gadgetcategories
Returns a list of gadget categories.
gadgets
Returns a list of gadgets used on this wiki.
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
Find all pages that link to the given language link.
logevents
Get events from logs.
messagecollection
Query MessageCollection about translations.
mystashedfiles
Get a list of files in the current user's upload stash.
pagepropnames
List all page property names in use on the wiki.
pageswithprop
List all pages using a given page property.
prefixsearch
Perform a prefix search for page titles.
protectedtitles
List all titles protected from creation.
querypage
Get a list provided by a QueryPage-based special page.
random
Get a set of random pages.
recentchanges
Enumerate recent changes.
search
Perform a full text search.
tags
List change tags.
usercontribs
Get all edits by a user.
users
Get information about a list of users.
watchlist
Get recent changes to pages in the current user's watchlist.
watchlistraw
Get all pages on the current user's watchlist.
deletedrevs
Deprecated. List deleted revisions.
Values (separate with | or alternative): allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, allusers, backlinks, blocks, categorymembers, embeddedin, exturlusage, filearchive, gadgetcategories, gadgets, imageusage, iwbacklinks, langbacklinks, logevents, messagecollection, mystashedfiles, pagepropnames, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, search, tags, usercontribs, users, watchlist, watchlistraw, deletedrevs
meta

Which metadata to get.

allmessages
Return messages from this site.
authmanagerinfo
Retrieve information about the current authentication status.
babel
Get information about what languages the user knows
filerepoinfo
Return meta information about image repositories configured on the wiki.
languageinfo
Return information about available languages.
languagestats
Query language stats.
managemessagegroups
Fetch possible renames for a message in a group during imports
messagegroups
Return information about message groups.
messagegroupstats
Query message group stats.
messagetranslations
Query all translations for a single message.
siteinfo
Return general information about the site.
tokens
Gets tokens for data-modifying actions.
userinfo
Get information about the current user.
oath
Internal. Check to see if two-factor authentication (OATH) is enabled for a user.
Values (separate with | or alternative): allmessages, authmanagerinfo, babel, filerepoinfo, languageinfo, languagestats, managemessagegroups, messagegroups, messagegroupstats, messagetranslations, siteinfo, tokens, userinfo, oath
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 query+export.

Type: boolean (details)
exportschema

Target the given version of the XML dump format when exporting. Can only be used with query+export.

One of the following values: 0.10, 0.11
Default: 0.11
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 | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
pageids

A list of page IDs to work on.

Type: list of integers
Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
revids

A list of revision IDs to work on.

Type: list of integers
Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
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.

allcategories
Enumerate all categories.
alldeletedrevisions
List all deleted revisions by a user or in a namespace.
allfileusages
List all file usages, including non-existing.
allimages
Enumerate all images sequentially.
alllinks
Enumerate all links that point to a given namespace.
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
List all redirects to a namespace.
allrevisions
List all revisions.
alltransclusions
List all transclusions (pages embedded using {{x}}), including non-existing.
backlinks
Find all pages that link to the given page.
categories
List all categories the pages belong to.
categorymembers
List all pages in a given category.
deletedrevisions
Get deleted revision information.
duplicatefiles
List all files that are duplicates of the given files based on hash values.
embeddedin
Find all pages that embed (transclude) the given title.
exturlusage
Enumerate pages that contain a given URL.
fileusage
Find all pages that use the given files.
images
Returns all files contained on the given pages.
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
Find all pages that link to the given language link.
links
Returns all links from the given pages.
linkshere
Find all pages that link to the given pages.
messagecollection
Query MessageCollection about translations.
pageswithprop
List all pages using a given page property.
prefixsearch
Perform a prefix search for page titles.
protectedtitles
List all titles protected from creation.
querypage
Get a list provided by a QueryPage-based special page.
random
Get a set of random pages.
recentchanges
Enumerate recent changes.
redirects
Returns all redirects to the given pages.
revisions
Get revision information.
search
Perform a full text search.
templates
Returns all pages transcluded on the given pages.
transcludedin
Find all pages that transclude the given pages.
watchlist
Get recent changes to pages in the current user's watchlist.
watchlistraw
Get all pages on the current user's watchlist.
One of the following values: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, 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 query+titles, query+pageids, and query+revids, and in pages returned by query+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 ban, en, crh, gan, iu, kk, ku, shi, sr, tg, uz and zh.

Type: boolean (details)

prop=categories (cl)

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

List all categories the pages belong to.

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 | or alternative): hidden, sortkey, timestamp
clshow

Which kind of categories to show.

Values (separate with | or alternative): !hidden, hidden
cllimit

How many categories to return.

Type: integer or max
The value must be between 1 and 500.
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 | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
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 [open in sandbox]
Get information about all categories used in the page Albert Einstein.
api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info [open in sandbox]

prop=categoryinfo (ci)

Returns information about the given categories.

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 [open in sandbox]

prop=contributors (pc)

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

Parameters:
pcgroup

Only include users in the given groups. Does not include implicit or auto-promoted groups like *, user, or autoconfirmed.

Values (separate with | or alternative): bot, bureaucrat, interface-admin, suppress, sysop
pcexcludegroup

Exclude users in the given groups. Does not include implicit or auto-promoted groups like *, user, or autoconfirmed.

Values (separate with | or alternative): bot, bureaucrat, interface-admin, suppress, sysop
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 | or alternative): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, delete-redirect, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmyuserjson, editmyuserjsredirect, editmywatchlist, editprotected, editsemiprotected, editsitecss, editsitejs, editsitejson, editusercss, edituserjs, edituserjson, gadgets-definition-edit, gadgets-edit, hideuser, import, importupload, interwiki, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, move-categorypages, move-rootuserpages, move-subpages, movefile, nominornewtalk, noratelimit, nuke, oathauth-api-all, oathauth-disable-for-user, oathauth-enable, oathauth-verify-user, oathauth-view-log, override-export-depth, pagelang, pagetranslation, patrol, patrolmarks, protect, purge, read, renameuser, replacetext, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, skipcaptcha, spamblacklistlog, suppressionlog, suppressredirect, suppressrevision, tboverride, tboverride-account, titleblacklistlog, translate, translate-groupreview, translate-import, translate-manage, translate-messagereview, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi
Maximum number of values is 50 (500 for clients allowed higher limits).
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 | or alternative): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, delete-redirect, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmyuserjson, editmyuserjsredirect, editmywatchlist, editprotected, editsemiprotected, editsitecss, editsitejs, editsitejson, editusercss, edituserjs, edituserjson, gadgets-definition-edit, gadgets-edit, hideuser, import, importupload, interwiki, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, move-categorypages, move-rootuserpages, move-subpages, movefile, nominornewtalk, noratelimit, nuke, oathauth-api-all, oathauth-disable-for-user, oathauth-enable, oathauth-verify-user, oathauth-view-log, override-export-depth, pagelang, pagetranslation, patrol, patrolmarks, protect, purge, read, renameuser, replacetext, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, skipcaptcha, spamblacklistlog, suppressionlog, suppressredirect, suppressrevision, tboverride, tboverride-account, titleblacklistlog, translate, translate-groupreview, translate-import, translate-manage, translate-messagereview, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi
Maximum number of values is 50 (500 for clients allowed higher limits).
pclimit

How many contributors to return.

Type: integer or max
The value must be between 1 and 500.
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 [open in sandbox]

prop=deletedrevisions (drv)

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

Get deleted revision information.

May be used in several ways:

  1. Get deleted revisions for a set of pages, by setting titles or pageids. Ordered by title and timestamp.
  2. Get data about a set of deleted revisions by setting their IDs with revids. Ordered by revision ID.
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. If the user has been revision deleted, a userhidden property will be returned.
userid
User ID of the revision creator. If the user has been revision deleted, a userhidden property will be returned.
size
Length (bytes) of the revision.
slotsize
Length (bytes) of each revision slot.
sha1
SHA-1 (base 16) of the revision. If the content has been revision deleted, a sha1hidden property will be returned.
slotsha1
SHA-1 (base 16) of each revision slot. If the content has been revision deleted, a sha1hidden property will be returned.
contentmodel
Content model ID of each revision slot.
comment
Comment by the user for the revision. If the comment has been revision deleted, a commenthidden property will be returned.
parsedcomment
Parsed comment by the user for the revision. If the comment has been revision deleted, a commenthidden property will be returned.
content
Content of each revision slot. If the content has been revision deleted, a texthidden property will be returned.
tags
Tags for the revision.
roles
List content slot roles that exist in the revision.
parsetree
Deprecated. Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model wikitext).
Values (separate with | or alternative): comment, content, contentmodel, flags, ids, parsedcomment, roles, sha1, size, slotsha1, slotsize, tags, timestamp, user, userid, parsetree
Default: ids|timestamp|flags|comment|user
drvslots

Which revision slots to return data for, when slot-related properties are included in drvprops. If omitted, data from the main slot will be returned in a backwards-compatible format.

Values (separate with | or alternative): main
To specify all values, use *.
drvlimit

Limit how many revisions will be returned.

Type: integer or max
The value must be between 1 and 500.
drvexpandtemplates
Deprecated.

Use action=expandtemplates instead. Expand templates in revision content (requires drvprop=content).

Type: boolean (details)
drvgeneratexml
Deprecated.

Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires drvprop=content).

Type: boolean (details)
drvparse
Deprecated.

Use action=parse instead. 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 the section with this identifier.

drvdiffto
Deprecated.

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

drvdifftotext
Deprecated.

Use action=compare instead. 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.

drvdifftotextpst
Deprecated.

Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with drvdifftotext.

Type: boolean (details)
drvcontentformat
Deprecated.

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

One of the following values: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
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, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
drvexcludeuser

Don't list revisions by this user.

Type: user, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
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&drvslots=*&drvprop=user|comment|content [open in sandbox]
List the information for deleted revision 123456.
api.php?action=query&prop=deletedrevisions&revids=123456 [open in sandbox]

prop=duplicatefiles (df)

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

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

Parameters:
dflimit

How many duplicate files to return.

Type: integer or max
The value must be between 1 and 500.
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)

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

Parameters:
ellimit

How many links to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
elcontinue

When more results are available, use this to continue.

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 [open in sandbox]

prop=fileusage (fu)

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

Find all pages that use the given files.

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 | or alternative): pageid, redirect, title
Default: pageid|title|redirect
funamespace

Only include pages in these namespaces.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
fushow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
Values (separate with | or alternative): !redirect, redirect
fulimit

How many to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
fucontinue

When more results are available, use this to continue.

prop=imageinfo (ii)

Returns file information and upload history.

Parameters:
iiprop

Which file information to get:

timestamp
Adds timestamp for the uploaded version.
user
Adds the user who uploaded each file version. If the user has been revision deleted, a userhidden property will be returned.
userid
Add the ID of the user that uploaded each file version. If the user has been revision deleted, a userhidden property will be returned.
comment
Comment on the version. If the comment has been revision deleted, a commenthidden property will be returned.
parsedcomment
Parse the comment on the version. If the comment has been revision deleted, a commenthidden property will be returned.
canonicaltitle
Adds the canonical title of the file. If the file has been revision deleted, a filehidden property will be returned.
url
Gives URL to the file and the description page. If the file has been revision deleted, a filehidden property will be returned.
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. If the file has been revision deleted, a filehidden property will be returned.
mime
Adds MIME type of the file. If the file has been revision deleted, a filehidden property will be returned.
thumbmime
Adds MIME type of the image thumbnail (requires url and param iiurlwidth). If the file has been revision deleted, a filehidden property will be returned.
mediatype
Adds the media type of the file. If the file has been revision deleted, a filehidden property will be returned.
metadata
Lists Exif metadata for the version of the file. If the file has been revision deleted, a filehidden property will be returned.
commonmetadata
Lists file format generic metadata for the version of the file. If the file has been revision deleted, a filehidden property will be returned.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted. If the file has been revision deleted, a filehidden property will be returned.
archivename
Adds the filename of the archive version for non-latest versions. If the file has been revision deleted, a filehidden property will be returned.
bitdepth
Adds the bit depth of the version. If the file has been revision deleted, a filehidden property will be returned.
uploadwarning
Used by the Special:Upload page to get information about an existing file. Not intended for use outside MediaWiki core.
badfile
Adds whether the file is on the MediaWiki:Bad image list
Values (separate with | or alternative): archivename, badfile, bitdepth, canonicaltitle, comment, commonmetadata, dimensions, extmetadata, mediatype, metadata, mime, parsedcomment, sha1, size, thumbmime, timestamp, uploadwarning, url, user, userid
Default: timestamp|user
iilimit

How many file revisions to return per file.

Type: integer or max
The value must be between 1 and 500.
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 | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
iiurlparam

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

Default: (empty)
iibadfilecontexttitle

If badfilecontexttitleprop=badfile is set, this is the page title used when evaluating the MediaWiki:Bad image list

iicontinue

When more results are available, use this to continue.

iilocalonly

Look only for files in the local repository.

Type: boolean (details)

prop=images (im)

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

Returns all files contained on the given pages.

Parameters:
imlimit

How many files to return.

Type: integer or max
The value must be between 1 and 500.
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 | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
imdir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending

prop=info (in)

Get basic page information.

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.
visitingwatchers
The number of watchers of each page who have visited recent edits to that page, if allowed.
notificationtimestamp
The watchlist notification timestamp of each page.
subjectid
The page ID of the parent page for each talk page.
associatedpage
The prefixed title of the associated subject or talk page.
url
Gives a full URL, an edit URL, and the canonical URL for each page.
readable
Deprecated. Whether the user can read this page. Use intestactions=read instead.
preload
Gives the text returned by EditFormPreloadText.
displaytitle
Gives the manner in which the page title is actually displayed.
varianttitles
Gives the display title in all variants of the site content language.
linkclasses
Gives the additional CSS classes (e.g. link colors) used for links to this page if they were to appear on the page named by inlinkcontext.
Values (separate with | or alternative): associatedpage, displaytitle, linkclasses, notificationtimestamp, preload, protection, subjectid, talkid, url, varianttitles, visitingwatchers, watched, watchers, readable
inlinkcontext

The context title to use when determining extra CSS classes (e.g. link colors) when inprop contains linkclasses.

Type: page title
Accepts non-existent pages.
Default: Main Page
intestactions

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

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
intestactionsdetail

Detail level for intestactions. Use the main module's errorformat and errorlang parameters to control the format of the messages returned.

boolean
Return a boolean value for each action.
full
Return messages describing why the action is disallowed, or an empty array if it is allowed.
quick
Like full but skipping expensive checks.
One of the following values: boolean, full, quick
Default: boolean
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 [open in sandbox]
Get general and protection information about the page Main Page.
api.php?action=query&prop=info&inprop=protection&titles=Main%20Page [open in sandbox]

Returns all interwiki links from the given pages.

Parameters:
iwprop

Which additional properties to get for each interwiki link:

url
Adds the full URL.
Values (separate with | or alternative): 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.

Type: integer or max
The value must be between 1 and 500.
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 [open in sandbox]

Returns all interlanguage links from the given pages.

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 | or alternative): autonym, langname, url
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.

Type: integer or max
The value must be between 1 and 500.
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= [open in sandbox]
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Returns all links from the given pages.

Parameters:
plnamespace

Show links in these namespaces only.

Values (separate with | or alternative): -1, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
pllimit

How many links to return.

Type: integer or max
The value must be between 1 and 500.
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 | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
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 [open in sandbox]
Get information about the link pages in the page Main Page.
api.php?action=query&generator=links&titles=Main%20Page&prop=info [open in sandbox]
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 [open in sandbox]

prop=linkshere (lh)

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

Find all pages that link to the given pages.

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 | or alternative): pageid, redirect, title
Default: pageid|title|redirect
lhnamespace

Only include pages in these namespaces.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
lhshow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
Values (separate with | or alternative): !redirect, redirect
lhlimit

How many to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
lhcontinue

When more results are available, use this to continue.

prop=pageimages (pi)

  • This module requires read rights.
  • Source: PageImages
  • License: WTFPL

Returns information about images on the page, such as thumbnail and presence of photos.

Parameters:
piprop

Which information to return:

thumbnail
URL and dimensions of thumbnail image associated with page, if any.
original
URL and original dimensions of image associated with page, if any.
name
Image title.
Values (separate with | or alternative): name, original, thumbnail
Default: thumbnail|name
pithumbsize

Maximum width in pixels of thumbnail images.

Type: integer
Default: 50
pilimit

Properties of how many pages to return.

Type: integer or max
The value must be between 1 and 50.
Default: 50
pilicense

Limit page images to a certain license type

One of the following values: any, free
Default: free
picontinue

When more results are available, use this to continue.

Type: integer
pilangcode

Code for the language the image is going to be rendered in if multiple languages are supported

Example:
Get name and 100-pixel thumbnail of an image on the Albert Einstein page.
api.php?action=query&prop=pageimages&titles=Albert%20Einstein&pithumbsize=100 [open in sandbox]

prop=pageprops (pp)

Get various page properties defined in the page content.

Parameters:
ppcontinue

When more results are available, use this to continue.

ppprop

Only list these page properties (action=query&list=pagepropnames returns page property names in use). Useful for checking whether pages use a certain page property.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
Example:
Get properties for the pages Main Page and MediaWiki.
api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki [open in sandbox]

prop=redirects (rd)

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

Returns all redirects to the given pages.

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 | or alternative): fragment, pageid, title
Default: pageid|title
rdnamespace

Only include pages in these namespaces.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
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 | or alternative): !fragment, fragment
rdlimit

How many redirects to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
rdcontinue

When more results are available, use this to continue.

prop=revisions (rv)

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

Get revision information.

May be used in several ways:

  1. Get data about a set of pages (last revision), by setting titles or pageids.
  2. Get revisions for one given page, by using titles or pageids with start, end, or limit.
  3. Get data about a set of revisions by setting their IDs with revids.
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. If the user has been revision deleted, a userhidden property will be returned.
userid
User ID of the revision creator. If the user has been revision deleted, a userhidden property will be returned.
size
Length (bytes) of the revision.
slotsize
Length (bytes) of each revision slot.
sha1
SHA-1 (base 16) of the revision. If the content has been revision deleted, a sha1hidden property will be returned.
slotsha1
SHA-1 (base 16) of each revision slot. If the content has been revision deleted, a sha1hidden property will be returned.
contentmodel
Content model ID of each revision slot.
comment
Comment by the user for the revision. If the comment has been revision deleted, a commenthidden property will be returned.
parsedcomment
Parsed comment by the user for the revision. If the comment has been revision deleted, a commenthidden property will be returned.
content
Content of each revision slot. If the content has been revision deleted, a texthidden property will be returned.
tags
Tags for the revision.
roles
List content slot roles that exist in the revision.
parsetree
Deprecated. Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model wikitext).
Values (separate with | or alternative): comment, content, contentmodel, flags, ids, parsedcomment, roles, sha1, size, slotsha1, slotsize, tags, timestamp, user, userid, parsetree
Default: ids|timestamp|flags|comment|user
rvslots

Which revision slots to return data for, when slot-related properties are included in rvprops. If omitted, data from the main slot will be returned in a backwards-compatible format.

Values (separate with | or alternative): main
To specify all values, use *.
rvlimit

Limit how many revisions will be returned.

May only be used with a single page (mode #2).
Type: integer or max
The value must be between 1 and 500.
rvexpandtemplates
Deprecated.

Use action=expandtemplates instead. Expand templates in revision content (requires rvprop=content).

Type: boolean (details)
rvgeneratexml
Deprecated.

Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires rvprop=content).

Type: boolean (details)
rvparse
Deprecated.

Use action=parse instead. 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 the section with this identifier.

rvdiffto
Deprecated.

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

rvdifftotext
Deprecated.

Use action=compare instead. 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.

rvdifftotextpst
Deprecated.

Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with rvdifftotext.

Type: boolean (details)
rvcontentformat
Deprecated.

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

One of the following values: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
rvstartid

Start enumeration from this revision's timestamp. The revision must exist, but need not belong to this page.

May only be used with a single page (mode #2).
Type: integer
rvendid

Stop enumeration at this revision's timestamp. The revision must exist, but need not belong to this page.

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, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
rvexcludeuser

Exclude revisions made by user.

May only be used with a single page (mode #2).
Type: user, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
rvtag

Only list revisions tagged with this tag.

rvcontinue

When more results are available, use this to continue.

prop=stashimageinfo (sii)

Returns file information for stashed files.

Parameters:
siifilekey

Key that identifies a previous upload that was stashed temporarily.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
siisessionkey
Deprecated.

Alias for siifilekey, for backward compatibility.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
siiprop

Which file information to get:

timestamp
Adds timestamp for the uploaded version.
canonicaltitle
Adds the canonical title of the file. If the file has been revision deleted, a filehidden property will be returned.
url
Gives URL to the file and the description page. If the file has been revision deleted, a filehidden property will be returned.
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. If the file has been revision deleted, a filehidden property will be returned.
mime
Adds MIME type of the file. If the file has been revision deleted, a filehidden property will be returned.
thumbmime
Adds MIME type of the image thumbnail (requires url and param siiurlwidth). If the file has been revision deleted, a filehidden property will be returned.
metadata
Lists Exif metadata for the version of the file. If the file has been revision deleted, a filehidden property will be returned.
commonmetadata
Lists file format generic metadata for the version of the file. If the file has been revision deleted, a filehidden property will be returned.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted. If the file has been revision deleted, a filehidden property will be returned.
bitdepth
Adds the bit depth of the version. If the file has been revision deleted, a filehidden property will be returned.
badfile
Adds whether the file is on the MediaWiki:Bad image list
Values (separate with | or alternative): badfile, bitdepth, canonicaltitle, commonmetadata, dimensions, extmetadata, metadata, mime, sha1, size, thumbmime, timestamp, url
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)

prop=templates (tl)

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

Returns all pages transcluded on the given pages.

Parameters:
tlnamespace

Show templates in these namespaces only.

Values (separate with | or alternative): -1, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
tllimit

How many templates to return.

Type: integer or max
The value must be between 1 and 500.
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 | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
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 [open in sandbox]
Get information about the template pages used on Main Page.
api.php?action=query&generator=templates&titles=Main%20Page&prop=info [open in sandbox]
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 [open in sandbox]

prop=transcludedin (ti)

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

Find all pages that transclude the given pages.

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 | or alternative): pageid, redirect, title
Default: pageid|title|redirect
tinamespace

Only include pages in these namespaces.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
tishow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
Values (separate with | or alternative): !redirect, redirect
tilimit

How many to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
ticontinue

When more results are available, use this to continue.

list=allcategories (ac)

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

Enumerate all categories.

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.

Type: integer or max
The value must be between 1 and 500.
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 | or alternative): hidden, size
Default: (empty)
Examples:
List categories with information on the number of pages in each.
api.php?action=query&list=allcategories&acprop=size [open in sandbox]
Retrieve info about the category page itself for categories beginning List.
api.php?action=query&generator=allcategories&gacprefix=List&prop=info [open in sandbox]

list=alldeletedrevisions (adr)

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

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

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. If the user has been revision deleted, a userhidden property will be returned.
userid
User ID of the revision creator. If the user has been revision deleted, a userhidden property will be returned.
size
Length (bytes) of the revision.
slotsize
Length (bytes) of each revision slot.
sha1
SHA-1 (base 16) of the revision. If the content has been revision deleted, a sha1hidden property will be returned.
slotsha1
SHA-1 (base 16) of each revision slot. If the content has been revision deleted, a sha1hidden property will be returned.
contentmodel
Content model ID of each revision slot.
comment
Comment by the user for the revision. If the comment has been revision deleted, a commenthidden property will be returned.
parsedcomment
Parsed comment by the user for the revision. If the comment has been revision deleted, a commenthidden property will be returned.
content
Content of each revision slot. If the content has been revision deleted, a texthidden property will be returned.
tags
Tags for the revision.
roles
List content slot roles that exist in the revision.
parsetree
Deprecated. Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model wikitext).
Values (separate with | or alternative): comment, content, contentmodel, flags, ids, parsedcomment, roles, sha1, size, slotsha1, slotsize, tags, timestamp, user, userid, parsetree
Default: ids|timestamp|flags|comment|user
adrslots

Which revision slots to return data for, when slot-related properties are included in adrprops. If omitted, data from the main slot will be returned in a backwards-compatible format.

Values (separate with | or alternative): main
To specify all values, use *.
adrlimit

Limit how many revisions will be returned.

Type: integer or max
The value must be between 1 and 500.
adrexpandtemplates
Deprecated.

Use action=expandtemplates instead. Expand templates in revision content (requires adrprop=content).

Type: boolean (details)
adrgeneratexml
Deprecated.

Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires adrprop=content).

Type: boolean (details)
adrparse
Deprecated.

Use action=parse instead. 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 the section with this identifier.

adrdiffto
Deprecated.

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

adrdifftotext
Deprecated.

Use action=compare instead. 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.

adrdifftotextpst
Deprecated.

Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with adrdifftotext.

Type: boolean (details)
adrcontentformat
Deprecated.

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

One of the following values: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
adruser

Only list revisions by this user.

Type: user, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
adrnamespace

Only list pages in this namespace.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
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, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
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)

list=allfileusages (af)

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

List all file usages, including non-existing.

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 | or alternative): ids, title
Default: title
aflimit

How many total items to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
afdir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending

list=allimages (ai)

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

Enumerate all images sequentially.

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. If the user has been revision deleted, a userhidden property will be returned.
userid
Add the ID of the user that uploaded each file version. If the user has been revision deleted, a userhidden property will be returned.
comment
Comment on the version. If the comment has been revision deleted, a commenthidden property will be returned.
parsedcomment
Parse the comment on the version. If the comment has been revision deleted, a commenthidden property will be returned.
canonicaltitle
Adds the canonical title of the file. If the file has been revision deleted, a filehidden property will be returned.
url
Gives URL to the file and the description page. If the file has been revision deleted, a filehidden property will be returned.
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. If the file has been revision deleted, a filehidden property will be returned.
mime
Adds MIME type of the file. If the file has been revision deleted, a filehidden property will be returned.
mediatype
Adds the media type of the file. If the file has been revision deleted, a filehidden property will be returned.
metadata
Lists Exif metadata for the version of the file. If the file has been revision deleted, a filehidden property will be returned.
commonmetadata
Lists file format generic metadata for the version of the file. If the file has been revision deleted, a filehidden property will be returned.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted. If the file has been revision deleted, a filehidden property will be returned.
bitdepth
Adds the bit depth of the version. If the file has been revision deleted, a filehidden property will be returned.
badfile
Adds whether the file is on the MediaWiki:Bad image list
Values (separate with | or alternative): badfile, bitdepth, canonicaltitle, comment, commonmetadata, dimensions, extmetadata, mediatype, metadata, mime, parsedcomment, sha1, size, timestamp, url, user, userid
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, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
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 | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
ailimit

How many images in total to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Enumerate all links that point to a given namespace.

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 | or alternative): ids, title
Default: title
alnamespace

The namespace to enumerate.

One of the following values: -1, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
Default: 0
allimit

How many total items to return.

Type: integer or max
The value must be between 1 and 500.
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 [open in sandbox]
List unique linked titles.
api.php?action=query&list=alllinks&alunique=&alfrom=B [open in sandbox]
Gets all linked titles, marking the missing ones.
api.php?action=query&generator=alllinks&galunique=&galfrom=B [open in sandbox]
Gets pages containing the links.
api.php?action=query&generator=alllinks&galfrom=B [open in sandbox]

list=allpages (ap)

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

Enumerate all pages sequentially in a given namespace.

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.

One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
Default: 0
apfilterredir

Which pages to list.

One of the following values: all, nonredirects, redirects
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 | or alternative): edit, move, upload
apprlevel

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

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

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

One of the following values: all, cascading, noncascading
Default: all
aplimit

How many total pages to return.

Type: integer or max
The value must be between 1 and 500.
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: all, withlanglinks, withoutlanglinks
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: all, definite, indefinite
Default: all

list=allredirects (ar)

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

List all redirects to a namespace.

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 | or alternative): fragment, ids, interwiki, title
Default: title
arnamespace

The namespace to enumerate.

One of the following values: -1, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
Default: 0
arlimit

How many total items to return.

Type: integer or max
The value must be between 1 and 500.
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 [open in sandbox]
List unique target pages.
api.php?action=query&list=allredirects&arunique=&arfrom=B [open in sandbox]
Gets all target pages, marking the missing ones.
api.php?action=query&generator=allredirects&garunique=&garfrom=B [open in sandbox]
Gets pages containing the redirects.
api.php?action=query&generator=allredirects&garfrom=B [open in sandbox]

list=allrevisions (arv)

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

List all revisions.

Parameters:
arvprop

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. If the user has been revision deleted, a userhidden property will be returned.
userid
User ID of the revision creator. If the user has been revision deleted, a userhidden property will be returned.
size
Length (bytes) of the revision.
slotsize
Length (bytes) of each revision slot.
sha1
SHA-1 (base 16) of the revision. If the content has been revision deleted, a sha1hidden property will be returned.
slotsha1
SHA-1 (base 16) of each revision slot. If the content has been revision deleted, a sha1hidden property will be returned.
contentmodel
Content model ID of each revision slot.
comment
Comment by the user for the revision. If the comment has been revision deleted, a commenthidden property will be returned.
parsedcomment
Parsed comment by the user for the revision. If the comment has been revision deleted, a commenthidden property will be returned.
content
Content of each revision slot. If the content has been revision deleted, a texthidden property will be returned.
tags
Tags for the revision.
roles
List content slot roles that exist in the revision.
parsetree
Deprecated. Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model wikitext).
Values (separate with | or alternative): comment, content, contentmodel, flags, ids, parsedcomment, roles, sha1, size, slotsha1, slotsize, tags, timestamp, user, userid, parsetree
Default: ids|timestamp|flags|comment|user
arvslots

Which revision slots to return data for, when slot-related properties are included in arvprops. If omitted, data from the main slot will be returned in a backwards-compatible format.

Values (separate with | or alternative): main
To specify all values, use *.
arvlimit

Limit how many revisions will be returned.

Type: integer or max
The value must be between 1 and 500.
arvexpandtemplates
Deprecated.

Use action=expandtemplates instead. Expand templates in revision content (requires arvprop=content).

Type: boolean (details)
arvgeneratexml
Deprecated.

Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires arvprop=content).

Type: boolean (details)
arvparse
Deprecated.

Use action=parse instead. Parse revision content (requires arvprop=content). For performance reasons, if this option is used, arvlimit is enforced to 1.

Type: boolean (details)
arvsection

Only retrieve the content of the section with this identifier.

arvdiffto
Deprecated.

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

arvdifftotext
Deprecated.

Use action=compare instead. Text to diff each revision to. Only diffs a limited number of revisions. Overrides arvdiffto. If arvsection is set, only that section will be diffed against this text.

arvdifftotextpst
Deprecated.

Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with arvdifftotext.

Type: boolean (details)
arvcontentformat
Deprecated.

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

One of the following values: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
arvuser

Only list revisions by this user.

Type: user, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
arvnamespace

Only list pages in this namespace.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
arvstart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)
arvend

The timestamp to stop enumerating at.

Type: timestamp (allowed formats)
arvdir

In which direction to enumerate:

newer
List oldest first. Note: arvstart has to be before arvend.
older
List newest first (default). Note: arvstart has to be later than arvend.
One of the following values: newer, older
Default: older
arvexcludeuser

Don't list revisions by this user.

Type: user, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
arvcontinue

When more results are available, use this to continue.

arvgeneratetitles

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

Type: boolean (details)

list=alltransclusions (at)

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

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

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 | or alternative): ids, title
Default: title
atnamespace

The namespace to enumerate.

One of the following values: -1, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
Default: 10
atlimit

How many total items to return.

Type: integer or max
The value must be between 1 and 500.
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 [open in sandbox]
List unique transcluded titles.
api.php?action=query&list=alltransclusions&atunique=&atfrom=B [open in sandbox]
Gets all transcluded titles, marking the missing ones.
api.php?action=query&generator=alltransclusions&gatunique=&gatfrom=B [open in sandbox]
Gets pages containing the transclusions.
api.php?action=query&generator=alltransclusions&gatfrom=B [open in sandbox]

list=allusers (au)

Enumerate all registered users.

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 | or alternative): bot, bureaucrat, interface-admin, suppress, sysop
auexcludegroup

Exclude users in the given groups.

Values (separate with | or alternative): bot, bureaucrat, interface-admin, suppress, sysop
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 | or alternative): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, delete-redirect, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmyuserjson, editmyuserjsredirect, editmywatchlist, editprotected, editsemiprotected, editsitecss, editsitejs, editsitejson, editusercss, edituserjs, edituserjson, gadgets-definition-edit, gadgets-edit, hideuser, import, importupload, interwiki, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, move-categorypages, move-rootuserpages, move-subpages, movefile, nominornewtalk, noratelimit, nuke, oathauth-api-all, oathauth-disable-for-user, oathauth-enable, oathauth-verify-user, oathauth-view-log, override-export-depth, pagelang, pagetranslation, patrol, patrolmarks, protect, purge, read, renameuser, replacetext, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, skipcaptcha, spamblacklistlog, suppressionlog, suppressredirect, suppressrevision, tboverride, tboverride-account, titleblacklistlog, translate, translate-groupreview, translate-import, translate-manage, translate-messagereview, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi
Maximum number of values is 50 (500 for clients allowed higher limits).
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).
centralids
Adds the central IDs and attachment status for the user.
Values (separate with | or alternative): blockinfo, centralids, editcount, groups, implicitgroups, registration, rights
aulimit

How many total user names to return.

Type: integer or max
The value must be between 1 and 500.
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)
auattachedwiki

With auprop=centralids, also indicate whether the user is attached with the wiki identified by this ID.

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

Find all pages that link to the given page.

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 | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
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, nonredirects, redirects
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).

Type: integer or max
The value must be between 1 and 500.
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)

list=blocks (bk)

List all blocked users and IP addresses.

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 | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
bkusers

List of users to search for (optional).

Type: list of users, by any of user name, IP and IP range
Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
bkip

Get all blocks applying to this IP address 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.

Type: integer or max
The value must be between 1 and 500.
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.).
restrictions
Adds the partial block restrictions if the block is not sitewide.
Values (separate with | or alternative): by, byid, expiry, flags, id, range, reason, restrictions, timestamp, user, userid
Default: id|user|by|timestamp|expiry|reason|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 | or alternative): !account, !ip, !range, !temp, account, ip, range, temp
bkcontinue

When more results are available, use this to continue.

list=categorymembers (cm)

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

List all pages in a given category.

Parameters:
cmtitle

Which category to enumerate (required). Must include the Category: 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 | or alternative): ids, sortkey, sortkeyprefix, timestamp, title, type
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.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
cmtype

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

Values (separate with | or alternative): file, page, subcat
Default: page|subcat|file
cmcontinue

When more results are available, use this to continue.

cmlimit

The maximum number of pages to return.

Type: integer or max
The value must be between 1 and 500.
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, ascending, desc, 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.

list=deletedrevs (dr)

  • This module is deprecated.
  • This module requires read rights.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

List deleted revisions.

Operates in three modes:

  1. List deleted revisions for the given titles, sorted by timestamp.
  2. List deleted contributions for the given user, sorted by timestamp (no titles specified).
  3. 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.

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
One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
Default: 0
drtag

Only list revisions tagged with this tag.

druser

Only list revisions by this user.

Type: user, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
drexcludeuser

Don't list revisions by this user.

Type: user, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
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 | or alternative): comment, content, len, minor, parentid, parsedcomment, revid, sha1, tags, token, user, userid
Default: user|comment
drlimit

The maximum amount of revisions to list.

Type: integer or max
The value must be between 1 and 500.
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 [open in sandbox]
List the last 50 deleted contributions by Bob (mode 2).
api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50 [open in sandbox]
List the first 50 deleted revisions in the main namespace (mode 3).
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50 [open in sandbox]
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= [open in sandbox]

list=embeddedin (ei)

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

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

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 | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
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, nonredirects, redirects
Default: all
eilimit

How many total pages to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10

list=exturlusage (eu)

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

Enumerate pages that contain a given URL.

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 | or alternative): ids, title, url
Default: ids|title|url
eucontinue

When more results are available, use this to continue.

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.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
eulimit

How many pages to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
euexpandurl

Expand protocol-relative URLs with the canonical protocol.

Type: boolean (details)

list=filearchive (fa)

Enumerate all deleted files sequentially.

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 | or alternative): archivename, bitdepth, description, dimensions, mediatype, metadata, mime, parseddescription, sha1, size, timestamp, user
Default: timestamp
falimit

How many images to return in total.

Type: integer or max
The value must be between 1 and 500.
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 [open in sandbox]

list=gadgetcategories (gc)

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 | or alternative): members, name, title
Default: name
gcnames

Names of categories to retrieve.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
Examples:
Get a list of existing gadget categories
api.php?action=query&list=gadgetcategories [open in sandbox]
Get all information about categories named "foo" and "bar"
api.php?action=query&list=gadgetcategories&gcnames=foo|bar&gcprop=name|title|members [open in sandbox]

list=gadgets (ga)

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 | or alternative): desc, id, metadata
Default: id|metadata
gacategories

Gadgets from what categories to retrieve.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
gaids

IDs of gadgets to retrieve.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
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 [open in sandbox]
Get a list of gadgets with all possible properties
api.php?action=query&list=gadgets&gaprop=id|metadata|desc [open in sandbox]
Get a list of gadgets belonging to category "foo"
api.php?action=query&list=gadgets&gacategories=foo [open in sandbox]
Get information about gadgets "foo" and "bar"
api.php?action=query&list=gadgets&gaids=foo|bar&gaprop=id|desc|metadata [open in sandbox]
Get a list of gadgets enabled by current user
api.php?action=query&list=gadgets&gaenabledonly [open in sandbox]

list=imageusage (iu)

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

Find all pages that use the given image title.

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 | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
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, nonredirects, redirects
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).

Type: integer or max
The value must be between 1 and 500.
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)
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

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".

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.

Type: integer or max
The value must be between 1 and 500.
Default: 10
iwblprop

Which properties to get:

iwprefix
Adds the prefix of the interwiki.
iwtitle
Adds the title of the interwiki.
Values (separate with | or alternative): iwprefix, iwtitle
Default: (empty)
iwbldir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

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.

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.

Type: integer or max
The value must be between 1 and 500.
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 | or alternative): lllang, lltitle
Default: (empty)
lbldir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending

list=logevents (le)

Get events from logs.

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. If the user has been revision deleted, a userhidden property will be returned.
userid
Adds the user ID who was responsible for the log event. If the user has been revision deleted, a userhidden property will be returned.
timestamp
Adds the timestamp for the log event.
comment
Adds the comment of the log event. If the comment has been revision deleted, a commenthidden property will be returned.
parsedcomment
Adds the parsed comment of the log event. If the comment has been revision deleted, a commenthidden property will be returned.
details
Lists additional details about the log event. If the log event has been revision deleted, an actionhidden property will be returned.
tags
Lists tags for the log event.
Values (separate with | or alternative): comment, details, ids, parsedcomment, tags, timestamp, title, type, user, userid
Default: ids|title|type|user|timestamp|comment|details
letype

Filter log entries to only this type.

One of the following values: Can be empty, or block, contentmodel, create, delete, import, interwiki, managetags, merge, messagebundle, move, newusers, oath, pagetranslation, patrol, protect, renameuser, rights, spamblacklist, suppress, tag, titleblacklist, translationreview, upload
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: block/block, block/reblock, block/unblock, contentmodel/change, contentmodel/new, create/create, delete/delete, delete/delete_redir, delete/delete_redir2, delete/event, delete/restore, delete/revision, import/interwiki, import/upload, interwiki/*, managetags/activate, managetags/create, managetags/deactivate, managetags/delete, merge/merge, messagebundle/deletefnok, messagebundle/deletefok, messagebundle/movenok, messagebundle/moveok, move/move, move/move_redir, newusers/autocreate, newusers/byemail, newusers/create, newusers/create2, newusers/newusers, oath/*, pagetranslation/associate, pagetranslation/deletefnok, pagetranslation/deletefok, pagetranslation/deletelnok, pagetranslation/deletelok, pagetranslation/discourage, pagetranslation/dissociate, pagetranslation/encourage, pagetranslation/mark, pagetranslation/movenok, pagetranslation/moveok, pagetranslation/prioritylanguages, pagetranslation/unmark, patrol/autopatrol, patrol/patrol, protect/modify, protect/move_prot, protect/protect, protect/unprotect, renameuser/renameuser, rights/autopromote, rights/rights, spamblacklist/*, suppress/block, suppress/delete, suppress/event, suppress/reblock, suppress/revision, tag/update, titleblacklist/*, translationreview/group, translationreview/message, upload/overwrite, upload/revert, upload/upload
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.

Type: user, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
letitle

Filter entries to those related to a page.

lenamespace

Filter entries to those in the given namespace.

One of the following values: -1, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
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.

Type: integer or max
The value must be between 1 and 500.
Default: 10
lecontinue

When more results are available, use this to continue.

list=messagecollection (mc)

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

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).

Type: integer or max
The value must be between 1 and 5,000.
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 | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
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 | or alternative): definition, properties, revision, tags, translation
Default: definition|translation

list=mystashedfiles (msf)

Get a list of files in the current user's upload stash.

Parameters:
msfprop

Which properties to fetch for the files.

size
Fetch the file size and image dimensions.
type
Fetch the file's MIME type and media type.
Values (separate with | or alternative): size, type
Default: (empty)
msflimit

How many files to get.

Type: integer or max
The value must be between 1 and 500.
Default: 10
msfcontinue

When more results are available, use this to continue.

Example:
Get the filekey, file size, and pixel size of files in the current user's upload stash.
api.php?action=query&list=mystashedfiles&msfprop=size [open in sandbox]

list=pagepropnames (ppn)

List all page property names in use on the wiki.

Parameters:
ppncontinue

When more results are available, use this to continue.

ppnlimit

The maximum number of names to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10

list=pageswithprop (pwp)

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

List all pages using a given page property.

Parameters:
pwppropname

Page property for which to enumerate pages (action=query&list=pagepropnames returns page property names in use).

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 property.
Values (separate with | or alternative): ids, title, value
Default: ids|title
pwpcontinue

When more results are available, use this to continue.

pwplimit

The maximum number of pages to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
pwpdir

In which direction to sort.

One of the following values: ascending, descending
Default: ascending

list=prefixsearch (ps)

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

Perform a prefix search for page titles.

Despite the similarity in names, this module is not intended to be equivalent to Special:PrefixIndex; for that, see action=query&list=allpages with the apprefix parameter. The purpose of this module is similar to action=opensearch: to take user input and provide the best-matching titles. Depending on the search engine backend, this might include typo correction, redirect avoidance, or other heuristics.

Parameters:
pssearch

Search string.

This parameter is required.
psnamespace

Namespaces to search. Ignored if pssearch begins with a valid namespace prefix.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
Default: 0
pslimit

Maximum number of results to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
psoffset

When more results are available, use this to continue.

Type: integer
Default: 0
Example:
Search for page titles beginning with meaning.
api.php?action=query&list=prefixsearch&pssearch=meaning [open in sandbox]

list=protectedtitles (pt)

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

List all titles protected from creation.

Parameters:
ptnamespace

Only list titles in these namespaces.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
ptlevel

Only list titles with these protection levels.

Values (separate with | or alternative): autoconfirmed, sysop
ptlimit

How many total pages to return.

Type: integer or max
The value must be between 1 and 500.
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 | or alternative): comment, expiry, level, parsedcomment, timestamp, user, userid
Default: timestamp|level
ptcontinue

When more results are available, use this to continue.

list=querypage (qp)

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

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

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, Fewestrevisions, GadgetUsage, ListDuplicatedFiles, Listredirects, Lonelypages, Longpages, MediaStatistics, Mostcategories, Mostimages, Mostinterwikis, Mostlinked, Mostlinkedcategories, Mostlinkedtemplates, Mostrevisions, Shortpages, Uncategorizedcategories, Uncategorizedimages, Uncategorizedpages, Uncategorizedtemplates, Unusedcategories, Unusedimages, Unusedtemplates, Unwatchedpages, Wantedcategories, Wantedfiles, Wantedpages, Wantedtemplates, Withoutinterwiki
qpoffset

When more results are available, use this to continue.

Type: integer
Default: 0
qplimit

Number of results to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10

list=random (rn)

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

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.

Parameters:
rnnamespace

Return pages in these namespaces only.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
rnfilterredir

How to filter for redirects.

One of the following values: all, nonredirects, redirects
Default: nonredirects
rnredirect
Deprecated.

Use rnfilterredir=redirects instead.

Type: boolean (details)
rnlimit

Limit how many random pages will be returned.

Type: integer or max
The value must be between 1 and 500.
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 [open in sandbox]
Return page info about two random pages from the main namespace.
api.php?action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info [open in sandbox]

list=recentchanges (rc)

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

Enumerate recent changes.

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.

Values (separate with | or alternative): -1, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
rcuser

Only list changes by this user.

Type: user, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
rcexcludeuser

Don't list changes by this user.

Type: user, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
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. If the user has been revision deleted, a userhidden property will be returned.
userid
Adds the user ID responsible for the edit. If the user has been revision deleted, a userhidden property will be returned.
comment
Adds the comment for the edit. If the comment has been revision deleted, a commenthidden property will be returned.
parsedcomment
Adds the parsed comment for the edit. If the comment has been revision deleted, a commenthidden property will be returned.
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. If the content has been revision deleted, a sha1hidden property will be returned.
Values (separate with | or alternative): comment, flags, ids, loginfo, parsedcomment, patrolled, redirect, sha1, sizes, tags, timestamp, title, user, userid
Default: title|timestamp|ids
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 | or alternative): !anon, !autopatrolled, !bot, !minor, !patrolled, !redirect, anon, autopatrolled, bot, minor, patrolled, redirect, unpatrolled
rclimit

How many total changes to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
rctype

Which types of changes to show.

Values (separate with | or alternative): categorize, edit, external, log, new
Default: edit|new|log|categorize
rctoponly

Only list changes which are the latest revision.

Type: boolean (details)
rctitle

Filter entries to those related to a page.

rccontinue

When more results are available, use this to continue.

rcgeneraterevisions

When being used as a generator, generate revision IDs rather than titles. Recent change entries without associated revision IDs (e.g. most log entries) will generate nothing.

Type: boolean (details)
rcslot

Only list changes that touch the named slot.

One of the following values: main

list=search (sr)

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

Perform a full text 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.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
Default: 0
srlimit

How many total pages to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
sroffset

When more results are available, use this to continue.

Type: integer
Default: 0
srwhat

Which type of search to perform.

One of the following values: nearmatch, text, title
srinfo

Which metadata to return.

Values (separate with | or alternative): rewrittenquery, suggestion, totalhits
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. Ignored.
hasrelated
Deprecated. Ignored.
extensiondata
Adds extra data generated by extensions.
Values (separate with | or alternative): categorysnippet, extensiondata, isfilematch, redirectsnippet, redirecttitle, sectionsnippet, sectiontitle, size, snippet, timestamp, titlesnippet, wordcount, hasrelated, score
Default: size|wordcount|timestamp|snippet
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 another which is thought to provide better results, for instance by correcting spelling errors.

Type: boolean (details)
srsort

Set the sort order of returned results.

One of the following values: relevance
Default: relevance

list=tags (tg)

List change tags.

Parameters:
tgcontinue

When more results are available, use this to continue.

tglimit

The maximum number of tags to list.

Type: integer or max
The value must be between 1 and 500.
Default: 10
tgprop

Which properties to get:

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 | or alternative): active, defined, description, displayname, hitcount, source
Default: (empty)

list=usercontribs (uc)

Get all edits by a user.

Parameters:
uclimit

The maximum number of contributions to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
ucstart

The start timestamp to return from, i.e. revisions before this timestamp.

Type: timestamp (allowed formats)
ucend

The end timestamp to return to, i.e. revisions after this timestamp.

Type: timestamp (allowed formats)
uccontinue

When more results are available, use this to continue.

ucuser

The users to retrieve contributions for. Cannot be used with ucuserids or ucuserprefix.

Type: list of users, by any of user name, IP and interwiki name (e.g. "prefix>ExampleName")
Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
ucuserids

The user IDs to retrieve contributions for. Cannot be used with ucuser or ucuserprefix.

Type: list of integers
Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
ucuserprefix

Retrieve contributions for all users whose names begin with this value. Cannot be used with ucuser or ucuserids.

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.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
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. If the comment has been revision deleted, a commenthidden property will be returned.
parsedcomment
Adds the parsed comment of the edit. If the comment has been revision deleted, a commenthidden property will be returned.
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 | or alternative): comment, flags, ids, parsedcomment, patrolled, size, sizediff, tags, timestamp, title
Default: ids|title|timestamp|comment|size|flags
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 | or alternative): !autopatrolled, !minor, !new, !patrolled, !top, autopatrolled, minor, new, patrolled, top
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 [open in sandbox]
Show contributions from all IP addresses with prefix 192.0.2..
api.php?action=query&list=usercontribs&ucuserprefix=192.0.2. [open in sandbox]

list=users (us)

Get information about a list of 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.
groupmemberships
Lists groups that each user has been explicitly assigned to, including the expiry date of each group membership.
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".
centralids
Adds the central IDs and attachment status for the user.
cancreate
Indicates whether an account for valid but unregistered usernames can be created.
Values (separate with | or alternative): blockinfo, cancreate, centralids, editcount, emailable, gender, groupmemberships, groups, implicitgroups, registration, rights
usattachedwiki

With usprop=centralids, indicate whether the user is attached with the wiki identified by this ID.

ususers

A list of users to obtain information for.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
ususerids

A list of user IDs to obtain information for.

Type: list of integers
Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).

list=watchlist (wl)

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

Get recent changes to pages in the current user's 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.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
wluser

Only list changes by this user.

Type: user, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
wlexcludeuser

Don't list changes by this user.

Type: user, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
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.

Type: integer or max
The value must be between 1 and 500.
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. If the user has been revision deleted, a userhidden property will be returned.
userid
Adds user ID of whoever made the edit. If the user has been revision deleted, a userhidden property will be returned.
comment
Adds comment of the edit. If the comment has been revision deleted, a commenthidden property will be returned.
parsedcomment
Adds parsed comment of the edit. If the comment has been revision deleted, a commenthidden property will be returned.
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.
tags
Lists tags for the entry.
expiry
(no description)
Values (separate with | or alternative): comment, expiry, flags, ids, loginfo, notificationtimestamp, parsedcomment, patrol, sizes, tags, timestamp, title, user, userid
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 | or alternative): !anon, !autopatrolled, !bot, !minor, !patrolled, !unread, anon, autopatrolled, bot, minor, patrolled, unread
wltype

Which types of changes to show:

edit
Regular page edits.
new
Page creations.
log
Log entries.
external
External changes.
categorize
Category membership changes.
Values (separate with | or alternative): categorize, edit, external, log, new
Default: edit|new|log|categorize
wlowner

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

Type: user, by 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 [open in sandbox]
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 [open in sandbox]
Fetch additional information about the top revision for recently changed pages on the current user's watchlist, including when temporarily watched items will expire.
api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment|expiry [open in sandbox]
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 [open in sandbox]
Fetch page info for recently changed pages on the current user's watchlist.
api.php?action=query&generator=watchlist&prop=info [open in sandbox]
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 [open in sandbox]
List the top revision for recently changed pages on the watchlist of user Example.
api.php?action=query&list=watchlist&wlowner=Example&wltoken=123ABC [open in sandbox]

list=watchlistraw (wr)

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

Get all pages on the current user's watchlist.

Parameters:
wrcontinue

When more results are available, use this to continue.

wrnamespace

Only list pages in the given namespaces.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303
To specify all values, use *.
wrlimit

How many total results to return per request.

Type: integer or max
The value must be between 1 and 500.
Default: 10
wrprop

Which additional properties to get:

changed
Adds timestamp of when the user was last notified about the edit.
Values (separate with | or alternative): changed
wrshow

Only list items that meet these criteria.

Values (separate with | or alternative): !changed, changed
wrowner

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

Type: user, by user name
wrtoken

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

wrdir

The direction in which to list.

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 [open in sandbox]
Fetch page info for pages on the current user's watchlist.
api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=info [open in sandbox]

meta=allmessages (am)

Return messages from this site.

Parameters:
ammessages

Which messages to output. * (default) means all messages.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
Default: *
amprop

Which properties to get.

Values (separate with | or alternative): 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 in the MediaWiki namespace. This lists all MediaWiki-namespace 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 | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
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.

meta=authmanagerinfo (ami)

Retrieve information about the current authentication status.

Parameters:
amisecuritysensitiveoperation

Test whether the user's current authentication status is sufficient for the specified security-sensitive operation.

amirequestsfor

Fetch information about the authentication requests needed for the specified authentication action.

One of the following values: change, create, create-continue, link, link-continue, login, login-continue, remove, unlink
amimergerequestfields

Merge field information for all authentication requests into one array.

Type: boolean (details)
amimessageformat

Format to use for returning messages.

One of the following values: html, none, raw, wikitext
Default: wikitext
Examples:
Fetch the requests that may be used when beginning a login.
api.php?action=query&meta=authmanagerinfo&amirequestsfor=login [open in sandbox]
Fetch the requests that may be used when beginning a login, with form fields merged.
api.php?action=query&meta=authmanagerinfo&amirequestsfor=login&amimergerequestfields=1 [open in sandbox]
Test whether authentication is sufficient for action foo.
api.php?action=query&meta=authmanagerinfo&amisecuritysensitiveoperation=foo [open in sandbox]

meta=babel (bab)

Get information about what languages the user knows

Parameter:
babuser

User to get information about

This parameter is required.
Type: user, by any of user name, IP, IP range and interwiki name (e.g. "prefix>ExampleName")
Example:
Get the Babel information for user Example
api.php?action=query&meta=babel&babuser=Example [open in sandbox]

meta=filerepoinfo (fri)

Return meta information about image repositories configured on the wiki.

Parameter:
friprop

Which repository properties to get (properties available may vary on other wikis).

canUpload
Whether files can be uploaded to this repository, e.g. via CORS and shared authentication.
displayname
The human-readable name of the repository wiki.
favicon
Repository wiki's favicon URL, from $wgFavicon.
initialCapital
Whether file names implicitly start with a capital letter.
local
Whether that repository is the local one or not.
name
The key of the repository - used in e.g. $wgForeignFileRepos and imageinfo return values.
rootUrl
Root URL path for image paths.
scriptDirUrl
Root URL path for the repository wiki's MediaWiki installation.
thumbUrl
Root URL path for thumbnail paths.
url
Public zone URL path.
Values (separate with | or alternative): canUpload, displayname, favicon, initialCapital, local, name, rootUrl, scriptDirUrl, thumbUrl, url
Default: canUpload|displayname|favicon|initialCapital|local|name|rootUrl|scriptDirUrl|thumbUrl|url

meta=languageinfo (li)

Return information about available languages.

Continuation may be applied if retrieving the information takes too long for one request.

Parameters:
liprop

Which information to get for each language.

code
The language code. (This code is MediaWiki-specific, though there are overlaps with other standards.)
bcp47
The BCP-47 language code.
dir
The writing direction of the language (either ltr or rtl).
autonym
The autonym of the language, that is, the name in that language.
name
The name of the language in the language specified by the uselang parameter, with language fallbacks applied if necessary.
fallbacks
The language codes of the fallback languages configured for this language. The implicit final fallback to 'en' is not included (but some languages may fall back to 'en' explicitly).
variants
The language codes of the variants supported by this language.
Values (separate with | or alternative): autonym, bcp47, code, dir, fallbacks, name, variants
Default: code
licode

Language codes of the languages that should be returned, or * for all languages.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
Default: *
licontinue

When more results are available, use this to continue.

Examples:
Get the language codes of all supported languages.
api.php?action=query&meta=languageinfo [open in sandbox]
Get the autonyms and German names of all supported languages.
api.php?action=query&meta=languageinfo&liprop=autonym|name&uselang=de [open in sandbox]
Get the fallback languages and variants of Occitan.
api.php?action=query&meta=languageinfo&liprop=fallbacks|variants&licode=oc [open in sandbox]
Get the BCP-47 language code and direction of all supported languages.
api.php?action=query&meta=languageinfo&liprop=bcp47|dir [open in sandbox]

meta=languagestats (ls)

Query language stats.

Parameters:
lsoffset

When more results are available, use this to continue.

Default: 0
lslanguage

Language code.

This parameter is required.
lsgroup

Message group ID.

Examples:
List of translation completion statistics for Finnish
api.php?action=query&meta=languagestats&lslanguage=fi [open in sandbox]
List of translation completion statistics for Finnish for group A
api.php?action=query&meta=languagestats&lslanguage=fi&group=A [open in sandbox]

meta=managemessagegroups (mmg)

Fetch possible renames for a message in a group during imports

Parameters:
mmggroupId

Group Id

This parameter is required.
mmgmessageKey

Message key

This parameter is required.
mmgchangesetName

Change set name - Default / Unattended / MediaWiki etc.

Default: default

meta=messagegroups (mg)

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 | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
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 | or alternative): class, description, exists, icon, id, label, namespace, priority, priorityforce, prioritylangs, sourcelanguage, 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)
mglanguageFilter

Only return message groups that can be translated to the given language.

Default: (empty)

meta=messagegroupstats (mgs)

Query message group stats.

Parameters:
mgsoffset

When more results are available, use this to continue.

Default: 0
mgsgroup

Message group ID.

This parameter is required.
mgssuppresscomplete

Do not display languages which have completed translation

Type: boolean (details)
mgssuppressempty

Do not display languages which do not have any translations

Type: boolean (details)
Example:
List of translation completion statistics for the group "page-Example"
api.php?action=query&meta=messagegroupstats&mgsgroup=page-Example [open in sandbox]

meta=messagetranslations (mt)

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 [open in sandbox]

meta=oath (oath)

Check to see if two-factor authentication (OATH) is enabled for a user.

Parameters:
oathuser

User to get information about. Defaults to the current user.

Type: user, by any of user name, IP, IP range and interwiki name (e.g. "prefix>ExampleName")
oathreason

Reason for querying the OATH status.

Examples:
Get information about the current user
api.php?action=query&meta=oath [open in sandbox]
Get information about user Example
api.php?action=query&meta=oath&oathuser=Example [open in sandbox]

meta=siteinfo (si)

Return general information about the site.

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 (file types) 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).
languagevariants
Returns a list of language codes for which LanguageConverter is enabled, and the variants supported for each.
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.
uploaddialog
Returns the upload dialog configuration.
Values (separate with | or alternative): dbrepllag, defaultoptions, extensions, extensiontags, fileextensions, functionhooks, general, interwikimap, languages, languagevariants, libraries, magicwords, namespacealiases, namespaces, protocols, restrictions, rightsinfo, showhooks, skins, specialpagealiases, statistics, uploaddialog, usergroups, variables
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.

meta=tokens

Gets tokens for data-modifying actions.

Parameter:
type

Types of token to request.

Values (separate with | or alternative): createaccount, csrf, login, patrol, rollback, userrights, watch
To specify all values, use *.
Default: csrf
Examples:
Retrieve a csrf token (the default).
api.php?action=query&meta=tokens [open in sandbox]
Retrieve a watch token and a patrol token.
api.php?action=query&meta=tokens&type=watch|patrol [open in sandbox]

meta=userinfo (ui)

Get information about the current user.

Parameters:
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.
groupmemberships
Lists groups that the current user has been explicitly assigned to, including the expiry date of each group membership.
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.
editcount
Adds the current user's edit count.
ratelimits
Lists all rate limits applying to the current user.
theoreticalratelimits
Lists all rate limits that would apply to the current user if they were not exempt from all ratelimits based on user rights or ip
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).
centralids
Adds the central IDs and attachment status for the user.
latestcontrib
Adds the date of user's latest contribution.
Values (separate with | or alternative): acceptlang, blockinfo, centralids, changeablegroups, editcount, email, groupmemberships, groups, hasmsg, implicitgroups, latestcontrib, options, ratelimits, realname, registrationdate, rights, theoreticalratelimits, unreadcount
To specify all values, use *.
uiattachedwiki

With uiprop=centralids, indicate whether the user is attached with the wiki identified by this ID.

Examples:
Get information about the current user.
api.php?action=query&meta=userinfo [open in sandbox]
Get additional information about the current user.
api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg [open in sandbox]