mirror of
https://github.com/searxng/searxng.git
synced 2025-11-09 00:04:00 -05:00
281 lines
22 KiB
HTML
281 lines
22 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="en" data-content_root="../../../">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<title>Springer Nature — SearXNG Documentation (2025.11.7+b9b46431b)</title>
|
||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||
<script src="../../../_static/documentation_options.js?v=abc48383"></script>
|
||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script data-project="searxng" data-version="2025.11.7+b9b46431b" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
|
||
<link rel="index" title="Index" href="../../../genindex.html" />
|
||
<link rel="search" title="Search" href="../../../search.html" />
|
||
<link rel="next" title="Startpage Engines" href="startpage.html" />
|
||
<link rel="prev" title="Sourcehut" href="sourcehut.html" />
|
||
</head><body>
|
||
<div class="related" role="navigation" aria-label="Related">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../../../genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="../../../py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="startpage.html" title="Startpage Engines"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="sourcehut.html" title="Sourcehut"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.7+b9b46431b)</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Springer Nature</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="module-searx.engines.springer">
|
||
<span id="springer-nature"></span><span id="springer-engine"></span><h1>Springer Nature<a class="headerlink" href="#module-searx.engines.springer" title="Link to this heading">¶</a></h1>
|
||
<p><a class="reference external" href="https://www.springernature.com/">Springer Nature</a> is a global publisher dedicated to providing service to
|
||
research community with official <a class="reference external" href="https://dev.springernature.com/docs/introduction/">Springer-API</a> (<a class="reference external" href="https://dev.springernature.com/docs/live-documentation/">API-Playground</a>).</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>The Springer engine requires an API key, which can be obtained via the
|
||
<a class="reference external" href="https://dev.springernature.com/subscription/">Springer subscription</a>.</p>
|
||
</div>
|
||
<p>Since the search term is passed 1:1 to the API, SearXNG users can use the
|
||
<a class="reference external" href="https://dev.springernature.com/docs/supported-query-params/">Supported Query Parameters</a>.</p>
|
||
<ul class="simple">
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">!springer</span> <span class="pre">(doi:10.1007/s10948-025-07019-1</span> <span class="pre">OR</span> <span class="pre">doi:10.1007/s10948-025-07035-1)</span></code></p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">!springer</span> <span class="pre">keyword:ybco</span></code></p></li>
|
||
</ul>
|
||
<p>However, please note that the available options depend on the subscription type.</p>
|
||
<p>For example, the <code class="docutils literal notranslate"><span class="pre">year:</span></code> filter requires a <em>Premium Plan</em> subscription.</p>
|
||
<ul class="simple">
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">!springer</span> <span class="pre">keyword:ybco</span> <span class="pre">year:2024</span></code></p></li>
|
||
</ul>
|
||
<p>The engine uses the REST <a class="reference external" href="https://dev.springernature.com/docs/api-endpoints/meta-api/">Meta-API</a> <cite>v2</cite> endpoint, but there is also a <a class="reference external" href="https://pypi.org/project/springernature-api-client/">Python
|
||
API Wrapper</a>.</p>
|
||
<section id="configuration">
|
||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||
<p>The engine has the following additional settings:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="#searx.engines.springer.api_key" title="searx.engines.springer.api_key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_key</span></code></a></p></li>
|
||
</ul>
|
||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">springer nature</span>
|
||
<span class="w"> </span><span class="nt">api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"..."</span>
|
||
<span class="w"> </span><span class="nt">inactive</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="implementations">
|
||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||
</section>
|
||
<dl class="py data">
|
||
<dt class="sig sig-object py" id="searx.engines.springer.nb_per_page">
|
||
<span class="sig-prename descclassname"><span class="pre">searx.engines.springer.</span></span><span class="sig-name descname"><span class="pre">nb_per_page</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#searx.engines.springer.nb_per_page" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Number of results to return in the request, see <a class="reference external" href="https://dev.springernature.com/docs/advanced-querying/pagination-limits/">Pagination and Limits</a> for
|
||
more details.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py data">
|
||
<dt class="sig sig-object py" id="searx.engines.springer.api_key">
|
||
<span class="sig-prename descclassname"><span class="pre">searx.engines.springer.</span></span><span class="sig-name descname"><span class="pre">api_key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.springer.api_key" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Key used for the <a class="reference external" href="https://dev.springernature.com/docs/api-endpoints/meta-api/">Meta-API</a>. Get your API key from: <a class="reference external" href="https://dev.springernature.com/subscription/">Springer subscription</a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="py data">
|
||
<dt class="sig sig-object py" id="searx.engines.springer.base_url">
|
||
<span class="sig-prename descclassname"><span class="pre">searx.engines.springer.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://api.springernature.com/meta/v2/json'</span></em><a class="headerlink" href="#searx.engines.springer.base_url" title="Link to this definition">¶</a></dt>
|
||
<dd><p>An enhanced endpoint with additional metadata fields and optimized queries
|
||
for more efficient and comprehensive retrieval (<a class="reference external" href="https://dev.springernature.com/docs/api-endpoints/meta-api/">Meta-API</a> <cite>v2</cite>).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="searx.engines.springer.setup">
|
||
<span class="sig-prename descclassname"><span class="pre">searx.engines.springer.</span></span><span class="sig-name descname"><span class="pre">setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/springer.html#setup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.springer.setup" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Initialization of the Springer engine, checks whether the
|
||
<a class="reference internal" href="#searx.engines.springer.api_key" title="searx.engines.springer.api_key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_key</span></code></a> is set, otherwise the engine is inactive.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
<div class="clearer"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<span id="sidebar-top"></span>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||
<div class="sphinxsidebarwrapper">
|
||
|
||
|
||
<p class="logo"><a href="../../../index.html">
|
||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||
</a></p>
|
||
|
||
|
||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer documentation</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="../../quickstart.html">Development Quickstart</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../commits.html">Git Commits & Change Management</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../contribution_guide.html">How to contribute</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../extended_types.html">Extended Types</a></li>
|
||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Springer Nature</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../search_api.html">Search API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../plugins/index.html">Plugins</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../translation.html">Translation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../reST.html">reST primer</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
|
||
</ul>
|
||
|
||
<h3>Project Links</h3>
|
||
<ul>
|
||
<li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
|
||
|
||
<li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
|
||
|
||
<li><a href="https://searx.space">Public instances</a>
|
||
|
||
<li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
|
||
</ul><h3>Navigation</h3>
|
||
<ul>
|
||
<li><a href="../../../index.html">Overview</a>
|
||
<ul>
|
||
<li><a href="../../index.html">Developer documentation</a>
|
||
<ul>
|
||
<li><a href="../index.html">Engine Implementations</a>
|
||
<ul>
|
||
<li>Previous: <a href="sourcehut.html" title="previous chapter">Sourcehut</a>
|
||
<li>Next: <a href="startpage.html" title="next chapter">Startpage Engines</a></ul>
|
||
</li></ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<search id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="../../../search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</search>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="../../../_sources/dev/engines/online/springer.rst.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright SearXNG team.
|
||
</div>
|
||
</body>
|
||
</html> |