Classes
class	ApiSearchResult
class	ApiSearchResults

Functions
	request (str query, dict[str, t.Any] params)
	response (SXNG_Response resp)
	init (dict[str, t.Any] engine_settings)

Variables
dict	about
str	base_url = "https://api.marginalia.nu"
bool	safesearch = True
list	categories = ["general"]
bool	paging = False
int	results_per_page = 20
	api_key = None

Detailed Description

`Marginalia Search`_ is an independent open source Internet search engine
operating out of Sweden. It is principally developed and operated by Viktor
Lofgren .

.. _Marginalia Search:
   https://about.marginalia-search.com/

Configuration
=============

The engine has the following required settings:

- :py:obj:`api_key`

You can configure a Marginalia engine by:

.. code:: yaml

   - name: marginalia
     engine: marginalia
     shortcut: mar
     api_key: ...

Implementations
===============

Function Documentation

◆ init()

searx.engines.marginalia.init ( dict[str, t.Any] engine_settings )

Definition at line 114 of file marginalia.py.

def init(engine_settings: dict[str, t.Any]):
 
    _api_key = engine_settings.get("api_key")
    if not _api_key:
        logger.error("missing api_key: see https://about.marginalia-search.com/article/api")
        return False
 
    if _api_key == "public":
        logger.error("invalid api_key (%s): see https://about.marginalia-search.com/article/api", api_key)
 
    return True

◆ request()

searx.engines.marginalia.request	(	str	query,
		dict[str, t.Any]	params )

Definition at line 86 of file marginalia.py.

def request(query: str, params: dict[str, t.Any]):
 
    query_params = {
        "count": results_per_page,
        "nsfw": min(params["safesearch"], 1),
    }
 
    params["url"] = f"{base_url}/{api_key}/search/{quote_plus(query)}?{urlencode(query_params)}"
    params["headers"]["User-Agent"] = searxng_useragent()
 
 

◆ response()

searx.engines.marginalia.response ( SXNG_Response resp )

Definition at line 97 of file marginalia.py.

def response(resp: SXNG_Response):
 
    res = EngineResults()
    resp_json: ApiSearchResults = resp.json()  # type: ignore
 
    for item in resp_json.get("results", []):
        res.add(
            res.types.MainResult(
                title=item["title"],
                url=item["url"],
                content=item.get("description", ""),
            )
        )
 
    return res
 
 

Variable Documentation

◆ about

dict searx.engines.marginalia.about

Initial value:

=  {
    "website": "https://marginalia.nu",
    "wikidata_id": None,
    "official_api_documentation": "https://about.marginalia-search.com/article/api/",
    "use_official_api": True,
    "require_api_key": True,
    "results": "JSON",
}

Definition at line 36 of file marginalia.py.

◆ api_key

searx.engines.marginalia.api_key = None

Definition at line 50 of file marginalia.py.

◆ base_url

str searx.engines.marginalia.base_url = "https://api.marginalia.nu"

Definition at line 45 of file marginalia.py.

◆ categories

list searx.engines.marginalia.categories = ["general"]

Definition at line 47 of file marginalia.py.

◆ paging

bool searx.engines.marginalia.paging = False

Definition at line 48 of file marginalia.py.

◆ results_per_page

int searx.engines.marginalia.results_per_page = 20

Definition at line 49 of file marginalia.py.

◆ safesearch

bool searx.engines.marginalia.safesearch = True

Definition at line 46 of file marginalia.py.

Classes

Functions

Variables