ZaclysIndustries
/
searxngRebrandZaclys
forked from zaclys/searxng
2
0
Fork 0
Code Issues Pull Requests Activity
searxngRebrandZaclys/docs/dev/search_api.rst

32 lines
2.3 KiB
ReStructuredText
Raw Normal View History

[enh] initial structure
2015-11-17 22:13:30 +00:00
Search API
==========
better API docs && more features in list
2016-07-09 20:31:21 +00:00
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.
[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
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
| 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 |
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
better API docs && more features in list
2016-07-09 20:31:21 +00:00
| ``lang`` | Code of the language | optional (default: ``all``) |
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
[enh] initial structure
2015-11-17 22:13:30 +00:00
| ``pageno`` | Search page number | optional (default: ``1``) |
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+