API:Search

From MediaWiki.org
Jump to: navigation, search
MediaWiki version: 1.11
Tools clipart.png This page is part of the MediaWiki API documentation.
Language: English
MediaWiki API

Quick overview:

v · d · e

Parameters[edit | edit source]

  • srinfo – What metadata to return.
Values (separate with '|'): totalhits, suggestion

Default: totalhits|suggestion

Type: one of totalhits, suggestion
  • srlimit – How many total pages to return.

No more than 50 (500 for bots) allowed.

Default: 10

Type: limit

  • srnamespace – The namespace(s) to enumerate (separate multiple values with '|').

Maximum number of values 50 (500 for bots)

Default: 0

Type: namespace

  • sroffset – Use this value to continue paging (return by query).

Default: 0

Type: integer

  • srbackend – Class name of search backend to use

Default: $wgSearchType

Type: string

  • srprop – What 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
score - Adds the score (if any) from the search engine
snippet - Adds a parsed snippet of the page
titlesnippet - Adds a parsed snippet of the page title
redirectsnippet - Adds a parsed snippet of the redirect
redirecttitle - Adds a parsed snippet of the redirect title
sectionsnippet - Adds a parsed snippet of the matching section
sectiontitle - Adds a parsed snippet of the matching section title
hasrelated - Indicates whether a related search is available
Values (separate with '|'): size, wordcount, timestamp, score, snippet, titlesnippet, redirecttitle, redirectsnippet, sectiontitle, sectionsnippet, hasrelated

Default: size|wordcount|timestamp|snippet

Type: one of size, wordcount, timestamp, score, snippet, titlesnippet, redirecttitle, redirectsnippet, sectiontitle, sectionsnippet, hasrelated

  • redirects – Include redirect pages in the search. Type: bool
  • srsearch (required) – Search for all page titles (or content) that has this value. Type: string
  • srwhat – Search inside the text or titles:
title - Search in page titles (default) (if search engine doesn't support title searches, such as Lucene which is used by Wikipedia, then srwhat=title falls back to text)
text - Search in page text
nearmatch - Search for the exact title
Depending on which search backend is in use, how srsearch is interpreted may vary. On Wikimedia wikis which use Lucene search, see w:Help:Searching#Search_engine_features for information about the search syntax.

Error Codes[edit | edit source]

  • invalidtitle – Bad title "key".
  • invalidtitle – Bad title "title".
  • nosearch – The search parameter must be set.
    This was param-search before 1.17
  • readapidenied – You need read permission to use this module.
  • search-text-disabled – text search is disabled.
  • search-title-disabled – title search is disabled.

Example[edit | edit source]

Show a list of 10 pages that contain the word 'wikipedia'

See also[edit | edit source]