free
/
searx
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 11 Wiki Activity
27 Commits
10 Branches
Tree: a8244e2d96
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'a8244e2d96'
${ noResults }
searx/docs/dev/search_api.rst

search_api.rst 2.3KB
History Raw

12345678910111213141516171819202122232425262728293031 
  1. Search API

  2. ==========

  3. 

  4. 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.

  5. 

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

  7. 

  8. .. code:: sh

  9. 

  10.     GET /

  11. 

  12. .. code:: sh

  13. 

  14.     GET /search

  15. 

  16. Parameters

  17. ``````````

  18. 

  19. +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+

  20. | Name             | Description                                                                                        |                             |

  21. +==================+====================================================================================================+=============================+

  22. | ``q``            | The search query, see :doc:`/user/search_syntax`                                                   | required                    |

  23. +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+

  24. | ``categories``   | Comma separated list, specifies the active search categories                                       | optional                    |

  25. +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+

  26. | ``engines``      | Comma separated list, specifies the active search engines                                          | optional                    |

  27. +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+

  28. | ``lang``         | Code of the language                                                                               | optional (default: ``all``) |

  29. +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+

  30. | ``pageno``       | Search page number                                                                                 | optional (default: ``1``)   |

  31. +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+