API:Imageinfo
(Redirected from Prop=imageinfo)
| This page is part of the MediaWiki Action API documentation. |
| MediaWiki version: | ≥ 1.11 |
GET request to retrieve information about an image file or files.
This module can be used as a generator.
API documentation
edit
![[open in sandbox]](/wiki/Special:ApiSandbox#action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo){kind=link}
![[open in sandbox]](/wiki/Special:ApiSandbox#action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&iiend=2007-12-31T23:59:59Z&iiprop=timestamp%7Cuser%7Curl){kind=link}
Example
editGET request
editGet information about the file, File:Billy_Tipton.jpg
![[try in ApiSandbox]](https://en.wikipedia.org/wiki/Special:ApiSandbox#action=query&format=json&prop=imageinfo&titles=File:Billy_Tipton.jpg){kind=link}
Response
editRequest URL:
{
"batchcomplete": "",
"query": {
"normalized": [
{
"from": "File:Billy_Tipton.jpg",
"to": "File:Billy Tipton.jpg"
}
],
"pages": {
"36266497": {
"pageid": 36266497,
"ns": 6,
"title": "File:Billy Tipton.jpg",
"imagerepository": "local",
"imageinfo": [
{
"timestamp": "2012-06-27T21:16:21Z",
"user": "Gobonobo"
}
]
}
}
}
}
Sample code
editPython
edit#This file is auto-generated. See modules.json and autogenerator.py for details
#!/usr/bin/python3
"""
get_imageinfo.py
MediaWiki API Demos
Demo of `Imageinfo` module: Get information about an image file.
MIT License
"""
import requests
S = requests.Session()
URL = "https://en.wikipedia.org/w/api.php"
PARAMS = {
"action": "query",
"format": "json",
"prop": "imageinfo",
"titles": "File:Billy_Tipton.jpg"
}
R = S.get(url=URL, params=PARAMS)
DATA = R.json()
PAGES = DATA["query"]["pages"]
for k, v in PAGES.items():
print(v["title"] + " is uploaded by User:" + v["imageinfo"][0]["user"])
PHP
edit<?php
//This file is autogenerated. See modules.json and autogenerator.py for details
/*
get_imageinfo.php
MediaWiki API Demos
Demo of `Imageinfo` module: Get information about an image file.
MIT License
*/
$endPoint = "https://en.wikipedia.org/w/api.php";
$params = [
"action" => "query",
"format" => "json",
"prop" => "imageinfo",
"titles" => "File:Billy Tipton.jpg"
];
$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 ) {
echo( $v["title"] . " is uploaded by User:" . $v["imageinfo"][0]["user"] . "\n" );
}
JavaScript
edit//This file is autogenerated. See modules.json and autogenerator.py for details
/*
get_imageinfo.js
MediaWiki API Demos
Demo of `Imageinfo` module: Get information about an image file.
MIT License
*/
var url = "https://en.wikipedia.org/w/api.php";
var params = {
action: "query",
format: "json",
prop: "imageinfo",
titles: "File:Billy Tipton.jpg"
};
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 p in pages) {
console.log(pages[p].title + " is uploaded by User:" + pages[p].imageinfo[0].user);
}
})
.catch(function(error){console.log(error);});
MediaWiki JS
edit// This file is autogenerated. See modules.json and autogenerator.py for details
/*
get_imageinfo.js
MediaWiki API Demos
Demo of `Imageinfo` module: Get information about an image file.
MIT License
*/
var params = {
action: 'query',
format: 'json',
prop: 'imageinfo',
titles: 'File:Billy Tipton.jpg'
},
api = new mw.Api();
api.get( params ).done( function ( data ) {
var pages = data.query.pages,
p;
for ( p in pages ) {
console.log( pages[ p ].title + ' is uploaded by User:' + pages[ p ].imageinfo[ 0 ].user );
}
} );
Demo app(s)
editPossible errors
edit| Code | Info |
|---|---|
| invalid-title | Invalid title in iibadfilecontexttitle parameter. |
| invalidurlparam | Invalid value for iiurlparam (name=value). |
| urlparamnormal | Could not normalize image parameters for name. |
Parameter history
edit- v1.23: Introduced
canonicaltitle,commonmetadata,iiextmetadatalanguage,iiextmetadatamultilang,iiextmetadatafilter - v1.22: Introduced
uploadwarning - v1.20: Introduced
iilocalonly - v1.18: Introduced
iimetadataversion,iiurlparam - v1.17: Introduced
userid,parsedcomment,thumbmime,extmetadata - v1.16: Introduced
dimensions - v1.15: Introduced
iicontinue - v1.14: Introduced
bitdepth - v1.13: Introduced
mime,archivename - v1.12: Deprecated
iihistory - v1.12: Introduced
iilimit,iistart,iiend,iiurlwidth,iiurlheight
Additional notes
edit- Files uploaded to the Wikimedia Commons will appear to be missing when accessed from other MediaWiki wikis.
- The timestamp from this module indicates the last time the image was modified.
- Since T360589, it is no longer guaranteed that the thumbnail URL returned by the API matches the requested thumbnail width (
iiurlwidth). The thumbnail, which will be fetched from a pregenerated list, is either of the same width or larger. This is not issue when the browser can do the resizing, but if you do require the exact size, you now need to access the appropriate thumbnail URL directly.
See also
edit- API:Fileinfo - to supersede this
propin future versions of the MediaWiki Action API - API:Stashimageinfo - retrieves information about stashed images
- API:Images - retrieves all images embedded on a page
- API:Info - retrieves basic information about a list of pages
- API:Imageusage - finds all pages that use the given image or images
- API:Duplicatefiles - finds any duplicates of the given file or files