jandieman
/
searxng
mirror of https://github.com/searxng/searxng.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
searxng/docs/dev/search_api.rst

36 lines
3.1 KiB
ReStructuredText
Raw Normal View History

[enh] initial structure
2015-11-17 22:13:30 +00:00
Search API
==========
add new search parameter time_range
2016-09-06 16:13:20 +00:00
The search supports both ``GET`` and ``POST``.
[enh] initial structure
2015-11-17 22:13:30 +00:00
better API docs && more features in list
2016-07-09 20:31:21 +00:00
Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
.. code:: sh
GET /
.. code:: sh
GET /search
[enh] initial structure
2015-11-17 22:13:30 +00:00
Parameters
better API docs && more features in list
2016-07-09 20:31:21 +00:00
``````````
[enh] initial structure
2015-11-17 22:13:30 +00:00
add possible values of time_range param
2016-09-10 13:12:11 +00:00
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
| Name | Description | |
+==================+====================================================================================================+==================================================+
| ``q`` | The search query, see :doc:`/user/search_syntax` | required |
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
| ``categories`` | Comma separated list, specifies the active search categories | optional |
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
| ``engines`` | Comma separated list, specifies the active search engines | optional |
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
| ``lang`` | Code of the language | optional (default: ``all``) |
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
| ``pageno`` | Search page number | optional (default: ``1``) |
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
| ``time_range`` | Time range of search | optional (possible: ``day``, ``month``, ``year``)|
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
add format param to search api
2017-07-09 20:02:29 +00:00
| ``format`` | Output format of results | optional (possible: ``json``, ``csv``, ``rss``) |
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+