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)

(main | query | prefixsearch)
  • 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.

Parameters:
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, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 420, 421, 460, 461, 470, 471, 710, 711, 828, 829, 2300, 2301, 2302, 2303, 2600, 5740, 5741, 7000, 7001, 7010, 7011, 7020, 7021, 7022, 7023, 7030, 7031, 7040, 7041, 7042, 7043, 7050, 7051, 7060, 7061, 7070, 7071, 7080, 7081, 7100, 7101, 7110, 7111, 7120, 7121, 7200, 7201, 7210, 7211, 7220, 7221, 7300, 7301, 7310, 7311, 7320, 7321, 7330, 7331, 10000, 10002, 10010, 10011, 10030, 10031
Maximum number of values is 50 (500 for clients that are allowed higher limits).
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.

Type: integer
Default: 0
Example:
Search for page titles beginning with meaning.
api.php?action=query&list=prefixsearch&pssearch=meaning [open in sandbox]