The action=query module allows you to fetch 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.
API documentation
The following documentation is the output of Special:ApiHelp/query, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org).
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.
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, crh, en, gan, iu, ku, mni, sh, shi, sr, tg, tly, uz, wuu, zgh and zh.
Unlike meta and list query modules, all property query modules work on a set of pages that can be specified in one of 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.
{"batchcomplete":true,"query":{"pages":[{"ns":0,"title":"Doesntexist","missing":true},{"title":"Talk:","invalidreason":"The requested page title is empty or contains only the name of a namespace.","invalid":true},{"pageid":15580374,"ns":0,"title":"Main Page"}]}}
Example 4: Continuing queries
When all the data is not returned in the response of a query, there will be a continue attribute to indicate that there is more data.
{"continue":{"accontinue":"List_of_largest_companies_in_Sri_Lanka","continue":"-||"},"query":{"allcategories":[{"category":"List of BioWare characters"},{"category":"List of Harlequin Romance novels"},{"category":"List of MPs elected in UK elections templates"},{"category":"List of Metamorphoses characters"},{"category":"List of Rockstar Games characters"},{"category":"List of Star Trek awards and nominations"},{"category":"List of Swedish films of the 2020s"},{"category":"List of association football clubs in the Republic of Ireland templates"},{"category":"List of awards and nominations received by Aleksej Pechkuroy"},{"category":"List of cabinet templates"}]}}
To get further data, add its values to the original request:
{"batchcomplete":true,"query":{"allcategories":[{"category":"List of largest companies in Sri Lanka"},{"category":"List of longest beaches of the world"},{"category":"List of ministers by ministry of Bangladesh"},{"category":"List of people from Palm Beach, Florida"},{"category":"List of video game characters"}]}}
Example 5: Batchcomplete
The API returns a batchcomplete element to indicate that all data for the current batch of items has been returned. MW 1.25+
In the response of the sample query below, batchcomplete has been included to indicate that all the data for each of the three images has been returned.
The next continuation will begin returning data for the next set of 3 images.
{"batchcomplete":true,"continue":{"aicontinue":"20020822143445|Do_You_Want_to_Know_a_Secret_(Beatles_song_-_sample).ogg","continue":"-||"},"query":{"allimages":[{"name":"Simon_and_Garfunkel_-_Mrs_Robinson.ogg","timestamp":"2002-08-04T19:55:17Z","url":"https://upload.wikimedia.org/wikipedia/en/6/64/Simon_and_Garfunkel_-_Mrs_Robinson.ogg","descriptionurl":"https://en.wikipedia.org/wiki/File:Simon_and_Garfunkel_-_Mrs_Robinson.ogg","descriptionshorturl":"https://en.wikipedia.org/w/index.php?curid=67723","ns":6,"title":"File:Simon and Garfunkel - Mrs Robinson.ogg"},{"name":"Simon_and_Garfunkel_-_Scarborough_Fair.ogg","timestamp":"2002-08-04T20:01:36Z","url":"https://upload.wikimedia.org/wikipedia/en/c/c1/Simon_and_Garfunkel_-_Scarborough_Fair.ogg","descriptionurl":"https://en.wikipedia.org/wiki/File:Simon_and_Garfunkel_-_Scarborough_Fair.ogg","descriptionshorturl":"https://en.wikipedia.org/w/index.php?curid=67779","ns":6,"title":"File:Simon and Garfunkel - Scarborough Fair.ogg"},{"name":"Beatles_please_me.ogg","timestamp":"2002-08-22T14:34:00Z","url":"https://upload.wikimedia.org/wikipedia/en/e/ee/Beatles_please_me.ogg","descriptionurl":"https://en.wikipedia.org/wiki/File:Beatles_please_me.ogg","descriptionshorturl":"https://en.wikipedia.org/w/index.php?curid=74826","ns":6,"title":"File:Beatles please me.ogg"}]}}
Example 6: Generators
Use generators if you want to get data about a set of pages.
For example, 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, combine the two API calls into one by using generator=categorymembers.
When using a list module as a generator, you don't need to specify the pages.
However, for a property module, you should specify the pages which the generator will work on.
For example, to load all pages that are linked to from the main page, use generator=links&titles=Main%20Page.
Parameters passed to a generator must be prefixed with a g. For instance, when using generator=backlinks, use gbllimit instead of bllimit.
The sample query below gets links and categories for the first three pages in the main namespace starting with "Ba".
{"continue":{"plcontinue":"14977970|0|Kirkwall_Ba_game","continue":"||categories"},"query":{"pages":[{"pageid":98178,"ns":0,"title":"Ba","links":[{"ns":0,"title":"BA"},{"ns":4,"title":"Wikipedia:Mainspace"},{"ns":4,"title":"Wikipedia:Naming conventions (capitalization)"},{"ns":4,"title":"Wikipedia:Protection policy"},{"ns":4,"title":"Wikipedia:Redirect"},{"ns":10,"title":"Template:R from miscapitalisation"},{"ns":10,"title":"Template:R from modification"},{"ns":10,"title":"Template:R to disambiguation page"},{"ns":14,"title":"Category:Redirects from ambiguous terms"},{"ns":14,"title":"Category:Redirects from other capitalisations"}],"categories":[{"ns":14,"title":"Category:Redirects from ambiguous terms"},{"ns":14,"title":"Category:Redirects from other capitalisations"},{"ns":14,"title":"Category:Unprintworthy redirects"}]},{"pageid":14977970,"ns":0,"title":"Ba'"},{"pageid":33351890,"ns":0,"title":"Ba'Al Shem Tov"}]}}
Continuing queries
Queries will often have more results available than are just shown in the original query. (Often this is because a List query's result limit has been reached.) In these cases, queries can be continued. More detailed information on continuing queries can be at API:Continue.
Possible warnings
Warning message
Cause
No support for special pages has been implemented.
Thrown if a title in the Special: or Media: namespace is given. The pages in these namespaces cannot be queried.
Redirect resolution cannot be used together with the revids parameter. Any redirects the revids point to have not been resolved.
Thrown if the redirect parameter is used in a query that specifies pages using revids.
Parameter history
v1.34: Introduced exportschema
v1.24: Introduced rawcontinue (note: raw continuation was the default behavior until v1.26)
v1.21: Introduced continue
Additional notes
Specifying titles through titles or pageids is limited to 50 titles per query, or 500 for those with the apihighlimits right.
Use multiple query modules together to get what you need in one request, e.g. prop=info|revisions&list=backlinks|embeddedin|allimages&meta=userinfo.
Generators always pass page titles to the query module. Unlike lists (which may include additional data by default), generators should not output any information themselves, unless when explicitly requested via the generator module's query parameters.
Resolving redirects
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 an example request). 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"
{"batchcomplete":true,"query":{"redirects":[{"from":"Wikipedia:!--","to":"Wikipedia:Manual of Style","tofragment":"Invisible comments"}],"pages":[{"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.
