User:Prisicilavilemen/Sandbox/API:Pageswithprop

This page is part of the MediaWiki Action API documentation.

MediaWiki version:

≥ 1.21

GET request List all pages using a given page property.

API documentation

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

list=pageswithprop (pwp)

(main | query | pageswithprop)

This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0-or-later

List all pages using a given page property.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Pageswithprop

Specific parameters:

Other general parameters are available.

pwppropname

Page property for which to enumerate pages (action=query&list=pagepropnames returns page property names in use).

This parameter is required.

pwpprop

Which pieces of information to include:

ids: Adds the page ID.
title: Adds the title and namespace ID of the page.
value: Adds the value of the page property.

Values (separate with | or alternative): ids, title, value

Default: ids|title

pwpcontinue

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

pwplimit

The maximum number of pages to return.

Type: integer or max

The value must be between 1 and 500.

Default: 10

pwpdir

In which direction to sort.

One of the following values: ascending, descending

Default: ascending

Examples:

List the first 10 pages using {{DISPLAYTITLE:}}.: api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value [open in sandbox]
Get additional information about the first 10 pages using __NOTOC__.: api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info [open in sandbox]

Example

GET request

Response

{
    "batchcomplete": "",
    "continue": {
        "ppncontinue": "kartographer_frames",
        "continue": "-||"
    },
    "query": {
        "pageswithprop": [
            {
                "pwppropname": "defaultsort"
            },
            {
                "pwppropname": "disambiguation"
            },
            {
                "pwppropname": "displaytitle"
            }
            ...
        ]
    }
}

Sample code

Python

#!/usr/bin/python3

"""
    get_pageswithprop.py

    MediaWiki API Demos
    Demo of `Pageswithprop` module: List all pages using a given page property.

    MIT License
"""

import requests

S = requests.Session()

URL = "https://en.wikipedia.org/w/api.php"

PARAMS = {
    "action": "query",
    "list": "pageswithprop",
    "pwppropname": "displaytitle",
    "format": "json"
}

R = S.get(url=URL, params=PARAMS)
DATA = R.json()

PAGESWITHPROP = DATA["query"]["pageswithprop"]

for p in PAGESWITHPROP:
    print(p["title"])

PHP

<?php
/*
    get_pageswithprop.php

    MediaWiki API Demos
    Demo of `Pageswithprop` module:  List all pages using a given page property.

    MIT License
*/

$endPoint = "https://en.wikipedia.org/w/api.php";
$params = [
    "action" => "query",
    "list" => "pageswithprop",
    "pwppropname" => "displaytitle",
    "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"]["pageswithprop"] as $k => $v ) {
    echo( $v["title"] . "\n" );
}

JavaScript

/*
    get_pageswithprops.js

    MediaWiki API Demos
    Demo of `Pageswithprop` module:  List all pages using a given page property.

    MIT License
*/

var url = "https://en.wikipedia.org/w/api.php"; 

var params = {
    action: "query",
    list: "pageswithprop",
    pwppropname: "displaytitle",
    format: "json",
};

url = url + "?origin=*";
Object.keys(params).forEach(function(key){url += "&" + key + "=" + params[key];});

fetch(url)
    .then(function(response){return response.json();})
    .then(function(response) {
        var pageswithprop = response.query.pageswithprop;
        for (var p in pageswithprop) {
            console.log(pageswithprop[p].title);
        }
    })
    .catch(function(error){console.log(error);});

MediaWiki JS

/*
	get_pageswithprop.js

	MediaWiki API Demos
	Demo of `Pageswithprop` module: List all pages using a given page property.

	MIT License
*/

var params = {
		action: 'query',
		list: 'pageswithprop',
		pwppropname: "displaytitle",
		format: 'json'
	},

api = new mw.Api();

api.get( params ).done( function ( data ) {
	var pageswithprops = data.query.pageswithprop,
		p;
	for ( p in pageswithprops ) {
		console.log( pageswithprops[ p ].title );
	}
} );