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
list=search
(sr)
This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0-or-later
Perform a full text search.
- srsearch
Search for page titles or content matching this value. You can use the search string to invoke special search features, depending on what the wiki's search backend implements.
This parameter is required.
- srnamespace
Search only within these namespaces.
Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
To specify all values, use *.
Default: 0
- srlimit
How many total pages to return.
Type: integer or max
The value must be between 1 and 500.
Default: 10
- sroffset
When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.
Type: integer
Default: 0
- srwhat
Which type of search to perform.
One of the following values: nearmatch, text, title
- srinfo
Which metadata to return.
Values (separate with | or alternative): rewrittenquery, suggestion, totalhits
Default: totalhits|suggestion|rewrittenquery
- srprop
Which properties to return:
- size
- Adds the size of the page in bytes.
- wordcount
- Adds the word count of the page.
- timestamp
- Adds the timestamp of when the page was last edited.
- snippet
- Adds a snippet of the page, with query term highlighting markup.
- titlesnippet
- Adds the page title, with query term highlighting markup.
- redirecttitle
- Adds the title of the matching redirect.
- redirectsnippet
- Adds the title of the matching redirect, with query term highlighting markup.
- sectiontitle
- Adds the title of the matching section.
- sectionsnippet
- Adds the title of the matching section, with query term highlighting markup.
- isfilematch
- Adds a boolean indicating if the search matched file content.
- categorysnippet
- Adds the matching category name, with query term highlighting markup.
- score
- Deprecated. Ignored.
- hasrelated
- Deprecated. Ignored.
- extensiondata
- Adds extra data generated by extensions.
Values (separate with | or alternative): categorysnippet, extensiondata, isfilematch, redirectsnippet, redirecttitle, sectionsnippet, sectiontitle, size, snippet, timestamp, titlesnippet, wordcount, hasrelated, score
Default: size|wordcount|timestamp|snippet
- srinterwiki
Include interwiki results in the search, if available.
Type: boolean (details)
- srenablerewrites
Enable internal query rewriting. Some search backends can rewrite the query into another which is thought to provide better results, for instance by correcting spelling errors.
Type: boolean (details)
- srsort
Set the sort order of returned results.
One of the following values: relevance
Default: relevance
Search for meaning.
- api.php?action=query&list=search&srsearch=meaning
[open in sandbox]
Search texts for meaning.
- api.php?action=query&list=search&srwhat=text&srsearch=meaning
[open in sandbox]
Get page info about the pages returned for a search for meaning.
- api.php?action=query&generator=search&gsrsearch=meaning&prop=info
[open in sandbox]