RSSHub

RSSHub

RSSHub

🍰 Everything is RSSible

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 Xiaojiong Wang

Contributors

TIP

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

Parameters

TIP

All parameters can be linked with & to 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:

API

Warning

The API is under active development and is subject to change. All suggestions are welcome!

RSSHub provides the following APIs:

List of Public Routes

Tip

This API will not return any routes under protected_router.js.

Eg: https://rsshub.app/api/routes/github

Route: /api/routes/:name?

Parameters:

A successful request returns a HTTP status code 200 OK with the result in JSON:

{
    "status": "success",
    "data": {
        "github": {
            "routes": [
                "/github/trending/:since/:language?",
                "/github/issue/:user/:repo",
                "/github/user/followers/:user",
                "/github/stars/:user/:repo"
            ]
        }
    },
    "message": "request returned 4 routes"
}

If no matching results were found, the server returns only a HTTP status code 204 No Content.

Application Updates

RSSHub

Update By @DIYgod

Example: https://rsshub.app/rsshub/rss

Route: /rsshub/rss

Parameters: N/A

MIUI

New firmware By @Indexyz

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

Route: /miui/:device/:type?

Parameters:

  • device, required -

    the device codename eg. aries for Mi 2S

  • type, optional -

    type

stable development
release dev

Firefox

New Release By @fengkx

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

Route: /firefox/release/:platform

Parameters:

  • platform, required -

    the platform

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

Thunderbird By @garywill

Update By @garywill

Example: https://rsshub.app/thunderbird/release

Route: /thunderbird/release

Parameters: N/A

App Store/Mac App Store

App Update By @cielpy

Example: https://rsshub.app/appstore/update/us/id697846300

Route: /appstore/update/:country/:id

Parameters:

  • country, required -

    App Store Country, obtain from the app URL https://itunes.apple.com/us/app/reeder-3/id697846300?mt=8, in this case, us

  • id, required -

    App Store app id, obtain from the app URL https://itunes.apple.com/us/app/reeder-3/id697846300?mt=8, in this case, id697846300

App Update By @HenryQW

Example: https://rsshub.app/appstore/price/us/mac/id1152443474

Route: /appstore/price/:country/:type/:id

Parameters:

  • country, required -

    App Store Country, obtain from the app URL https://itunes.apple.com/us/app/id1152443474, in this case, us

  • type, required -

    App type，either iOS or mac

  • id, required -

    App Store app id, obtain from the app URL https://itunes.apple.com/us/app/id1152443474, in this case, id1152443474

In-App-Purchase Price Drop Alert By @HenryQW

Example: https://rsshub.app/appstore/iap/us/id953286746

Route: /appstore/iap/:country/:id

Parameters:

  • country, required -

    App Store Country, obtain from the app URL https://itunes.apple.com/us/app/id953286746, in this case, us

  • id, required -

    App Store app id, obtain from the app URL https://itunes.apple.com/us/app/id953286746, in this case, id953286746

F-Droid

App Update By @garywill

Example: https://rsshub.app/fdroid/apprelease/com.termux

Route: /fdroid/apprelease/:app

Parameters:

  • app, required -

    App's package name

Greasy Fork

Script Update By @imlonghao

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

Route: /greasyfork/:language/:domain?

Parameters:

  • language, required -

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

  • domain, optional -

    the script's target domain

Thunderbird

Changelog By @garywill

Example: https://rsshub.app/thunderbird/release

Route: /thunderbird/release

Parameters: N/A

Nvidia Web Driver

Changelog By @cielpy

Example: https://rsshub.app/nvidia/webdriverupdate

Route: /nvidia/webdriverupdate

Parameters: N/A

Social Media

pixiv

User Bookmark By @EYHN

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

Route: /pixiv/user/bookmarks/:id

Parameters:

  • id, required -

    user id, available in user's homepage URL

User Activity By @EYHN

Example: https://rsshub.app/pixiv/user/15288095

Route: /pixiv/user/:id

Parameters:

  • id, required -

    user id, available in user's homepage URL

Rankings By @EYHN

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

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

Parameters:

  • mode, required -

    rank type

  • date, optional -

    format: 2018-4-25

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

Disqus

Comment By @DIYgod

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

Route: /disqus/posts/:forum

Parameters:

  • forum, required -

    forum, disqus name of the target website

Twitter

User By @DIYgod

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

Route: /twitter/user/:id

Parameters:

  • id, required -

    twitter handler

Instagram

User By @DIYgod

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

Route: /instagram/user/:id

Parameters:

  • id, required -

    Instagram id

Youtube

User By @DIYgod

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

Route: /youtube/user/:username/:embed?

Parameters:

  • username, required -

    YouTuber id

  • embed, optional -

    Default to embed the video, set to any value to disable embedding

Channel By @DIYgod

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

Route: /youtube/channel/:id/:embed?

Parameters:

  • id, required -

    YouTube channel id

  • embed, optional -

    Default to embed the video, set to any value to disable embedding

Playlist By @DIYgod

Example: https://rsshub.app/youtube/playlist/PLqQ1RwlxOgeLTJ1f3fNMSwhjVgaWKo_9Z

Route: /youtube/playlist/:id/:embed?

Parameters:

  • id, required -

    YouTube playlist id

  • embed, optional -

    Default to embed the video, set to any value to disable embedding

Telegram

Channel By @DIYgod

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

Route: /telegram/channel/:username

Parameters:

  • username, required -

    channel name

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.

Travel

All the Flight Deals

Flight Deals By @HenryQW

Example: https://rsshub.app/atfd/us+new%20york,gb+london/1

Route: /atfd/:locations/:nearby?

Parameters:

  • locations, required -

    the departing city, consists of an 「ISO 3166-1 country code」 and a 「city name」. Origin's ISO 3166-1 country code + city name, eg. us+new york, https://rsshub.app/atfd/us+new york. Multiple origins are supported via a comma separated string, eg. us+new york,gb+london, https://rsshub.app/atfd/us+new york,gb+london/.

  • nearby, optional -

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

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

TIP

If the city name contains a space like Mexico City, replace the space with %20, Mexico%20City.

Hopper

Flight Deals By @HenryQW

Example: https://rsshub.app/hopper/1/LHR/PEK

Route: /hopper/:lowestOnly/:from/:to?

Parameters:

  • lowestOnly, required -

    set to 1 will return the cheapest deal only, instead of all deals, so you don't get spammed

  • from, required -

    origin airport IATA code

  • to, optional -

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

This route returns a list of flight deals (in most cases, 6 flight deals) for a period defined by Hopper's algorithm, which means the travel date will be totally random (could be tomorrow or 10 months from now).

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

Programming

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 By @dragon-yuan

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

Route: /github/repos/:user

Parameters:

  • user, required -

    GitHub username

Trending By @DIYgod

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

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

Parameters:

  • since, required -

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

  • language, optional -

    the feed language, available in Trending page 's URL

Issue By @HenryQW

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

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

Parameters:

  • user, required -

    GitHub username

  • repo, required -

    GitHub repo name

Follower By @HenryQW

Example: https://rsshub.app/github/user/followers/HenryQW

Route: /github/user/follower/:user

Parameters:

  • user, required -

    GitHub username

Star By @HenryQW

Example: https://rsshub.app/github/stars/DIYGod/RSSHub

Route: /github/stars/:user/:repo

Parameters:

  • user, required -

    GitHub username

  • repo, required -

    GitHub repo name

GitLab

Explore By @imlonghao

Example: https://rsshub.app/gitlab/explore/trending

Route: /gitlab/explore/:type

Parameters:

  • type, required -

    type

Trending Most stars All
trending starred all

Uncategorized

EZTV

TIP

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

Torrent Lookup by IMDB ID By @Songkeys

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

Route: /eztv/torrents/:imdb_id

Parameters:

  • imdb_id, required -

    search for the IMDB ID of the desired show, available at IMDB

Hexo Blog

Blog using Next theme By @fengkx

Example: https://rsshub.app/hexo/next/fengkx.top

Route: /hexo/next/:url

Parameters:

  • url, required -

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

Google

Google Scholar Keywords Monitoring By @HenryQW

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

Route: /google/scholar/:query

Parameters:

  • query, required -

    query statement which supports「Basic」and「Advanced」modes

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.

  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.

Dribbble

Popular By @DIYgod

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

Route: /dribbble/popular/:timeframe?

Parameters:

  • timeframe, optional -

    support the following values: week, month, year and ever

User (or team) By @DIYgod

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

Route: /dribbble/user/:name

Parameters:

  • name, required -

    username, available in user's homepage URL

Keyword By @DIYgod

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

Route: /dribbble/keyword/:keyword

Parameters:

  • keyword, required -

    desired keyword

Apple

Exchange and Repair Extension Programs By @metowolf @HenryQW

Example: https://rsshub.app/apple/exchange_repair

Route: /apple/exchange_repair/:country?

Parameters:

  • country, optional -

    country code in apple.com URL (exception: for United States please use us), default to China cn

Edit this page on GitHub
Last Updated: 9/26/2018, 9:20:22 AM