API:Documentation template

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.

Module "Module_name" not found.

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