Search API¶
The search supports both GET and POST.
Furthermore, two endpoints / and /search are available for querying.
GET /
GET /search
Parameters¶
qrequiredThe search query. This string is passed to external search services. Thus, SearXNG supports syntax of each search service. For example,
site:github.com SearXNGis 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
categoriesoptionalComma separated list, specifies the active search categories
enginesoptionalComma separated list, specifies the active search engines.
langdefaultallCode of the language.
pagenodefault1Search page number.
time_rangeoptional[
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.
formatoptional[
json,csv,rss]Output format of results.
results_on_new_tabdefault0[
0,1]Open search results on new tab.
image_proxydefaultFalse[
True,False]Proxy image results through SearXNG.
autocompletedefault empty[
google,dbpedia,duckduckgo,startpage,wikipedia]Service which completes words as you type.
safesearchdefaultNone[
0,1,None]Filter search results of engines which support safe search. See if an engine supports safe search in the preferences page of an instance.
themedefaultsimple[
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_pluginsoptionalList 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
disabled_plugins: optionalList of disabled plugins.
- default:
DOAI_rewrite,Infinite_scroll,Vim-like_hotkeys,Hostname_replace- values:
DOAI_rewrite,HTTPS_rewrite,Infinite_scroll,Vim-like_hotkeys,Self_Informations,Tracker_URL_remover,Search_on_category_select,Hostname_replace
enabled_enginesoptionalall enginesList of enabled engines.
disabled_enginesoptionalall enginesList of disabled engines.