MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=opensearch
(main | opensearch)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0-or-later
Search the wiki using the OpenSearch protocol.
Parameters:
- search
Search string.
- This parameter is required.
- namespace
Namespaces to search. Ignored if search begins with a valid namespace prefix.
- Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 420, 421, 460, 461, 470, 471, 710, 711, 828, 829, 2300, 2301, 2302, 2303, 2600, 5740, 5741, 7000, 7001, 7010, 7011, 7020, 7021, 7022, 7023, 7030, 7031, 7040, 7041, 7042, 7043, 7050, 7051, 7060, 7061, 7070, 7071, 7080, 7081, 7100, 7101, 7110, 7111, 7120, 7121, 7200, 7201, 7210, 7211, 7220, 7221, 7300, 7301, 7310, 7311, 7320, 7321, 7330, 7331, 10000, 10002, 10010, 10011, 10030, 10031
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- To specify all values, use *.
- Default: 0
- limit
Maximum number of results to return.
- Type: integer or max
- The value must be between 1 and 500.
- Default: 10
- suggest
- Deprecated.
No longer used.
- Type: boolean (details)
- redirects
How to handle redirects:
- return
- Return the redirect itself.
- resolve
- Return the target page. May return fewer than limit results.
For historical reasons, the default is "return" for format=json and "resolve" for other formats.
- One of the following values: resolve, return
- format
The format of the output.
- One of the following values: json, jsonfm, xml, xmlfm
- Default: json
- warningsaserror
If warnings are raised with format=json, return an API error instead of ignoring them.
- Type: boolean (details)
Example:
- Find pages beginning with Te.
- api.php?action=opensearch&search=Te [open in sandbox]