xiaoxue_admin
/
RSSHub
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
RSSHub/docs/en/parameter.md

6.2 KiB
Raw Blame History

Parameters

::: tip

The parameters can be linked with & to used together to generate a complex feed.

:::

Filtering

::: warning Warning

Please make sure you've fully URL-encoded the parameters. Do not rely on the browser's automatic URL encoding. Some characters, such as +, &, will not be automatically encoded, resulting in the final parsing result not being correct.

:::

The following URL query parameters are supported, Regex support is built-in.

Set filter to include the content

  • filter: filter title and description

  • filter_title: filter title only

  • filter_description: filter description only

  • filter_author: filter author only

  • filter_time: filter pubDate, in seconds, return specified time range. Item without pubDate will not be filtered.

For example: https://rsshub.app/dribbble/popular?filter=Blue|Yellow|Black

Set filterout to exclude unwanted content.

  • filterout: filter title and description

  • filterout_title: filter title only

  • filterout_description: filter description only

  • filterout_author: filter author only

For example: https://rsshub.app/dribbble/popular?filterout=Blue|Yellow|Black

Set filter_case_sensitive to determine whether the filtering keywords should be case sensitive. The parameter would apply to both filter and filterout.

Default: true

Example: https://rsshub.app/dribbble/popular?filter=BluE|yeLLow|BlaCK&filter_case_sensitive=false

Limit Entries

Set limit to limit the number of articles in the feed.

E.g. Dribbble Popular Top 10 https://rsshub.app/dribbble/popular?limit=10

Fulltext

Enable fulltext via mode parameter.

E.g. Bilibili article https://rsshub.app/bilibili/user/article/334958638?mode=fulltext

Access Control

Set key or code to grant access to requests. See Access Control Configuration.

Telegram Instant View

Replace website link with Telegram's Instant View link.

Enable Telegram Instant View requires a page template, it can be obtained from Telegram's Instant View page

  • tgiv: template hash, obtained from the link of template page generated（the string after &rhash=）

E.g. https://rsshub.app/novel/biquge/94_94525?tgiv=bd3c42818a7f7e

Sci-hub link

Output Sci-hub link in scientific journal routes, this supports major journals or routes that output DOIs.

  • scihub: set to any value

E.g. https://rsshub.app/pnas/latest?scihub=1

Conversion between Traditional and Simplified Chinese

  • opencc: s2t (Simplified Chinese to Traditional Chinese)、t2s (Traditional Chinese to Simplified Chinese), other optional values refer to simplecc-wasm - Configurations

E.g. https://rsshub.app/dcard/posts/popular?opencc=t2s

Multimedia processing

::: warning 注意

This is an experimental API

The following operation allows user to inject codes, which is harmful in web environment. However, RSS feed reader usually limits these functions. While normally routes won't need these functions, please set ALLOW_USER_HOTLINK_TEMPLATE to true if you understand how these parameters works.

:::

  • image_hotlink_template: replace image URL in the description to avoid anti-hotlink protection, leave it blank to disable this function. Usage reference #2769. You may use any property listed in URL (suffixing with _ue results in URL encoding), format of JS template literal. e.g. ${protocol}//${host}${pathname}, https://i3.wp.com/${host}${pathname}, https://images.weserv.nl?url=${href_ue}
  • multimedia_hotlink_template: the same as image_hotlink_template but apply to audio and video. Note: the service must follow redirects, allow reverse-proxy for audio and video, and must drop the Referer header when reverse-proxying. Here is an easy-to-deploy project that fits these requirements. The project accepts simple URL concatenation, e.g. https://example.com/${href}, in which example.com should be replaced with the domain name of the service you've deployed
  • wrap_multimedia_in_iframe: wrap audio and video in <iframe> to prevent the reader from sending Referer header. This workaround is only compatible with a few readers, such as RSS Guard and Akregator, which may not support the previous method. You can try this method in such a case

There are more details in the FAQ.

Output Formats

RSSHub conforms to RSS 2.0 and Atom Standard, simply append .rss .atom to the end of the feed address to obtain the feed in corresponding format. The default output format is RSS 2.0.

For example:

Debug

If the RSSHub instance is running with debugInfo=true enabled, suffixing a route with .debug.json will result in the value of ctx.state.json being returned.

This feature aims to facilitate debugging or developing customized features. A route developer has the freedom to determine whether to adopt it or not, without any format requirement.

For example：

  • /furstar/characters/cn.debug.json

Brief introduction

Set the parameter brief to generate a brief pure-text introduction with a limited number of characters ( ≥ 100).

For example：

  • Brief introduction with 100 characters: ?brief=100