RSSHub/docs/en

sidebar

sidebar
auto

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:

• 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

API

::: warning 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 Tip This API will not return any routes under 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/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

MIUI

stable	development
release	dev

Firefox

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

Thunderbird

App Store/Mac App Store

F-Droid

Greasy Fork

Thunderbird

Nvidia Web Driver

Social Media

pixiv

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

Twitter

Instagram

Youtube

Telegram

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

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

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

:::

GitLab

Trending	Most stars	All
trending	starred	all

Uncategorized

EZTV

::: tip

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

:::

Hexo Blog

Google

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

Apple