MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/API

list=prefixsearch (ps)

(main | query | prefixsearch)
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Notkunarleyfi: 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, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
To specify all values, use *.
Default: 0
pslimit

Maximum number of results to return.

No more than 500 (5.000 for bots) allowed.
Type: integer or max
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]