API:Images
Jump to navigation
Jump to search
![]() | 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 .
Contents
API documentation[edit]
prop=images (im)
Returns all files contained on the given pages. Parameters:
Examples:
|
Example[edit]
GET Request[edit]
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.
Response[edit]
{
"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[edit]
get_page_images.py
#!/usr/bin/python3
"""
get_page_images.py
MediaWiki Action API Code Samples
Demo of `Images` module: Get all image files embedded in a
single page.
MIT license
"""
import requests
S = requests.Session()
URL = "https://en.wikipedia.org/w/api.php"
PARAMS = {
'action':'query',
'format':'json',
'prop':'images',
'titles':'Albert Einstein'
}
R = S.get(url=URL, params=PARAMS)
DATA = R.json()
print(DATA)
Parameter History[edit]
- v1.13: Introduced
imcontinue
,imlimit
- v1.18: Introduced
imimages
- v1.19: Introduced
imdir
See also[edit]
- API:Imageinfo - Gets information for any titles in the image namespace. Will eventually get superseded by
prop=fileinfo
. - API:Stashimageinfo - Gets information for stashed images or files in the namespace. Output is identical to API:Imageinfo .
- API:Imageusage - Finds all pages that use the given images.
- API:Duplicatefiles - Lists any duplicates of the given images or files.
- API:Allimages - Lists all images, by title or timestamp.