Closes: https://github.com/searxng/searxng/issues/1541 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
3.4 KiB
Search API
The search supports both GET
and POST
.
Furthermore, two endpoints /
and /search
are available for querying.
GET /
GET /search
Parameters
Further reading ..
engines-dev
settings.yml
configured engines
q
: requiredThe search query. This string is passed to external search services. Thus, SearXNG supports syntax of each search service. For example,
site:github.com SearXNG
is a valid query for Google. However, if simply the query above is passed to any search engine which does not filter its results based on this syntax, you might not get the results you wanted.See more at
search-syntax
categories
: optionalComma separated list, specifies the active search categories (see
configured engines
)engines
: optionalComma separated list, specifies the active search engines (see
configured engines
).language
: default fromsettings search
Code of the language.
pageno
: default1
Search page number.
time_range
: optional[
day
,month
,year
]Time range of search for engines which support it. See if an engine supports time range search in the preferences page of an instance.
format
: optional[
json
,csv
,rss
]Output format of results. Format needs to be activated in
settings search
.results_on_new_tab
: default0
[
0
,1
]Open search results on new tab.
image_proxy
: default fromsettings server
[
True
,False
]Proxy image results through SearXNG.
autocomplete
: default fromsettings search
[
google
,dbpedia
,duckduckgo
,startpage
,wikipedia
,swisscows
,qwant
]Service which completes words as you type.
safesearch
: default fromsettings search
[
0
,1
,2
]Filter search results of engines which support safe search. See if an engine supports safe search in the preferences page of an instance.
theme
: defaultsimple
[
simple
]Theme of instance.
Please note, available themes depend on an instance. It is possible that an instance administrator deleted, created or renamed themes on their instance. See the available options in the preferences page of the instance.
enabled_plugins
: optionalList of enabled plugins.
- default
HTTPS_rewrite
,Self_Informations
,Search_on_category_select
,Tracker_URL_remover
- values
DOAI_rewrite
,HTTPS_rewrite
,Infinite_scroll
,Vim-like_hotkeys
,Self_Informations
,Tracker_URL_remover
,Search_on_category_select
,Hostname_replace
,Tor_check_plugin
disabled_plugins
: optionalList of disabled plugins.
- default
DOAI_rewrite
,Infinite_scroll
,Vim-like_hotkeys
,Hostname_replace
,Tor_check_plugin
- values
DOAI_rewrite
,HTTPS_rewrite
,Infinite_scroll
,Vim-like_hotkeys
,Self_Informations
,Tracker_URL_remover
,Search_on_category_select
,Hostname_replace
,Tor_check_plugin
enabled_engines
: optional : allengines <searx/engines>
List of enabled engines.
disabled_engines
: optional : allengines <searx/engines>
List of disabled engines.