forked from Ponysearch/Ponysearch
25 lines
1.8 KiB
ReStructuredText
25 lines
1.8 KiB
ReStructuredText
|
Search API
|
||
|
|
==========
|
||
|
|
|
||
|
|
Search API endpoints: ``/``, ``/search``
|
||
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||
|
|
|
||
|
|
Endpoints have equivalent functionality.
|
||
|
|
|
||
|
|
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 |
|
||
|
|
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
|
||
|
|
| ``pageno`` | Search page number | optional (default: ``1``) |
|
||
|
|
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
|
||
|
|
|
||
|
|
Both ``GET`` and ``POST`` methods are supported.
|