API:Documentation template

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 info about the current 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 Tutorials Action API Tutorial Article ideas generator Nearby places viewer Picture of the day viewer

MediaWiki version:

≥ 1.23

API documentation

To embed the documentation of an API module, use the template below. Remember to replace "module name" with the name of an actual module. All main modules are here.

Example

GET Request

Description of script

api.php?action=query&format=json [try in ApiSandbox]

Response

{
    "batchcomplete":""
}

Sample code

hello.py

#!/usr/bin/python3

"""
    hello.py

    MediaWiki Action API Code Samples
    Demo of `...` module
    MIT license
"""

import requests

S = requests.Session()

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

PARAMS = {
    'action':"query",
    'format':"json"
}

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

print(DATA)

Demo app(s)

• Add a link to the demo app. Embed an image of the demo if applicable

Possible errors

Code	Info

Parameter history

• v1.x: Introduced parameter_1, parameter_2
• v0.x: Deprecated parameter_3

See also

• Add link to documentation of related modules