Source-Code¶

This is a partial documentation of our source code. We are not aiming to document every item from the source code, but we will add documentation when requested.

Contents

Custom message extractor (i18n)
- extract()
Arch Linux
- Arch Linux Wiki
- fetch_traits()
Dailymotion
- Dailymotion (Videos)
- fetch_traits()
- family_filter_map
- iframe_src
- result_fields
- safesearch_params
- search_url
DukcDukGo engines
- DuckDuckGo Lite
- cache_vqd()
- fetch_traits()
- get_ddg_lang()
- get_vqd()
- send_accept_language_header
- DuckDuckGo Images
- DuckDuckGo Instant Answer API
- area_to_str()
- is_broken_text()
- DuckDuckGo Weather
Engine model
- Engine
Engine traits
- EngineTraits
- EngineTraitsEncoder
- EngineTraitsMap
SearXNG’s engines
- is_missing_required_attributes()
- load_engine()
- load_engines()
- using_tor_proxy()
- engine_shortcuts
Bing Engines
- Bing WEB
- Bing Images
- Bing Videos
- Bing News
Demo Offline Engine
- init()
- search()
Demo Online Engine
- init()
- request()
- response()
Google Engines
- Google API
- Google WEB
- Google Autocomplete
- Google Images
- Google Videos
- Google News
- Google Scholar
Peertube Engines
- Peertube Video
- SepiaSearch
Startpage engines
- Startpage regions
- Startpage languages
- Startpage categories
- fetch_traits()
- get_sc_code()
- request()
- sc_code_cache_sec
- search_form_xpath
- send_accept_language_header
- startpage_categ
Tineye
- parse_tineye_match()
- request()
- response()
- DOWNLOAD_ERROR
- FORMAT_NOT_SUPPORTED
- NO_SIGNATURE_ERROR
- engine_type
Wikimedia
- Wikipedia
- Wikidata
Yahoo Engine
- fetch_traits()
- parse_url()
- request()
- response()
- lang2domain
SearXNG Exceptions
- SearxEngineAPIException
- SearxEngineAccessDeniedException
- SearxEngineCaptchaException
- SearxEngineException
- SearxEngineResponseException
- SearxEngineTooManyRequestsException
- SearxEngineXPathException
- SearxException
- SearxParameterException
- SearxSettingsException
- SearxXPathSyntaxException
Online /info
- InfoPage
- InfoPageSet
Locales
- build_engine_locales()
- get_engine_locale()
- get_locale()
- get_locale_descr()
- get_offical_locales()
- get_translations()
- language_tag()
- locales_initialize()
- match_locale()
- region_tag()
- ADDITIONAL_TRANSLATIONS
- LOCALE_BEST_MATCH
- LOCALE_NAMES
- RTL_LOCALES
- SearXNG’s locale codes
Limiter Plugin
Tor check plugin
- description
- name
- preference_section
- query_examples
- query_keywords
Redis DB
- OLD_REDIS_URL_DEFAULT_URL
Redis Library
- drop_counter()
- incr_counter()
- incr_sliding_window()
- lua_script_storage()
- purge_by_prefix()
- secret_hash()
- LUA_SCRIPT_STORAGE
Search
- EngineRef
- SearchQuery
- Search
- SearchWithPlugins
Search processors
- Abstract processor class
- Offline processor
- Online processor
- Online currency processor
- Online Dictionary processor
- Online URL search processor
Utility functions for the engines
- convert_str_to_int()
- detect_language()
- dict_subset()
- ecma_unescape()
- eval_xpath()
- eval_xpath_getindex()
- eval_xpath_list()
- extract_text()
- extract_url()
- gen_useragent()
- get_engine_from_settings()
- get_torrent_size()
- get_xpath()
- html_to_text()
- int_or_zero()
- is_valid_lang()
- normalize_url()
- searx_useragent()
- to_string()
- SEARCH_LANGUAGE_CODES