mirror of
https://github.com/searxng/searxng.git
synced 2024-08-24 07:00:15 +02:00
Merge pull request #679 from kvch/gh-pages
docs: time_range search param, embed
This commit is contained in:
commit
34039ab85f
@ -76,3 +76,19 @@ Sample response
|
|||||||
],
|
],
|
||||||
"safe_search": 0
|
"safe_search": 0
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Embed search bar
|
||||||
|
----------------
|
||||||
|
|
||||||
|
The search bar can be embedded into websites. Just paste the example into the HTML of the site.
|
||||||
|
URL of the searx instance and values are customizable.
|
||||||
|
|
||||||
|
.. code:: html
|
||||||
|
|
||||||
|
<form method="post" action="https://searx.me/">
|
||||||
|
<!-- search query --> <input type="text" name="q" />
|
||||||
|
<!-- categories --> <input type="hidden" name="categories" value="general,social media" />
|
||||||
|
<!-- language --> <input type="hidden" name="lang" value="all" />
|
||||||
|
<!-- locale --> <input type="hidden" name="locale" value="en" />
|
||||||
|
<!-- date filter --> <input type="hidden" name="time_range" value="month" />
|
||||||
|
</form>
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
Search API
|
Search API
|
||||||
==========
|
==========
|
||||||
|
|
||||||
The search supports both ``GET`` and ``POST``. However, using ``GET`` the parameters of the request remain hidden. So it is advised to use ``GET`` for querying.
|
The search supports both ``GET`` and ``POST``.
|
||||||
|
|
||||||
Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
|
Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
|
||||||
|
|
||||||
@ -16,16 +16,18 @@ Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
|
|||||||
Parameters
|
Parameters
|
||||||
``````````
|
``````````
|
||||||
|
|
||||||
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
|
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
|
||||||
| Name | Description | |
|
| Name | Description | |
|
||||||
+==================+====================================================================================================+=============================+
|
+==================+====================================================================================================+==================================================+
|
||||||
| ``q`` | The search query, see :doc:`/user/search_syntax` | required |
|
| ``q`` | The search query, see :doc:`/user/search_syntax` | required |
|
||||||
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
|
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
|
||||||
| ``categories`` | Comma separated list, specifies the active search categories | optional |
|
| ``categories`` | Comma separated list, specifies the active search categories | optional |
|
||||||
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
|
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
|
||||||
| ``engines`` | Comma separated list, specifies the active search engines | optional |
|
| ``engines`` | Comma separated list, specifies the active search engines | optional |
|
||||||
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
|
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
|
||||||
| ``lang`` | Code of the language | optional (default: ``all``) |
|
| ``lang`` | Code of the language | optional (default: ``all``) |
|
||||||
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
|
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
|
||||||
| ``pageno`` | Search page number | optional (default: ``1``) |
|
| ``pageno`` | Search page number | optional (default: ``1``) |
|
||||||
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
|
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
|
||||||
|
| ``time_range`` | Time range of search | optional (possible: ``day``, ``month``, ``year``)|
|
||||||
|
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
|
||||||
|
Loading…
Reference in New Issue
Block a user