2015-11-17 23:13:30 +01:00
|
|
|
Search API
|
|
|
|
|
==========
|
|
|
|
|
|
2016-09-06 18:13:20 +02:00
|
|
|
The search supports both ``GET`` and ``POST``.
|
2015-11-17 23:13:30 +01:00
|
|
|
|
2016-07-09 22:31:21 +02:00
|
|
|
Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
|
|
|
|
|
|
|
|
|
|
.. code:: sh
|
|
|
|
|
|
|
|
|
|
GET /
|
|
|
|
|
|
|
|
|
|
.. code:: sh
|
|
|
|
|
|
|
|
|
|
GET /search
|
2015-11-17 23:13:30 +01:00
|
|
|
|
|
|
|
|
Parameters
|
2016-07-09 22:31:21 +02:00
|
|
|
``````````
|
2015-11-17 23:13:30 +01:00
|
|
|
|
2016-09-10 15:12:11 +02: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``)|
|
|
|
|
|
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
|
2017-07-09 22:02:29 +02:00
|
|
|
| ``format`` | Output format of results | optional (possible: ``json``, ``csv``, ``rss``) |
|
|
|
|
|
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
|
