git.iko.soy/searx
on e30dc2f help sign in
searx/docs/dev/search_api.rst
120 lines 3.5 kB history raw
1.. _search API:
3==========
4Search API
5==========
7The search supports both ``GET`` and ``POST``.
9Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
12``GET /``
14``GET /search``
16Parameters
17==========
19.. sidebar:: Further reading ..
21 - :ref:`engines-dev`
22 - :ref:`settings.yml`
23 - :ref:`engines generic`
25``q`` : required
26 The search query. This string is passed to external search services. Thus,
27 searx supports syntax of each search service. For example, ``site:github.com
28 searx`` is a valid query for Google. However, if simply the query above is
29 passed to any search engine which does not filter its results based on this
30 syntax, you might not get the results you wanted.
32 See more at :ref:`search-syntax`
34``categories`` : optional
35 Comma separated list, specifies the active search categories
37``engines`` : optional
38 Comma separated list, specifies the active search engines.
40``lang`` : default ``all``
41 Code of the language.
43``pageno`` : default ``1``
44 Search page number.
46``time_range`` : optional
47 [ ``day``, ``month``, ``year`` ]
49 Time range of search for engines which support it. See if an engine supports
50 time range search in the preferences page of an instance.
52``format`` : optional
53 [ ``json``, ``csv``, ``rss`` ]
55 Output format of results.
57``results_on_new_tab`` : default ``0``
58 [ ``0``, ``1`` ]
60 Open search results on new tab.
62``image_proxy`` : default ``False``
63 [ ``True``, ``False`` ]
65 Proxy image results through searx.
67``autocomplete`` : default *empty*
68 [ ``google``, ``dbpedia``, ``duckduckgo``, ``startpage``, ``wikipedia`` ]
70 Service which completes words as you type.
72``safesearch`` : default ``None``
73 [ ``0``, ``1``, ``None`` ]
75 Filter search results of engines which support safe search. See if an engine
76 supports safe search in the preferences page of an instance.
78``theme`` : default ``oscar``
79 [ ``oscar``, ``simple``, ``legacy``, ``pix-art``, ``courgette`` ]
81 Theme of instance.
83 Please note, available themes depend on an instance. It is possible that an
84 instance administrator deleted, created or renamed themes on their instance.
85 See the available options in the preferences page of the instance.
87``oscar-style`` : default ``logicodev``
88 [ ``pointhi``, ``logicodev`` ]
90 Style of Oscar theme. It is only parsed if the theme of an instance is
91 ``oscar``.
93 Please note, available styles depend on an instance. It is possible that an
94 instance administrator deleted, created or renamed styles on their
95 instance. See the available options in the preferences page of the instance.
97``enabled_plugins`` : optional
98 List of enabled plugins.
100 :default: ``HTTPS_rewrite``, ``Self_Informations``,
101 ``Search_on_category_select``, ``Tracker_URL_remover``
103 :values: [ ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``,
104 ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``,
105 ``Search_on_category_select`` ]
107``disabled_plugins``: optional
108 List of disabled plugins.
110 :default: ``DOAI_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``
111 :values: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``,
112 ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``,
113 ``Search_on_category_select``
115``enabled_engines`` : optional : *all* :origin:`engines <searx/engines>`
116 List of enabled engines.
118``disabled_engines`` : optional : *all* :origin:`engines <searx/engines>`
119 List of disabled engines.