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.
- 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
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)
Find pages beginning with Te.
- api.php?action=opensearch&search=Te
[open in sandbox]