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=prefixsearch
(ps)
This module requires read rights.
This module can be used as a generator.
Source: MediaWiki
License: GPL-2.0-or-later
Perform a prefix search for page titles.
Despite the similarity in names, this module is not intended to be equivalent to Special:PrefixIndex; for that, see action=query&list=allpages with the apprefix parameter. The purpose of this module is similar to action=opensearch: to take user input and provide the best-matching titles. Depending on the search engine backend, this might include typo correction, redirect avoidance, or other heuristics.
- pssearch
Search string.
This parameter is required.
- psnamespace
Namespaces to search. Ignored if pssearch 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
To specify all values, use *.
Default: 0
- pslimit
Maximum number of results to return.
Type: integer or max
The value must be between 1 and 500.
Default: 10
- psoffset
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
Search for page titles beginning with meaning.
- api.php?action=query&list=prefixsearch&pssearch=meaning
[open in sandbox]