API:Images

MediaWiki Action API
Basics All Query modules Get properties of pages List pages matching a criterion Get module parameters information Get meta information about the wiki and user Authentication Get tokens for data modifying operations Login Logout Assert user Accounts and Users Create an account Block or unblock a user Get the current user's watchlist as a feed Change user options Change user group membership Send an email Page Operations Parse content of a page Create and edit a page Upload a file Import a page Delete a page Watch or unwatch a page Purge cache for page(s) Rollback a page Move a page Patrol a page or revision Restore revisions of a deleted page Change a page's protection level Change a page's language More... Search Search for a title or text Fetch results in an OpenSearch format Search for wiki pages near a location Search for a language Perform a prefix search for page titles Developer Utilities Access libraries Cross-site requests Creating an API module in an extension Using the API in MediaWiki and extensions Restricting API usage Localisation Implementation strategy

MediaWiki version:

≥ 1.11

GET Request to list embedded media files on provided pages.

This module can be used as a generator .

API documentation

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 Parameters: imlimit How many files to return. No more than 500 (5,000 for bots) allowed. Type: integer or max Default: 10 imcontinue When more results are available, use this to continue. 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 bots). imdir The direction in which to list. One of the following values: ascending, descending Default: ascending Examples: Get a list of files used in the Main Page. api.php?action=query&prop=images&titles=Main%20Page [open in sandbox] Get information about all files used in the Main Page. api.php?action=query&generator=images&titles=Main%20Page&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

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

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

See also

• 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.