123456789101112131415161718192021222324
  1. Search API
  2. ==========
  3. Search API endpoints: ``/``, ``/search``
  4. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  5. Endpoints have equivalent functionality.
  6. Parameters
  7. ^^^^^^^^^^
  8. +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
  9. | Name | Description | |
  10. +==================+====================================================================================================+=============================+
  11. | ``q`` | The search query, see :doc:`/user/search_syntax` | required |
  12. +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
  13. | ``categories`` | Comma separated list, specifies the active search categories | optional |
  14. +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
  15. | ``engines`` | Comma separated list, specifies the active search engines | optional |
  16. +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
  17. | ``pageno`` | Search page number | optional (default: ``1``) |
  18. +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
  19. Both ``GET`` and ``POST`` methods are supported.