RSSHub/docs/en

sidebar

sidebar
auto

RSSHub

🍰 Everything can be RSS

RSSHub is a lightweight and extensible RSS feed aggregator, it's able to generate feeds from pretty much everything.

Special Thanks

Special Sponsors

Sponsors

• Liuyang

• Zuyang

• Sayori Studio

Contributors

::: tip

Free feel to test the demo instance, the cache expiry time is set to 10 minutes.

:::

Parameters

::: tip

All parameters can be used together to generate a complex feed

:::

Filtering

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

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

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

Limit Entries

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

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

Output Formats

RSSHub supports RSS 2.0、Atom and JSON Feed as the output formats, simply append .rss .atom or .json to the end of the feed address, default to RSS 2.0

For exmaple:

• Default (RSS 2.0) - https://rsshub.app/dribbble/popular
• RSS 2.0 - https://rsshub.app/dribbble/popular.rss
• Atom - https://rsshub.app/dribbble/popular.atom
• JSON Feed - https://rsshub.app/dribbble/popular.json
• Apply filters or URL query https://rsshub.app/dribbble/popular.atom?filterout=Blue|Yellow|Black

Application Updates

RSSHub

Eg: https://rsshub.app/rsshub/rss

Route: /rsshub/rss

Parameters: N/A

MIUI

Eg: https://rsshub.app/miui/aries/

Route: /miui/:device/:type?

Parameters:

device: the device codename eg. aries for Mi 2S

type: type, optional

stable	development
release	dev

Firefox New Release

Eg: https://rsshub.app/firefox/release/desktop

Route: /firefox/release/:platform

Parameters: platform

Desktop	Android	Beta	Nightly	Android Beta
desktop	android	beta	nightly	android-beta

pixiv

User Bookmark

Eg: https://rsshub.app/pixiv/user/bookmarks/15288095

Route: /pixiv/user/bookmarks/:id

Parameters: id, user id, available in user's homepage URL

User Activity

Eg: https://rsshub.app/pixiv/user/11

Route: /pixiv/user/:id

Parameters: id, user id, available in user's homepage URL

Rankings

Eg: https://rsshub.app/pixiv/ranking/week

Route: /pixiv/ranking/:mode/:date?

Parameters

mode: rank type

pixiv daily rank	pixiv weekly rank	pixiv monthly rank	pixiv male rank	pixiv female rank	pixiv original rank	pixiv rookie user rank
day	week	month	day_male	day_female	week_original	week_rookie

pixiv R-18 daily rank	pixiv R-18 male rank	pixiv R-18 female rank	pixiv R-18 weekly rank	pixiv R-18G rank
day_r18	day_male_r18	day_female_r18	week_r18	week_r18g

date: data, format: 2018-4-25

Disqus

Comment

Eg: https://rsshub.app/disqus/posts/diygod-me

Route: /disqus/posts/:forum

Parameters: forum, disqus name of the target website

Twitter

User

Eg: https://rsshub.app/twitter/user/DIYgod

Route: /twitter/user/:id

Parameters: id, twitter handler

Instagram

User

Eg: https://rsshub.app/instagram/user/diygod

Route: /instagram/user/:id

Parameters: id, Instagram id

Youtube

User

Eg: https://rsshub.app/youtube/user/JFlaMusic

Route: /youtube/user/:username

Parameters: username, Youtuber's username

Channel

Eg: https://rsshub.app/youtube/channel/UCDwDMPOZfxVV0x_dz0eQ8KQ

Route: /youtube/channel/:id

Parameters: id, channel id

Dribbble

Popular

举例:

https://rsshub.app/dribbble/popular

https://rsshub.app/dribbble/popular/week

Route: /dribbble/popular/:timeframe?

Parameters: timeframe, optional, support the following values: week, month, year and ever

User（or team）

Eg: https://rsshub.app/dribbble/user/google

Route: /dribbble/user/:name

Parameters: name, username, available in user's homepage URL

Keyword

Eg: https://rsshub.app/dribbble/keyword/player

Route: /dribbble/keyword/:keyword

Parameters: keyword, the desired keyword

Telegram

Channel

::: tip

Bot initialization required: Add Telegram Bot @RSSHub_bot as an admin to the channel and send at least one message in the channel for the bot to obtain the chat_id.

:::

Eg: https://rsshub.app/telegram/channel/awesomeDIYgod

Route: /telegram/channel/:username

Parameters: username, channel name

GitHub

::: tip

GitHub provides some official RSS feeds:

• Repo releases: https://github.com/:owner/:repo/releases.atom
• Repo commits: https://github.com/:owner/:repo/commits.atom
• User activities: https://github.com/:user.atom

:::

User Repo

Eg: https://rsshub.app/github/repos/DIYgod

Route: /github/repos/:user

Parameters: user, username

Trending

Eg:

https://rsshub.app/github/trending/daily

https://rsshub.app/github/trending/daily/javascript

Route: /github/trending/:since/:language?

Parameters:

since, time frame, available in Trending page 's URL, possible values are: daily, weekly or monthly

language, the feed language, available in Trending page 's URL

Issue

Eg: https://rsshub.app/github/issue/DIYgod/RSSHub

Route: /github/issue/:user/:repo

Parameters:

user, username

repo, repo name

EZTV

::: tip

EZTV provides an official RSS feed of all torrents: https://eztv.ag/ezrss.xml

:::

Torrent Lookup by IMDB ID

Eg: https://rsshub.app/eztv/torrents/6048596

Route: /eztv/torrents/:imdb_id

Parameters: imdb_id, search for the IMDB ID of the desired show, available at IMDB

Hexo Blog

Blog using Next theme

Eg: http://rsshub.app/hexo/next/fengkx.top

路由: /hexo/next/:url

Parameters: url, the blog URL without the protocol (http:// and https://)

Greasy Fork

Script Update

Eg: https://rsshub.app/greasyfork/en/google.com

Route: /greasyfork/:language/:domain?

Parameters:

language, language, located on the top right corner of Greasy Fork's search page, set to all for including all languages

domain, the script's target domain, optional

All the Flight Deals

Flight Deals

Eg: https://rsshub.app/atfd/us+new york,gb+london/1

Route: /atfd/:locations/:nearby?

Parameters:

locations: the departing city, consists of an 「ISO 3166-1 country code」 and a 「city name」:

1. Origin's ISO 3166-1 country code + city name, eg. us+new york, https://rsshub.app/atfd/us+new york
2. Multiple origins are support via a comma separated string, eg. us+new york,gb+london, https://rsshub.app/atfd/us+new york,gb+london/

For ISO 3166-1 country codes please refer to Wikipedia ISO_3166-1

nearby: whether includes nearby airports, optional value of 0 or 1, default to 0 (exclude nearby airports)

Google

Google Scholar Keywords Monitoring

::: warning

Google Scholar has strict anti-crawling mechanism implemented, the demo below doesn't guarantee availability. Please deploy your own instance as it might increase the stability.

:::

Eg: https://rsshub.app/google/scholar/data+visualization

Route: /google/scholar/:query

Parameters: query, query statement which supports「Basic」and「Advanced」modes:

1. Basic mode, sample query is the keywords desired, eg.「data visualization」, https://rsshub.app/google/scholar/data+visualization.

2. Advanced mode, visit Google Scholar, click the top left corner and select「Advanced Search」, fill in your conditions and submit the search. The URL should look like this: https://scholar.google.com/scholar?as_q=data+visualization&as_epq=&as_oq=&as_eq=&as_occt=any&as_sauthors=&as_publication=&as_ylo=2018&as_yhi=&hl=en&as_sdt=0%2C5, copy everything after https://scholar.google.com/scholar? from the URL and use it as the query for this route. The complete URL for the above example should look like this: https://rsshub.app/google/scholar/as_q=data+visualization&as_epq=&as_oq=&as_eq=&as_occt=any&as_sauthors=&as_publication=&as_ylo=2018&as_yhi=&hl=en&as_sdt=0%2C5.

Hopper

Hopper Flight Deals

Eg: London Heathrow Airport ✈ Beijing Capital International Airport https://rsshub.app/hopper/LHR/PEK

Route: /hopper/:from/:to?

Parameters:

from, origin airport IATA code

to, destination airport IATA code, optional, if unset the destination will be set to anywhere

For airport IATA code please refer to Wikipedia List of airports by IATA code