API:Query

From MediaWiki.org
Jump to: navigation, search
Language: English  • Deutsch • español • فارسی • 日本語 • русский • 中文
Tools clipart.png This page is part of the MediaWiki action API documentation.
MediaWiki APIsAPI:Main page



MediaWiki action API

v · d · e

The action=query module allows you to get information about a wiki and the data stored in it, such as the wikitext of a particular page, the links and categories of a set of pages, or the token you need to change wiki content.

Introduction and guidelines[edit source]

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

You should use multiple query modules together to get what you need in one request, e.g. prop=info|revisions&list=backlinks|embeddedin|allimages&meta=userinfo is a call to six modules in one request.

Unlike meta and list query modules, all property query modules work on a set of pages that you specify using either titles, pageids, revids, or generator parameters. Use one of the first three if you know the pages' titles, page ids, or revision ids. Do not ask for one page at a time – this is very inefficient, and consumes lots of extra resources and bandwidth. Instead you should request information about multiple pages by combining their titles or ids with the '|' pipe symbol: titles=PageA|PageB|PageC.

Use generator if you want to get data about a set of pages that would be the result of another API call. For example, if you want to get data about pages in a certain category, instead of querying list=categorymembers and then querying again with pageids set to all the returned pages, you should combine the two API calls into one by specifying generator=categorymembers in place of the list parameter. More details are in #Generators below.

If you're querying Wikimedia wikis and requesting results as format=json (or php), then specify formatversion=2. The original result format was designed around XML; the new structure is easier to process (and defaults to utf8). However, it is still subject to change in MediaWiki 1.26.

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 its returned values with your original request and call the api again. Repeat until there is no more continue section. More details are in #Continuing queries below.

Sample query[edit source]

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=jsonfm&titles=Main%20Page

This means fetch (action=query) the content (rvprop=content) of the most recent revision of Main Page (titles=Main%20Page) in JSON with whitespace to make it easier to read (format=jsonfm).

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 pages[edit source]

You can specify pages in the following ways:

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

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

Title normalization[edit source]

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, "_" → " " (space), "Project" → "Wikipedia", ...

api.php?action=query&titles=Project:articleA|article_B [try in ApiSandbox]
Result 
{
    "query": {
        "normalized": [
            {
                "from": "Project:articleA",
                "to": "Wikipedia:ArticleA"
            },
            {
                "from": "article_B",
                "to": "Article B"
            }
        ],
        "pages": {
            "-1": {
                "ns": 4,
                "title": "Wikipedia:ArticleA",
                "missing": ""
            },
            "-2": {
                "ns": 0,
                "title": "Article B",
                "missing": ""
            }
        }
    }
}

Missing and invalid titles[edit source]

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

A missing title, an invalid one and an existing one in JSON

api.php?action=query&titles=Doesntexist|Main%20Page|Talk:&format=jsonfm [try in ApiSandbox]
Result 
{
	"query": {
		"pages": {
			"-2": {
				"ns": 0,
				"title": "Doesntexist",
				"missing": ""
			},
			"-1": {
				"title": "Talk:",
				"invalid": ""
			},
			"54": {
				"pageid": 54,
				"ns": 0,
				"title": "Main Page",
			}
		}
	}
}

Resolving redirects[edit source]

Redirects can be resolved automatically, so that the target of a redirect is returned instead of the given title. When present, they will always contain from and to attributes and may contain a tofragment attribute for those redirects that point to specific sections.

Both normalization and redirection may take place. In the case of multiple 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.

The examples below show how the redirects parameter works.

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

api.php?action=query&titles=Main%20page&redirects [try in ApiSandbox]
Result 
{
    "query": {
        "redirects": [
            {
                "from": "Main page",
                "to": "Main Page"
            }
        ],
        "pages": {
            "1": {
                "pageid": 1,
                "ns": 0,
                "title": "Main Page"
            }
        }
    }
}

Same request but without the "redirects" parameter.

api.php?action=query&titles=Main%20page [try in ApiSandbox]
Result 
{
    "query": {
        "pages": {
            "3": {
                "pageid": 3,
                "ns": 0,
                "title": "Main page"
            }
        }
    }
}

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

api.php?action=query&titles=Main%20page&prop=info [try in ApiSandbox]
Result 
{
    "query": {
        "pages": {
            "3": {
                "pageid": 3,
                "ns": 0,
                "title": "Main page",
                "contentmodel": "wikitext",
                "pagelanguage": "en",
                "touched": "2015-02-21T13:03:17Z",
                "lastrevid": 3,
                "length": 23,
                "redirect": "",
            }
        }
    }
}

Request with a section link. "Wikipedia:!--" is a redirect to "Wikipedia:Manual of Style#Invisible comments"

api.php?action=query&titles=Wikipedia:!--&redirects [try in ApiSandbox]
Result 
{
    "query": {
        "redirects": [
            {
                "from": "Wikipedia:!--",
                "to": "Wikipedia:Manual of Style",
                "tofragment": "Invisible comments"
            }
        ],
        "pages": {
            "33697": {
                "pageid": 33697,
                "ns": 4,
                "title": "Wikipedia:Manual of Style"
            }
        }
    }
}

Here is a case of a circular redirect: Page1 → Page2 → Page3 → Page1. Also, in this example a non-normalized name 'page1' is used.

api.php?action=query&titles=page1&redirects [try in ApiSandbox]
Result 
{
    "query": {
        "normalized": [
            {
                "from": "page1",
                "to": "Page1"
            }
        ],
        "redirects": [
            {
                "from": "Page1",
                "to": "Page2"
            },
            {
                "from": "Page2",
                "to": "Page3"
            },
            {
                "from": "Page3",
                "to": "Page1"
            }
        ]
    }
}

Limits[edit source]

See here for more information on limits.

Continuing queries[edit source]

MediaWiki version: ≥ 1.21
Warning Warning: See #Backwards compatibility of continue below for breaking changes to continue handling in MediaWiki 1.26

Very often you will not get all the data you want in one API query. When that happens the API result indicates there is more data. MediaWiki 1.21 introduced a coherent way of handling this: the result will have a continue element, and to get the next portion of the data, you make another request appending the values in the continue element. You must specify continue= in the initial query to select this approach, although we plan to make it the default in 1.26; see #Backwards compatibility of continue below.

Example of using the continue value

api.php?action=query&list=allcategories&acprefix=List%20of&continue= [try in ApiSandbox]
Result 
{
    "continue": {
        "accontinue": "List_of_19th_century_baseball_players",
        "continue": "-||"
    },
    "batchcomplete": "",
    "query": {
        "allcategories": [
            {
                "*": "List of"
            },
            {
                "*": "List ofPalestinians"
            },
            {
                "*": "List of \"M\" series military vehicles"
            },
            {
                "*": "List of ''The Fast and the Furious'' characters"
            },
            {
                "*": "List of 100 Deeds for Eddie McDowd"
            },
            {
                "*": "List of 1919 Actors"
            },
            {
                "*": "List of 1972 births"
            },
            {
                "*": "List of 1999 ballet premieres"
            },
            {
                "*": "List of 19th-century Russian artists"
            },
            {
                "*": "List of 19th century Russian artists"
            }
        ]
    }
}

Because there are more data matching the query, the API result includes a continue element. If you want further data, you would add its values (in the example, continue=-|| and accontinue=List_of_19th_century_baseball_players) to the original request (the new value for continue replaces the initial empty string) to get the next set of results. You continue to do this until an API result does not have a continue element, indicating there are no more data matching the query.

Here is Python code showing how to iterate over query results (using the python requests lib). Note you should not manipulate or depend on any specifics of the values returned inside the continue element, as they may change.

for result in query({'generator': 'allpages', 'prop': 'links'}):
    # process result data
...
def query(request):
    request['action'] = 'query'
    request['format'] = 'json'
    lastContinue = {'continue': ''}
    while True:
        # Clone original request
        req = request.copy()
        # Modify it with the values returned in the 'continue' section of the last result.
        req.update(lastContinue)
        # Call API
        result = requests.get('http://en.wikipedia.org/w/api.php', params=req).json()
        if 'error' in result:
            raise Error(result['error'])
        if 'warnings' in result:
            print(result['warnings'])
        if 'query' in result:
            yield result['query']
        if 'continue' not in result:
            break
        lastContinue = result['continue']

batchcomplete[edit source]

When you make an API request using a generator together with properties, the API result may signal to continue because there are more properties to retrieve for the pages so far, or because there are more pages from the generator, or both. From version 1.25 onwards, the API returns a batchcomplete element to indicate that all data for the current "batch" of pages has been returned. This can be useful to avoid building a combined result set for thousands of pages when using a generator together with prop modules that may themselves need continuation.

Backwards compatibility of continue[edit source]

Prior to MediaWiki 1.26, if you did not specify continue=, API results would indicate there is additional data by returning a query-continue element, explained in Raw query continue. In the 1.26 development cycle in July, API results will switch by default to the continue element approach described above.

  • If you don't handle continuation at all, you don't need to do anything.
  • If your client code handles the old query-continue and you don't want to adopt the new approach, then you must specify rawcontinue= to to get continuation data in the old format, otherwise your code will break when the default continuation handling changes.
    • rawcontinue was added in MediaWiki 1.24, if you specify it in API requests to MediaWiki installs running prior releases the API response will include an API warning.

Getting a list of page IDs[edit source]

When not using the new JSON formatversion=2, the result page set in JSON is returned as an object keyed by page ID which can be difficult to properly iterate over in JavaScript. The indexpageids parameter returns these page IDs as an array for easier iteration. Note that the ordering of these page IDs still does not necessarily correspond to the ordering of the input (whether directly or via a generator). Getting a list of all page IDs

api.php?action=query&titles=Main%20Page|Fksdlfsdss|Talk:&indexpageids=&format=jsonfm [try in ApiSandbox]
Result 
{
	"query": {
		"pageids": [
			"-2",
			"-1",
			"15580374"
		],
		"pages": {
			"-2": {
				"ns": 0,
				"title": "Fksdlfsdss",
				"missing": ""
			},
			"-1": {
				"title": "Talk:",
				"invalid": ""
			},
			"15580374": {
				"pageid": 15580374,
				"ns": 0,
				"title": "Main Page"
			}
		}
	}
}

Exporting pages[edit source]

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 [try in ApiSandbox]
Result 
<mediawiki xsi:schemaLocation="http://www.mediawiki.org/xml/export-0.10/ http://www.mediawiki.org/xml/export-0.10.xsd" version="0.10" xml:lang="en">
  <siteinfo>
    <sitename>Wikipedia</sitename>
    <dbname>enwiki</dbname>
    <base>https://en.wikipedia.org/wiki/Main_Page</base>
    <generator>MediaWiki 1.28.0-wmf.13</generator>
    <case>first-letter</case>
    <namespaces>
      <namespace key="-2" case="first-letter">Media</namespace>
      <namespace key="-1" case="first-letter">Special</namespace>
      <namespace key="0" case="first-letter"/>
      <namespace key="1" case="first-letter">Talk</namespace>
      <namespace key="2" case="first-letter">User</namespace>
      <namespace key="3" case="first-letter">User talk</namespace>
      <namespace key="4" case="first-letter">Wikipedia</namespace>
      <namespace key="5" case="first-letter">Wikipedia talk</namespace>
      <namespace key="6" case="first-letter">File</namespace>
      <namespace key="7" case="first-letter">File talk</namespace>
      <namespace key="8" case="first-letter">MediaWiki</namespace>
      <namespace key="9" case="first-letter">MediaWiki talk</namespace>
      <namespace key="10" case="first-letter">Template</namespace>
      <namespace key="11" case="first-letter">Template talk</namespace>
      <namespace key="12" case="first-letter">Help</namespace>
      <namespace key="13" case="first-letter">Help talk</namespace>
      <namespace key="14" case="first-letter">Category</namespace>
      <namespace key="15" case="first-letter">Category talk</namespace>
      <namespace key="100" case="first-letter">Portal</namespace>
      <namespace key="101" case="first-letter">Portal talk</namespace>
      <namespace key="108" case="first-letter">Book</namespace>
      <namespace key="109" case="first-letter">Book talk</namespace>
      <namespace key="118" case="first-letter">Draft</namespace>
      <namespace key="119" case="first-letter">Draft talk</namespace>
      <namespace key="446" case="first-letter">Education Program</namespace>
      <namespace key="447" case="first-letter">Education Program talk</namespace>
      <namespace key="710" case="first-letter">TimedText</namespace>
      <namespace key="711" case="first-letter">TimedText talk</namespace>
      <namespace key="828" case="first-letter">Module</namespace>
      <namespace key="829" case="first-letter">Module talk</namespace>
      <namespace key="2300" case="first-letter">Gadget</namespace>
      <namespace key="2301" case="first-letter">Gadget talk</namespace>
      <namespace key="2302" case="case-sensitive">Gadget definition</namespace>
      <namespace key="2303" case="case-sensitive">Gadget definition talk</namespace>
      <namespace key="2600" case="first-letter">Topic</namespace>
    </namespaces>
  </siteinfo>
  <page>
    <title>API</title>
    <ns>0</ns>
    <id>27697087</id>
    <redirect title="Application programming interface"/>
    <revision>
      <id>367741756</id>
      <parentid>367741564</parentid>
      <timestamp>2010-06-13T08:41:17Z</timestamp>
      <contributor>
        <username>Graham87</username>
        <id>194203</id>
      </contributor>
      <minor/>
      <comment>Protected API: restore protection ([edit=sysop] (indefinite) [move=sysop] (indefinite))</comment>
      <model>wikitext</model>
      <format>text/x-wiki</format>
      <text xml:space="preserve" bytes="70">#REDIRECT [[Application programming interface]]{{R from abbreviation}}</text>
      <sha1>hehu8mw35upjd9zpmt1ze1mp4pcg7dn</sha1>
    </revision>
  </page>
</mediawiki>

Exporting all templates used in API

api.php?action=query&generator=templates&titles=API&export&format=xml [try in ApiSandbox]
Result 
<?xml version="1.0"?>
<api>
  <query>
    <pages>
      <page pageid="16385" ns="10" title="Template:API Intro" />
      <page pageid="6458" ns="10" title="Template:Languages" />
      <page pageid="9631" ns="10" title="Template:Languages/Lang" />
    </pages>
    <export>
      <!-- XML dump here -->
    </export>
  </query>
</api>

See also: Importing pages

Generators[edit source]

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 generated pages as if they were given in a parameter. Only one generator is allowed.

Some property modules can also be used as a generator. Unlike list modules, however, you are required to specify the titles, pageids or revids for the generator to work on. For example, if you wanted to load all pages that are linked to from the main page, you would use generator=links&titles=Main%20Page. Other query modules will then ignore the given titles and instead use the titles from the 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[edit source]

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 [try in ApiSandbox]
Result 
<?xml version="1.0" encoding="utf-8"?>
<api>
  <query-continue>
    <allpages gapfrom="Ba&#039;ad Sneen (Song)" />
  </query-continue>
  <query>
    <pages>
      <page pageid="98178" ns="0" title="Ba">
        <links>
          <pl ns="0" title="BA" />
          <pl ns="4" title="Wikipedia:Redirect" />
          <pl ns="4" title="Wikipedia:Template messages/Redirect pages" />
          <pl ns="10" title="Template:R from alternative name" />
          <pl ns="10" title="Template:R from alternative spelling" />
          <pl ns="14" title="Category:Redirects from other capitalisations" />
        </links>
        <categories>
          <cl ns="14" title="Category:Redirects from other capitalisations" />
          <cl ns="14" title="Category:Unprintworthy redirects" />
        </categories>
      </page>
      <page pageid="14977970" ns="0" title="Ba&#039;">
        <links>
          <pl ns="0" title="Kirkwall Ba game" />
        </links>
      </page>
      <page pageid="10463369" ns="0" title="Ba&#039;Gamnan">
        <links>
          <pl ns="0" title="Characters of Final Fantasy XII" />
        </links>
      </page>
    </pages>
  </query>
</api>

Generators and redirects[edit source]

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 [try in ApiSandbox]
Result 
<?xml version="1.0" encoding="utf-8"?>
<api>
  <query>
    <pages>
      <page pageid="32" ns="0" title="TitleA">
        <links>
          <pl ns="0" title="TitleA1" />
          <pl ns="0" title="TitleA2" />
          <pl ns="0" title="TitleA3" />
        </links>
      </page>
      <page pageid="54" ns="0" title="TitleC">
        <links>
          <pl ns="0" title="TitleC1" />
          <pl ns="0" title="TitleC2" />
        </links>
      </page>
    </pages>
    <redirects>
      <r from="TitleB" to="TitleC" />
    </redirects>
  </query>
</api>

Generators and continuation[edit source]

You can continue queries using a generator the same way as other queries. In the first call to the API, the generator will create a batch of titles to work on. Each subsequent continuation will give you only data from that batch until you have all of it, at which point the batchcomplete property will be set. This enables you to process that batch before continuing with the rest of the query, if you wish. The next continuation will then create a new batch from the generator and so on. If you use rawcontinue, please read API:Raw Query Continue to understand which parameters you have to include in the continuation queries. If instead you use continue, you simply pass all parameters back, as you do for queries without a generator. Please note that for generators used together with a non-query module, the continue format will always be used.

More generator examples[edit source]

Show info about 4 pages starting at the letter "T"
https://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"
https://en.wikipedia.org/w/api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content

Page types[edit source]

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 https://mediawiki.org prop=extlinks list=exturlusage

Possible warnings[edit source]

  • 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
Retrieved from "https://www.mediawiki.org/w/index.php?title=API:Query&oldid=2241842"