summaryrefslogtreecommitdiff
path: root/docs/dev/search_api.rst
blob: 59d3c825f900c776e766627a60e2b10ce346ed35 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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.

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