git.iko.soy/searx
on d2db02f help sign in
searx/docs/admin/api.rst
94 lines 2.1 kB history raw
1.. _adminapi:
3Administration API
4------------------
6Get configuration data
7~~~~~~~~~~~~~~~~~~~~~~
9.. code:: sh
11 GET /config
13Sample response
14```````````````
16.. code:: sh
18 {
19 "autocomplete": "",
20 "categories": [
21 "map",
22 "it",
23 "images",
24 ],
25 "default_locale": "",
26 "default_theme": "oscar",
27 "engines": [
28 {
29 "categories": [
30 "map"
31 ],
32 "enabled": true,
33 "name": "openstreetmap",
34 "shortcut": "osm"
35 },
36 {
37 "categories": [
38 "it"
39 ],
40 "enabled": true,
41 "name": "arch linux wiki",
42 "shortcut": "al"
43 },
44 {
45 "categories": [
46 "images"
47 ],
48 "enabled": true,
49 "name": "google images",
50 "shortcut": "goi"
51 },
52 {
53 "categories": [
54 "it"
55 ],
56 "enabled": false,
57 "name": "bitbucket",
58 "shortcut": "bb"
59 },
60 ],
61 "instance_name": "searx",
62 "locales": {
63 "de": "Deutsch (German)",
64 "en": "English",
65 "eo": "Esperanto (Esperanto)",
66 },
67 "plugins": [
68 {
69 "enabled": true,
70 "name": "HTTPS rewrite"
71 },
72 {
73 "enabled": false,
74 "name": "Vim-like hotkeys"
75 }
76 ],
77 "safe_search": 0
78 }
80Embed search bar
81----------------
83The search bar can be embedded into websites. Just paste the example into the HTML of the site.
84URL of the searx instance and values are customizable.
86.. code:: html
88 <form method="post" action="https://searx.me/">
89 <!-- search query --> <input type="text" name="q" />
90 <!-- categories --> <input type="hidden" name="categories" value="general,social media" />
91 <!-- language --> <input type="hidden" name="lang" value="all" />
92 <!-- locale --> <input type="hidden" name="locale" value="en" />
93 <!-- date filter --> <input type="hidden" name="time_range" value="month" />
94 </form>