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.
- 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, 120, 121, 122, 123, 640, 641
- To specify all values, use *.
- Default: 0
- srlimit
How many total pages to return.
- No more than 500 (5,000 for bots) allowed.
- Type: integer or max
- Default: 10
- sroffset
When more results are available, use this to continue.
- Type: integer
- Default: 0
- srqiprofile
Query independent profile to use (affects ranking algorithm).
- classic
- Ranking based on the number of incoming links, some templates, page language and recency (templates/language/recency may not be activated on this wiki).
- classic_noboostlinks
- Ranking based on some templates, page language and recency when activated on this wiki.
- empty
- Ranking based solely on query dependent features (for debug only).
- wsum_inclinks
- Weighted sum based on incoming links
- wsum_inclinks_pv
- Weighted sum based on incoming links and weekly pageviews
- popular_inclinks_pv
- Ranking based primarily on page views
- popular_inclinks
- Ranking based primarily on incoming link counts
- wikibase_prefix
- Default rescore profile for completion search
- wikibase_prefix_boost
- Rescore profile for completion search with statement boosting
- wikibase
- Default rescore profile for fulltext search
- wikibase_phrase
- Rescore profile for fulltext search with phrase scoring
- engine_autoselect
- Let the search engine decide on the best profile to use.
- One of the following values: classic, classic_noboostlinks, empty, wsum_inclinks, wsum_inclinks_pv, popular_inclinks_pv, popular_inclinks, wikibase_prefix, wikibase_prefix_boost, wikibase, wikibase_phrase, engine_autoselect
- Default: engine_autoselect
- srwhat
Which type of search to perform.
- One of the following values: title, text, nearmatch
- srinfo
Which metadata to return.
- Values (separate with | or alternative): totalhits, suggestion, rewrittenquery
- 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 parsed snippet of the page.
- titlesnippet
- Adds a parsed snippet of the page title.
- redirecttitle
- Adds the title of the matching redirect.
- redirectsnippet
- Adds a parsed snippet of the redirect title.
- sectiontitle
- Adds the title of the matching section.
- sectionsnippet
- Adds a parsed snippet of the matching section title.
- isfilematch
- Adds a boolean indicating if the search matched file content.
- categorysnippet
- Adds a parsed snippet of the matching category.
- score
- Deprecated. Ignored.
- hasrelated
- Deprecated. Ignored.
- extensiondata
- Adds extra data generated by extensions.
- Values (separate with | or alternative): size, wordcount, timestamp, snippet, titlesnippet, redirecttitle, redirectsnippet, sectiontitle, sectionsnippet, isfilematch, categorysnippet, score, hasrelated, extensiondata
- 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, just_match, none, incoming_links_asc, incoming_links_desc, last_edit_asc, last_edit_desc, create_timestamp_asc, create_timestamp_desc, random
- 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]