free
/
searx
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 11 Wiki Activity
76 Commits
10 Branches
Tree: c1d57e8206
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'c1d57e8206'
${ noResults }
searx/dev/search_api.html

search_api.html 12KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194 
  1. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

  3.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">

  6.   <head>

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  8.     <title>Search API &#8212; searx 0.12.0 documentation</title>

  9.     <link rel="stylesheet" href="../_static/style.css" type="text/css" />

  10.     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

  11.     <script type="text/javascript">

  12.       var DOCUMENTATION_OPTIONS = {

  13.         URL_ROOT:    '../',

  14.         VERSION:     '0.12.0',

  15.         COLLAPSE_INDEX: false,

  16.         FILE_SUFFIX: '.html',

  17.         HAS_SOURCE:  true,

  18.         SOURCELINK_SUFFIX: '.txt'

  19.       };

  20.     </script>

  21.     <script type="text/javascript" src="../_static/jquery.js"></script>

  22.     <script type="text/javascript" src="../_static/underscore.js"></script>

  23.     <script type="text/javascript" src="../_static/doctools.js"></script>

  24.     <link rel="index" title="Index" href="../genindex.html" />

  25.     <link rel="search" title="Search" href="../search.html" />

  26.     <link rel="next" title="Plugins" href="plugins.html" />

  27.     <link rel="prev" title="Engine overview" href="engine_overview.html" />

  28.    

  29.   

  30.   <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />

  31.   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">

  32. 

  33.   </head>

  34.   <body>  

  35. 

  36.     <div class="document">

  37.       <div class="documentwrapper">

  38.         <div class="bodywrapper">

  39.           <div class="body" role="main">

  40.             

  41.   <div class="section" id="search-api">

  42. <h1>Search API<a class="headerlink" href="#search-api" title="Permalink to this headline">¶</a></h1>

  43. <p>The search supports both <code class="docutils literal"><span class="pre">GET</span></code> and <code class="docutils literal"><span class="pre">POST</span></code>.</p>

  44. <p>Furthermore, two enpoints <code class="docutils literal"><span class="pre">/</span></code> and <code class="docutils literal"><span class="pre">/search</span></code> are available for querying.</p>

  45. <p><code class="docutils literal"><span class="pre">GET</span> <span class="pre">/</span></code></p>

  46. <p><code class="docutils literal"><span class="pre">GET</span> <span class="pre">/search</span></code></p>

  47. <div class="section" id="parameters">

  48. <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>

  49. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">q</span>

  50. </pre></div>

  51. </div>

  52. <p>The search query. This string is passed to external search services.

  53. Thus, searx supports syntax of each search service. For example, <code class="docutils literal"><span class="pre">site:github.com</span> <span class="pre">searx</span></code> is a valid

  54. query for Google. However, if simply the query above is passed to any search engine which does not filter its

  55. results based on this syntax, you might not get the results you wanted.</p>

  56. <p>See more at <a class="reference internal" href="../user/search_syntax.html"><span class="doc">Search syntax</span></a></p>

  57. <p>Required.</p>

  58. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">categories</span>

  59. </pre></div>

  60. </div>

  61. <p>Comma separated list, specifies the active search categories</p>

  62. <p>Optional.</p>

  63. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">engines</span>

  64. </pre></div>

  65. </div>

  66. <p>Comma separated list, specifies the active search engines.</p>

  67. <p>Optional.</p>

  68. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">lang</span>

  69. </pre></div>

  70. </div>

  71. <p>Code of the language.</p>

  72. <p>Optional.</p>

  73. <p>Default: <code class="docutils literal"><span class="pre">all</span></code></p>

  74. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">pageno</span>

  75. </pre></div>

  76. </div>

  77. <p>Search page number.</p>

  78. <p>Optional.</p>

  79. <p>Default: <code class="docutils literal"><span class="pre">1</span></code></p>

  80. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">time_range</span>

  81. </pre></div>

  82. </div>

  83. <p>Time range of search for engines which support it. See if an engine supports time range search in the preferences page of an instance.</p>

  84. <p>Optional.</p>

  85. <p>Possible: <code class="docutils literal"><span class="pre">day</span></code>, <code class="docutils literal"><span class="pre">month</span></code>, <code class="docutils literal"><span class="pre">year</span></code></p>

  86. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="nb">format</span>

  87. </pre></div>

  88. </div>

  89. <p>Output format of results.</p>

  90. <p>Optional.</p>

  91. <p>Possible: <code class="docutils literal"><span class="pre">json</span></code>, <code class="docutils literal"><span class="pre">csv</span></code>, <code class="docutils literal"><span class="pre">rss</span></code></p>

  92. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">results_on_new_tab</span>

  93. </pre></div>

  94. </div>

  95. <p>Open search results on new tab.</p>

  96. <p>Optional.</p>

  97. <p>Default: <code class="docutils literal"><span class="pre">0</span></code></p>

  98. <p>Possible: <code class="docutils literal"><span class="pre">0</span></code>, <code class="docutils literal"><span class="pre">1</span></code></p>

  99. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">image_proxy</span>

  100. </pre></div>

  101. </div>

  102. <p>Proxy image results through searx.</p>

  103. <p>Optional.</p>

  104. <p>Default: <code class="docutils literal"><span class="pre">False</span></code></p>

  105. <p>Possible: <code class="docutils literal"><span class="pre">True</span></code>, <code class="docutils literal"><span class="pre">False</span></code></p>

  106. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">autocomplete</span>

  107. </pre></div>

  108. </div>

  109. <p>Service which completes words as you type.</p>

  110. <p>Optional.</p>

  111. <p>Default: empty</p>

  112. <p>Possible: <code class="docutils literal"><span class="pre">google</span></code>, <code class="docutils literal"><span class="pre">dbpedia</span></code>, <code class="docutils literal"><span class="pre">duckduckgo</span></code>, <code class="docutils literal"><span class="pre">startpage</span></code>, <code class="docutils literal"><span class="pre">wikipedia</span></code></p>

  113. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">safesearch</span>

  114. </pre></div>

  115. </div>

  116. <p>Filter search results of engines which support safe search. See if an engine supports safe search in the preferences page of an instance.</p>

  117. <p>Optional.</p>

  118. <p>Default: <code class="docutils literal"><span class="pre">None</span></code></p>

  119. <p>Possible: <code class="docutils literal"><span class="pre">0</span></code>, <code class="docutils literal"><span class="pre">1</span></code>, <code class="docutils literal"><span class="pre">None</span></code></p>

  120. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">theme</span>

  121. </pre></div>

  122. </div>

  123. <p>Theme of instance.</p>

  124. <p>Optional.</p>

  125. <p>Default: <code class="docutils literal"><span class="pre">oscar</span></code></p>

  126. <p>Possible: <code class="docutils literal"><span class="pre">oscar</span></code>, <code class="docutils literal"><span class="pre">simple</span></code>, <code class="docutils literal"><span class="pre">legacy</span></code>, <code class="docutils literal"><span class="pre">pix-art</span></code>, <code class="docutils literal"><span class="pre">courgette</span></code></p>

  127. <p>Please note, available themes depend on an instance. It is possible that an instance administrator deleted, created or renamed themes on his/her instance. See the available options in the preferences page of the instance.</p>

  128. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">oscar</span><span class="o">-</span><span class="n">style</span>

  129. </pre></div>

  130. </div>

  131. <p>Style of Oscar theme. It is only parsed if the theme of an instance is <code class="docutils literal"><span class="pre">oscar</span></code>.</p>

  132. <p>Optional.</p>

  133. <p>Default: <code class="docutils literal"><span class="pre">logicodev</span></code></p>

  134. <p>Possible: <code class="docutils literal"><span class="pre">pointhi</span></code>, <code class="docutils literal"><span class="pre">logicodev</span></code></p>

  135. <p>Please note, available styles depend on an instance. It is possible that an instance administrator deleted, created or renamed styles on his/her instance. See the available options in the preferences page of the instance.</p>

  136. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">enabled_plugins</span>

  137. </pre></div>

  138. </div>

  139. <p>List of enabled plugins.</p>

  140. <p>Optional.</p>

  141. <p>Default: <code class="docutils literal"><span class="pre">HTTPS_rewrite</span></code>, <code class="docutils literal"><span class="pre">Self_Informations</span></code>, <code class="docutils literal"><span class="pre">Search_on_category_select</span></code>, <code class="docutils literal"><span class="pre">Tracker_URL_remover</span></code></p>

  142. <p>Possible: <code class="docutils literal"><span class="pre">DOAI_rewrite</span></code>, <code class="docutils literal"><span class="pre">HTTPS_rewrite</span></code>, <code class="docutils literal"><span class="pre">Infinite_scroll</span></code>, <code class="docutils literal"><span class="pre">Vim-like_hotkeys</span></code>, <code class="docutils literal"><span class="pre">Self_Informations</span></code>, <code class="docutils literal"><span class="pre">Tracker_URL_remover</span></code>, <code class="docutils literal"><span class="pre">Search_on_category_select</span></code></p>

  143. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">disabled_plugins</span>

  144. </pre></div>

  145. </div>

  146. <p>List of disabled plugins.</p>

  147. <p>Optional.</p>

  148. <p>Default: <code class="docutils literal"><span class="pre">DOAI_rewrite</span></code>, <code class="docutils literal"><span class="pre">Infinite_scroll</span></code>, <code class="docutils literal"><span class="pre">Vim-like_hotkeys</span></code></p>

  149. <p>Possible: <code class="docutils literal"><span class="pre">DOAI_rewrite</span></code>, <code class="docutils literal"><span class="pre">HTTPS_rewrite</span></code>, <code class="docutils literal"><span class="pre">Infinite_scroll</span></code>, <code class="docutils literal"><span class="pre">Vim-like_hotkeys</span></code>, <code class="docutils literal"><span class="pre">Self_Informations</span></code>, <code class="docutils literal"><span class="pre">Tracker_URL_remover</span></code>, <code class="docutils literal"><span class="pre">Search_on_category_select</span></code></p>

  150. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">enabled_engines</span>

  151. </pre></div>

  152. </div>

  153. <p>List of enabled engines.</p>

  154. <p>Optional.</p>

  155. <p>Possible:  all engines</p>

  156. <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">disabled_engines</span>

  157. </pre></div>

  158. </div>

  159. <p>List of disabled engines.</p>

  160. <p>Optional.</p>

  161. <p>Possible: all engines</p>

  162. </div>

  163. </div>

  164. 

  165. 

  166.           </div>

  167.         </div>

  168.       </div>

  169.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  170.         <div class="sphinxsidebarwrapper"><div class="sidebar_container body">

  171. <h1>Searx</h1>

  172. <ul>

  173.     <li><a href="../index.html">Home</a></li>

  174.     <li><a href="https://github.com/asciimoo/searx">Source</a></li>

  175.     <li><a href="../blog/blog.html">Blog</a></li>

  176.     <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>

  177.     <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>

  178. </ul>

  179. <hr />

  180. <ul>

  181.     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>

  182.     <li><a href="https://flattr.com/submit/auto?user_id=asciimoo&url=https://github.com/asciimoo/searx&title=searx&language=&tags=github&category=software">Flattr</a></li>

  183.     <li><a href="https://gratipay.com/searx">Gratipay</a></li>

  184. </ul>

  185. </div>

  186.         </div>

  187.       </div>

  188.       <div class="clearer"></div>

  189.     </div>

  190.     <div class="footer">

  191.       &copy; Copyright 2015-2017, Adam Tauber.

  192.     </div>

  193.   </body>

  194. </html>