MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

action=opensearch

(main | opensearch)

Search the wiki using the OpenSearch protocol.

Specific parameters:

Other general parameters are available.

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, 100, 101, 118, 119, 710, 711, 828, 829

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

profile

Search profile to use.

strict: Strict profile with few punctuation characters removed but diacritics and stress marks are kept.
normal: Few punctuation characters, some diacritics and stopwords removed.
fuzzy: Similar to normal with typo correction (two typos supported).
fast-fuzzy: Experimental fuzzy profile (may be removed at any time)
classic: Classic prefix, few punctuation characters and some diacritics removed.
engine_autoselect: Let the search engine decide on the best profile to use.

One of the following values: classic, engine_autoselect, fast-fuzzy, fuzzy, normal, strict

Default: engine_autoselect

suggest

Deprecated.

No longer used.

Type: boolean (details)

redirects

How to handle redirects:

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: