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.

  • https://www.mediawiki.org/wiki/Special:MyLanguage/API:Prefixsearch
Specific parameters:
Other general parameters are available.
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, 200, 201, 202, 203, 204, 205, 208, 209, 250, 251, 252, 253, 274, 275, 420, 421, 460, 461, 740, 741, 742, 743, 744, 745, 746, 747, 748, 749, 828, 829, 844, 845, 3002, 3003, 3004, 3105
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. More detailed information on how to continue queries can be found on mediawiki.org.

Type: integer
The value must be no less than 0.
Default: 0
Example:
Search for page titles beginning with meaning.
api.php?action=query&list=prefixsearch&pssearch=meaning [open in sandbox]
Retrieved from "https://tunearch.org/wiki/Special:ApiHelp"

We use cookies (and similar technologies) to personalise content and improve The Traditional Tune Archive website.

With these cookies we collect few and indispensable information about you. With this we adapt our website and communication to your preferences. You can read more about it in our privacy policy.

If you want to manage your cookie preferences, click on Manage preferences. By clicking on Accept all, you agree to the use of all cookies. You can change or withdraw your consent at any time.

Accept all cookiesManage preferences
Something went wrong
Dismiss