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-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
- To specify all values, use *.
- 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]
Debug data:
[SQLBagOStuff] MainObjectStash using store ReplicatedBagOStuff[objectcache] MainWANObjectCache using store EmptyBagOStuffIP: 3.148.233.130Start request GET /mediawiki/api.php?action=help&modules=opensearch
HTTP HEADERS:
CONTENT-TYPE:
CONTENT-LENGTH: 0
USER-AGENT: Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)
REFERER: https://zero-k.info/mediawiki/Special:ApiHelp/opensearch
HOST: zero-k.info
ACCEPT-ENCODING: gzip, br, zstd, deflate
ACCEPT: */*
CONNECTION: close[localisation] LocalisationCache: using store LCStoreDB[session] SessionManager using store SqlBagOStuff[DBReplication] Cannot use ChronologyProtector with EmptyBagOStuff[DBReplication] Wikimedia\Rdbms\LBFactory::getChronologyProtector: request info {
"IPAddress": "3.148.233.130",
"UserAgent": "Mozilla\/5.0 AppleWebKit\/537.36 (KHTML, like Gecko; compatible; ClaudeBot\/1.0; +claudebot@anthropic.com)",
"ChronologyProtection": false,
"ChronologyPositionIndex": 0,
"ChronologyClientId": false
}[DBConnection] Wikimedia\Rdbms\LoadBalancer::lazyLoadReplicationPositions: executed chronology callback.[DBConnection] Wikimedia\Rdbms\LoadBalancer::getLocalConnection: connected to database 0 at 'localhost'.[SQLBagOStuff] Connection mysql object #127 (handle id #121) will be used for SqlBagOStuff[session] SessionBackend "8ot6726dmv8gm93lvda3hcja8pg9ogl4" is unsaved, marking dirty in constructor[session] SessionBackend "8ot6726dmv8gm93lvda3hcja8pg9ogl4" save: dataDirty=1 metaDirty=1 forcePersist=0[cookie] already deleted setcookie: "wikidb229_mw__session", "", "1715249773", "/", "", "", "1"[cookie] already deleted setcookie: "wikidb229_mw_UserID", "", "1715249773", "/", "", "", "1"[cookie] already deleted setcookie: "wikidb229_mw_Token", "", "1715249773", "/", "", "", "1"[cookie] already deleted setcookie: "forceHTTPS", "", "1715249773", "/", "", "", "1"[DBConnection] Wikimedia\Rdbms\LoadBalancer::getLocalConnection: connected to database 0 at 'localhost'.[MessageCache] MessageCache using store SqlBagOStuff[SQLBagOStuff] Connection mysql object #127 (handle id #121) will be used for SqlBagOStuff[SQLBagOStuff] Connection mysql object #127 (handle id #121) will be used for SqlBagOStuff[SQLBagOStuff] Connection mysql object #127 (handle id #121) will be used for SqlBagOStuff[SQLBagOStuff] Connection mysql object #127 (handle id #121) will be used for SqlBagOStuff[SQLBagOStuff] SqlBagOStuff::lock failed due to timeout for wikidb229-mw_:messages:en.[ContentHandler] Created handler for wikitext: WikitextContentHandler[SQLBagOStuff] Connection mysql object #127 (handle id #121) will be used for SqlBagOStuff[SQLBagOStuff] Connection mysql object #127 (handle id #121) will be used for SqlBagOStuff[MessageCache] MessageCache::load: Loading en... local cache is empty, global cache is expired/volatile, loading from databaseParserFactory: using preprocessor: Preprocessor_HashUnstubbing $wgLang on call of $wgLang::_unstub from ParserOptions->__construct