Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
SearXNG Documentation (2026.5.7+ef6290c8c)
Logo
SearXNG Documentation (2026.5.7+ef6290c8c)
  • User information
    • Search syntax
    • Configured Engines
    • About SearXNG
  • Why use a private instance?
  • Administrator documentation
    • Settings
      • settings.yml
      • engines:
      • brand:
      • general:
      • search:
      • server:
      • ui:
      • redis:
      • valkey:
      • outgoing:
      • categories_as_tabs:
      • plugins:
    • Installation
    • Installation container
    • Installation Script
    • Step by step installation
    • Granian
    • uWSGI
    • NGINX
    • Apache
    • SearXNG maintenance
    • Answer CAPTCHA from server’s IP
    • Favicons
    • Limiter
    • Administration API
    • Architecture
    • List of plugins
    • Buildhosts
  • Developer documentation
    • Development Quickstart
    • Git Commits & Change Management
    • How to contribute
    • Extended Types
    • Engine Implementations
      • Engine Library
      • SearXNG’s engines loader
      • Engine Overview
      • Demo Online Engine
      • XPath Engine
      • MediaWiki Engine
      • JSON Engine
      • Adobe Stock
      • Alpine Linux Packages
      • Anna’s Archive
      • AOL
      • Arch Linux
      • arXiv
      • Astrophysics Data System (ADS)
      • Azure Resources
      • Bing Engines
      • Bpb
      • Brave Engines
      • BT4G
      • ChinaSo
      • CORE
      • Crossref
      • Dailymotion
      • Discourse Forums
      • DuckDuckGo Engines
      • Geizhals
      • Gitea
      • Github Code
      • GitLab
      • Google Engines
      • Hugging Face
      • Karmasearch
      • Lemmy
      • Library of Congress
      • Marginalia Search
      • Mastodon
      • Moviepilot
      • Matrix Rooms Search (MRS)
      • Mwmbl Engine
      • Odysee
      • OpenAlex
      • Open Library
      • Peertube Engines
      • Piped
      • Presearch Engine
      • PubMed
      • Qwant
      • RadioBrowser
      • Recoll Engine
      • Repology
      • Reuters
      • Semantic Scholar
      • Soundcloud
      • Sourcehut
      • Springer Nature
      • Startpage Engines
      • Tagesschau API
      • Torznab WebAPI
      • Tube Archivist
      • Void Linux binary packages
      • Wallhaven
      • Wikimedia
      • Yacy
      • Yahoo Engine
      • Z-Library
      • Offline Concept
      • Demo Offline Engine
      • Command Line Engines
      • NoSQL databases
      • Local Search APIs
      • SQL Engines
      • Tineye
    • Result Types
      • Result
      • Main Search Results
        • MainResult
        • Key-Value Results
        • Code Results
        • Paper Results
        • File Results
      • Answer Results
      • Correction Results
      • Suggestion Results
      • Infobox Results
    • Simple Theme Templates
    • Search API
    • Plugins
      • Plugin Development
      • Built-in Plugins
        • Calculator
        • Hash Values
        • Hostnames
        • Infinite scroll
        • Self-Info
        • Tor check
        • Unit Converter
        • Time Zone
    • Answerers
      • Answerer Development
      • Built-in Answerers
        • Random
        • Statistics
    • Translation
    • Makefile & ./manage
    • reST primer
    • Tooling box searxng_extra
      • searxng_extra/update/
  • DevOps tooling box
    • utils/searxng.sh
  • Source-Code
    • Custom message extractor (i18n)
    • Bot Detection
    • Caches
    • SearXNG Exceptions
    • Favicons (source)
    • Online /info
    • Locales
    • Search
    • Search processors
    • Settings Loader
    • SQLite DB
    • Utility functions for the engines
    • Valkey DB
    • Valkey Library
    • Weather
Back to top
View this page
Edit this page

Search¶

class searx.search.models.EngineRef(name: str, category: str)[source]¶

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)[source]¶

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

class searx.search.Search(search_query: SearchQuery)[source]¶

Search information container

search_query: searx.search.SearchQuery¶
result_container: searx.results.ResultContainer¶
search() → searx.results.ResultContainer[source]¶
class searx.search.SearchWithPlugins(search_query: SearchQuery, request: SXNG_Request, user_plugins: list[str])[source]¶

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[source]¶
Next
Search processors
Previous
Locales
Copyright © SearXNG team
Made with Furo
💾 🌐
On this page
  • Search
    • EngineRef
    • SearchQuery
    • Search
      • Search.search_query
      • Search.result_container
      • Search.search()
    • SearchWithPlugins
      • SearchWithPlugins.search_query
      • SearchWithPlugins.result_container
      • SearchWithPlugins.ordered_plugin_list
      • SearchWithPlugins.request
      • SearchWithPlugins.search()