engine_overview.html 23KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>Engine overview &mdash; searx 0.8.0 documentation</title>
  7. <link rel="stylesheet" href="../_static/style.css" type="text/css" />
  8. <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '../',
  12. VERSION: '0.8.0',
  13. COLLAPSE_INDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="../_static/jquery.js"></script>
  19. <script type="text/javascript" src="../_static/underscore.js"></script>
  20. <script type="text/javascript" src="../_static/doctools.js"></script>
  21. <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
  22. <link rel="next" title="Search API" href="search_api.html" />
  23. <link rel="prev" title="Installation" href="install/installation.html" />
  24. <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
  25. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
  26. </head>
  27. <body role="document">
  28. <div class="document">
  29. <div class="documentwrapper">
  30. <div class="bodywrapper">
  31. <div class="body" role="main">
  32. <div class="section" id="engine-overview">
  33. <h1><a class="toc-backref" href="#id2">Engine overview</a><a class="headerlink" href="#engine-overview" title="Permalink to this headline">¶</a></h1>
  34. <p>searx is a <a class="reference external" href="https://en.wikipedia.org/wiki/Metasearch_engine">metasearch-engine</a>,
  35. so it is using different search engines to provide better results.</p>
  36. <p>Because there is no general search-api which can be used for every
  37. search-engine, there must be build an adapter between searx and the
  38. external search-engine. This adapters are stored in the folder
  39. <a class="reference external" href="https://github.com/asciimoo/searx/tree/master/searx/engines">*searx/engines*</a>,
  40. and this site is build to make an general documentation about this
  41. engines</p>
  42. <div class="contents topic" id="contents">
  43. <p class="topic-title first">Contents</p>
  44. <ul class="simple">
  45. <li><a class="reference internal" href="#engine-overview" id="id2">Engine overview</a><ul>
  46. <li><a class="reference internal" href="#general-engine-configuration" id="id3">general engine configuration</a><ul>
  47. <li><a class="reference internal" href="#engine-file" id="id4">engine-file</a></li>
  48. <li><a class="reference internal" href="#settings-yml" id="id5">settings.yml</a></li>
  49. <li><a class="reference internal" href="#overrides" id="id6">overrides</a></li>
  50. <li><a class="reference internal" href="#example-code" id="id7">example-code</a></li>
  51. </ul>
  52. </li>
  53. <li><a class="reference internal" href="#doing-request" id="id8">doing request</a><ul>
  54. <li><a class="reference internal" href="#passed-arguments" id="id9">passed arguments</a></li>
  55. <li><a class="reference internal" href="#parsed-arguments" id="id10">parsed arguments</a></li>
  56. <li><a class="reference internal" href="#id1" id="id11">example-code</a></li>
  57. </ul>
  58. </li>
  59. <li><a class="reference internal" href="#returning-results" id="id12">returning results</a><ul>
  60. <li><a class="reference internal" href="#default" id="id13">default</a></li>
  61. <li><a class="reference internal" href="#images" id="id14">images</a></li>
  62. <li><a class="reference internal" href="#videos" id="id15">videos</a></li>
  63. <li><a class="reference internal" href="#torrent" id="id16">torrent</a></li>
  64. <li><a class="reference internal" href="#map" id="id17">map</a></li>
  65. </ul>
  66. </li>
  67. </ul>
  68. </li>
  69. </ul>
  70. </div>
  71. <div class="section" id="general-engine-configuration">
  72. <h2><a class="toc-backref" href="#id3">general engine configuration</a><a class="headerlink" href="#general-engine-configuration" title="Permalink to this headline">¶</a></h2>
  73. <p>It is required to tell searx what results can the engine provide. The
  74. arguments can be inserted in the engine file, or in the settings file
  75. (normally <code class="docutils literal"><span class="pre">settings.yml</span></code>). The arguments in the settings file override
  76. the one in the engine file.</p>
  77. <p>Really, it is for most options no difference if there are contained in
  78. the engine-file or in the settings. But there is a standard where to
  79. place specific arguments by default.</p>
  80. <div class="section" id="engine-file">
  81. <h3><a class="toc-backref" href="#id4">engine-file</a><a class="headerlink" href="#engine-file" title="Permalink to this headline">¶</a></h3>
  82. <table border="1" class="docutils">
  83. <colgroup>
  84. <col width="29%" />
  85. <col width="15%" />
  86. <col width="56%" />
  87. </colgroup>
  88. <thead valign="bottom">
  89. <tr class="row-odd"><th class="head">argument</th>
  90. <th class="head">type</th>
  91. <th class="head">information</th>
  92. </tr>
  93. </thead>
  94. <tbody valign="top">
  95. <tr class="row-even"><td>categories</td>
  96. <td>list</td>
  97. <td>pages, in which the engine is working</td>
  98. </tr>
  99. <tr class="row-odd"><td>paging</td>
  100. <td>boolean</td>
  101. <td>support multible pages</td>
  102. </tr>
  103. <tr class="row-even"><td>language_support</td>
  104. <td>boolean</td>
  105. <td>support language choosing</td>
  106. </tr>
  107. </tbody>
  108. </table>
  109. </div>
  110. <div class="section" id="settings-yml">
  111. <h3><a class="toc-backref" href="#id5">settings.yml</a><a class="headerlink" href="#settings-yml" title="Permalink to this headline">¶</a></h3>
  112. <table border="1" class="docutils">
  113. <colgroup>
  114. <col width="17%" />
  115. <col width="14%" />
  116. <col width="68%" />
  117. </colgroup>
  118. <thead valign="bottom">
  119. <tr class="row-odd"><th class="head">argument</th>
  120. <th class="head">type</th>
  121. <th class="head">information</th>
  122. </tr>
  123. </thead>
  124. <tbody valign="top">
  125. <tr class="row-even"><td>name</td>
  126. <td>string</td>
  127. <td>name of search-engine</td>
  128. </tr>
  129. <tr class="row-odd"><td>engine</td>
  130. <td>string</td>
  131. <td>name of searx-engine (filename without .py)</td>
  132. </tr>
  133. <tr class="row-even"><td>shortcut</td>
  134. <td>string</td>
  135. <td>shortcut of search-engine</td>
  136. </tr>
  137. <tr class="row-odd"><td>timeout</td>
  138. <td>string</td>
  139. <td>specific timeout for search-engine</td>
  140. </tr>
  141. </tbody>
  142. </table>
  143. </div>
  144. <div class="section" id="overrides">
  145. <h3><a class="toc-backref" href="#id6">overrides</a><a class="headerlink" href="#overrides" title="Permalink to this headline">¶</a></h3>
  146. <p>There are some options, with have default values in the engine, but are
  147. often overwritten by the settings. If the option is assigned in the
  148. engine-file with <code class="docutils literal"><span class="pre">None</span></code> it has to be redefined in the settings,
  149. otherwise searx is not starting with that engine.</p>
  150. <p>The naming of that overrides can be wathever you want. But we recommend
  151. the using of already used overrides if possible:</p>
  152. <table border="1" class="docutils">
  153. <colgroup>
  154. <col width="24%" />
  155. <col width="11%" />
  156. <col width="65%" />
  157. </colgroup>
  158. <thead valign="bottom">
  159. <tr class="row-odd"><th class="head">argument</th>
  160. <th class="head">type</th>
  161. <th class="head">information</th>
  162. </tr>
  163. </thead>
  164. <tbody valign="top">
  165. <tr class="row-even"><td>base_url</td>
  166. <td>string</td>
  167. <td>base-url, can be overwrite to use same engine on other url</td>
  168. </tr>
  169. <tr class="row-odd"><td>number_of_results</td>
  170. <td>int</td>
  171. <td>maximum number of results per request</td>
  172. </tr>
  173. <tr class="row-even"><td>language</td>
  174. <td>string</td>
  175. <td>ISO code of language and country like en_US</td>
  176. </tr>
  177. <tr class="row-odd"><td>api_key</td>
  178. <td>string</td>
  179. <td>api-key if required by engine</td>
  180. </tr>
  181. </tbody>
  182. </table>
  183. </div>
  184. <div class="section" id="example-code">
  185. <h3><a class="toc-backref" href="#id7">example-code</a><a class="headerlink" href="#example-code" title="Permalink to this headline">¶</a></h3>
  186. <div class="code python highlight-python"><div class="highlight"><pre><span class="c"># engine dependent config</span>
  187. <span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;general&#39;</span><span class="p">]</span>
  188. <span class="n">paging</span> <span class="o">=</span> <span class="bp">True</span>
  189. <span class="n">language_support</span> <span class="o">=</span> <span class="bp">True</span>
  190. </pre></div>
  191. </div>
  192. </div>
  193. </div>
  194. <div class="section" id="doing-request">
  195. <h2><a class="toc-backref" href="#id8">doing request</a><a class="headerlink" href="#doing-request" title="Permalink to this headline">¶</a></h2>
  196. <p>To perform a search you have to specific at least a url on which the
  197. request is performing</p>
  198. <div class="section" id="passed-arguments">
  199. <h3><a class="toc-backref" href="#id9">passed arguments</a><a class="headerlink" href="#passed-arguments" title="Permalink to this headline">¶</a></h3>
  200. <p>This arguments can be used to calculate the search-query. Furthermore,
  201. some of that parameters are filled with default values which can be
  202. changed for special purpose.</p>
  203. <table border="1" class="docutils">
  204. <colgroup>
  205. <col width="21%" />
  206. <col width="11%" />
  207. <col width="68%" />
  208. </colgroup>
  209. <thead valign="bottom">
  210. <tr class="row-odd"><th class="head">argument</th>
  211. <th class="head">type</th>
  212. <th class="head">default-value, informations</th>
  213. </tr>
  214. </thead>
  215. <tbody valign="top">
  216. <tr class="row-even"><td>url</td>
  217. <td>string</td>
  218. <td><code class="docutils literal"><span class="pre">''</span></code></td>
  219. </tr>
  220. <tr class="row-odd"><td>method</td>
  221. <td>string</td>
  222. <td><code class="docutils literal"><span class="pre">'GET'</span></code></td>
  223. </tr>
  224. <tr class="row-even"><td>headers</td>
  225. <td>set</td>
  226. <td><code class="docutils literal"><span class="pre">{}</span></code></td>
  227. </tr>
  228. <tr class="row-odd"><td>data</td>
  229. <td>set</td>
  230. <td><code class="docutils literal"><span class="pre">{}</span></code></td>
  231. </tr>
  232. <tr class="row-even"><td>cookies</td>
  233. <td>set</td>
  234. <td><code class="docutils literal"><span class="pre">{}</span></code></td>
  235. </tr>
  236. <tr class="row-odd"><td>verify</td>
  237. <td>boolean</td>
  238. <td><code class="docutils literal"><span class="pre">True</span></code></td>
  239. </tr>
  240. <tr class="row-even"><td>headers.User-Agent</td>
  241. <td>string</td>
  242. <td>a random User-Agent</td>
  243. </tr>
  244. <tr class="row-odd"><td>category</td>
  245. <td>string</td>
  246. <td>current category, like <code class="docutils literal"><span class="pre">'general'</span></code></td>
  247. </tr>
  248. <tr class="row-even"><td>started</td>
  249. <td>datetime</td>
  250. <td>current date-time</td>
  251. </tr>
  252. <tr class="row-odd"><td>pageno</td>
  253. <td>int</td>
  254. <td>current pagenumber</td>
  255. </tr>
  256. <tr class="row-even"><td>language</td>
  257. <td>string</td>
  258. <td>specific language code like <code class="docutils literal"><span class="pre">'en_US'</span></code>, or <code class="docutils literal"><span class="pre">'all'</span></code> if unspecified</td>
  259. </tr>
  260. </tbody>
  261. </table>
  262. </div>
  263. <div class="section" id="parsed-arguments">
  264. <h3><a class="toc-backref" href="#id10">parsed arguments</a><a class="headerlink" href="#parsed-arguments" title="Permalink to this headline">¶</a></h3>
  265. <p>The function <code class="docutils literal"><span class="pre">def</span> <span class="pre">request(query,</span> <span class="pre">params):</span></code> is always returning the
  266. <code class="docutils literal"><span class="pre">params</span></code> variable back. Inside searx, the following paramters can be
  267. used to specific a search-request:</p>
  268. <table border="1" class="docutils">
  269. <colgroup>
  270. <col width="15%" />
  271. <col width="14%" />
  272. <col width="72%" />
  273. </colgroup>
  274. <thead valign="bottom">
  275. <tr class="row-odd"><th class="head">argument</th>
  276. <th class="head">type</th>
  277. <th class="head">information</th>
  278. </tr>
  279. </thead>
  280. <tbody valign="top">
  281. <tr class="row-even"><td>url</td>
  282. <td>string</td>
  283. <td>requested url</td>
  284. </tr>
  285. <tr class="row-odd"><td>method</td>
  286. <td>string</td>
  287. <td>HTTP request methode</td>
  288. </tr>
  289. <tr class="row-even"><td>headers</td>
  290. <td>set</td>
  291. <td>HTTP header informations</td>
  292. </tr>
  293. <tr class="row-odd"><td>data</td>
  294. <td>set</td>
  295. <td>HTTP data informations (parsed if <code class="docutils literal"><span class="pre">method</span> <span class="pre">!=</span> <span class="pre">'GET'</span></code>)</td>
  296. </tr>
  297. <tr class="row-even"><td>cookies</td>
  298. <td>set</td>
  299. <td>HTTP cookies</td>
  300. </tr>
  301. <tr class="row-odd"><td>verify</td>
  302. <td>boolean</td>
  303. <td>Performing SSL-Validity check</td>
  304. </tr>
  305. </tbody>
  306. </table>
  307. </div>
  308. <div class="section" id="id1">
  309. <h3><a class="toc-backref" href="#id11">example-code</a><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
  310. <div class="code python highlight-python"><div class="highlight"><pre><span class="c"># search-url</span>
  311. <span class="n">base_url</span> <span class="o">=</span> <span class="s">&#39;https://example.com/&#39;</span>
  312. <span class="n">search_string</span> <span class="o">=</span> <span class="s">&#39;search?{query}&amp;page={page}&#39;</span>
  313. <span class="c"># do search-request</span>
  314. <span class="k">def</span> <span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
  315. <span class="n">search_path</span> <span class="o">=</span> <span class="n">search_string</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
  316. <span class="n">query</span><span class="o">=</span><span class="n">urlencode</span><span class="p">({</span><span class="s">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">}),</span>
  317. <span class="n">page</span><span class="o">=</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;pageno&#39;</span><span class="p">])</span>
  318. <span class="n">params</span><span class="p">[</span><span class="s">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="n">search_path</span>
  319. <span class="k">return</span> <span class="n">params</span>
  320. </pre></div>
  321. </div>
  322. </div>
  323. </div>
  324. <div class="section" id="returning-results">
  325. <h2><a class="toc-backref" href="#id12">returning results</a><a class="headerlink" href="#returning-results" title="Permalink to this headline">¶</a></h2>
  326. <p>Searx has the possiblity to return results in different media-types.
  327. Currently the following media-types are supported:</p>
  328. <ul class="simple">
  329. <li>default</li>
  330. <li>images</li>
  331. <li>videos</li>
  332. <li>torrent</li>
  333. <li>map</li>
  334. </ul>
  335. <p>to set another media-type as default, you must set the parameter
  336. <code class="docutils literal"><span class="pre">template</span></code> to the required type.</p>
  337. <div class="section" id="default">
  338. <h3><a class="toc-backref" href="#id13">default</a><a class="headerlink" href="#default" title="Permalink to this headline">¶</a></h3>
  339. <table border="1" class="docutils">
  340. <colgroup>
  341. <col width="13%" />
  342. <col width="87%" />
  343. </colgroup>
  344. <thead valign="bottom">
  345. <tr class="row-odd"><th class="head">result-parameter</th>
  346. <th class="head">information</th>
  347. </tr>
  348. </thead>
  349. <tbody valign="top">
  350. <tr class="row-even"><td>url</td>
  351. <td>string, which is representing the url of the result</td>
  352. </tr>
  353. <tr class="row-odd"><td>title</td>
  354. <td>string, which is representing the title of the result</td>
  355. </tr>
  356. <tr class="row-even"><td>content</td>
  357. <td>string, which is giving a general result-text</td>
  358. </tr>
  359. <tr class="row-odd"><td>publishedDate</td>
  360. <td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, represent when the result is published</td>
  361. </tr>
  362. </tbody>
  363. </table>
  364. </div>
  365. <div class="section" id="images">
  366. <h3><a class="toc-backref" href="#id14">images</a><a class="headerlink" href="#images" title="Permalink to this headline">¶</a></h3>
  367. <p>to use this template, the parameter</p>
  368. <table border="1" class="docutils">
  369. <colgroup>
  370. <col width="11%" />
  371. <col width="89%" />
  372. </colgroup>
  373. <thead valign="bottom">
  374. <tr class="row-odd"><th class="head">result-parameter</th>
  375. <th class="head">information</th>
  376. </tr>
  377. </thead>
  378. <tbody valign="top">
  379. <tr class="row-even"><td>template</td>
  380. <td>is set to <code class="docutils literal"><span class="pre">images.html</span></code></td>
  381. </tr>
  382. <tr class="row-odd"><td>url</td>
  383. <td>string, which is representing the url to the result site</td>
  384. </tr>
  385. <tr class="row-even"><td>title</td>
  386. <td>string, which is representing the title of the result <em>(partly implemented)</em></td>
  387. </tr>
  388. <tr class="row-odd"><td>content</td>
  389. <td><em>(partly implemented)</em></td>
  390. </tr>
  391. <tr class="row-even"><td>publishedDate</td>
  392. <td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, represent when the result is published <em>(partly implemented)</em></td>
  393. </tr>
  394. <tr class="row-odd"><td>img_src</td>
  395. <td>string, which is representing the url to the result image</td>
  396. </tr>
  397. <tr class="row-even"><td>thumbnail_src</td>
  398. <td>string, which is representing the url to a small-preview image</td>
  399. </tr>
  400. </tbody>
  401. </table>
  402. </div>
  403. <div class="section" id="videos">
  404. <h3><a class="toc-backref" href="#id15">videos</a><a class="headerlink" href="#videos" title="Permalink to this headline">¶</a></h3>
  405. <table border="1" class="docutils">
  406. <colgroup>
  407. <col width="13%" />
  408. <col width="87%" />
  409. </colgroup>
  410. <thead valign="bottom">
  411. <tr class="row-odd"><th class="head">result-parameter</th>
  412. <th class="head">information</th>
  413. </tr>
  414. </thead>
  415. <tbody valign="top">
  416. <tr class="row-even"><td>template</td>
  417. <td>is set to <code class="docutils literal"><span class="pre">videos.html</span></code></td>
  418. </tr>
  419. <tr class="row-odd"><td>url</td>
  420. <td>string, which is representing the url of the result</td>
  421. </tr>
  422. <tr class="row-even"><td>title</td>
  423. <td>string, which is representing the title of the result</td>
  424. </tr>
  425. <tr class="row-odd"><td>content</td>
  426. <td><em>(not implemented yet)</em></td>
  427. </tr>
  428. <tr class="row-even"><td>publishedDate</td>
  429. <td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, represent when the result is published</td>
  430. </tr>
  431. <tr class="row-odd"><td>thumbnail</td>
  432. <td>string, which is representing the url to a small-preview image</td>
  433. </tr>
  434. </tbody>
  435. </table>
  436. </div>
  437. <div class="section" id="torrent">
  438. <h3><a class="toc-backref" href="#id16">torrent</a><a class="headerlink" href="#torrent" title="Permalink to this headline">¶</a></h3>
  439. <table border="1" class="docutils">
  440. <colgroup>
  441. <col width="11%" />
  442. <col width="89%" />
  443. </colgroup>
  444. <tbody valign="top">
  445. <tr class="row-odd"><td>result-parameter</td>
  446. <td>information</td>
  447. </tr>
  448. <tr class="row-even"><td>template</td>
  449. <td>is set to <code class="docutils literal"><span class="pre">`torrent.html`</span></code></td>
  450. </tr>
  451. <tr class="row-odd"><td>url</td>
  452. <td>string, which is representing the url of the result</td>
  453. </tr>
  454. <tr class="row-even"><td>title</td>
  455. <td>string, which is representing the title of the result</td>
  456. </tr>
  457. <tr class="row-odd"><td>content</td>
  458. <td>string, which is giving a general result-text</td>
  459. </tr>
  460. <tr class="row-even"><td>publishedDate</td>
  461. <td>[datetime.datetime](<a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">https://docs.python.org/2/library/datetime.html#datetime-objects</a>), represent when the result is published _(not implemented yet)_</td>
  462. </tr>
  463. <tr class="row-odd"><td>seed</td>
  464. <td>int, number of seeder</td>
  465. </tr>
  466. <tr class="row-even"><td>leech</td>
  467. <td>int, number of leecher</td>
  468. </tr>
  469. <tr class="row-odd"><td>filesize</td>
  470. <td>int, size of file in bytes</td>
  471. </tr>
  472. <tr class="row-even"><td>files</td>
  473. <td>int, number of files</td>
  474. </tr>
  475. <tr class="row-odd"><td>magnetlink</td>
  476. <td>string, which is the [magnetlink](<a class="reference external" href="https://en.wikipedia.org/wiki/Magnet_URI_scheme">https://en.wikipedia.org/wiki/Magnet_URI_scheme</a>) of the result</td>
  477. </tr>
  478. <tr class="row-even"><td>torrentfile</td>
  479. <td>string, which is the torrentfile of the result</td>
  480. </tr>
  481. </tbody>
  482. </table>
  483. </div>
  484. <div class="section" id="map">
  485. <h3><a class="toc-backref" href="#id17">map</a><a class="headerlink" href="#map" title="Permalink to this headline">¶</a></h3>
  486. <table border="1" class="docutils">
  487. <colgroup>
  488. <col width="16%" />
  489. <col width="84%" />
  490. </colgroup>
  491. <thead valign="bottom">
  492. <tr class="row-odd"><th class="head">result-parameter</th>
  493. <th class="head">information</th>
  494. </tr>
  495. </thead>
  496. <tbody valign="top">
  497. <tr class="row-even"><td>url</td>
  498. <td>string, which is representing the url of the result</td>
  499. </tr>
  500. <tr class="row-odd"><td>title</td>
  501. <td>string, which is representing the title of the result</td>
  502. </tr>
  503. <tr class="row-even"><td>content</td>
  504. <td>string, which is giving a general result-text</td>
  505. </tr>
  506. <tr class="row-odd"><td>publishedDate</td>
  507. <td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, represent when the result is published</td>
  508. </tr>
  509. <tr class="row-even"><td>latitude</td>
  510. <td>latitude of result (in decimal format)</td>
  511. </tr>
  512. <tr class="row-odd"><td>longitude</td>
  513. <td>longitude of result (in decimal format)</td>
  514. </tr>
  515. <tr class="row-even"><td>boundingbox</td>
  516. <td>boundingbox of result (array of 4. values <code class="docutils literal"><span class="pre">[lat-min,</span> <span class="pre">lat-max,</span> <span class="pre">lon-min,</span> <span class="pre">lon-max]</span></code>)</td>
  517. </tr>
  518. <tr class="row-odd"><td>geojson</td>
  519. <td>geojson of result (<a class="reference external" href="http://geojson.org">http://geojson.org</a>)</td>
  520. </tr>
  521. <tr class="row-even"><td>osm.type</td>
  522. <td>type of osm-object (if OSM-Result)</td>
  523. </tr>
  524. <tr class="row-odd"><td>osm.id</td>
  525. <td>id of osm-object (if OSM-Result)</td>
  526. </tr>
  527. <tr class="row-even"><td>address.name</td>
  528. <td>name of object</td>
  529. </tr>
  530. <tr class="row-odd"><td>address.road</td>
  531. <td>street adress of object</td>
  532. </tr>
  533. <tr class="row-even"><td>address.house_number</td>
  534. <td>house number of object</td>
  535. </tr>
  536. <tr class="row-odd"><td>address.locality</td>
  537. <td>city, place of object</td>
  538. </tr>
  539. <tr class="row-even"><td>address.postcode</td>
  540. <td>postcode of object</td>
  541. </tr>
  542. <tr class="row-odd"><td>address.country</td>
  543. <td>country of object</td>
  544. </tr>
  545. </tbody>
  546. </table>
  547. </div>
  548. </div>
  549. </div>
  550. </div>
  551. </div>
  552. </div>
  553. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  554. <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
  555. <h1>Searx</h1>
  556. <ul>
  557. <li><a href="../index.html">Home</a></li>
  558. <li><a href="https://github.com/asciimoo/searx">Source</a></li>
  559. <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
  560. <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
  561. </ul>
  562. <hr />
  563. <ul>
  564. <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
  565. <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>
  566. <li><a href="https://gratipay.com/searx">Gratipay</a></li>
  567. </ul>
  568. </div>
  569. </div>
  570. </div>
  571. <div class="clearer"></div>
  572. </div>
  573. <div class="footer">
  574. &copy; Copyright 2015, Adam Tauber.
  575. </div>
  576. </body>
  577. </html>