API:Lists

MediaWiki Action API
Basics All Query modules Get properties of pages List pages matching a criterion Get module parameters information Get meta information about the wiki and user Authentication Get tokens for data modifying operations Login Logout Assert user Accounts and Users Create an account Block or unblock a user Get the current user's watchlist as a feed Change user options Change user group membership Send an email Page Operations Parse content of a page Create and edit a page Upload a file Import a page Delete a page Watch or unwatch a page Purge cache for page(s) Rollback a page Move a page Patrol a page or revision Restore revisions of a deleted page Change a page's protection level Change a page's language More... Search Search for a title or text Fetch results in an OpenSearch format Search for wiki pages near a location Search for a language Perform a prefix search for page titles Developer Utilities Access libraries Cross-site requests Creating an API module in an extension Using the API in MediaWiki and extensions Restricting API usage Localisation Implementation strategy

Lists differ from properties in two aspects - instead of appending data to the elements in the pages element, each list has its own separated branch in the query element. To use the list API, specify action=query&list=list1|list2|... in the URL. Also, list output is limited by number of items, and may be continued using the query-continue element. Unless indicated otherwise, modules listed on this page can be used as generators.

Submodules

Browse all in a single page

• allcategories
• alldeletedrevisions
• allfileusages
• allimages
• alllinks
• allpages
• allredirects
• allrevisions
• alltransclusions
• allusers
• backlinks
• blocks
• categorymembers
• deletedrevs
• embeddedin
• exturlusage
• filearchive
• imageusage
• iwbacklinks
• langbacklinks
• logevents
• pagepropnames
• pageswithprop
• prefixsearch
• protectedtitles
• querypage
• random
• recentchanges
• search
• tags
• usercontribs
• users
• watchlist
• watchlistraw

Limits

All list queries return a limited number of results. This limit is 10 by default, and can be set as high as 500 for regular users, or 5000 for users with the apihighlimits right (typically bots and sysops). The limit parameter for a given module consists of the module prefix followed by limit, so ptlimit is the maximum number of protectedtitles returned, and cmlimit is the maximum number of categorymembers returned. Some modules impose stricter limits under certain conditions. If you're not sure which limit applies to you and just want as many results as possible, set the limit to max. In that case, a <limits> element will be returned, specifying the limits used.

Warnings

If you set the limit to a value higher than the maximum, a warning will be thrown, which looks like:

Code	Info
allpages	aplimit may not be over 500 (set to 1000) for users.

ap can be replaced with any other module prefix. The ap prefix corresponds to the list=allpages parameter

Example

Getting the maximum amount of revisions with content and backlinks for w:Winnipeg, Manitoba

api.php?action=query&titles=Winnipeg,_Manitoba&prop=revisions&rvlimit=max&rvprop=content&list=backlinks&bltitle=Winnipeg,_Manitoba&bllimit=max [try in ApiSandbox]