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

search_api.txt 3.1KB
History Raw

1234567891011121314151617181920212223242526272829303132333435 
  1. Search API

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

  3. 

  4. The search supports both ``GET`` and ``POST``.

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

  32. | ``time_range``   | Time range of search                                                                               | optional (possible: ``day``, ``month``, ``year``)|

  33. +------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+

  34. | ``format``       | Output format of results                                                                           | optional (possible: ``json``, ``csv``, ``rss``)  |

  35. +------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+