<!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 > Piped — SearXNG Documentation (2025.2.9+a1e2b2546)< / 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=09da0b18" > < / 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.2.9+a1e2b2546" 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 = "Presearch Engine" href = "presearch.html" / >
< link rel = "prev" title = "Peertube Engines" href = "peertube.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 = "presearch.html" title = "Presearch Engine"
accesskey = "N" > next< / a > |< / li >
< li class = "right" >
< a href = "peertube.html" title = "Peertube Engines"
accesskey = "P" > previous< / a > |< / li >
< li class = "nav-item nav-item-0" > < a href = "../../../index.html" > SearXNG Documentation (2025.2.9+a1e2b2546)< / 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 = "" > Piped< / a > < / li >
< / ul >
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< section id = "piped" >
< span id = "piped-engine" > < / span > < h1 > Piped< a class = "headerlink" href = "#piped" title = "Link to this heading" > ¶< / a > < / h1 >
< nav class = "contents local" id = "contents" >
< p class = "topic-title" > Contents< / p >
< ul class = "simple" >
< li > < p > < a class = "reference internal" href = "#configuration" id = "id1" > Configuration< / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "#known-quirks" id = "id2" > Known Quirks< / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "#implementations" id = "id3" > Implementations< / a > < / p > < / li >
< / ul >
< / nav >
< p id = "module-searx.engines.piped" > An alternative privacy-friendly YouTube frontend which is efficient by
design. < a class = "reference external" href = "https://docs.piped.video/docs/architecture/" > Piped’ < / a > consists of 3 components:< / p >
< ul class = "simple" >
< li > < p > < a class = "reference internal" href = "#searx.engines.piped.backend_url" title = "searx.engines.piped.backend_url" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > backend< / span > < / code > < / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "#searx.engines.piped.frontend_url" title = "searx.engines.piped.frontend_url" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > frontend< / span > < / code > < / a > < / p > < / li >
< li > < p > proxy< / p > < / li >
< / ul >
< section id = "configuration" >
< h2 > < a class = "toc-backref" href = "#id1" role = "doc-backlink" > Configuration< / a > < a class = "headerlink" href = "#configuration" title = "Link to this heading" > ¶< / a > < / h2 >
< p > The < a class = "reference internal" href = "#searx.engines.piped.backend_url" title = "searx.engines.piped.backend_url" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > backend_url< / span > < / code > < / a > and < a class = "reference internal" href = "#searx.engines.piped.frontend_url" title = "searx.engines.piped.frontend_url" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > frontend_url< / span > < / code > < / a > has to be set in the engine
named < cite > piped< / cite > and are used by all piped engines< / 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" > piped< / 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" > piped< / span >
< span class = "w" > < / span > < span class = "nt" > piped_filter< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l l-Scalar l-Scalar-Plain" > videos< / span >
< span class = "w" > < / span > < span class = "l l-Scalar l-Scalar-Plain" > ...< / span >
< span class = "w" > < / span > < span class = "nt" > frontend_url< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l l-Scalar l-Scalar-Plain" > https://..< / span >
< span class = "w" > < / span > < span class = "nt" > backend_url< / span > < span class = "p" > :< / span >
< span class = "w" > < / span > < span class = "p p-Indicator" > -< / span > < span class = "w" > < / span > < span class = "l l-Scalar l-Scalar-Plain" > https://..< / span >
< span class = "w" > < / span > < span class = "p p-Indicator" > -< / span > < span class = "w" > < / span > < span class = "l l-Scalar l-Scalar-Plain" > https://..< / 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" > piped.music< / 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" > piped< / span >
< span class = "w" > < / span > < span class = "nt" > network< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l l-Scalar l-Scalar-Plain" > piped< / 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" > ppdm< / span >
< span class = "w" > < / span > < span class = "nt" > piped_filter< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l l-Scalar l-Scalar-Plain" > music_songs< / span >
< span class = "w" > < / span > < span class = "l l-Scalar l-Scalar-Plain" > ...< / span >
< / pre > < / div >
< / div >
< / section >
< section id = "known-quirks" >
< h2 > < a class = "toc-backref" href = "#id2" role = "doc-backlink" > Known Quirks< / a > < a class = "headerlink" href = "#known-quirks" title = "Link to this heading" > ¶< / a > < / h2 >
< p > The implementation to support < a class = "reference internal" href = "../enginelib.html#searx.enginelib.Engine.paging" title = "searx.enginelib.Engine.paging" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > paging< / span > < / code > < / a >
is based on the < em > nextpage< / em > method of Piped’ < a class = "reference internal" href = "#searx.engines.piped.frontend_url" title = "searx.engines.piped.frontend_url" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > frontend< / span >
< span class = "pre" > API< / span > < / code > < / a > . This feature is < em > next page driven< / em > and plays well with the
< a class = "reference internal" href = "../../../admin/settings/settings_ui.html#settings-ui" > < span class = "std std-ref" > infinite_scroll< / span > < / a > setting in SearXNG but it does not really
fit into SearXNG’ < / p >
< / section >
< section id = "implementations" >
< h2 > < a class = "toc-backref" href = "#id3" role = "doc-backlink" > Implementations< / a > < 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.piped.backend_url" >
< span class = "sig-prename descclassname" > < span class = "pre" > searx.engines.piped.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > backend_url< / span > < / span > < em class = "property" > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#list" title = "(in Python v3.13)" > < span class = "pre" > list< / span > < / a > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > |< / span > < / span > < span class = "w" > < / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.13)" > < span class = "pre" > str< / span > < / a > < / em > < em class = "property" > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "pre" > 'https://pipedapi.kavin.rocks'< / span > < / em > < a class = "headerlink" href = "#searx.engines.piped.backend_url" title = "Link to this definition" > ¶< / a > < / dt >
< dd > < p > < a class = "reference external" href = "https://github.com/TeamPiped/Piped-Backend" > Piped-Backend< / a > : The core component behind Piped. The value is an URL or a
list of URLs. In the latter case instance will be selected randomly. For a
complete list of official instances see Piped-Instances (< a class = "reference external" href = "https://piped-instances.kavin.rocks/" > JSON< / a > )< / p >
< / dd > < / dl >
< dl class = "py data" >
< dt class = "sig sig-object py" id = "searx.engines.piped.frontend_url" >
< span class = "sig-prename descclassname" > < span class = "pre" > searx.engines.piped.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > frontend_url< / span > < / span > < em class = "property" > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.13)" > < span class = "pre" > str< / span > < / a > < / em > < em class = "property" > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "pre" > 'https://piped.video'< / span > < / em > < a class = "headerlink" href = "#searx.engines.piped.frontend_url" title = "Link to this definition" > ¶< / a > < / dt >
< dd > < p > < a class = "reference external" href = "https://github.com/TeamPiped/Piped" > Piped-Frontend< / a > : URL to use as link and for embeds.< / p >
< / dd > < / dl >
< dl class = "py data" >
< dt class = "sig sig-object py" id = "searx.engines.piped.piped_filter" >
< span class = "sig-prename descclassname" > < span class = "pre" > searx.engines.piped.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > piped_filter< / span > < / span > < em class = "property" > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "pre" > 'all'< / span > < / em > < a class = "headerlink" href = "#searx.engines.piped.piped_filter" title = "Link to this definition" > ¶< / a > < / dt >
< dd > < p > Content filter < code class = "docutils literal notranslate" > < span class = "pre" > music_songs< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > videos< / span > < / code > < / 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 = "../../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’ < / 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’ < / 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 = "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 = "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 = "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 = "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 = "peertube.html" > Peertube Engines< / a > < / li >
< li class = "toctree-l5 current" > < a class = "current reference internal" href = "#" > 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 = "seekr.html" > Seekr Engines< / 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 = "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 = "../../lxcdev.html" > Developing in Linux Containers< / 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 = "peertube.html" title = "previous chapter" > Peertube Engines< / a >
< li > Next: < a href = "presearch.html" title = "next chapter" > Presearch Engine< / 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/piped.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 >