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

Contributors

Logo designed by sheldonrrr

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

Parameters

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
filter_author: filter author 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
filterout_author: filter author 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 and Atom as the output formats, simply append .rss .atom 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
Apply filters or URL query https://rsshub.app/dribbble/popular.atom?filterout=Blue|Yellow|Black

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 lib/protected_router.js.

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

Route: /api/routes/:name?

Parameters:

name, route's top level name as in https://github.com/DIYgod/RSSHub/tree/master/lib/routes. Optional, returns all public routes if not specified.

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

Author: @DIYgod

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

Route: /rsshub/rss

Parameters: N/A

MIUI

New firmware

Author: @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

Author: @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

Update

Author: @garywill

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

Route: /thunderbird/release

Parameters: N/A

App Store/Mac App Store

App Update

Author: @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

Price Drop

Author: @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

Author: @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

Author: @garywill

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

Route: /fdroid/apprelease/:app

Parameters:

app, required -
App's package name

Greasy Fork

Script Update

Author: @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

Author: @garywill

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

Route: /thunderbird/release

Parameters: N/A

Nvidia Web Driver

Changelog

Author: @cielpy

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

Route: /nvidia/webdriverupdate

Parameters: N/A

Docker Hub

Image New Build

Author: @HenryQW

Example: https://rsshub.app/dockerhub/build/wangqiru/ttrss

Route: /dockerhub/build/:owner/:image/:tag?

Parameters:

owner, required -
Image owner
image, required -
Image name
tag, optional -
Image tag，default to latest

pixiv

User Bookmark

Author: @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

Author: @EYHN

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

Route: /pixiv/user/:id

Parameters:

id, required -
user id, available in user's homepage URL

Rankings

Author: @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

Author: @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 timeline

Author: @DIYgod

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

Route: /twitter/user/:id

Parameters:

id, required -
user id

User following timeline

作者: @DIYgod

举例: https://rsshub.app/twitter/followings/DIYgod

路由: /twitter/followings/:id

参数:

id, 必选 -
user id

User following timeline needs Twitter token corresponding id, so this route is only for self-hosted, see Install - Route-specific Configurations for details

List timeline

Author: @xyqfer

Example: https://rsshub.app/twitter/list/ladyleet/javascript

Route: /twitter/list/:id/:name

Parameters:

id, required -
user name
name, required -
list name

User likes

作者: @xyqfer

举例: https://rsshub.app/twitter/likes/DIYgod

路由: /twitter/likes/:id

参数:

id, 必选 -
user name

Instagram

User

Author: @DIYgod

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

Route: /instagram/user/:id

Parameters:

id, required -
Instagram id

Hashtag

Author: @widyakumara

Example: https://rsshub.app/instagram/tag/urbantoys

Route: /instagram/tag/:tag

Parameters:

tag, required -
Instagram hashtag

Youtube

User

Author: @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

Author: @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

Author: @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

Channel

Author: @DIYgod

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

Route: /telegram/channel/:username

Parameters:

username, required -
channel name

Sticker Pack

Author: @DIYgod

Example: https://rsshub.app/telegram/stickerpack/DIYgod

Route: /telegram/stickerpack/:name

Parameters:

name, required -
Sticker Pack name, available in the sharing URL

Gaming

Steam

Steam search

Author: @maple3142

Example: https://rsshub.app/steam/search/specials=1&term=atelier

Route: /steam/search/:params

Parameters:

params, required -
search parameters

Get serach parameters from the URL.

For instance, in https://store.steampowered.com/search/?specials=1&term=atelier, the parameters are specials=1&term=atelier.

Steam news

Author: @maple3142

Example: https://rsshub.app/steam/news/282800

Route: /steam/news/:appids

Parameters:

appids, required -
game id

SteamGifts

Discussions

Author: @whtsky

Example: https://rsshub.app/steamgifts/discussions

Route: /steamgifts/discussions/:category?

Parameters:

category, optional -
category name, default to All

Nintendo

eShop New Game Releases

Author: @HFO4

Example: https://rsshub.app/nintendo/eshop/hk

Route: /nintendo/eshop/:region

Parameters:

region, required -
Region, currently supports hk(Hong Kong), jp(Japan) and us(USA)

Nintendo Direct

Author: @HFO4

Example: https://rsshub.app/nintendo/direct

Route: /nintendo/direct

Parameters: N/A

News（Hong Kong only）

作者: @HFO4

举例: https://rsshub.app/nintendo/news

路由: /nintendo/news

参数: 无

PlayStation Store

Game List（Hong Kong only）

Author: @DIYgod

Example: https://rsshub.app/ps/list/STORE-MSF86012-PLUS_FTT_CONTENT

Route: /ps/list/:gridName

Parameters:

gridName, required -
gridName from the list

Compatible with lists with an URL like https://store.playstation.com/zh-hans-hk/grid/STORE-MSF86012-PLUS_FTT_CONTENT. For instance PSN Free to Play, the gridName is STORE-MSF86012-PLUS_FTT_CONTENT

Metacritic

Game Releases

Author: @HenryQW

Example: https://rsshub.app/metacritic/release/switch/coming

Route: /metacritic/release/:platform/:type?/:sort?

Parameters:

platform, required -
console platform
type, optional -
release type, default to new
sort, optional -
sorting type, default to date

Platforms supported:

PS 4	Xbox One	Switch	PC	Wii U	3DS	PS Vita	iOS
ps4	xboxone	switch	pc	wii-u	3ds	vita	ios

Release types, default to new:

New	Coming Soon	All
new	coming	all

Sorting types, default to date:

Date	Metacritic Score	User Score
date	metascore	userscore

ACG

Vol.moe

vol

Author: @CoderTonyChan

Example: https://rsshub.app/vol/finsh

Route: /vol/:mode?

Parameters:

mode, optional -
mode type

Comics are serialized	Comics is finshed
serial	finish

Travel

All the Flight Deals

Flight Deals

Author: @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

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

Hopper

Flight Deals

Author: @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

News

BBC

Author: @HenryQW

Example: https://rsshub.app/bbc/chinese

Route: /bbc/:channel?

Parameters:

channel, optional -
channel, default to top stories

Provides a better reading experience (full text articles) over the official ones.

Support major channels, refer to BBC RSS feeds. Eg, business for https://feeds.bbci.co.uk/news/business/rss.xml.

Channel with a single path, such as https://feeds.bbci.co.uk/news/business/rss.xml, use /bbc/business.
Channel contains multiple paths, such as https://feeds.bbci.co.uk/news/world/asia/rss.xml, replace / with -, /bbc/world-asia.
Exemption: use /bbc/chinese for BBC News Chinese.

Programming

GitHub

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
Private feed: https://github.com/:user.private.atom?token=:secret (You can find Subscribe to your news feed in dashboard page after login)

User Repo

Author: @dragon-yuan

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

Route: /github/repos/:user

Parameters:

user, required -
GitHub username

Issue

Author: @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

Author: @HenryQW

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

Route: /github/user/follower/:user

Parameters:

user, required -
GitHub username

Star

Author: @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

Author: @imlonghao

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

Route: /gitlab/explore/:type

Parameters:

type, required -
type

Trending	Most stars	All
trending	starred	all

Parcel Tracking

Hermes

Hermes UK

Author: @HenryQW

Example: https://rsshub.app/parcel/hermesuk/[tracking number]

Route: /parcel/hermesuk/:tracking

Parameters:

tracking, required -
Tracking number

Uncategorized

EZTV

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

Torrent Lookup by IMDB ID

Author: @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

Author: @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://)

Blog using Yilia theme

Author: @aha2mao

Example: https://rsshub.app/hexo/yilia/cloudstone.xin

Route: /hexo/yilia/:url

Parameters:

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

Google

Google Scholar Keywords Monitoring

Author: @HenryQW

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

Route: /google/scholar/:query

Parameters:

query, required -
query statement which supports「Basic」and「Advanced」modes

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.

Basic mode, sample query is the keywords desired, eg.「data visualization」, https://rsshub.app/google/scholar/data+visualization.
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

User (or team)

Author: @DIYgod

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

Route: /dribbble/user/:name

Parameters:

name, required -
username, available in user's homepage URL

Keyword

Author: @DIYgod

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

Route: /dribbble/keyword/:keyword

Parameters:

keyword, required -
desired keyword

Apple

Exchange and Repair Extension Programs

Author: @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

The Verge

Author: @HenryQW

Example: https://rsshub.app/verge

Route: /verge

Parameters: N/A

Provides a better reading experience (full text articles) over the official one.

99% Invisible

Transcript

Author: @Ji4n1ng

Example: https://rsshub.app/99percentinvisible/transcript

Route: /99percentinvisible/transcript

Parameters: N/A

AutoTrader

Search

Author: @HenryQW

Example: https://rsshub.app/autotrader/radius=50&postcode=sw1a1aa&onesearchad=Used&onesearchad=Nearly%20New&onesearchad=New&price-to=9000&year-from=2012&body-type=Hatchback&transmission=Automatic&exclude-writeoff-categories=on

Route: /autotrader/:query

Parameters:

query, required -
the search query

Conduct a search with desired filters on AutoTrader
Copy everything in the URL after ?, for example: https://www.autotrader.co.uk/car-search?radius=50&postcode=sw1a1aa&onesearchad=Used&onesearchad=Nearly%20New&onesearchad=New&price-to=9000&year-from=2012&body-type=Hatchback&transmission=Automatic&exclude-writeoff-categories=on will produce radius=50&postcode=sw1a1aa&onesearchad=Used&onesearchad=Nearly%20New&onesearchad=New&price-to=9000&year-from=2012&body-type=Hatchback&transmission=Automatic&exclude-writeoff-categories=on

United Nations

Security Council Vetoed a Resolution

Author: @HenryQW

Example: https://rsshub.app/un/scveto

Route: /un/scveto

Parameters: N/A

The Guardian

Editorial

Author: @HenryQW

Example: https://rsshub.app/guardian/editorial

Route: /guardian/editorial

Parameters: N/A

Provides a better reading experience (full text articles) over the official one.

iDownloadBlog

Author: @HenryQW

Example: https://rsshub.app/iDownloadBlog

Route: /iDownloadBlog/index

Parameters: N/A

Provides a better reading experience (full text articles) over the official one.

9To5

9To5 Sub-site

Author: @HenryQW

Example: https://rsshub.app/9to5/mac

Route: /9to5/:type

Parameters:

type, required -
The sub-site name

Supported sub-sites：

Mac	Google	Toys
Mac	Google	Toys

All Poetry

Poems

Author: @HenryQW

Example: https://rsshub.app/allpoetry/newest

Route: /allpoetry/:order?

Parameters:

order, optional -
order by type, best or newest, default to best

RSSHub

# Special Thanks

# Special Sponsors

# Sponsors

# Contributors

# Parameters

# Filtering

# Limit Entries

# Output Formats

# API

# List of Public Routes

# Application Updates

# RSSHub

# Update

# MIUI

# New firmware

# Firefox

# New Release

# Thunderbird

# Update

# App Store/Mac App Store

# App Update

# Price Drop

# In-App-Purchase Price Drop Alert

# F-Droid

# App Update

# Greasy Fork

# Script Update

# Thunderbird

# Changelog

# Nvidia Web Driver

# Changelog

# Docker Hub

# Image New Build

# Social Media

# pixiv

# User Bookmark

# User Activity

# Rankings

# Disqus

# Comment

# Twitter

# User timeline

# User following timeline

# List timeline

# User likes

# Instagram

# User

# Hashtag

# Youtube

# User

# Channel

# Playlist

# Telegram

# Channel

# Sticker Pack

# Gaming

# Steam

# Steam search

# Steam news

# SteamGifts

# Discussions

# Nintendo

# eShop New Game Releases

# Nintendo Direct

# News（Hong Kong only）

# PlayStation Store

# Game List（Hong Kong only）

# Metacritic

# Game Releases

# ACG

# Vol.moe

# vol

# Travel

# All the Flight Deals

# Flight Deals

# Hopper

# Flight Deals

# News

# BBC

Special Thanks

Special Sponsors

Sponsors

Contributors

Parameters

Filtering

Limit Entries

Output Formats

API

List of Public Routes

Application Updates

RSSHub

Update

MIUI

New firmware

Firefox

New Release

Thunderbird

Update

App Store/Mac App Store

App Update

Price Drop

In-App-Purchase Price Drop Alert

F-Droid

App Update

Greasy Fork

Script Update

Thunderbird

Changelog

Nvidia Web Driver

Changelog

Docker Hub

Image New Build

Social Media

pixiv

User Bookmark

User Activity

Rankings

Disqus

Comment

Twitter

User timeline

User following timeline

List timeline

User likes

Instagram

User

Hashtag

Youtube

User

Channel

Playlist

Telegram

Channel

Sticker Pack

Gaming

Steam

Steam search

Steam news

SteamGifts

Discussions

Nintendo

eShop New Game Releases

Nintendo Direct

News（Hong Kong only）

PlayStation Store

Game List（Hong Kong only）

Metacritic

Game Releases

ACG

Vol.moe

vol

Travel

All the Flight Deals

Flight Deals

Hopper

Flight Deals

News

BBC

BBC