MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/API

action=opensearch

(main | opensearch)
  • This module requires read rights.
  • Source: MediaWiki
  • License: GPL-2.0+

Search the wiki using the OpenSearch protocol.

Parameters:
search

Search string.

This parameter is required.
namespace

Namespaces to search.

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, 170, 171, 1094, 1095, 1096, 1097, 1098, 1099, 1102, 1103, 1198, 1199, 1202, 1203, 1210, 1211, 1218, 1219, 1226, 1227, 1234, 1235, 1242, 1243, 1250, 1251, 1258, 1259, 1266, 1267, 1274, 1275, 1282, 1283, 1290, 1291, 1298, 1299, 1306, 1307, 1314, 1315, 1322, 1323, 1330, 1331, 1338, 1339, 1346, 1347, 1354, 1355, 1362, 1363, 1364, 1365, 1366, 1367, 1368, 1369, 1370, 1371, 1373, 1374, 1382, 1383, 1384, 1385, 1386, 1387
Maximum number of values is 50 (500 for bots).
Default: 0
limit

Maximum number of results to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
suggest

Do nothing if $wgEnableOpenSearchSuggest is false.

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: return, resolve
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]