API:Query

This page is part of the MediaWiki API documentation.

MediaWiki API

Quick overview:

• Quick start guide
• FAQ
  • Etiquette and usage limits
• Tutorial
• Formats
• Error reporting
• Restricting usage
• Authentication
  • Login
  • Logout
  • Account creation
• Queries
  • Meta information
  • Properties
  • Lists
• Search suggestions
• Expanding templates and rendering
• Purging pages' caches
• Parameter information
• Changing wiki content
  • Create and edit pages
  • Move pages
  • Rollback
  • Delete pages
  • Restore deleted revisions
  • (Un)protect pages
  • (Un)block users
  • (Un)watch pages
  • Send email
  • Patrol changes
  • Import pages
  • Change user group membership
  • Upload files
  • User options
• Watchlist feed
• Extensions
• Using the API in MediaWiki and extensions
• Miscellaneous
• Implementation
• Client code

The action=query module allows you to get most of the data stored in a wiki, including tokens for editing.

The query module has many submodules (called query modules), each with a different function. There are three types of query modules:

• Meta information about the wiki and the logged-in user
• Properties of pages, including page revisions and content
• Lists of pages that match certain criteria

Multiple modules should be used together to get what you need in one request, e.g. prop=info|revisions&list=backlinks|embeddedin|imagelinks&meta=userinfo is a call to six modules in one request.

Unlike meta and list modules, all property modules work on a set of pages provided with either titles, pageids, revids, or generator parameters. Use the first three if you know page's title/page id/revision id. Do not ask for one page at a time - this is very inefficient, and consumes lots of extra resources and bandwidth. You should combine multiple titles or ids with a "|"' symbol: titles=PageA|PageB|PageC.

Use generator if you want to get data about pages that are result of another api call. For example, if you want to get data about pages in a certain category (list=categorymembers), and than call api with pageids set to all the returned results, you should combine two calls into one by setting generator=categorymembers instead of the list parameter.

Lastly, you should always request the new "continue" syntax to iterate over results. To use it, always pass an empty continue= parameter, and check if the result contains a continue section. If it does, merge returned values with the original request and call the api again. Repeat until there is no more continue section.

Sample query

Before we get into the nitty-gritty, here's a useful sample query that simply gets the wiki markup (content) of a page:

api.php?action=query&prop=revisions&rvprop=content&format=xml&titles=Main%20Page

This means fetch (action=query) the content (rvprop=content) of the most recent revision of Main Page (titles=Main%20Page) in XML format (format=xml).

Alternatively, you can use action=raw as a parameter to index.php to get the content of a page: index.php?title=Main%20Page&action=raw

Specifying titles

You can specify titles in the following ways:

• Using the titles parameter, e.g. titles=Foo|Bar|Main_Page
• Using the pageids parameter, e.g. pageids=123|456|75915
• Using the revids parameter, e.g. revids=478198|54872|54894545
  • Most query modules will use the page the revision ID belongs to. Only prop=revisions actually uses the revision ID itself
• Using a generator

Specifying titles through the query string is limited to 50 titles per query (or 500 for those with the apihighlimits right, usually bots and sysops).

Title normalization

Title normalization converts page titles to their canonical form. This means capitalizing the first character, replacing underscores with spaces, and changing namespace to the localized form defined for that wiki. Title normalization is done automatically, regardless of which query modules are used. However, any trailing line breaks in page titles (\n) will cause odd behavior and they should be stripped out first.

Capitalization, localization, "_" => " ", "Project" => "Wikipedia", ...

api.php?action=query&titles=Project:articleA|article_B

Missing and invalid titles

Titles that don't exist or are invalid still appear in the <pages> section, but they have the missing="" or invalid="" attribute set. In output formats that support numeric array keys (such as JSON and PHP serialized), missing and invalid titles will have unique, negative page IDs. Query modules will just ignore missing or invalid titles, as they can't do anything useful with them. A missing title, an invalid one and an existing one in JSON

api.php?action=query&titles=Doesntexist|Main%20Page|Talk:&format=jsonfm

Titles in the Special: and Media: namespaces

Currently, titles in the Special: and Media: namespaces cannot be queried. If any such titles are found in the titles= parameter or passed to a module by a generator, a warning will be issued.

Resolving redirects

Redirects can be resolved automatically, so that the target of redirect is returned instead of the given title. The example below isn't really useful because it doesn't use any query modules, but shows how the redirects parameter works. Both normalization and redirection may take place. In case of double redirects, all redirects will be resolved, and in case of a circular redirect, there might not be a page in the 'pages' section (see also below). Redirect resolution cannot be used in combination with the revids= parameter or with a generator generating revids; doing that will produce a warning and will not resolve redirects for the specified revids.

Using "redirects" parameter. "Main page" is a redirect to "Main Page"

api.php?action=query&titles=Main%20page&redirects

Same request but without the "redirects" parameter.

api.php?action=query&titles=Main%20page

Without "redirects" you may want to use prop=info to obtain redirect status.

api.php?action=query&titles=Main%20page&prop=info

Circular redirects

Assume Page1 → Page2 → Page3 → Page1 (circular redirect). Also, in this example a non-normalized name 'page1' is used. Circular redirect behavior

api.php?action=query&titles=page1&redirects

Limits

See here for more information on limits.

Continuing queries

See legacy continue for the query-continue information

Very often you will not get all the data you want in one request. If there is more data, the result will have a continue element. Appending contained values to your original request will get the next portion of the data. Due to legacy reasons, until we introduce API 2.0, you should always include a continue= parameter to let the servers know you support this feature.

Using the query-continue value

api.php?action=query&list=allcategories&acprefix=List%20of&continue=

You can now add continue="-||" and accontinue="List of Baptist sub-denominations" to the original request (the new value for continue would replace the initial empty string) to get the next set of results. If there is no more results, there will not be a continue element.

Note that clients should not be manipulating or depending on any specifics of the values returned inside the continue element, as they may change.

Getting a list of page IDs

With the indexpageids parameter, you'll get a list of all page IDs listed in the <pageids> element. This is particularly useful for formats like JSON in which the pages array has numeric indexes. Getting a list of all page IDs

api.php?action=query&titles=Main%20Page|Fksdlfsdss|Talk:&indexpageids&format=jsonfm

Exporting pages

You can export pages through the API with the export parameter. If the export parameter is set, an XML dump of all pages in the <pages> element will be added to the result. The export parameter only gives a result when used with specified titles (Generator, titles, pageids or revid). Note that the XML dump will be wrapped in the requested format; if that format is XML, characters like < and > will be encoded as entities (&lt; and &gt;) If the exportnowrap parameter is also set, only the XML dump (not wrapped in an API result) will be returned.

Exporting the contents of API

api.php?action=query&titles=API&export&exportnowrap

Exporting all templates used in API

api.php?action=query&generator=templates&titles=API&export

See also: Importing pages

Generators

With generators, you can use the output of a list instead of the titles parameter. The output of the list must be a list of pages, whose titles are automatically used instead of the titles, pageids or revids parameter. Other query modules will treat those pages as if they were provided by the user through the titles parameter. Only one generator is allowed. Some prop modules can also be used as a generator.

Parameters passed to a generator must be prefixed with a g. For instance, when using generator=backlinks, use gbltitle instead of bltitle.

It should also be noted that generators only pass page titles to the 'real' query, and do not output any information themselves. Setting parameters like gcmprop will therefore have no effect.

Using list=allpages as generator

Get links and categories for the first three pages in the main namespace starting with "Ba"

api.php?action=query&generator=allpages&gaplimit=3&gapfrom=Ba&prop=links|categories

Generators and redirects

Here, we use prop=links as a generator. This query will get all the links from all the pages that are linked from Title. For this example, assume that Title has links to TitleA and TitleB. TitleB is a redirect to TitleC. TitleA links to TitleA1, TitleA2, TitleA3; and TitleC links to TitleC1 and TitleC2. Redirect are solved because the redirects parameter is set.

The query will execute the following steps:

1. Resolve redirects for titles in the titles parameter
2. For all the titles in the titles parameter, get the list of pages they link to
3. Resolve redirects in that list
4. Run the prop=links query on that list of titles

Using redirect resolution with generators

api.php?action=query&generator=links&titles=Title&prop=links&redirects

More generator examples

Show info about 4 pages starting at the letter "T"

http://en.wikipedia.org/w/api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info

Show content of first 2 non-redirect pages beginning at "Re"

http://en.wikipedia.org/w/api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content

Page types

Page Type	Example	Used in the given page(s)	Which pages have it	List all in the wiki
Page Link	[[Page]]	prop=links	list=backlinks	list=alllinks
Template transclusion	{{Template}}	prop=templates	list=embeddedin	list=alltransclusions
Categories	[[category:Cat]]	prop=categories	list=categorymembers	list=allcategories
Images	[[file:image.png]]	prop=images	list=imageusage	list=allimages
Language links	[[ru:Page]]	prop=langlinks	list=langbacklinks
Interwiki links	[[meta:Page]]	prop=iwlinks	list=iwbacklinks
URLs	http://mediawiki.org	prop=extlinks	list=exturlusage

Possible warnings

• No support for special pages has been implemented
  • Thrown if a title in the Special: or Media: namespace is given
• Redirect resolution cannot be used together with the revids= parameter. Any redirects the revids= point to have not been resolved.
  • Note that this can also be caused by a generator that generates revids