opensource/RSSHub
1
0
Fork 0
mirror of https://github.com/DIYgod/RSSHub.git synced 2025-12-06 05:03:44 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
61ee926cfbbcd57f9ae3f9fd9b51b1a680e020f0
RSSHub/docs/en
History

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 Anonymous Sion Kazama 琚致远

FAQs

Q: How does RSSHub work？

A: When a request is received, RSSHub fetches the corresponding data from the original site, the result ing contents will be output in RSS format. Caching is implemented to avoid requesting original sites for content. And of course, we throw in a little magic 🎩.

Q: Can I use the demo instance？

A: rsshub.app is the demo instance provided, running the latest build of RSSHub from master branch, the cache is set 20 minutes and it's free to use. However, popular websites such as Instagram and YouTube etc. may pose a request quota on individual IP address, which means it can get unreliable from time to time for the demo instance. You are encouraged to host your own RSSHub instance for a better usability.

Q: Why are images not loading in some RSSHub routes？

A: RSSHub fetches and respects the original image URLs from original sites, referrerpolicy="no-referrer" attribute is added to all images to solve the issues caused by cross-domain requests. Third party RSS service providers such as Feedly and Inoreader, strip this attribute off which leads to cross-domain requests being blocked.

Q: The website I want is not supported QAQ

A: If you are a JavaScript developer, please follow this guide for submitting a pull request, otherwise, follow the issue template to submit a new issue, and patiently wait for Santa Claus. For priority responses, consider sponsoring us.

Q: Where do I get the changelog for RSSHub？

A: Subscribe our RSS here: RSSHub added a new route.

Contributors

Logo designed by sheldonrrr

::: tip

Feel free 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 example:

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

Update

MIUI

New firmware

stable development
release dev

Firefox

New Release

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

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

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

Twitter

User timeline

User following timeline

::: warning

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

User likes

Instagram

User

Hashtag

Youtube

User

Channel

Playlist

Telegram

Channel

Sticker Pack

Gaming

Steam

Steam search

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

SteamGifts

Discussions

Nintendo

eShop New Game Releases

Nintendo Direct

News（Hong Kong only）

PlayStation Store

Game List（Hong Kong only）

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

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

Comics are serialized Comics is finshed
serial finish

Travel

All the Flight Deals

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

Flight Deals

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

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:

:::

User Repo

Trending

Issue

Follower

Star

GitLab

Explore

Trending Most stars All
trending starred all

Parcel Tracking

Hermes

Hermes UK

E-commerce

leboncoin

Transform any search into a feed.

For instance, in https://www.leboncoin.fr/recherche/?category=10&locations=Paris_75015, the query is category=10&locations=Paris_75015

Uncategorized

EZTV

::: tip

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

:::

Torrent Lookup by IMDB ID

Hexo Blog

Blog using Next theme

Blog using Yilia theme

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.

:::

  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

User (or team)

Keyword

Apple

Exchange and Repair Extension Programs

The Verge

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

99% Invisible

Transcript

AutoTrader

Search

  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

Security Council Vetoed a Resolution

The Guardian

Editorial

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

iDownloadBlog

iDownloadBlog

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

9To5

9To5 Sub-site

Supported sub-sites：

Mac Google Toys
Mac Google Toys

All Poetry

Poems

Japanpost

Track & Trace Service

aptonic

New Dropzone Actions

Reference in New Issue View Git Blame Copy Permalink