opensource/RSSHub
1
0
Fork 0
mirror of https://github.com/DIYgod/RSSHub.git synced 2025-12-05 20:27:52 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
359c18de1dc1731d70c0d94e221b13f776ff3a2d
RSSHub/docs/en
History
DIYgod a8a4c050f6 docs: add icon, move logo.png
2019-04-23 15:03:58 +08:00
..
install
docs: proxy
2019-04-18 14:36:38 +08:00
joinus
docs: PascalCase component
2019-03-25 00:51:16 +08:00
support
docs: support, close #1788
2019-03-23 00:41:23 +08:00
README.md
docs: add icon, move logo.png
2019-04-23 15:03:58 +08:00

README.md

sidebar
sidebar
auto

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

Eternal Proxy Liuyang Sayori Studio 匿名 Sion Kazama

Contributors

Logo designed by sheldonrrr

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

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

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 lib/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

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

Docker Hub

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.

For private channels, pass the channel id (such as -1001001234567) intstead of :username. The easiest way to get id is described here.

:::

ACG

Vol.moe

Comics are serialized Comics is finshed
serial finish

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

News

BBC

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

::: tip

GitHub provides some official RSS feeds:

:::

GitLab

Trending Most stars All
trending starred all

Parcel Tracking

Hermes

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

The Verge

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

99% Invisible

AutoTrader

  1. Conduct a search with desired filters on AutoTrader
  2. 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

The Guardian

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

iDownloadBlog

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

9To5

Supported sub-sites：

Mac Google Toys
Mac Google Toys

All Poetry

Reference in New Issue View Git Blame Copy Permalink