API:Images

Translate this page

This page is part of the MediaWiki Action API documentation.

MediaWiki version:

≥ 1.11

GET request to list embedded media files on provided pages.

This module can be used as a generator.

API documentation

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

prop=images (im)

(main | query | images)

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

Returns all files contained on the given pages.

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

Specific parameters:

Other general parameters are available.

imlimit: How many files to return.; Type: integer or max; The value must be between 1 and 500.; Default: 10
imcontinue: When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.
imimages: Only list these files. Useful for checking whether a certain page has a certain file.; Separate values with | or alternative.; Maximum number of values is 50 (500 for clients that are allowed higher limits).
imdir: The direction in which to list.; One of the following values: ascending, descending; Default: ascending

Examples:

Get a list of files used on the page MediaWiki.: api.php?action=query&prop=images&titles=MediaWiki [open in sandbox]
Get information about all files used on the page MediaWiki.: api.php?action=query&generator=images&titles=MediaWiki&prop=info [open in sandbox]

Example

GET request

In the below query, we call the API to get a list of image files embedded on the English Wikipedia's page on Albert Einstein.

api.php?action=query&titles=Albert%20Einstein&format=json&prop=images [try in ApiSandbox]

Response

{
    "continue": {
        "imcontinue": "736|Albert_Einstein_signature_1934.svg",
        "continue": "||"
    },
    "query": {
        "pages": {
            "736": {
                "pageid": 736,
                "ns": 0,
                "title": "Albert Einstein",
                "images": [
                    {
                        "ns": 6,
                        "title": "File:1919 eclipse positive.jpg"
                    },
                    {
                        "ns": 6,
                        "title": "File:Albert Einstein's exam of maturity grades (color2).jpg"
                    },
                    {
                        "ns": 6,
                        "title": "File:Albert Einstein (Nobel).png"
                    },
                    ...
                ]
            }
        }
    }
}

Sample code

Python

#!/usr/bin/python3

"""
    get_page_images.py

    MediaWiki API Demos
    Demo of `Images` module: Send a GET request to obtain a JSON
	object listing all of the image files embedded on a single page

    MIT License
"""

import requests

S = requests.Session()

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

PARAMS = {
    "action": "query",
    "format": "json",
    "titles": "Albert Einstein",
    "prop": "images"
}

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

PAGES = DATA['query']['pages']

for k, v in PAGES.items():
    for img in v['images']:
        print(img["title"])

PHP

<?php
/*
    get_page_images.php

    MediaWiki API Demos
    Demo of `Images` module: Send a GET request to obtain a JSON
	object listing all of the image files embedded on a single page

    MIT License
*/

$endPoint = "https://en.wikipedia.org/w/api.php";
$params = [
    "action" => "query",
    "prop" => "images",
    "titles" => "Albert Einstein",
    "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"]["pages"] as $k => $v ) {
    foreach( $v["images"] as $k => $v ) {
        echo( $v["title"] . "\n" );
    }
}

JavaScript

/*
    get_page_images.js

    MediaWiki API Demos
    Demo of `Images` module: Send a GET request to obtain a JSON
	object listing all of the image files embedded on a single page

    MIT License
*/

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

var params = {
    action: "query",
    prop: "images",
    titles: "Albert Einstein",
    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 pages = response.query.pages;
        for (var page in pages) {
            for (var img of pages[page].images) {
                console.log(img.title);
            }
        }
    })
    .catch(function(error){console.log(error);});

MediaWiki JS

/*
	get_page_images.js

	MediaWiki API Demos
	Demo of `Images` module: Send a GET request to obtain a JSON
	object listing all of the image files embedded on a single page

	MIT License
*/

var params = {
		action: 'query',
		prop: 'images',
		titles: 'Albert Einstein',
		format: 'json'
	},
	api = new mw.Api();

api.get( params ).done( function ( data ) {
	var pages = data.query.pages,
		page;
	for ( page in pages ) {
		pages[ page ].images.forEach( function ( img ) {
			console.log( img.title );
		} );
	}
} );

Demo app(s)

API:Picture of the day viewer

Parameter history

v1.13: Introduced imcontinue, imlimit
v1.18: Introduced imimages
v1.19: Introduced imdir