Skip to content
Back to top
View this page
Edit this page

# Search

class searx.search.models.EngineRef(name: str, category: str)

  Reference by names to an engine and category

final class searx.search.models.SearchQuery(query: str, engineref_list: list[EngineRef], lang: str = 'all', safesearch: Literal[0, 1, 2] = 0, pageno: int = 1, time_range: Literal['day', 'week', 'month', 'year'] | None = None, timeout_limit: float | None = None, external_bang: str | None = None, engine_data: dict[str, dict[str, str]] | None = None, redirect_to_first_result: bool | None = None)

  container for all the search parameters (query, language, etc…)

class searx.search.Search(search_query: SearchQuery)

  Search information container

  search_query: searx.search.SearchQuery
  result_container: searx.results.ResultContainer
  search() → searx.results.ResultContainer

class searx.search.SearchWithPlugins(search_query: SearchQuery, request: SXNG_Request, user_plugins: list[str])

  Inherit from the Search class, add calls to the plugins.

  search_query: searx.search.SearchQuery
  result_container: searx.results.ResultContainer
  ordered_plugin_list: List
  request: flask.request
  search() → searx.results.ResultContainer