mirror of
https://github.com/searxng/searxng.git
synced 2025-09-08 19:28:32 +02:00
293 lines
No EOL
21 KiB
HTML
293 lines
No EOL
21 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>OpenAlex — SearXNG Documentation (2025.9.1+501327ddf)</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=015ee560"></script>
|
||
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
|
||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script data-project="searxng" data-version="2025.9.1+501327ddf" 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="Peertube Engines" href="peertube.html" />
|
||
<link rel="prev" title="Odysee" href="odysee.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="peertube.html" title="Peertube Engines"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="odysee.html" title="Odysee"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.9.1+501327ddf)</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="">OpenAlex</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="openalex">
|
||
<span id="openalex-engine"></span><h1>OpenAlex<a class="headerlink" href="#openalex" title="Link to this heading">¶</a></h1>
|
||
<section id="overview">
|
||
<h2>Overview<a class="headerlink" href="#overview" title="Link to this heading">¶</a></h2>
|
||
<p>The OpenAlex engine integrates the <a class="reference external" href="https://openalex.org">OpenAlex</a> Works API to return scientific paper
|
||
results using the <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/templates/simple/result_templates/paper.html">paper.html</a>
|
||
template. It is an “online” JSON engine that uses the official public API and does
|
||
not require an API key.</p>
|
||
<section id="key-features">
|
||
<h3>Key features<a class="headerlink" href="#key-features" title="Link to this heading">¶</a></h3>
|
||
<ul class="simple">
|
||
<li><p>Uses the official Works endpoint (JSON)</p></li>
|
||
<li><p>Paging support via <code class="docutils literal notranslate"><span class="pre">page</span></code> and <code class="docutils literal notranslate"><span class="pre">per-page</span></code></p></li>
|
||
<li><p>Relevance sorting (<code class="docutils literal notranslate"><span class="pre">sort=relevance_score:desc</span></code>)</p></li>
|
||
<li><p>Language filter support (maps SearXNG language to <code class="docutils literal notranslate"><span class="pre">filter=language:<iso2></span></code>)</p></li>
|
||
<li><p>Maps fields commonly used in scholarly results: title, authors, abstract
|
||
(reconstructed from inverted index), journal/venue, publisher, DOI, tags
|
||
(concepts), PDF/HTML links, pages, volume, issue, published date, and a short
|
||
citations comment</p></li>
|
||
<li><p>Supports OpenAlex “polite pool” by adding a <code class="docutils literal notranslate"><span class="pre">mailto</span></code> parameter</p></li>
|
||
</ul>
|
||
</section>
|
||
</section>
|
||
<section id="configuration">
|
||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||
<p>Minimal example for <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/settings.yml">settings.yml</a>:</p>
|
||
<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">openalex</span>
|
||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">openalex</span>
|
||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">oa</span>
|
||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">science, scientific publications</span>
|
||
<span class="w"> </span><span class="nt">timeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5.0</span>
|
||
<span class="w"> </span><span class="c1"># Recommended by OpenAlex: join the polite pool with an email address</span>
|
||
<span class="w"> </span><span class="nt">mailto</span><span class="p">:</span><span class="w"> </span><span class="s">"[email</span><span class="nv"> </span><span class="s">protected]"</span>
|
||
</pre></div>
|
||
</div>
|
||
<section id="notes">
|
||
<h3>Notes<a class="headerlink" href="#notes" title="Link to this heading">¶</a></h3>
|
||
<ul class="simple">
|
||
<li><p>The <code class="docutils literal notranslate"><span class="pre">mailto</span></code> key is optional but recommended by OpenAlex for better service.</p></li>
|
||
<li><p>Language is inherited from the user’s UI language; when it is not <code class="docutils literal notranslate"><span class="pre">all</span></code>, the
|
||
engine adds <code class="docutils literal notranslate"><span class="pre">filter=language:<iso2></span></code> (e.g. <code class="docutils literal notranslate"><span class="pre">language:fr</span></code>). If OpenAlex has
|
||
few results for that language, you may see fewer items.</p></li>
|
||
<li><p>Results typically include a main link. When the primary landing page from
|
||
OpenAlex is a DOI resolver, the engine will use that stable link. When an open
|
||
access link is available, it is exposed via the <code class="docutils literal notranslate"><span class="pre">PDF</span></code> and/or <code class="docutils literal notranslate"><span class="pre">HTML</span></code> links
|
||
in the result footer.</p></li>
|
||
</ul>
|
||
</section>
|
||
</section>
|
||
<section id="what-is-returned">
|
||
<h2>What is returned<a class="headerlink" href="#what-is-returned" title="Link to this heading">¶</a></h2>
|
||
<p>Each result uses the <code class="docutils literal notranslate"><span class="pre">paper.html</span></code> template and may include:</p>
|
||
<ul class="simple">
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">title</span></code> and <code class="docutils literal notranslate"><span class="pre">content</span></code> (abstract; reconstructed from the inverted index)</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">authors</span></code> (display names)</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">journal</span></code> (host venue display name) and <code class="docutils literal notranslate"><span class="pre">publisher</span></code></p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">doi</span></code> (normalized to the plain DOI, without the <code class="docutils literal notranslate"><span class="pre">https://doi.org/</span></code> prefix)</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">tags</span></code> (OpenAlex concepts display names)</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">pdf_url</span></code> (Open access PDF if available) and <code class="docutils literal notranslate"><span class="pre">html_url</span></code> (landing page)</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">publishedDate</span></code> (parsed from <code class="docutils literal notranslate"><span class="pre">publication_date</span></code>)</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">pages</span></code>, <code class="docutils literal notranslate"><span class="pre">volume</span></code>, <code class="docutils literal notranslate"><span class="pre">number</span></code> (issue)</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> and a brief <code class="docutils literal notranslate"><span class="pre">comments</span></code> string with citation count</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="rate-limits-polite-pool">
|
||
<h2>Rate limits & polite pool<a class="headerlink" href="#rate-limits-polite-pool" title="Link to this heading">¶</a></h2>
|
||
<p>OpenAlex offers a free public API with generous daily limits. For extra courtesy
|
||
and improved service quality, include a contact email in each request via
|
||
<code class="docutils literal notranslate"><span class="pre">mailto</span></code>. You can set it directly in the engine configuration as shown above.
|
||
See: <a class="reference external" href="https://docs.openalex.org/how-to-use-the-api/api-overview">OpenAlex API overview</a>.</p>
|
||
</section>
|
||
<section id="troubleshooting">
|
||
<h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Link to this heading">¶</a></h2>
|
||
<ul class="simple">
|
||
<li><p>Few or no results in a non-English UI language:
|
||
Ensure the selected language has sufficient coverage at OpenAlex, or set the
|
||
UI language to English and retry.</p></li>
|
||
<li><p>Preference changes fail while testing locally:
|
||
Make sure your <code class="docutils literal notranslate"><span class="pre">server.secret_key</span></code> and <code class="docutils literal notranslate"><span class="pre">server.base_url</span></code> are set in your
|
||
instance settings so signed cookies work; see <a class="reference internal" href="../../../admin/settings/settings_server.html#settings-server"><span class="std std-ref">server:</span></a>.</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="module-searx.engines.openalex">
|
||
<span id="implementation"></span><h2>Implementation<a class="headerlink" href="#module-searx.engines.openalex" title="Link to this heading">¶</a></h2>
|
||
</section>
|
||
</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="../../rtm_asdf.html">Runtime 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="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="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 current"><a class="current reference internal" href="#">OpenAlex</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="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="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="soundcloud.html">Soundcloud</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="odysee.html" title="previous chapter">Odysee</a>
|
||
<li>Next: <a href="peertube.html" title="next chapter">Peertube 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/openalex.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> |