MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
list=search (sr)
- This module requires read rights.
- This module can be used as a generator.
Perform a full text search.
Parameters:
- srsearch
Search for all page titles (or content) that have this value.
- This parameter is required.
- srnamespace
Search only within these namespaces.
- Values (separate with "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Default: 0
- srwhat
Which type of search to perform.
- One value: title, text, nearmatch
- srinfo
Which metadata to return.
- Values (separate with "|"): totalhits, suggestion
- Default: totalhits|suggestion
- 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 parsed snippet of the page.
- titlesnippet
- Adds a parsed snippet of the page title.
- redirectsnippet
- Adds a parsed snippet of the redirect title.
- redirecttitle
- Adds the title of the matching redirect.
- sectionsnippet
- Adds a parsed snippet of the matching section title.
- sectiontitle
- Adds the title of the matching section.
- score
- Deprecated and ignored.
- hasrelated
- Deprecated and ignored.
- Values (separate with "|"): size, wordcount, timestamp, score, snippet, titlesnippet, redirecttitle, redirectsnippet, sectiontitle, sectionsnippet, hasrelated
- Default: size|wordcount|timestamp|snippet
- sroffset
When more results are available, use this to continue.
- Default: 0
- srlimit
How many total pages to return.
- No more than 50 (500 for bots) allowed.
- Default: 10
- srinterwiki
Include interwiki results in the search, if available.
Examples:
- Search for "meaning"
- api.php?action=query&list=search&srsearch=meaning
- Search texts for "meaning"
- api.php?action=query&list=search&srwhat=text&srsearch=meaning
- Ger page info about the pages returned for a search for "meaning"
- api.php?action=query&generator=search&gsrsearch=meaning&prop=info