git.iko.soy/searx
on f9be534 help sign in
searx/docs/dev/search_api.rst
119 lines 3.5 kB history raw
1==========
2Search API
3==========
5The search supports both ``GET`` and ``POST``.
7Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
10``GET /``
12``GET /search``
14Parameters
15==========
17.. sidebar:: Further reading ..
19 - :ref:`engines generic`
20 - :ref:`configured engines`
21 - :ref:`engine settings`
22 - :ref:`engine file`
24``q`` : required
25 The search query. This string is passed to external search services. Thus,
26 searx supports syntax of each search service. For example, ``site:github.com
27 searx`` is a valid query for Google. However, if simply the query above is
28 passed to any search engine which does not filter its results based on this
29 syntax, you might not get the results you wanted.
31 See more at :ref:`search-syntax`
33``categories`` : optional
34 Comma separated list, specifies the active search categories
36``engines`` : optional
37 Comma separated list, specifies the active search engines.
39``lang`` : default ``all``
40 Code of the language.
42``pageno`` : default ``1``
43 Search page number.
45``time_range`` : optional
46 [ ``day``, ``month``, ``year`` ]
48 Time range of search for engines which support it. See if an engine supports
49 time range search in the preferences page of an instance.
51``format`` : optional
52 [ ``json``, ``csv``, ``rss`` ]
54 Output format of results.
56``results_on_new_tab`` : default ``0``
57 [ ``0``, ``1`` ]
59 Open search results on new tab.
61``image_proxy`` : default ``False``
62 [ ``True``, ``False`` ]
64 Proxy image results through searx.
66``autocomplete`` : default *empty*
67 [ ``google``, ``dbpedia``, ``duckduckgo``, ``startpage``, ``wikipedia`` ]
69 Service which completes words as you type.
71``safesearch`` : default ``None``
72 [ ``0``, ``1``, ``None`` ]
74 Filter search results of engines which support safe search. See if an engine
75 supports safe search in the preferences page of an instance.
77``theme`` : default ``oscar``
78 [ ``oscar``, ``simple``, ``legacy``, ``pix-art``, ``courgette`` ]
80 Theme of instance.
82 Please note, available themes depend on an instance. It is possible that an
83 instance administrator deleted, created or renamed themes on his/her instance.
84 See the available options in the preferences page of the instance.
86``oscar-style`` : default ``logicodev``
87 [ ``pointhi``, ``logicodev`` ]
89 Style of Oscar theme. It is only parsed if the theme of an instance is
90 ``oscar``.
92 Please note, available styles depend on an instance. It is possible that an
93 instance administrator deleted, created or renamed styles on his/her
94 instance. See the available options in the preferences page of the instance.
96``enabled_plugins`` : optional
97 List of enabled plugins.
99 :default: ``HTTPS_rewrite``, ``Self_Informations``,
100 ``Search_on_category_select``, ``Tracker_URL_remover``
102 :values: [ ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``,
103 ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``,
104 ``Search_on_category_select`` ]
106``disabled_plugins``: optional
107 List of disabled plugins.
109 :default: ``DOAI_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``
110 :values: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``,
111 ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``,
112 ``Search_on_category_select``
114``enabled_engines`` : optional : *all* :origin:`engines <searx/engines>`
115 List of enabled engines.
117``disabled_engines`` : optional : *all* :origin:`engines <searx/engines>`
118 List of disabled engines.