searx/docs/dev/search_api.rst

Search API
==========

The search supports both ``GET`` and ``POST``.

Furthermore, two enpoints ``/`` and ``/search`` are available for querying.

.. code:: sh

    GET /

.. code:: sh

    GET /search

Parameters
``````````

+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
| 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``)|
+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+