Search API¶
The search supports both GET
and POST
.
Furthermore, two endpoints /
and /search
are available for querying.
GET /
GET /search
Parameters¶
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 from 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 search:.
results_on_new_tab
default0
[
0
,1
]Open search results on new tab.
image_proxy
default from server:[
True
,False
]Proxy image results through SearXNG.
autocomplete
default from search:[
google
,dbpedia
,duckduckgo
,mwmbl
,startpage
,wikipedia
,stract
,swisscows
,qwant
]Service which completes words as you type.
safesearch
default from 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:
Hash_plugin
,Self_Information
,Tracker_URL_remover
,Ahmia_blacklist
- values:
Hash_plugin
,Self_Information
,Tracker_URL_remover
,Ahmia_blacklist
,Hostnames_plugin
,Open_Access_DOI_rewrite
,Vim-like_hotkeys
,Tor_check_plugin
disabled_plugins
: optionalList of disabled plugins.
- default:
Hostnames_plugin
,Open_Access_DOI_rewrite
,Vim-like_hotkeys
,Tor_check_plugin
- values:
see values from
enabled_plugins
enabled_engines
optionalall enginesList of enabled engines.
disabled_engines
optionalall enginesList of disabled engines.