MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

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

action=query

(main | query)

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

Fetch data from and about MediaWiki.

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

Parameters:

prop

Which properties to get for the queried pages.

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

list

Which lists to get.

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

meta

Which metadata to get.

Values (separate with |): allmessages, authmanagerinfo, filerepoinfo, siteinfo, tokens, userinfo

indexpageids

Include an additional pageids section listing all returned page IDs.

Type: boolean (details)

export

Export the current revisions of all given or generated pages.

Type: boolean (details)

exportnowrap

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

Type: boolean (details)

iwurl

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

Type: boolean (details)

continue

When more results are available, use this to continue.

rawcontinue

Return raw query-continue data for continuation.

Type: boolean (details)

titles

A list of titles to work on.

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

pageids

A list of page IDs to work on.

Type: list of integers

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

revids

A list of revision IDs to work on.

Type: list of integers

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

generator

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

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

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, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw

redirects

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

Type: boolean (details)

converttitles

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

Type: boolean (details)

Examples:

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

prop=categories (cl)

(main | query | categories)

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

List all categories the pages belong to.

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

Parameters:

clprop

Which additional properties to get for each category:

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

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

clshow

Which kind of categories to show.

Values (separate with |): hidden, !hidden

cllimit

How many categories to return.

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

Type: integer or max

Default: 10

clcontinue

When more results are available, use this to continue.

clcategories

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

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

cldir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

Examples:

Get a list of categories the page Albert Einstein belongs to.: api.php?action=query&prop=categories&titles=Albert%20Einstein [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)

(main | query | categoryinfo)

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

Returns information about the given categories.

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

Parameter:

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

Example:

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

prop=contributors (pc)

(main | query | contributors)

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

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

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

Parameters:

pcgroup: Only include users in the given groups. Does not include implicit or auto-promoted groups like *, user, or autoconfirmed.; Values (separate with |): bot, sysop, bureaucrat
pcexcludegroup: Exclude users in the given groups. Does not include implicit or auto-promoted groups like *, user, or autoconfirmed.; Values (separate with |): bot, sysop, bureaucrat
pcrights: Only include users having the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.; Values (separate with |): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmywatchlist, editsemiprotected, editusercssjs, editusercss, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, passwordreset, patrol, patrolmarks, protect, purge, read, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi, renameuser, spamblacklistlog; Maximum number of values is 50 (500 for bots).
pcexcluderights: Exclude users having the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.; Values (separate with |): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmywatchlist, editsemiprotected, editusercssjs, editusercss, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, passwordreset, patrol, patrolmarks, protect, purge, read, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi, renameuser, spamblacklistlog; Maximum number of values is 50 (500 for bots).
pclimit: How many contributors to return.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10
pccontinue: When more results are available, use this to continue.

Example:

Show contributors to the page Main Page.: api.php?action=query&prop=contributors&titles=Main_Page [open in sandbox]

prop=deletedrevisions (drv)

(main | query | deletedrevisions)

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

Get deleted revision information.

May be used in several ways:

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

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

Parameters:

drvprop

Which properties to get for each revision:

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

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

Default: ids|timestamp|flags|comment|user

drvlimit

Limit how many revisions will be returned.

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

Type: integer or max

drvexpandtemplates

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

Type: boolean (details)

drvgeneratexml

Deprecated.

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

Type: boolean (details)

drvparse

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

Type: boolean (details)

drvsection

Only retrieve the content of this section number.

drvdiffto

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

drvdifftotext

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

drvdifftotextpst

Perform a pre-save transform on the text before diffing it. Only valid when used with drvdifftotext.

Type: boolean (details)

drvcontentformat

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

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

drvstart

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

Type: timestamp (allowed formats)

drvend

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

Type: timestamp (allowed formats)

drvdir

In which direction to enumerate:

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

One of the following values: newer, older

Default: older

drvtag

Only list revisions tagged with this tag.

drvuser

Only list revisions by this user.

Type: user name

drvexcludeuser

Don't list revisions by this user.

Type: user name

drvcontinue

When more results are available, use this to continue.

Examples:

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

prop=duplicatefiles (df)

(main | query | duplicatefiles)

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

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

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

Parameters:

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

Examples:

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

prop=extlinks (el)

(main | query | extlinks)

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

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

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

Parameters:

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

Example:

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

prop=fileusage (fu)

(main | query | fileusage)

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

Find all pages that use the given files.

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

Parameters:

fuprop

Which properties to get:

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

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

Default: pageid|title|redirect

funamespace

Only include pages in these namespaces.

Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

fushow

Show only items that meet these criteria:

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

Values (separate with |): redirect, !redirect

fulimit

How many to return.

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

Type: integer or max

Default: 10

fucontinue

When more results are available, use this to continue.

Examples:

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

prop=imageinfo (ii)

(main | query | imageinfo)

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

Returns file information and upload history.

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

Parameters:

iiprop

Which file information to get:

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

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

Default: timestamp|user

iilimit

How many file revisions to return per file.

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

Type: integer or max

Default: 1

iistart

Timestamp to start listing from.

Type: timestamp (allowed formats)

iiend

Timestamp to stop listing at.

Type: timestamp (allowed formats)

iiurlwidth

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

Type: integer

Default: -1

iiurlheight

Similar to iiurlwidth.

Type: integer

Default: -1

iimetadataversion

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

Default: 1

iiextmetadatalanguage

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

Default: en

iiextmetadatamultilang

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

Type: boolean (details)

iiextmetadatafilter

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

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

iiurlparam

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

Default: (empty)

iicontinue

When more results are available, use this to continue.

iilocalonly

Look only for files in the local repository.

Type: boolean (details)

Examples:

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

prop=images (im)

(main | query | images)

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

Returns all files contained on the given pages.

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

Parameters:

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

Examples:

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

prop=info (in)

(main | query | info)

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

Get basic page information.

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

Parameters:

inprop

Which additional properties to get:

protection: List the protection level of each page.
talkid: The page ID of the talk page for each non-talk page.
watched: List the watched status of each page.
watchers: The number of watchers, if allowed.
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.
url: Gives a full URL, an edit URL, and the canonical URL for each page.
readable: Whether the user can read this page.
preload: Gives the text returned by EditFormPreloadText.
displaytitle: Gives the manner in which the page title is actually displayed.

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

intestactions

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

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

intoken

Deprecated.

Use action=query&meta=tokens instead.

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

incontinue

When more results are available, use this to continue.

Examples:

Get information about the page Main Page.: api.php?action=query&prop=info&titles=Main%20Page [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]

prop=iwlinks (iw)

(main | query | iwlinks)

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

Returns all interwiki links from the given pages.

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

Parameters:

iwprop

Which additional properties to get for each interlanguage link:

url: Adds the full URL.

Values (separate with |): url

iwprefix

Only return interwiki links with this prefix.

iwtitle

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

iwdir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

iwlimit

How many interwiki links to return.

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

Type: integer or max

Default: 10

iwcontinue

When more results are available, use this to continue.

iwurl

Deprecated.

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

Type: boolean (details)

Example:

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

prop=langlinks (ll)

(main | query | langlinks)

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

Returns all interlanguage links from the given pages.

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

Parameters:

llprop

Which additional properties to get for each interlanguage link:

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

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

lllang

Only return language links with this language code.

lltitle

Link to search for. Must be used with lllang.

lldir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

llinlanguagecode

Language code for localised language names.

Default: en

lllimit

How many langlinks to return.

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

Type: integer or max

Default: 10

llcontinue

When more results are available, use this to continue.

llurl

Deprecated.

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

Type: boolean (details)

Example:

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

prop=links (pl)

(main | query | links)

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

Returns all links from the given pages.

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

Parameters:

plnamespace: Show links in these namespaces only.; Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
pllimit: How many links to return.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10
plcontinue: When more results are available, use this to continue.
pltitles: Only list links to these titles. Useful for checking whether a certain page links to a certain title.; Separate values with |. Maximum number of values is 50 (500 for bots).
pldir: The direction in which to list.; One of the following values: ascending, descending; Default: ascending

Examples:

Get links from the page Main Page: api.php?action=query&prop=links&titles=Main%20Page [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)

(main | query | linkshere)

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

Find all pages that link to the given pages.

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

Parameters:

lhprop

Which properties to get:

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

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

Default: pageid|title|redirect

lhnamespace

Only include pages in these namespaces.

Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

lhshow

Show only items that meet these criteria:

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

Values (separate with |): redirect, !redirect

lhlimit

How many to return.

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

Type: integer or max

Default: 10

lhcontinue

When more results are available, use this to continue.

Examples:

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

prop=pageprops (pp)

(main | query | pageprops)

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

Get various page properties defined in the page content.

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

Parameters:

ppcontinue: When more results are available, use this to continue.
ppprop: Only list these 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 |. Maximum number of values is 50 (500 for bots).

Example:

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

prop=redirects (rd)

(main | query | redirects)

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

Returns all redirects to the given pages.

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

Parameters:

rdprop

Which properties to get:

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

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

Default: pageid|title

rdnamespace

Only include pages in these namespaces.

Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

rdshow

Show only items that meet these criteria:

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

Values (separate with |): fragment, !fragment

rdlimit

How many redirects to return.

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

Type: integer or max

Default: 10

rdcontinue

When more results are available, use this to continue.

Examples:

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

prop=references (rf)

(main | query | references)

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

Return a data representation of references associated with the given pages.

Parameter:

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

Example:

References associated with Albert Einstein.: api.php?action=query&prop=references&titles=Albert%20Einstein [open in sandbox]

prop=revisions (rv)

(main | query | revisions)

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

Get revision information.

May be used in several ways:

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

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

Parameters:

rvprop

Which properties to get for each revision:

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

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

Default: ids|timestamp|flags|comment|user

rvlimit

Limit how many revisions will be returned.

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

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

Type: integer or max

rvexpandtemplates

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

Type: boolean (details)

rvgeneratexml

Deprecated.

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

Type: boolean (details)

rvparse

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

Type: boolean (details)

rvsection

Only retrieve the content of this section number.

rvdiffto

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

rvdifftotext

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

rvdifftotextpst

Perform a pre-save transform on the text before diffing it. Only valid when used with rvdifftotext.

Type: boolean (details)

rvcontentformat

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

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

rvstartid

From which revision ID to start enumeration.

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

Type: integer

rvendid

Stop revision enumeration on this revision ID.

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

Type: integer

rvstart

From which revision timestamp to start enumeration.

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

Type: timestamp (allowed formats)

rvend

Enumerate up to this timestamp.

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

Type: timestamp (allowed formats)

rvdir

In which direction to enumerate:

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

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

One of the following values: newer, older

Default: older

rvuser

Only include revisions made by user.

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

Type: user name

rvexcludeuser

Exclude revisions made by user.

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

Type: user name

rvtag

Only list revisions tagged with this tag.

rvtoken

Deprecated.

Which tokens to obtain for each revision.

Values (separate with |): rollback

rvcontinue

When more results are available, use this to continue.

Examples:

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

prop=stashimageinfo (sii)

(main | query | stashimageinfo)

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

Returns file information for stashed files.

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

Parameters:

siifilekey

Key that identifies a previous upload that was stashed temporarily.

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

siisessionkey

Deprecated.

Alias for siifilekey, for backward compatibility.

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

siiprop

Which file information to get:

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

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

Default: timestamp|url

siiurlwidth

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

Type: integer

Default: -1

siiurlheight

Similar to siiurlwidth.

Type: integer

Default: -1

siiurlparam

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

Default: (empty)

Examples:

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

prop=templates (tl)

(main | query | templates)

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

Returns all pages transcluded on the given pages.

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

Parameters:

tlnamespace: Show templates in this namespaces only.; Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
tllimit: How many templates to return.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10
tlcontinue: When more results are available, use this to continue.
tltemplates: Only list these templates. Useful for checking whether a certain page uses a certain template.; Separate values with |. Maximum number of values is 50 (500 for bots).
tldir: The direction in which to list.; One of the following values: ascending, descending; Default: ascending

Examples:

Get the templates used on the page Main Page.: api.php?action=query&prop=templates&titles=Main%20Page [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)

(main | query | transcludedin)

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

Find all pages that transclude the given pages.

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

Parameters:

tiprop

Which properties to get:

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

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

Default: pageid|title|redirect

tinamespace

Only include pages in these namespaces.

Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

tishow

Show only items that meet these criteria:

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

Values (separate with |): redirect, !redirect

tilimit

How many to return.

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

Type: integer or max

Default: 10

ticontinue

When more results are available, use this to continue.

Examples:

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

list=allcategories (ac)

(main | query | allcategories)

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

Enumerate all categories.

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

Parameters:

acfrom

The category to start enumerating from.

accontinue

When more results are available, use this to continue.

acto

The category to stop enumerating at.

acprefix

Search for all category titles that begin with this value.

acdir

Direction to sort in.

One of the following values: ascending, descending

Default: ascending

acmin

Only return categories with at least this many members.

Type: integer

acmax

Only return categories with at most this many members.

Type: integer

aclimit

How many categories to return.

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

Type: integer or max

Default: 10

acprop

Which properties to get:

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

Values (separate with |): size, hidden

Default: (empty)

Examples:

List categories with information on the number of pages in each.: api.php?action=query&list=allcategories&acprop=size [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)

(main | query | alldeletedrevisions)

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

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

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

Parameters:

adrprop

Which properties to get for each revision:

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

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

Default: ids|timestamp|flags|comment|user

adrlimit

Limit how many revisions will be returned.

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

Type: integer or max

adrexpandtemplates

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

Type: boolean (details)

adrgeneratexml

Deprecated.

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

Type: boolean (details)

adrparse

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

Type: boolean (details)

adrsection

Only retrieve the content of this section number.

adrdiffto

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

adrdifftotext

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

adrdifftotextpst

Perform a pre-save transform on the text before diffing it. Only valid when used with adrdifftotext.

Type: boolean (details)

adrcontentformat

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

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

adruser

Only list revisions by this user.

Type: user name

adrnamespace

Only list pages in this namespace.

Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

adrstart

The timestamp to start enumerating from.

May only be used with adruser.

Type: timestamp (allowed formats)

adrend

The timestamp to stop enumerating at.

May only be used with adruser.

Type: timestamp (allowed formats)

adrdir

In which direction to enumerate:

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

One of the following values: newer, older

Default: older

adrfrom

Start listing at this title.

Cannot be used with adruser.

adrto

Stop listing at this title.

Cannot be used with adruser.

adrprefix

Search for all page titles that begin with this value.

Cannot be used with adruser.

adrexcludeuser

Don't list revisions by this user.

Cannot be used with adruser.

Type: user name

adrtag

Only list revisions tagged with this tag.

adrcontinue

When more results are available, use this to continue.

adrgeneratetitles

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

Type: boolean (details)

Examples:

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

list=allfileusages (af)

(main | query | allfileusages)

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

List all file usages, including non-existing.

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

Parameters:

afcontinue

When more results are available, use this to continue.

affrom

The title of the file to start enumerating from.

afto

The title of the file to stop enumerating at.

afprefix

Search for all file titles that begin with this value.

afunique

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

Type: boolean (details)

afprop

Which pieces of information to include:

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

Values (separate with |): ids, title

Default: title

aflimit

How many total items to return.

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

Type: integer or max

Default: 10

afdir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

Examples:

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

list=allimages (ai)

(main | query | allimages)

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

Enumerate all images sequentially.

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

Parameters:

aisort

Property to sort by.

One of the following values: name, timestamp

Default: name

aidir

The direction in which to list.

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

Default: ascending

aifrom

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

aito

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

aicontinue

When more results are available, use this to continue.

aistart

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

Type: timestamp (allowed formats)

aiend

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

Type: timestamp (allowed formats)

aiprop

Which file information to get:

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

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

Default: timestamp|url

aiprefix

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

aiminsize

Limit to images with at least this many bytes.

Type: integer

aimaxsize

Limit to images with at most this many bytes.

Type: integer

aisha1

SHA1 hash of image. Overrides aisha1base36.

aisha1base36

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

aiuser

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

Type: user name

aifilterbots

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

One of the following values: all, bots, nobots

Default: all

aimime

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

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

ailimit

How many images in total to return.

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

Type: integer or max

Default: 10

Examples:

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

list=alllinks (al)

(main | query | alllinks)

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

Enumerate all links that point to a given namespace.

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

Parameters:

alcontinue

When more results are available, use this to continue.

alfrom

The title of the link to start enumerating from.

alto

The title of the link to stop enumerating at.

alprefix

Search for all linked titles that begin with this value.

alunique

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

Type: boolean (details)

alprop

Which pieces of information to include:

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

Values (separate with |): ids, title

Default: title

alnamespace

The namespace to enumerate.

One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

Default: 0

allimit

How many total items to return.

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

Type: integer or max

Default: 10

aldir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

Examples:

List linked titles, including missing ones, with page IDs they are from, starting at B.: api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title [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)

(main | query | allpages)

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

Enumerate all pages sequentially in a given namespace.

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

Parameters:

apfrom

The page title to start enumerating from.

apcontinue

When more results are available, use this to continue.

apto

The page title to stop enumerating at.

apprefix

Search for all page titles that begin with this value.

apnamespace

The namespace to enumerate.

One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

Default: 0

apfilterredir

Which pages to list.

One of the following values: all, redirects, nonredirects

Default: all

apminsize

Limit to pages with at least this many bytes.

Type: integer

apmaxsize

Limit to pages with at most this many bytes.

Type: integer

apprtype

Limit to protected pages only.

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

apprlevel

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

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

apprfiltercascade

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

One of the following values: cascading, noncascading, all

Default: all

aplimit

How many total pages to return.

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

Type: integer or max

Default: 10

apdir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

apfilterlanglinks

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

One of the following values: withlanglinks, withoutlanglinks, all

Default: all

apprexpiry

Which protection expiry to filter the page on:

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

One of the following values: indefinite, definite, all

Default: all

Examples:

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

list=allredirects (ar)

(main | query | allredirects)

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

List all redirects to a namespace.

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

Parameters:

arcontinue

When more results are available, use this to continue.

arfrom

The title of the redirect to start enumerating from.

arto

The title of the redirect to stop enumerating at.

arprefix

Search for all target pages that begin with this value.

arunique

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

Type: boolean (details)

arprop

Which pieces of information to include:

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

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

Default: title

arnamespace

The namespace to enumerate.

One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

Default: 0

arlimit

How many total items to return.

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

Type: integer or max

Default: 10

ardir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

Examples:

List target pages, including missing ones, with page IDs they are from, starting at B.: api.php?action=query&list=allredirects&arfrom=B&arprop=ids|title [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)

(main | query | allrevisions)

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

List all revisions.

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

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.
userid: User ID of the revision creator.
size: Length (bytes) of the revision.
sha1: SHA-1 (base 16) of the revision.
contentmodel: Content model ID of the revision.
comment: Comment by the user for the revision.
parsedcomment: Parsed comment by the user for the revision.
content: Text of the revision.
tags: Tags for the revision.
parsetree: The XML parse tree of revision content (requires content model wikitext).

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

Default: ids|timestamp|flags|comment|user

arvlimit

Limit how many revisions will be returned.

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

Type: integer or max

arvexpandtemplates

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

Type: boolean (details)

arvgeneratexml

Deprecated.

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

Type: boolean (details)

arvparse

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 this section number.

arvdiffto

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

arvdifftotext

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

Perform a pre-save transform on the text before diffing it. Only valid when used with arvdifftotext.

Type: boolean (details)

arvcontentformat

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

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

arvuser

Only list revisions by this user.

Type: user name

arvnamespace

Only list pages in this namespace.

Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

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 name

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)

Examples:

List the last 50 contributions by user Example.: api.php?action=query&list=allrevisions&arvuser=Example&arvlimit=50 [open in sandbox]
List the first 50 revisions in the main namespace.: api.php?action=query&list=allrevisions&arvdir=newer&arvlimit=50 [open in sandbox]

list=alltransclusions (at)

(main | query | alltransclusions)

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

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

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

Parameters:

atcontinue

When more results are available, use this to continue.

atfrom

The title of the transclusion to start enumerating from.

atto

The title of the transclusion to stop enumerating at.

atprefix

Search for all transcluded titles that begin with this value.

atunique

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

Type: boolean (details)

atprop

Which pieces of information to include:

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

Values (separate with |): ids, title

Default: title

atnamespace

The namespace to enumerate.

One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

Default: 10

atlimit

How many total items to return.

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

Type: integer or max

Default: 10

atdir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

Examples:

List transcluded titles, including missing ones, with page IDs they are from, starting at B.: api.php?action=query&list=alltransclusions&atfrom=B&atprop=ids|title [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)

(main | query | allusers)

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

Enumerate all registered users.

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

Parameters:

aufrom

The user name to start enumerating from.

auto

The user name to stop enumerating at.

auprefix

Search for all users that begin with this value.

audir

Direction to sort in.

One of the following values: ascending, descending

Default: ascending

augroup

Only include users in the given groups.

Values (separate with |): bot, sysop, bureaucrat

auexcludegroup

Exclude users in the given groups.

Values (separate with |): bot, sysop, bureaucrat

aurights

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

Values (separate with |): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmywatchlist, editsemiprotected, editusercssjs, editusercss, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, passwordreset, patrol, patrolmarks, protect, purge, read, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi, renameuser, spamblacklistlog

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

auprop

Which pieces of information to include:

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

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

aulimit

How many total user names to return.

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

Type: integer or max

Default: 10

auwitheditsonly

Only list users who have made edits.

Type: boolean (details)

auactiveusers

Only list users active in the last 30 days.

Type: boolean (details)

auattachedwiki

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

Example:

List users starting at Y.: api.php?action=query&list=allusers&aufrom=Y [open in sandbox]

list=backlinks (bl)

(main | query | backlinks)

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

Find all pages that link to the given page.

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

Parameters:

bltitle: Title to search. Cannot be used together with blpageid.
blpageid: Page ID to search. Cannot be used together with bltitle.; Type: integer
blcontinue: When more results are available, use this to continue.
blnamespace: The namespace to enumerate.; Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
bldir: The direction in which to list.; One of the following values: ascending, descending; Default: ascending
blfilterredir: How to filter for redirects. If set to nonredirects when blredirect is enabled, this is only applied to the second level.; One of the following values: all, redirects, nonredirects; Default: all
bllimit: How many total pages to return. If blredirect is enabled, the limit applies to each level separately (which means up to 2 * bllimit results may be returned).; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10
blredirect: If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.; Type: boolean (details)

Examples:

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

list=blocks (bk)

(main | query | blocks)

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

List all blocked users and IP addresses.

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

Parameters:

bkstart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)

bkend

The timestamp to stop enumerating at.

Type: timestamp (allowed formats)

bkdir

In which direction to enumerate:

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

One of the following values: newer, older

Default: older

bkids

List of block IDs to list (optional).

Type: list of integers

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

bkusers

List of users to search for (optional).

Type: list of user names

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

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.

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

Type: integer or max

Default: 10

bkprop

Which properties to get:

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

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

bkshow

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

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

bkcontinue

When more results are available, use this to continue.

Examples:

List blocks.: api.php?action=query&list=blocks [open in sandbox]
List blocks of users Alice and Bob.: api.php?action=query&list=blocks&bkusers=Alice|Bob [open in sandbox]

list=categorymembers (cm)

(main | query | categorymembers)

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

List all pages in a given category.

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

Parameters:

cmtitle

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

Default: ids|title

cmnamespace

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

Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

cmtype

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

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

Default: page|subcat|file

cmcontinue

When more results are available, use this to continue.

cmlimit

The maximum number of pages to return.

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

Type: integer or max

Default: 10

cmsort

Property to sort by.

One of the following values: sortkey, timestamp

Default: sortkey

cmdir

In which direction to sort.

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

Default: ascending

cmstart

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

Type: timestamp (allowed formats)

cmend

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

Type: timestamp (allowed formats)

cmstarthexsortkey

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

cmendhexsortkey

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

cmstartsortkeyprefix

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

cmendsortkeyprefix

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

cmstartsortkey

Deprecated.

Use cmstarthexsortkey instead.

cmendsortkey

Deprecated.

Use cmendhexsortkey instead.

Examples:

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

list=deletedrevs (dr)

(main | query | deletedrevs)

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

List deleted revisions.

Operates in three modes:

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

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

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

Parameters:

drstart

The timestamp to start enumerating from.

Modes: 1, 2

Type: timestamp (allowed formats)

drend

The timestamp to stop enumerating at.

Modes: 1, 2

Type: timestamp (allowed formats)

drdir

In which direction to enumerate:

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

Modes: 1, 3

One of the following values: newer, older

Default: older

drfrom

Start listing at this title.

Mode: 3

drto

Stop listing at this title.

Mode: 3

drprefix

Search for all page titles that begin with this value.

Mode: 3

drunique

List only one revision for each page.

Mode: 3

Type: boolean (details)

drnamespace

Only list pages in this namespace.

Mode: 3

One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

Default: 0

drtag

Only list revisions tagged with this tag.

druser

Only list revisions by this user.

Type: user name

drexcludeuser

Don't list revisions by this user.

Type: user name

drprop

Which properties to get:

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

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

Default: user|comment

drlimit

The maximum amount of revisions to list.

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

Type: integer or max

Default: 10

drcontinue

When more results are available, use this to continue.

Examples:

List the last deleted revisions of the pages Main Page and Talk:Main Page, with content (mode 1).: api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content [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)

(main | query | embeddedin)

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

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

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

Parameters:

eititle: Title to search. Cannot be used together with eipageid.
eipageid: Page ID to search. Cannot be used together with eititle.; Type: integer
eicontinue: When more results are available, use this to continue.
einamespace: The namespace to enumerate.; Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
eidir: The direction in which to list.; One of the following values: ascending, descending; Default: ascending
eifilterredir: How to filter for redirects.; One of the following values: all, redirects, nonredirects; Default: all
eilimit: How many total pages to return.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10

Examples:

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

list=exturlusage (eu)

(main | query | exturlusage)

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

Enumerate pages that contain a given URL.

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

Parameters:

euprop

Which pieces of information to include:

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

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

Default: ids|title|url

euoffset

When more results are available, use this to continue.

Type: integer

euprotocol

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

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

Default: (empty)

euquery

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

eunamespace

The page namespaces to enumerate.

Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

eulimit

How many pages to return.

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

Type: integer or max

Default: 10

euexpandurl

Expand protocol-relative URLs with the canonical protocol.

Type: boolean (details)

Example:

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

list=filearchive (fa)

(main | query | filearchive)

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

Enumerate all deleted files sequentially.

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

Parameters:

fafrom

The image title to start enumerating from.

fato

The image title to stop enumerating at.

faprefix

Search for all image titles that begin with this value.

fadir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

fasha1

SHA1 hash of image. Overrides fasha1base36.

fasha1base36

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

faprop

Which image information to get:

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

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

Default: timestamp

falimit

How many images to return in total.

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

Type: integer or max

Default: 10

facontinue

When more results are available, use this to continue.

Example:

Show a list of all deleted files.: api.php?action=query&list=filearchive [open in sandbox]

list=imageusage (iu)

(main | query | imageusage)

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

Find all pages that use the given image title.

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

Parameters:

iutitle: Title to search. Cannot be used together with iupageid.
iupageid: Page ID to search. Cannot be used together with iutitle.; Type: integer
iucontinue: When more results are available, use this to continue.
iunamespace: The namespace to enumerate.; Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
iudir: The direction in which to list.; One of the following values: ascending, descending; Default: ascending
iufilterredir: How to filter for redirects. If set to nonredirects when iuredirect is enabled, this is only applied to the second level.; One of the following values: all, redirects, nonredirects; Default: all
iulimit: How many total pages to return. If iuredirect is enabled, the limit applies to each level separately (which means up to 2 * iulimit results may be returned).; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 10
iuredirect: If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.; Type: boolean (details)

Examples:

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

list=iwbacklinks (iwbl)

(main | query | iwbacklinks)

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

Find all pages that link to the given interwiki link.

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

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

Parameters:

iwblprefix

Prefix for the interwiki.

iwbltitle

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

iwblcontinue

When more results are available, use this to continue.

iwbllimit

How many total pages to return.

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

Type: integer or max

Default: 10

iwblprop

Which properties to get:

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

Values (separate with |): iwprefix, iwtitle

Default: (empty)

iwbldir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

Examples:

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

list=langbacklinks (lbl)

(main | query | langbacklinks)

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

Find all pages that link to the given language link.

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

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

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

Parameters:

lbllang

Language for the language link.

lbltitle

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

lblcontinue

When more results are available, use this to continue.

lbllimit

How many total pages to return.

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

Type: integer or max

Default: 10

lblprop

Which properties to get:

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

Values (separate with |): lllang, lltitle

Default: (empty)

lbldir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

Examples:

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

list=logevents (le)

(main | query | logevents)

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

Get events from logs.

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

Parameters:

leprop

Which properties to get:

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

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

letype

Filter log entries to only this type.

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

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: renameuser/renameuser, spamblacklist/*, block/block, block/reblock, block/unblock, contentmodel/change, contentmodel/new, delete/delete, delete/event, delete/restore, delete/revision, import/interwiki, import/upload, managetags/activate, managetags/create, managetags/deactivate, managetags/delete, merge/merge, move/move, move/move_redir, patrol/patrol, patrol/autopatrol, protect/modify, protect/move_prot, protect/protect, protect/unprotect, rights/autopromote, rights/rights, suppress/block, suppress/delete, suppress/event, suppress/reblock, suppress/revision, tag/update, upload/overwrite, upload/revert, upload/upload, newusers/newusers, newusers/create, newusers/create2, newusers/byemail, newusers/autocreate

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 name

letitle

Filter entries to those related to a page.

lenamespace

Filter entries to those in the given namespace.

One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

leprefix

Filter entries that start with this prefix.

letag

Only list event entries tagged with this tag.

lelimit

How many total event entries to return.

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

Type: integer or max

Default: 10

lecontinue

When more results are available, use this to continue.

Example:

List recent log events.: api.php?action=query&list=logevents [open in sandbox]

list=mystashedfiles (msf)

(main | query | mystashedfiles)

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

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

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

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 |): size, type

Default: (empty)

msflimit

How many files to get.

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

Type: integer or max

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)

(main | query | pagepropnames)

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

List all page property names in use on the wiki.

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

Parameters:

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

Example:

Get first 10 property names.: api.php?action=query&list=pagepropnames [open in sandbox]

list=pageswithprop (pwp)

(main | query | pageswithprop)

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

List all pages using a given page property.

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

Parameters:

pwppropname

Page 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 |): ids, title, value

Default: ids|title

pwpcontinue

When more results are available, use this to continue.

pwplimit

The maximum number of pages to return.

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

Type: integer or max

Default: 10

pwpdir

In which direction to sort.

One of the following values: ascending, descending

Default: ascending

Examples:

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

list=prefixsearch (ps)

(main | query | prefixsearch)

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

Perform a prefix search for page titles.

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.

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

Parameters:

pssearch: Search string.; This parameter is required.
psnamespace: Namespaces to search.; Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15; Default: 0
pslimit: Maximum number of results to return.; No more than 100 (200 for bots) allowed.; Type: integer or max; Default: 10
psoffset: Number of results to skip.; Type: integer; Default: 0

Example:

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

list=protectedtitles (pt)

(main | query | protectedtitles)

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

List all titles protected from creation.

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

Parameters:

ptnamespace

Only list titles in these namespaces.

Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

ptlevel

Only list titles with these protection levels.

Values (separate with |): autoconfirmed, sysop

ptlimit

How many total pages to return.

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

Type: integer or max

Default: 10

ptdir

In which direction to enumerate:

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

One of the following values: newer, older

Default: older

ptstart

Start listing at this protection timestamp.

Type: timestamp (allowed formats)

ptend

Stop listing at this protection timestamp.

Type: timestamp (allowed formats)

ptprop

Which properties to get:

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

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

Default: timestamp|level

ptcontinue

When more results are available, use this to continue.

Examples:

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

list=querypage (qp)

(main | query | querypage)

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

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

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

Parameters:

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

Example:

Return results from Special:Ancientpages.: api.php?action=query&list=querypage&qppage=Ancientpages [open in sandbox]

list=random (rn)

(main | query | random)

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

Get a set of random pages.

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

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

Parameters:

rnnamespace: Return pages in these namespaces only.; Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
rnfilterredir: How to filter for redirects.; One of the following values: all, redirects, nonredirects; Default: nonredirects
rnredirect: Deprecated.; Use rnfilterredir=redirects instead.; Type: boolean (details)
rnlimit: Limit how many random pages will be returned.; No more than 500 (5,000 for bots) allowed.; Type: integer or max; Default: 1
rncontinue: When more results are available, use this to continue.

Examples:

Return two random pages from the main namespace.: api.php?action=query&list=random&rnnamespace=0&rnlimit=2 [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)

(main | query | recentchanges)

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

Enumerate recent changes.

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

Parameters:

rcstart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)

rcend

The timestamp to end enumerating.

Type: timestamp (allowed formats)

rcdir

In which direction to enumerate:

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

One of the following values: newer, older

Default: older

rcnamespace

Filter changes to only these namespaces.

Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

rcuser

Only list changes by this user.

Type: user name

rcexcludeuser

Don't list changes by this user.

Type: user name

rctag

Only list changes tagged with this tag.

rcprop

Include additional pieces of information:

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

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

Default: title|timestamp|ids

rctoken

Deprecated.

Use action=query&meta=tokens instead.

Values (separate with |): patrol

rcshow

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

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

rclimit

How many total changes to return.

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

Type: integer or max

Default: 10

rctype

Which types of changes to show.

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

Default: edit|new|log|categorize

rctoponly

Only list changes which are the latest revision.

Type: boolean (details)

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)

Examples:

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

list=search (sr)

(main | query | search)

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

Perform a full text search.

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

Parameters:

srsearch

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

This parameter is required.

srnamespace

Search only within these namespaces.

Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

Default: 0

srwhat

Which type of search to perform.

One of the following values: title, text, nearmatch

srinfo

Which metadata to return.

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

Default: totalhits|suggestion|rewrittenquery

srprop

Which properties to return:

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

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

Default: size|wordcount|timestamp|snippet

sroffset

When more results are available, use this to continue.

Type: integer

Default: 0

srlimit

How many total pages to return.

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

Type: integer or max

Default: 10

srinterwiki

Include interwiki results in the search, if available.

Type: boolean (details)

srenablerewrites

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

Type: boolean (details)

Examples:

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

list=tags (tg)

(main | query | tags)

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

List change tags.

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

Parameters:

tgcontinue

When more results are available, use this to continue.

tglimit

The maximum number of tags to list.

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

Type: integer or max

Default: 10

tgprop

Which properties to get:

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

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

Default: name

Example:

List available tags.: api.php?action=query&list=tags&tgprop=displayname|description|hitcount|defined [open in sandbox]

list=usercontribs (uc)

(main | query | usercontribs)

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

Get all edits by a user.

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

Parameters:

uclimit

The maximum number of contributions to return.

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

Type: integer or max

Default: 10

ucstart

The start timestamp to return from.

Type: timestamp (allowed formats)

ucend

The end timestamp to return to.

Type: timestamp (allowed formats)

uccontinue

When more results are available, use this to continue.

ucuser

The users to retrieve contributions for.

Type: list of user names

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

ucuserprefix

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

ucdir

In which direction to enumerate:

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

One of the following values: newer, older

Default: older

ucnamespace

Only list contributions in these namespaces.

Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

ucprop

Include additional pieces of information:

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

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

ucshow

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

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

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

uctag

Only list revisions tagged with this tag.

uctoponly

Deprecated.

Only list changes which are the latest revision.

Type: boolean (details)

Examples:

Show contributions of user Example.: api.php?action=query&list=usercontribs&ucuser=Example [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)

(main | query | users)

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

Get information about a list of users.

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

Parameters:

usprop

Which pieces of information to include:

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

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.

Type: list of user names

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

ustoken

Deprecated.

Use action=query&meta=tokens instead.

Values (separate with |): userrights

Example:

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

list=watchlist (wl)

(main | query | watchlist)

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

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

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

Parameters:

wlallrev

Include multiple revisions of the same page within given timeframe.

Type: boolean (details)

wlstart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)

wlend

The timestamp to end enumerating.

Type: timestamp (allowed formats)

wlnamespace

Filter changes to only the given namespaces.

Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

wluser

Only list changes by this user.

Type: user name

wlexcludeuser

Don't list changes by this user.

Type: user name

wldir

In which direction to enumerate:

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

One of the following values: newer, older

Default: older

wllimit

How many total results to return per request.

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

Type: integer or max

Default: 10

wlprop

Which additional properties to get:

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

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

Default: ids|title|flags

wlshow

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

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

wltype

Which types of changes to show:

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

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

Default: edit|new|log|categorize

wlowner

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

Type: user name

wltoken

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

wlcontinue

When more results are available, use this to continue.

Examples:

List the top revision for recently changed pages on the current user's watchlist.: api.php?action=query&list=watchlist [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 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)

(main | query | watchlistraw)

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

Get all pages on the current user's watchlist.

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

Parameters:

wrcontinue

When more results are available, use this to continue.

wrnamespace

Only list pages in the given namespaces.

Values (separate with |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

wrlimit

How many total results to return per request.

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

Type: integer or max

Default: 10

wrprop

Which additional properties to get:

changed: Adds timestamp of when the user was last notified about the edit.

Values (separate with |): changed

wrshow

Only list items that meet these criteria.

Values (separate with |): changed, !changed

wrowner

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

Type: user name

wrtoken

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

wrdir

In which direction to enumerate:

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

One of the following values: ascending, descending

Default: ascending

wrfromtitle

Title (with namespace prefix) to begin enumerating from.

wrtotitle

Title (with namespace prefix) to stop enumerating at.

Examples:

List pages on the current user's watchlist.: api.php?action=query&list=watchlistraw [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)

(main | query | allmessages)

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

Return messages from this site.

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

Parameters:

ammessages: Which messages to output. * (default) means all messages.; Separate values with |. Maximum number of values is 50 (500 for bots).; Default: *
amprop: Which properties to get.; Values (separate with |): default
amenableparser: Set to enable parser, will preprocess the wikitext of message (substitute magic words, handle templates, etc.).; Type: boolean (details)
amnocontent: If set, do not include the content of the messages in the output.; Type: boolean (details)
amincludelocal: Also include local messages, i.e. messages that don't exist in the software but do exist as a MediaWiki: page. This lists all MediaWiki: pages, so it will also list those that aren't really messages such as Common.js.; Type: boolean (details)
amargs: Arguments to be substituted into message.; Separate values with |. Maximum number of values is 50 (500 for bots).
amfilter: Return only messages with names that contain this string.
amcustomised: Return only messages in this customisation state.; One of the following values: all, modified, unmodified; Default: all
amlang: Return messages in this language.
amfrom: Return messages starting at this message.
amto: Return messages ending at this message.
amtitle: Page name to use as context when parsing message (for amenableparser option).
amprefix: Return messages with this prefix.

Examples:

Show messages starting with ipb-.: api.php?action=query&meta=allmessages&amprefix=ipb- [open in sandbox]
Show messages august and mainpage in German.: api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de [open in sandbox]

meta=authmanagerinfo (ami)

(main | query | authmanagerinfo)

Source: MediaWiki
License: GPL-2.0+

Retrieve information about the current authentication status.

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

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: login, login-continue, create, create-continue, link, link-continue, change, 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, wikitext, raw, none; 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=filerepoinfo (fri)

(main | query | filerepoinfo)

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

Return meta information about image repositories configured on the wiki.

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

Parameter:

friprop

Which repository properties to get (there may be more available on some wikis):

apiurl: URL to the repository API - helpful for getting image info from the host.
name: The key of the repository - used in e.g. $wgForeignFileRepos and imageinfo return values.
displayname: The human-readable name of the repository wiki.
rooturl: Root URL for image paths.
local: Whether that repository is the local one or not.

Values (separate with |): name, displayname, rootUrl, local, url, thumbUrl, initialCapital, scriptDirUrl, scriptExtension, favicon, canUpload

Example:

Get information about file repositories.: api.php?action=query&meta=filerepoinfo&friprop=apiurl|name|displayname [open in sandbox]

meta=siteinfo (si)

(main | query | siteinfo)

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

Return general information about the site.

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

Parameters:

siprop

Which information to get:

general: Overall system information.
namespaces: List of registered namespaces and their canonical names.
namespacealiases: List of registered namespace aliases.
specialpagealiases: List of special page aliases.
magicwords: List of magic words and their aliases.
interwikimap: Returns interwiki map (optionally filtered, optionally localised by using siinlanguagecode).
dbrepllag: Returns database server with the highest replication lag.
statistics: Returns site statistics.
usergroups: Returns user groups and the associated permissions.
libraries: Returns libraries installed on the wiki.
extensions: Returns extensions installed on the wiki.
fileextensions: Returns list of file extensions (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).
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 |): general, namespaces, namespacealiases, specialpagealiases, magicwords, interwikimap, dbrepllag, statistics, usergroups, libraries, extensions, fileextensions, rightsinfo, restrictions, languages, skins, extensiontags, functionhooks, showhooks, variables, protocols, defaultoptions, uploaddialog

Default: general

sifilteriw

Return only local or only nonlocal entries of the interwiki map.

One of the following values: local, !local

sishowalldb

List all database servers, not just the one lagging the most.

Type: boolean (details)

sinumberingroup

Lists the number of users in user groups.

Type: boolean (details)

siinlanguagecode

Language code for localised language names (best effort) and skin names.

Examples:

Fetch site information.: api.php?action=query&meta=siteinfo&siprop=general|namespaces|namespacealiases|statistics [open in sandbox]
Fetch a list of local interwiki prefixes.: api.php?action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local [open in sandbox]
Check the current replication lag.: api.php?action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb= [open in sandbox]

meta=tokens

(main | query | tokens)

Source: MediaWiki
License: GPL-2.0+

Gets tokens for data-modifying actions.

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

Parameter:

type: Types of token to request.; Values (separate with |): createaccount, csrf, login, patrol, rollback, userrights, watch; 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)

(main | query | userinfo)

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

Get information about the current user.

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

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.
implicitgroups: Lists all the groups the current user is automatically a member of.
rights: Lists all the rights the current user has.
changeablegroups: Lists the groups the current user can add to and remove from.
options: Lists all preferences the current user has set.
preferencestoken: Deprecated. Get a token to change current user's preferences.
editcount: Adds the current user's edit count.
ratelimits: Lists all rate limits applying to the current user.
email: Adds the user's email address and email authentication date.
realname: Adds the user's real name.
acceptlang: Echoes the Accept-Language header sent by the client in a structured format.
registrationdate: Adds the user's registration date.
unreadcount: Adds the count of unread pages on the user's watchlist (maximum 999; returns 1000+ if more).
centralids: Adds the central IDs and attachment status for the user.

Values (separate with |): blockinfo, hasmsg, groups, implicitgroups, rights, changeablegroups, options, preferencestoken, editcount, ratelimits, email, realname, acceptlang, registrationdate, unreadcount, centralids

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]