MediaWiki API help

Which action to perform.

The format of the output.

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

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

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

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

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

Include the hostname that served the request in the results.

Include the current timestamp in the result.

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

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

What to do with aggregate message group.

Aggregate message group ID.

Message group ID.

Aggregate message group name.

Aggregate message group description.

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

The query string in ask-language

The query conditions, i.e. the requirements for a subject to be included

The query printouts, i.e. the properties to show per subject

The query parameters, i.e. all non-condition and non-printout arguments

Username, IP address, or IP range to block.

Expiry time. May be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). If set to infinite, indefinite, or never, the block will never expire.

Reason for block.

Block anonymous users only (i.e. disable anonymous edits for this IP address).

Prevent account creation.

Automatically block the last used IP address, and any subsequent IP addresses they try to login from.

Prevent user from sending email through the wiki. (Requires the blockemail right).

Hide the username from the block log. (Requires the hideuser right).

Allow the user to edit their own talk page (depends on $wgBlockAllowsUTEdit).

If the user is already blocked, overwrite the existing block.

Watch the user's or IP address's user and talk pages.

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

The subject to be queried

A particular subobject id for the related subject

Type of token being tested.

Token to test.

Maximum allowed age of the token, in seconds.

Search term to provide completions for.

Search context limiting the search, e.g. geo or category.

How many results to return.

First title to compare.

First page ID to compare.

First revision to compare.

Second title to compare.

Second page ID to compare.

Second revision to compare.

Username.

Password (ignored if mailpassword is set).

Domain for external authentication (optional).

Account creation token obtained in first request.

Email address of user (optional).

Real name of user (optional).

If set to any value, a random password will be emailed to the user.

Optional reason for creating the account to be put in the logs.

Language code to set as default for the user (optional, defaults to content language).

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

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

Reason for the deletion. If not set, an automatically generated reason will be used.

Add the page to the current user's watchlist.

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

Remove the page from the current user's watchlist.

The name of the old image to delete as provided by action=query&prop=imageinfo&iiprop=archivename.

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

A list of notification IDs to mark as read.

If set, marks all of a user's notifications as read.

A list of sections to mark as read.

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

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

Type of notifications to mark as seen: 'alert', 'message' or 'all'.

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

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

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

The title for a new section.

Page content.

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

Change tags to apply to the revision.

Minor edit.

Non-minor edit.

Mark this edit as bot.

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

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

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

Don't edit the page if it exists already.

Throw an error if the page doesn't exist.

Add the page to the current user's watchlist.

Remove the page from the current user's watchlist.

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

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

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

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

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

Undo this revision. Overrides text, prependtext and appendtext.

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

Automatically resolve redirects.

Content serialization format used for the input text.

Content model of the new content.

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

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

User to send email to.

Subject header.

Mail body.

Send a copy of this mail to me.

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

Title of page.

Wikitext to convert.

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

Which pieces of information to get.

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

wikitext

The expanded wikitext.

categories

Any categories present in the input that are not represented in the wikitext output.

properties

Page properties defined by expanded magic words in the wikitext.

volatile

Whether the output is volatile and should not be reused elsewhere within the page.

ttl

The maximum time after which caches of the result should be invalidated.

modules

Any ResourceLoader modules that parser functions have requested be added to the output. Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules.

jsconfigvars

Gives the JavaScript configuration variables specific to the page.

encodedjsconfigvars

Gives the JavaScript configuration variables specific to the page as a JSON string.

parsetree

The XML parse tree of the input.

Whether to include HTML comments in the output.

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

Id of the page (subject) to be displayed

Template to use for formatting

Printouts to send to the template

The format of the feed.

What users to get the contributions for.

Which namespace to filter the contributions by.

From year (and earlier).

From month (and earlier).

Filter contributions that have these tags.

Show only deleted contributions.

Only show edits that are latest revisions.

Only show edits that are page creations.

Show the size difference between revisions.

The format of the feed.

Namespace to limit the results to.

All namespaces but the selected one.

Include associated (talk or main) namespace.

Days to limit the results to.

Maximum number of results to return.

Show changes since then.

Hide minor changes.

Hide changes made by bots.

Hide changes made by anonymous users.

Hide changes made by registered users.

Hide patrolled changes.

Hide changes made by the current user.

Filter by tag.

Show only changes on pages linked from this page.

Show changes on pages linked to the selected page instead.

The format of the feed.

List pages modified within this many hours from now.

Link directly to changed sections if possible.

Include multiple revisions of the same page within given timeframe.

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

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

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

Which types of changes to show:

edit

Regular page edits.

external

External changes.

new

Page creations.

log

Log entries.

Don't list changes by this user.

Target filename, without the File: prefix.

Upload comment.

Archive name of the revision to revert to.

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

The Flickr URL to be tested.

When set, the complete blacklist is returned. Cannot be used together with url.

The Flow submodule to invoke.

The page to take the action on.

An edit token

State to put topic in, either "lock" or "unlock".

Reason for locking or unlocking the topic.

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

Revision ID of the current description revision, to check for edit conflicts.

Content for description.

Format of the description (wikitext|html)

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

Post ID.

Revision ID of the current post revision, to check for edit conflicts.

Content for post.

Format of the post content (wikitext|html)

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

Revision ID of the current title revision, to check for edit conflicts.

Content for title.

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

Revision ID of the current topic summary revision, if any, to check for edit conflicts.

Content for the summary.

Format of the summary (wikitext|html)

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

State to put topic in, either lock or unlock.

Reason for locking or unlocking the topic. Note, the on-wiki Flow client uses "Marked as resolved" here, and puts optional additional information in the summary.

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

What level to moderate at.

Reason for moderation.

ID of the post to moderate.

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

What level to moderate at.

Reason for moderation.

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

Text for new topic title.

Content for the topic's initial reply.

Format of the new topic's initial reply (wikitext|html)

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

Post ID to reply to.

Content for new post.

Format of the new post (wikitext|html)

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

Revision id to start undo at.

Revision id to end undo at.

Revision id to start undo at.

Revision id to end undo at.

Revision id to start undo at.

Revision id to end undo at.

Format to return the content in.

Load this revision, instead of the most recent.

ID of the post to view.

Format to return the content in.

ID of the post for which to view revision history.

Format to return the content in.

Format to return the content in.

Format to return the content in.

Load this revision, instead of the most recent.

Direction to order the topics.

Sorting option of the topics, either updated (ordered by topic update time), or newest (ordered by topic creation time).

Save sortby option to user preferences, if set.

Offset value (in UUID format) to start fetching topics at; used only with newest ordering

Offset value (as a topic update timestamp, in TS_MW format (YYYYMMDDHHMMSS)), to start fetching topics at; used only with updated ordering

Includes the offset item in the results as well

Number of topics to fetch.

Whether to respond with only the information required for the TOC

Format to convert content from.

Format to convert content to.

Content to be converted.

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

ID of the page. Cannot be used together with title.

The UUID of the post to thank for.

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

The locations to geocode

The geocoding service to use

Message group.

Language code.

The new state for the group.

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

Modules to display help for (values of the action and format parameters, or main). Can specify submodules with a +.

Include help for submodules of the named module.

Include help for submodules recursively.

Wrap the output in a standard API response structure.

Include a table of contents in the HTML output.

Degrees to rotate image clockwise.

When more results are available, use this to continue.

A list of titles to work on.

A list of page IDs to work on.

A list of revision IDs to work on.

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.

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

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.

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

Import summary.

Uploaded XML file.

For interwiki imports: wiki to import from.

For interwiki imports: page to import.

For interwiki imports: import the full history, not just the current version.

For interwiki imports: import all included templates as well.

Import to this namespace. Cannot be used together with rootpage.

Import as subpage of this page. Cannot be used together with namespace.

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

Search string.

Number of spelling mistakes allowed in the search string.

User name.

Password.

Domain (optional).

Login token obtained in first request.

Which operation to perform:

create

Create a new change tag for manual use.

delete

Remove a change tag from the database, including removing the tag from all revisions, recent change entries and log entries on which it is used.

activate

Activate a change tag, allowing users to apply it manually.

deactivate

Deactivate a change tag, preventing users from applying it manually.

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

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

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

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

Title of the page to rename. Cannot be used together with fromid.

Page ID of the page to rename. Cannot be used together with from.

Title to rename the page to.

Reason for the rename.

Rename the talk page, if it exists.

Rename subpages, if applicable.

Don't create a redirect.

Add the page and the redirect to the current user's watchlist.

Remove the page and the redirect from the current user's watchlist.

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

Ignore any warnings.

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

Search string.

Maximum number of results to return.

Namespaces to search.

Do nothing if $wgEnableOpenSearchSuggest is false.

How to handle redirects:

return

Return the redirect itself.

resolve

Return the target page. May return fewer than limit results.

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

The format of the output.

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

Resets preferences to the site defaults.

List of types of options to reset when the reset option is set.

List of changes, formatted name=value (e.g. skin=vector). Value cannot contain pipe characters. If no value is given (not even an equals sign), e.g., optionname|otheroption|..., the option will be reset to its default value.

The name of the option that should be set to the value given by optionvalue.

The value for the option specified by optionname, can contain pipe characters.

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

List of module names (values of the action and format parameters, or main). Can specify submodules with a +.

Format of help strings.

List of query module names (value of prop, meta or list parameter). Use modules=query+foo instead of querymodules=foo.

Get information about the main (top-level) module as well. Use modules=main instead.

Get information about the pageset module (providing titles= and friends) as well.

List of format module names (value of format parameter). Use modules instead.

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

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

Summary to parse.

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

Parse the content of this page. Overrides page.

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

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

Which pieces of information to get:

text

Gives the parsed text of the wikitext.

langlinks

Gives the language links in the parsed wikitext.

categories

Gives the categories in the parsed wikitext.

categorieshtml

Gives the HTML version of the categories.

links

Gives the internal links in the parsed wikitext.

templates

Gives the templates in the parsed wikitext.

images

Gives the images in the parsed wikitext.

externallinks

Gives the external links in the parsed wikitext.

sections

Gives the sections in the parsed wikitext.

revid

Adds the revision ID of the parsed page.

displaytitle

Adds the title of the parsed wikitext.

headitems

Gives items to put in the <head> of the page.

headhtml

Gives parsed <head> of the page.

modules

Gives the ResourceLoader modules used on the page. Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules.

jsconfigvars

Gives the JavaScript configuration variables specific to the page.

encodedjsconfigvars

Gives the JavaScript configuration variables specific to the page as a JSON string.

indicators

Gives the HTML of page status indicators used on the page.

iwlinks

Gives interwiki links in the parsed wikitext.

wikitext

Gives the original wikitext that was parsed.

properties

Gives various properties defined in the parsed wikitext.

limitreportdata

Gives the limit report in a structured way. Gives no data, when disablelimitreport is set.

limitreporthtml

Gives the HTML version of the limit report. Gives no data, when disablelimitreport is set.

parsetree

The XML parse tree of revision content (requires content model wikitext)

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

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

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

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

new section is only honored when specifying text.

New section title when section is new.

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

Use disablelimitreport instead.

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

Omit edit section links from the parser output.

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

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

Parse in preview mode.

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

Omit table of contents in output.

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

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

Recentchanges ID to patrol.

Revision ID to patrol.

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

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

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

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

Note: Any actions not listed will have restrictions removed.

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

Reason for (un)protecting.

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

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

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

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

Update the links tables.

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

When more results are available, use this to continue.

A list of titles to work on.

A list of page IDs to work on.

A list of revision IDs to work on.

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.

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

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.

Which properties to get for the queried pages.

Which lists to get.

Which metadata to get.

Include an additional pageids section listing all returned page IDs.

Export the current revisions of all given or generated pages.

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

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

When more results are available, use this to continue.

Return raw query-continue data for continuation.

A list of titles to work on.

A list of page IDs to work on.

A list of revision IDs to work on.

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.

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

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.

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

Which kind of categories to show.

How many categories to return.

When more results are available, use this to continue.

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

The direction in which to list.

When more results are available, use this to continue.

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

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

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

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

How many contributors to return.

When more results are available, use this to continue.

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

Limit how many revisions will be returned.

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

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

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

Only retrieve the content of this section number.

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

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.

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

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

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

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.

Only list revisions tagged with this tag.

Only list revisions by this user.

Don't list revisions by this user.

When more results are available, use this to continue.

How many duplicate files to return.

When more results are available, use this to continue.

The direction in which to list.

Look only for files in the local repository.

How many links to return.

When more results are available, use this to continue.

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.

Search string without protocol. Useful for checking whether a certain page contains a certain external url.

Expand protocol-relative URLs with the canonical protocol.

Which properties to get:

pageid

Page ID of each page.

title

Title of each page.

redirect

Flag if the page is a redirect.

Only include pages in these namespaces.

Show only items that meet these criteria:

redirect

Only show redirects.

!redirect

Only show non-redirects.

How many to return.

When more results are available, use this to continue.

Which properties to return:

url

Adds url.

pageid

Adds page ID.

namespace

Adds namespace ID.

How many links to return.

When more results are available, use this to continue.

Filter local usage of the file.

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.

How many file revisions to return per file.

Timestamp to start listing from.

Timestamp to stop listing at.

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.

Similar to iiurlwidth.

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

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.

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

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

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

When more results are available, use this to continue.

Look only for files in the local repository.

How many files to return.

When more results are available, use this to continue.

Only list these files. Useful for checking whether a certain page has a certain file.

The direction in which to list.

Which additional properties to get:

protection

List the protection level of each page.

talkid

The page ID of the talk page for each non-talk page.

watched

List the watched status of each page.

watchers

The number of watchers, if allowed.

notificationtimestamp

The watchlist notification timestamp of each page.

subjectid

The page ID of the parent page for each talk page.

url

Gives a full URL, an edit URL, and the canonical URL for each page.

readable

Whether the user can read this page.

preload

Gives the text returned by EditFormPreloadText.

displaytitle

Gives the manner in which the page title is actually displayed.

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

Use action=query&meta=tokens instead.

When more results are available, use this to continue.

Which additional properties to get for each interlanguage link:

url

Adds the full URL.

Only return interwiki links with this prefix.

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

The direction in which to list.

How many interwiki links to return.

When more results are available, use this to continue.

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

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.

Only return language links with this language code.

Link to search for. Must be used with lllang.

The direction in which to list.

Language code for localised language names.

How many langlinks to return.

When more results are available, use this to continue.

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

Show links in these namespaces only.

How many links to return.

When more results are available, use this to continue.

Only list links to these titles. Useful for checking whether a certain page links to a certain title.

The direction in which to list.

Which properties to get:

pageid

Page ID of each page.

title

Title of each page.

redirect

Flag if the page is a redirect.

Only include pages in these namespaces.

Show only items that meet these criteria:

redirect

Only show redirects.

!redirect

Only show non-redirects.

How many to return.

When more results are available, use this to continue.

When more results are available, use this to continue.

Only list these props. Useful for checking whether a certain page uses a certain page prop.

When more results are available, use this to continue.

The types of terms to get, e.g. 'description'. If not specified, all types are returned.

Which properties to get:

pageid

Page ID of each redirect.

title

Title of each redirect.

fragment

Fragment of each redirect, if any.

Only include pages in these namespaces.

Show only items that meet these criteria:

fragment

Only show redirects with a fragment.

!fragment

Only show redirects without a fragment.

How many redirects to return.

When more results are available, use this to continue.

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

Limit how many revisions will be returned.

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

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

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

Only retrieve the content of this section number.

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

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.

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

From which revision ID to start enumeration.

Stop revision enumeration on this revision ID.

From which revision timestamp to start enumeration.

Enumerate up to this timestamp.

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.

Only include revisions made by user.

Exclude revisions made by user.

Only list revisions tagged with this tag.

Which tokens to obtain for each revision.

When more results are available, use this to continue.

Key that identifies a previous upload that was stashed temporarily.

Alias for siifilekey, for backward compatibility.

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.

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.

Similar to siiurlwidth.

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

Show templates in this namespaces only.

How many templates to return.

When more results are available, use this to continue.

Only list these templates. Useful for checking whether a certain page uses a certain template.

The direction in which to list.

Which properties to get:

pageid

Page ID of each page.

title

Title of each page.

redirect

Flag if the page is a redirect.

Only include pages in these namespaces.

Show only items that meet these criteria:

redirect

Only show redirects.

!redirect

Only show non-redirects.

How many to return.

When more results are available, use this to continue.

What video information to get:

timestamp

Adds timestamp for the uploaded version.

user

Adds the user who uploaded the video version.

userid

Add the user ID that uploaded the video version.

comment

Comment on the version.

parsedcomment

Parse the comment on the version.

canonicaltitle

Adds the canonical title of the video file.

url

Gives URL to the video and the description page.

size

Adds the size of the video in bytes, its height and its width. Page count and duration are added if applicable.

dimensions

Alias for size.

sha1

Adds SHA-1 hash for the video.

mime

Adds MIME type of the video.

thumbmime

Adds MIME type of the video thumbnail (requires url and param viurlwidth).

mediatype

Adds the media type of the video.

metadata

Lists Exif metadata for the version of the video.

commonmetadata

Lists file format generic metadata for the version of the video.

extmetadata

Lists formatted metadata combined from multiple sources. Results are HTML formatted.

archivename

Adds the filename of the archive version for non-latest versions.

bitdepth

Adds the bit depth of the version.

uploadwarning

Used by the Special:Upload page to get information about an existing file. Not intended for use outside MediaWiki core.

derivatives

Adds an array of the different format and quality versions of an audio or video file that are available.

How many file revisions to return per file.

Timestamp to start listing from.

Timestamp to stop listing at.

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

Similar to viurlwidth.

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

When more results are available, use this to continue.

Only list campaigns that are enabled.

Number of campaigns to return.

When more results are available, use this to continue.

The category to start enumerating from.

When more results are available, use this to continue.

The category to stop enumerating at.

Search for all category titles that begin with this value.

Direction to sort in.

Only return categories with at least this many members.

Only return categories with at most this many members.

How many categories to return.

Which properties to get:

size

Adds number of pages in the category.

hidden

Tags categories that are hidden with __HIDDENCAT__.

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

Limit how many revisions will be returned.

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

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

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

Only retrieve the content of this section number.

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

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.

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

Only list revisions by this user.

Only list pages in this namespace.

The timestamp to start enumerating from.

The timestamp to stop enumerating at.

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.

Start listing at this title.

Stop listing at this title.

Search for all page titles that begin with this value.

Don't list revisions by this user.

Only list revisions tagged with this tag.

When more results are available, use this to continue.

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

When more results are available, use this to continue.

The title of the file to start enumerating from.

The title of the file to stop enumerating at.

Search for all file titles that begin with this value.

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

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.

How many total items to return.

The direction in which to list.

Property to sort by.

The direction in which to list.

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

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

When more results are available, use this to continue.

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

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

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.

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

Limit to images with at least this many bytes.

Limit to images with at most this many bytes.

SHA1 hash of image. Overrides aisha1base36.

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

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

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

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

How many images in total to return.

When more results are available, use this to continue.

The title of the link to start enumerating from.

The title of the link to stop enumerating at.

Search for all linked titles that begin with this value.

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

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.

The namespace to enumerate.

How many total items to return.

The direction in which to list.

The page title to start enumerating from.

When more results are available, use this to continue.

The page title to stop enumerating at.

Search for all page titles that begin with this value.

The namespace to enumerate.

Which pages to list.

Limit to pages with at least this many bytes.

Limit to pages with at most this many bytes.

Limit to protected pages only.

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

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

How many total pages to return.

The direction in which to list.

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

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.

When more results are available, use this to continue.

The title of the redirect to start enumerating from.

The title of the redirect to stop enumerating at.

Search for all target pages that begin with this value.

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.

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

The namespace to enumerate.

How many total items to return.

The direction in which to list.

When more results are available, use this to continue.

The title of the transclusion to start enumerating from.

The title of the transclusion to stop enumerating at.

Search for all transcluded titles that begin with this value.

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

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.

The namespace to enumerate.

How many total items to return.

The direction in which to list.

The user name to start enumerating from.

The user name to stop enumerating at.

Search for all users that begin with this value.

Direction to sort in.

Only include users in the given groups.

Exclude users in the given groups.

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

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

How many total user names to return.

Only list users who have made edits.

Only list users active in the last 30 days.

Title to search. Cannot be used together with blpageid.

Page ID to search. Cannot be used together with bltitle.

When more results are available, use this to continue.

The namespace to enumerate.

The direction in which to list.

How to filter for redirects. If set to nonredirects when blredirect is enabled, this is only applied to the second level.

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

If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.

The timestamp to start enumerating from.

The timestamp to stop enumerating at.

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.

List of block IDs to list (optional).

List of users to search for (optional).

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

The maximum number of blocks to list.

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

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

When more results are available, use this to continue.

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

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

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.

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

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

When more results are available, use this to continue.

The maximum number of pages to return.

Property to sort by.

In which direction to sort.

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

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

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

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

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

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.

Use cmstarthexsortkey instead.

Use cmendhexsortkey instead.

The timestamp to start enumerating from.

The timestamp to stop enumerating at.

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.

Start listing at this title.

Stop listing at this title.

Search for all page titles that begin with this value.

List only one revision for each page.

Only list pages in this namespace.

Only list revisions tagged with this tag.

Only list revisions by this user.

Don't list revisions by this user.

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.

The maximum amount of revisions to list.

When more results are available, use this to continue.

Title to search. Cannot be used together with eipageid.

Page ID to search. Cannot be used together with eititle.

When more results are available, use this to continue.

The namespace to enumerate.

The direction in which to list.

How to filter for redirects.

How many total pages to return.

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.

When more results are available, use this to continue.

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.

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

The page namespaces to enumerate.

How many pages to return.

Expand protocol-relative URLs with the canonical protocol.

The image title to start enumerating from.

The image title to stop enumerating at.

Search for all image titles that begin with this value.

The direction in which to list.

SHA1 hash of image. Overrides fasha1base36.

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

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.

How many images to return in total.

When more results are available, use this to continue.

What gadget category information to get:

name

Internal category name.

title

Category title.

members

Number of gadgets in category.

Names of categories to retrieve.

What gadget information to get:

id

Internal gadget ID.

metadata

The gadget metadata.

desc

Gadget description transformed into HTML (can be slow, use only if really needed).

Gadgets from what categories to retrieve.

IDs of gadgets to retrieve.

List only gadgets allowed to current user.

List only gadgets enabled by current user.

Title to search. Cannot be used together with iupageid.

Page ID to search. Cannot be used together with iutitle.

When more results are available, use this to continue.

The namespace to enumerate.

The direction in which to list.

How to filter for redirects. If set to nonredirects when iuredirect is enabled, this is only applied to the second level.

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

If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.

Prefix for the interwiki.

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

When more results are available, use this to continue.

How many total pages to return.

Which properties to get:

iwprefix

Adds the prefix of the interwiki.

iwtitle

Adds the title of the interwiki.