Jump to content
MediaWiki

API:Querypage

From mediawiki.org
This page is part of the MediaWiki Action API documentation.
MediaWiki Action API
Basics
Authentication
Accounts and Users
Page Operations
Search
Developer Utilities
Tutorials
v · d · e
MediaWiki version:
≥ 1.18

GET request to get a list provided by a QueryPage-based special page.

API documentation

[edit ]
The following documentation is the output of Special:ApiHelp/query+querypage, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org).

list=querypage (qp)

(main | query | querypage)
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Get a list provided by a QueryPage-based special page.

Specific parameters:
Other general parameters are available.
qppage

The name of the special page. Note, this is case-sensitive.

This parameter is required.
One of the following values: Ancientpages, BrokenRedirects, Deadendpages, DisambiguationPageLinks, DisambiguationPages, DoubleRedirects, Fewestrevisions, GadgetUsage, GloballyWantedFiles, ListDuplicatedFiles, Listredirects, Lonelypages, Longpages, MediaStatistics, MostGloballyLinkedFiles, Mostcategories, Mostimages, Mostinterwikis, Mostlinked, Mostlinkedcategories, Mostlinkedtemplates, Mostrevisions, OrphanedTimedText, Shortpages, Uncategorizedcategories, Uncategorizedimages, Uncategorizedpages, Uncategorizedtemplates, UnconnectedPages, Unusedcategories, Unusedimages, Unusedtemplates, Unwatchedpages, Wantedcategories, Wantedfiles, Wantedpages, Wantedtemplates, Withoutinterwiki
qpoffset

When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.

Type: integer
Default: 0
qplimit

Number of results to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10

Example

[edit ]

GET request

[edit ]
In the below query, we call the API to get a list of the first ten pages which are uncategorized

Response

[edit ]
{
"batchcomplete":"",
"continue":{
"continue":"-||",
"qpoffset":10
},
"query":{
"querypage":{
"cached":"",
"cachedtimestamp":"2019年02月22日T11:46:48Z",
"maxresults":5000,
"name":"Uncategorizedpages",
"results":[
{
"ns":0,
"title":"Abelardo Delgado",
"value":"0"
},
{
"ns":0,
"title":"Agriculture in Tonga",
"value":"0"
},
{
"ns":0,
"title":"Andriandramaka",
"value":"0"
}
...
]
}
}
}

Sample code

[edit ]

Python

[edit ]
#!/usr/bin/python3
"""
 get_querypage_list.py
 MediaWiki API Demos
 Demo of `Querypage` module: List first 10 pages which are uncategorized
 MIT License
"""
importrequests
S = requests.Session()
URL = "https://en.wikipedia.org/w/api.php"
PARAMS = {
 "qplimit": "10",
 "action": "query",
 "qppage": "Uncategorizedpages",
 "list": "querypage",
 "format": "json"
}
R = S.get(url=URL, params=PARAMS)
DATA = R.json()
QUERYPAGE = DATA['query']['querypage']['results']
for p in QUERYPAGE:
 print(str(p['title']))

PHP

[edit ]
<?php
/*
 get_querypage_list.php
 MediaWiki API Demos
 Demo of `Querypage` module: List first 10 pages which are uncategorized
 MIT License
*/
$endPoint = "https://en.wikipedia.org/w/api.php";
$params = [
 "action" => "query",
 "list" => "querypage",
 "qppage" => "Uncategorizedpages",
 "qplimit" => "10",
 "format" => "json"
];
$url = $endPoint . "?" . http_build_query( $params );
$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
$output = curl_exec( $ch );
curl_close( $ch );
$result = json_decode( $output, true );
foreach( $result["query"]["querypage"]["results"] as $page ){
 echo( $page["title"] . "\n" );
}

JavaScript

[edit ]
/*
 get_querypage_list.js
 MediaWiki API Demos
 Demo of `Querypage` module: List first 10 pages which are uncategorized
 MIT License
*/
varurl="https://en.wikipedia.org/w/api.php";
varparams={
action:"query",
list:"querypage",
qppage:"Uncategorizedpages",
qplimit:"10",
format:"json"
};
url=url+"?origin=*";
Object.keys(params).forEach(function(key){url+="&"+key+"="+params[key];});
fetch(url)
.then(function(response){returnresponse.json();})
.then(function(response){
varquerypage=response.query.querypage.results;
for(varpinquerypage){
console.log(querypage[p].title);
}
})
.catch(function(error){console.log(error);});

MediaWiki JS

[edit ]
/*
	get_querypage_list.js
	MediaWiki API Demos
	Demo of `Querypage` module: List first 10 pages which are uncategorized
	MIT License
*/
varparams={
action:'query',
list:'querypage',
qppage:'Uncategorizedpages',
qplimit:'10',
format:'json'
},
api=newmw.Api();
api.get(params).done(function(data){
varquerypage=data.query.querypage.results,
p;
for(pinquerypage){
console.log(querypage[p].title);
}
});

Special page values

[edit ]

(MediaWiki 1.32.0)

Ancientpages Listredirects Mostlinked Unusedtemplates
BrokenRedirects Lonelypages Mostrevisions Unwatchedpages
Deadendpages Longpages Shortpages Wantedcategories
DisambiguationPageLinks MediaStatistics Uncategorizedcategories Wantedfiles
DisambiguationPages Mostcategories Uncategorizedpages Wantedpages
DoubleRedirects MostGloballyLinkedFiles Uncategorizedimages Wantedtemplates
EntityUsage Mostimages Uncategorizedtemplates Withoutinterwiki
Fewestrevisions Mostinterwikis UnconnectedPages
GloballyWantedFiles Mostlinkedcategories Unusedcategories
ListDuplicatedFiles Mostlinkedtemplates Unusedimages

Possible errors

[edit ]
Code Info
unknown_qppage Unrecognized value for parameter qppage: value.
noqppage The qppage parameter must be set.

Additional notes

[edit ]
  • This module can be used as a generator .
  • Namespace filtering is unavailable on these pages. The possible way is to manually filter "ns" from collected results.

See also

[edit ]

AltStyle によって変換されたページ (->オリジナル) /