MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

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

action=query

(main | query)

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

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.

Specific parameters:

Other general parameters are available.

prop

Which properties to get for the queried pages.

categories: List all categories the pages belong to.
categoryinfo: Returns information about the given categories.
cirrusbuilddoc: Dump of a CirrusSearch article document from the database servers
cirruscompsuggestbuilddoc: Dump of the document used by the completion suggester
cirrusdoc: Dump of a CirrusSearch article document from the search servers
contributors: Get the list of logged-in contributors and the count of anonymous contributors to a page.
deletedrevisions: Get deleted revision information.
duplicatefiles: List all files that are duplicates of the given files based on hash values.
entityterms: Get the terms (labels, descriptions and aliases) of the entity on this page.
extlinks: Returns all external URLs (not interwikis) from the given pages.
extracts: Returns plain-text or limited HTML extracts of the given pages.
fileusage: Find all pages that use the given files.
imageinfo: Returns file information and upload history.
images: Returns all files contained on the given pages.
info: Get basic page information.
iwlinks: Returns all interwiki links from the given pages.
langlinks: Returns all interlanguage links from the given pages.
links: Returns all links from the given pages.
linkshere: Find all pages that link to the given pages.
pageimages: Returns information about images on the page, such as thumbnail and presence of photos.
pageprops: Get various page properties defined in the page content.
pageterms: Get the wbwh-test terms (typically labels, descriptions and aliases) associated with a page via a sitelink.
redirects: Returns all redirects to the given pages.
revisions: Get revision information.
stashimageinfo: Returns file information for stashed files.
templates: Returns all pages transcluded on the given pages.
transcludedin: Find all pages that transclude the given pages.
wbentityusage: Returns all entity IDs used in the given pages.
description: Internal. Get a short description a.k.a. subtitle explaining what the target page is about.
mapdata: Internal. Request all Kartographer map data for the given pages

Values (separate with | or alternative): categories, categoryinfo, cirrusbuilddoc, cirruscompsuggestbuilddoc, cirrusdoc, contributors, deletedrevisions, duplicatefiles, entityterms, extlinks, extracts, fileusage, imageinfo, images, info, iwlinks, langlinks, links, linkshere, pageimages, pageprops, pageterms, redirects, revisions, stashimageinfo, templates, transcludedin, wbentityusage, description, mapdata

list

Which lists to get.

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

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

meta

Which metadata to get.

allmessages: Return messages from this site.
authmanagerinfo: Retrieve information about the current authentication status.
filerepoinfo: Return meta information about image repositories configured on the wiki.
languageinfo: Return information about available languages.
notifications: Get notifications waiting for the current user.
siteinfo: Return general information about the site.
tokens: Gets tokens for data-modifying actions.
unreadnotificationpages: Get pages for which there are unread notifications for the current user.
userinfo: Get information about the current user.
wbcontentlanguages: Returns information about the content languages Wikibase accepts in different contexts.
wikibase: Get information about the Wikibase client and the associated Wikibase repository.

Values (separate with | or alternative): allmessages, authmanagerinfo, filerepoinfo, languageinfo, notifications, siteinfo, tokens, unreadnotificationpages, userinfo, wbcontentlanguages, wikibase

indexpageids

Include an additional pageids section listing all returned page IDs.

Type: boolean (details)

export

Export the current revisions of all given or generated pages.

Type: boolean (details)

exportnowrap

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

Type: boolean (details)

exportschema

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

One of the following values: 0.10, 0.11

Default: 0.11

iwurl

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

Type: boolean (details)

continue

When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.

rawcontinue

Return raw query-continue data for continuation.

Type: boolean (details)

titles

A list of titles to work on.

Separate values with | or alternative.

Maximum number of values is 50 (500 for clients that are allowed higher limits).

pageids

A list of page IDs to work on.

Type: list of integers

Separate values with | or alternative.

Maximum number of values is 50 (500 for clients that are allowed higher limits).

revids

A list of revision IDs to work on. Note that almost all query modules will convert revision IDs to the corresponding page ID and work on the latest revision instead. Only prop=revisions uses exact revisions for its response.

Type: list of integers

Separate values with | or alternative.

Maximum number of values is 50 (500 for clients that are allowed higher limits).

generator

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

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

allcategories: Enumerate all categories.
alldeletedrevisions: List all deleted revisions by a user or in a namespace.
allfileusages: List all file usages, including non-existing.
allimages: Enumerate all images sequentially.
alllinks: Enumerate all links that point to a given namespace.
allpages: Enumerate all pages sequentially in a given namespace.
allredirects: List all redirects to a namespace.
allrevisions: List all revisions.
alltransclusions: List all transclusions (pages embedded using {{x}}), including non-existing.
backlinks: Find all pages that link to the given page.
categories: List all categories the pages belong to.
categorymembers: List all pages in a given category.
deletedrevisions: Get deleted revision information.
duplicatefiles: List all files that are duplicates of the given files based on hash values.
embeddedin: Find all pages that embed (transclude) the given title.
exturlusage: Enumerate pages that contain a given URL.
fileusage: Find all pages that use the given files.
images: Returns all files contained on the given pages.
imageusage: Find all pages that use the given image title.
iwbacklinks: Find all pages that link to the given interwiki link.
langbacklinks: Find all pages that link to the given language link.
links: Returns all links from the given pages.
linkshere: Find all pages that link to the given pages.
pageswithprop: List all pages using a given page property.
prefixsearch: Perform a prefix search for page titles.
protectedtitles: List all titles protected from creation.
querypage: Get a list provided by a QueryPage-based special page.
random: Get a set of random pages.
recentchanges: Enumerate recent changes.
redirects: Returns all redirects to the given pages.
revisions: Get revision information.
search: Perform a full text search.
templates: Returns all pages transcluded on the given pages.
transcludedin: Find all pages that transclude the given pages.
watchlist: Get recent changes to pages in the current user's watchlist.
watchlistraw: Get all pages on the current user's watchlist.
wblistentityusage: Returns all pages that use the given entity IDs.
wbsearch: Internal. Searches for entities using labels and aliases.

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, wblistentityusage, wbsearch

redirects

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

Type: boolean (details)

converttitles

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

Type: boolean (details)

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]