MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
action=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.
- 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, gadgetcategories, gadgets, imageusage, iwbacklinks, langbacklinks, logevents, messagecollection, mystashedfiles, pagepropnames, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, search, tags, usercontribs, users, watchlist, watchlistraw
- meta
Which metadata to get.
- Values (separate with |): allmessages, authmanagerinfo, babel, filerepoinfo, languagestats, messagegroups, messagegroupstats, messagetranslations, 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, messagecollection, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
- redirects
Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.
- Type: boolean (details)
- converttitles
Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan, iu, kk, ku, shi, sr, tg, uz, zh.
- Type: boolean (details)
- 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]