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, 274, 275, 420, 421, 828, 829, 2300, 2301, 2302, 2303, 3296, 3297, 3300, 3301, 3302, 3303, 3304, 3305, 3306, 3307, 3308, 3309, 3310, 3311, 3312, 3313, 3314, 3315, 3316, 3317, 3318, 3319, 3320, 3321, 3322, 3323, 3330, 3331, 3332, 3333, 3334, 3335, 3336, 3337, 3338, 3339, 3340, 3341, 3342, 3343, 3344, 3345, 3346, 3347, 3348, 3349, 3350, 3351, 3352, 3353, 3354, 3355, 3356, 3357, 3358, 3359, 3360, 3361, 3362, 3363, 3364, 3365, 3366, 3367, 3368, 3369, 3370, 3371, 3372, 3373
- 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]