@@ -5,31 +5,200 @@ The search supports both ``GET`` and ``POST``.
55
66Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
77
8+
9+``GET /``
10+
11+``GET /search``
12+
13+Parameters
14+~~~~~~~~~~
15+
816.. code:: sh
917
10− GET /
18+ q
19+
20+The search query. This string is passed to external search services.
21+Thus, searx supports syntax of each search service. For example, ``site:github.com searx`` is a valid
22+query for Google. However, if simply the query above is passed to any search engine which does not filter its
23+results based on this syntax, you might not get the results you wanted.
24+
25+
26+See more at :doc:`/user/search_syntax`
27+
28+Required.
1129
1230.. code:: sh
1331
14− GET /search
32+ categories
1533
16−Parameters
17−``````````
18−
19−+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
20−| Name | Description | |
21−+==================+====================================================================================================+==================================================+
22−| ``q`` | The search query, see :doc:`/user/search_syntax` | required |
23−+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
24−| ``categories`` | Comma separated list, specifies the active search categories | optional |
25−+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
26−| ``engines`` | Comma separated list, specifies the active search engines | optional |
27−+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
28−| ``lang`` | Code of the language | optional (default: ``all``) |
29−+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
30−| ``pageno`` | Search page number | optional (default: ``1``) |
31−+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
32−| ``time_range`` | Time range of search | optional (possible: ``day``, ``month``, ``year``)|
33−+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
34−| ``format`` | Output format of results | optional (possible: ``json``, ``csv``, ``rss``) |
35−+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
34+Comma separated list, specifies the active search categories
35+
36+Optional.
37+
38+.. code:: sh
39+
40+ engines
41+
42+Comma separated list, specifies the active search engines.
43+
44+Optional.
45+
46+.. code:: sh
47+
48+ lang
49+
50+Code of the language.
51+
52+Optional.
53+
54+Default: ``all``
55+
56+.. code:: sh
57+
58+ pageno
59+
60+Search page number.
61+
62+Optional.
63+
64+Default: ``1``
65+
66+.. code:: sh
67+
68+ time_range
69+
70+Time range of search for engines which support it. See if an engine supports time range search in the preferences page of an instance.
71+
72+Optional.
73+
74+Possible: ``day``, ``month``, ``year``
75+
76+.. code:: sh
77+
78+ format
79+
80+Output format of results.
81+
82+Optional.
83+
84+Possible: ``json``, ``csv``, ``rss``
85+
86+.. code:: sh
87+
88+ results_on_new_tab
89+
90+Open search results on new tab.
91+
92+Optional.
93+
94+Default: ``0``
95+
96+Possible: ``0``, ``1``
97+
98+.. code:: sh
99+
100+ image_proxy
101+
102+Proxy image results through searx.
103+
104+Optional.
105+
106+Default: ``False``
107+
108+Possible: ``True``, ``False``
109+
110+.. code:: sh
111+
112+ autocomplete
113+
114+Service which completes words as you type.
115+
116+Optional.
117+
118+Default: empty
119+
120+Possible: ``google``, ``dbpedia``, ``duckduckgo``, ``startpage``, ``wikipedia``
121+
122+.. code:: sh
123+
124+ safesearch
125+
126+Filter search results of engines which support safe search. See if an engine supports safe search in the preferences page of an instance.
127+
128+Optional.
129+
130+Default: ``None``
131+
132+Possible: ``0``, ``1``, ``None``
133+
134+.. code:: sh
135+
136+ theme
137+
138+Theme of instance.
139+
140+Optional.
141+
142+Default: ``oscar``
143+
144+Possible: ``oscar``, ``simple``, ``legacy``, ``pix-art``, ``courgette``
145+
146+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.
147+
148+.. code:: sh
149+
150+ oscar-style
151+
152+Style of Oscar theme. It is only parsed if the theme of an instance is ``oscar``.
153+
154+Optional.
155+
156+Default: ``logicodev``
157+
158+Possible: ``pointhi``, ``logicodev``
159+
160+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.
161+
162+.. code:: sh
163+
164+ enabled_plugins
165+
166+List of enabled plugins.
167+
168+Optional.
169+
170+Default: ``HTTPS_rewrite``, ``Self_Informations``, ``Search_on_category_select``, ``Tracker_URL_remover``
171+
172+Possible: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``, ``Search_on_category_select``
173+
174+.. code:: sh
175+
176+ disabled_plugins
177+
178+List of disabled plugins.
179+
180+Optional.
181+
182+Default: ``DOAI_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``
183+
184+Possible: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``, ``Search_on_category_select``
185+
186+.. code:: sh
187+
188+ enabled_engines
189+
190+List of enabled engines.
191+
192+Optional.
193+
194+Possible: all engines
195+
196+.. code:: sh
197+
198+ disabled_engines
199+
200+List of disabled engines.
201+
202+Optional.
203+
204+Possible: all engines