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, 828, 829, 2300, 2301, 2302, 2303, 3000, 3002, 3004, 3006, 3008, 3010, 3012, 3014, 3016, 3018, 3020, 3022, 3024, 3026, 3028, 3030, 3032, 3034, 3036, 3038, 3040, 3042, 3044, 3046, 3048, 3050, 3052, 3054, 3056, 3058, 3060, 3062, 3064, 3066, 3068, 3070, 3072, 3074, 3076, 3078, 3080, 3082, 3084, 3086, 3088, 3090, 3092, 3094, 3096, 3098, 3100, 3102, 3104, 3106, 3108, 3110, 3112, 3114, 3116, 3118, 3120, 3122, 3124, 3126
- Maximum number of values is 50 (500 for clients 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]