API/Search

<languages/>

<translate> GET request to perform an advanced search for wiki pages by title or content text match.

API documentation

</translate>

<translate>

GET request

</translate>

<translate>

Response

</translate> <syntaxhighlight lang="python3"> {

   "batchcomplete": "",
   "continue": {
       "sroffset": 10,
       "continue": "-||"
   },
   "query": {
       "searchinfo": {
           "totalhits": 5060
       },
       "search": [
           {
               "ns": 0,
               "title": "Nelson Mandela",
               "pageid": 21492751,
               "size": 196026,
               "wordcount": 23664,
               "snippet": "Nelson Rolihlahla Mandela (/mænˈdɛlə/, Xhosa: [xoliɬaˈɬa manˈdɛla]; 18 July 1918 – 5 December 2013) was a South African anti-apartheid revolutionary,",
               "timestamp": "2018-07-23T07:59:43Z"
           },
           {
               "ns": 0,
               "title": "Death of Nelson Mandela",
               "pageid": 41284488,
               "size": 133513,
               "wordcount": 13512,
               "snippet": "On December 5, 2013, Nelson Mandela, the first President of South Africa to be elected in a fully representative democratic election, as well as the country's",
               "timestamp": "2018-07-19T17:30:59Z"
           }
           ...
       ]
   }

} </syntaxhighlight>

<translate>

Sample code

</translate>

/Sample code 1}}

<translate>

Possible errors

</translate>

<translate> Code</translate>	<translate> Info</translate>
nosrsearch
search-text-disabled
search-title-disabled
search-error	<translate> search error has occurred</translate>

<translate>

Parameter history

</translate>

• v1.24: <translate> Deprecated <tvar name=1>score,hasrelated</tvar></translate>
• v1.23:
  • <translate> Removed <tvar name=1>srredirects</tvar>.</translate> <translate> Redirects are always included.</translate>
  • <translate> Introduced <tvar name=1>srinterwiki</tvar></translate>
• v1.22: <translate> Introduced <tvar name=1>srbackend</tvar></translate>
• v1.17: <translate> Introduced <tvar name=1>nearmatch, score, titlesnippet, redirecttitle, redirectsnippet, sectiontitle, sectionsnippet, hasrelated</tvar></translate>
• v1.16: <translate> Introduced <tvar name=1>srinfo, srprop</tvar></translate>

<translate>

Additional notes

• Depending on which search backend is in use, how <tvar name=1>srsearch</tvar> is interpreted may vary.</translate> <translate> On Wikimedia wikis which use CirrusSearch, see <tvar name=1></tvar> for information about the search syntax.</translate>

<translate>

See also

</translate>

---

Sample content adapted from mediawikiwiki:API:Search on mediawiki.org, licensed under CC BY-SA 4.0.