🌟 Popular
AP News
News
🔴 Failed Test🔍 Support Radar
💡 Example: https://rsshub.app/apnews/rss/business
🛎️ Route: /apnews/rss/:category?
🔗 Parameters:
category
- Optional
- Default: index
- Description: Category from the first segment of the corresponding site, or
index
for the front page.
🐙 Source Code: /apnews/rss.ts
Topics
🔴 Failed Test🔍 Support Radar
💡 Example: https://rsshub.app/apnews/topics/apf-topnews
🛎️ Route: /apnews/topics/:topic?
🔗 Parameters:
topic
- Optional
- Default: trending-news
- Description: Topic name, can be found in URL. For example: the topic name of AP Top News https://apnews.com/apf-topnews is
apf-topnews
🐙 Source Code: /apnews/topics.ts
Apple
App Update
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/apple/apps/update/us/id408709785
🛎️ Route: /apple/apps/update/:country/:id/:platform?
🔗 Parameters:
country
- Required
- Description: App Store Country, obtain from the app URL, see below
id
- Required
- Description: App id, obtain from the app URL
platform
- Optional
- Options:
- Description: App Platform, see below, all by default
🐙 Source Code: /apple/apps.ts
TIP
For example, the URL of GarageBand in the App Store is https://apps.apple.com/us/app/messages/id408709785
. In this case, the App Store Country
parameter for the route is us
, and the App id
parameter is id1146560473
. So the route should be /apple/apps/update/us/id408709785
.
Docker Hub
Image New Build
🟢 Passed Test
💡 Example: https://rsshub.app/dockerhub/build/diygod/rsshub
🛎️ Route: /dockerhub/build/:owner/:image/:tag?
🔗 Parameters:
owner
- Required
- Description: Image owner, the owner of the official image fills in the library, for example: /dockerhub/build/library/mysql
image
- Required
- Description: Image name
tag
- Optional
- Default: latest
- Description: Image tag
🐙 Source Code: /dockerhub/build.ts
Epic Games Store
Free games
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/epicgames/freegames
🛎️ Route: /epicgames/freegames/:locale?/:country?
🔗 Parameters:
locale
- Optional
- Default: en-US
- Description: Locale
country
- Optional
- Default: US
- Description: Country
🐙 Source Code: /epicgames/index.ts
Fediverse
Timeline
🟢 Passed Test
💡 Example: https://rsshub.app/fediverse/timeline/[email protected]
🛎️ Route: /fediverse/timeline/:account
🔗 Parameters:
account
- Required
- Description: username@domain
🐙 Source Code: /fediverse/timeline.ts
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
- Private feed:
https://github.com/:user.private.atom?token=:secret
(You can find Subscribe to your news feed in dashboard page after login) - Wiki history:
https://github.com/:owner/:repo/wiki.atom
Repo Issues
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/github/issue/DIYgod/RSSHub/open
🛎️ Route: /github/issue/:user/:repo/:state?/:labels?
🔗 Parameters:
user
- Required
- Description: GitHub username
repo
- Required
- Description: GitHub repo name
state
- Optional
- Default: open
- Options:
- Description: the state of the issues.
labels
- Optional
- Description: a list of comma separated label names
🐙 Source Code: /github/issue.ts
Repo Stars
🟡 Missing Test⚙️ Config Required🔍 Support Radar
💡 Example: https://rsshub.app/github/stars/DIYgod/RSSHub
🛎️ Route: /github/stars/:user/:repo
🔗 Parameters:
user
- Required
- Description: GitHub username
repo
- Required
- Description: GitHub repo name
⚙️ Deployment Configs:
GITHUB_ACCESS_TOKEN
, required - GitHub Access Token
🐙 Source Code: /github/star.ts
Trending
🟡 Missing Test⚙️ Config Required🔍 Support Radar
💡 Example: https://rsshub.app/github/trending/daily/javascript/en
🛎️ Route: /github/trending/:since/:language/:spoken_language?
🔗 Parameters:
since
- Required
- Options:
- Description: time range
language
- Required
- Default: any
- Description: the feed language, available in Trending page 's URL, don't filter option is
any
spoken_language
- Optional
- Description: natural language, available in Trending page 's URL
⚙️ Deployment Configs:
GITHUB_ACCESS_TOKEN
, required -
🐙 Source Code: /github/trending.ts
User Activities
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/github/activity/DIYgod
🛎️ Route: /github/activity/:user
🔗 Parameters:
user
- Required
- Description: GitHub username
🐙 Source Code: /github/activity.ts
Get the activities of a user on GitHub, based on the GitHub official RSS feed
Google
Scholar Author Citations
🟢 Passed Test🚨 Strict Anti-crawling
💡 Example: https://rsshub.app/google/citations/mlmE4JMAAAAJ
🛎️ Route: /google/citations/:id
🔗 Parameters:
id
- Required
- Description: N
🐙 Source Code: /google/citations.ts
The parameter id in the route is the id in the URL of the user's Google Scholar reference page, for example https://scholar.google.com/citations?user=mlmE4JMAAAAJ
to mlmE4JMAAAAJ
.
Query parameters are also supported here, for example https://scholar.google.com/citations?user=mlmE4JMAAAAJ&sortby=pubdate
to mlmE4JMAAAAJ&sortby=pubdate
. Please make sure that the user id (mlmE4JMAAAAJ
in this case) should be the first parameter in the query string.
Scholar Keywords Monitoring
🔴 Failed Test🚨 Strict Anti-crawling
💡 Example: https://rsshub.app/google/scholar/data+visualization
🛎️ Route: /google/scholar/:query
🔗 Parameters:
query
- Required
- Description: query statement which supports「Basic」and「Advanced」modes
🐙 Source Code: /google/scholar.ts
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.
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.
Hpoi 手办维基
角色周边
🟢 Passed Test
💡 Example: https://rsshub.app/hpoi/items/character/1035374
🛎️ Route: /hpoi/items/character/:id/:order?
🔗 Parameters:
id
- Required
- Description: 角色 ID
order
- Optional
- Description: 排序, 见下表,默认为 add
🐙 Source Code: /hpoi/character.ts
发售 | 入库 | 总热度 | 一周热度 | 一天热度 | 评价 |
---|---|---|---|---|---|
release | add | hits | hits7Day | hitsDay | rating |
所有周边
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/hpoi/items/all
🛎️ Route: /hpoi/items/all/:order?
🔗 Parameters:
order
- Optional
- Description: 排序, 见下表,默认为 add
🐙 Source Code: /hpoi/all.ts
发售 | 入库 | 总热度 | 一周热度 | 一天热度 | 评价 |
---|---|---|---|---|---|
release | add | hits | hits7Day | hitsDay | rating |
作品周边
🟢 Passed Test
💡 Example: https://rsshub.app/hpoi/items/work/4117491
🛎️ Route: /hpoi/items/work/:id/:order?
🔗 Parameters:
id
- Required
- Description: 作品 ID
order
- Optional
- Description: 排序, 见下表,默认为 add
🐙 Source Code: /hpoi/work.ts
发售 | 入库 | 总热度 | 一周热度 | 一天热度 | 评价 |
---|---|---|---|---|---|
release | add | hits | hits7Day | hitsDay | rating |
Instagram
User Profile - Picnob
🔴 Failed Test🚨 Strict Anti-crawling🎭 Rely on Puppeteer🔍 Support Radar
💡 Example: https://rsshub.app/picnob/user/xlisa_olivex
🛎️ Route: /picnob/user/:id
🔗 Parameters:
id
- Required
- Description: Instagram id
🐙 Source Code: /picnob/user.ts
JavBus
WARNING
Requests from non-Asia areas will be redirected to login page.
Language
You can change the language of each route to the languages listed below.
English | 日本语 | 한국의 | 中文 |
---|---|---|---|
en | ja | ko | (leave it empty) |
TIP
JavBus has multiple backup domains, these routes use default domain https://javbus.com
. If the domain is unreachable, you can add ?domain=<domain>
to the end of the route to specify the domain to visit. Let say you want to use the backup domain https://javsee.icu
, you can add ?domain=javsee.icu
to the end of the route, then the route will be /javbus/en?domain=javsee.icu
Note: Western has different domain than the main site, the backup domains are also different. The default domain is https://javbus.org
and you can add ?western_domain=<domain>
to the end of the route to specify the domain to visit. Let say you want to use the backup domain https://javsee.one
, you can add ?western_domain=javsee.one
to the end of the route, then the route will be /javbus/western/en?western_domain=javsee.one
Works
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/javbus/star/rwt
🛎️ Route: /javbus/:path{.+}?
🔗 Parameters:
path{.}
- Optional
- Description: N/A
🐙 Source Code: /javbus/index.ts
Lofter
User
🟢 Passed Test
💡 Example: https://rsshub.app/lofter/user/i
🛎️ Route: /lofter/user/:name?
🔗 Parameters:
name
- Optional
- Description: Lofter user name, can be found in the URL
🐙 Source Code: /lofter/user.ts
Mastodon
TIP
Official user RSS:
- RSS:
https://**:instance**/users/**:username**.rss
(Example) - Atom:
(Only for pawoo.net, example)https://**:instance**/users/**:username**.atom
These feed do not include boosts (a.k.a. reblogs). RSSHub provides a feed for user timeline based on the Mastodon API, but to use that, you may need to create application on a Mastodon instance, and configure your RSSHub instance. Check the Deploy Guide for route-specific configurations.
Instance timeline (local)
🟢 Passed Test
💡 Example: https://rsshub.app/mastodon/timeline/pawoo.net/true
🛎️ Route: /mastodon/timeline/:site/:only_media?
🔗 Parameters:
site
- Required
- Description: instance address, only domain, no
http://
orhttps://
protocol header
only_media
- Optional
- Description: whether only display media content, default to false, any value to true
🐙 Source Code: /mastodon/timeline-local.ts
If the instance address is not mastodon.social
or pawoo.net
, then the route requires ALLOW_USER_SUPPLY_UNSAFE_DOMAIN
to be true
.
Instance timeline (federated)
🟢 Passed Test
💡 Example: https://rsshub.app/mastodon/remote/pawoo.net/true
🛎️ Route: /mastodon/remote/:site/:only_media?
🔗 Parameters:
site
- Required
- Description: instance address, only domain, no
http://
orhttps://
protocol header
only_media
- Optional
- Description: whether only display media content, default to false, any value to true
🐙 Source Code: /mastodon/timeline-remote.ts
If the instance address is not mastodon.social
or pawoo.net
, then the route requires ALLOW_USER_SUPPLY_UNSAFE_DOMAIN
to be true
.
User timeline
🟢 Passed Test
💡 Example: https://rsshub.app/mastodon/acct/[email protected]/statuses
🛎️ Route: /mastodon/acct/:acct/statuses/:only_media?
🔗 Parameters:
acct
- Required
- Description: Webfinger account URI, like
user@host
only_media
- Optional
- Description: whether only display media content, default to false, any value to true
🐙 Source Code: /mastodon/acct.ts
Started from Mastodon v4.0.0, the use of the search
API in the route no longer requires a user token. If the domain of your Webfinger account URI is the same as the API host of the instance (i.e., no delegation called in some other protocols), then no configuration is required and the route is available out of the box. However, you can still specify these route-specific configurations if you need to override them.
NASA
Astronomy Picture of the Day
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/nasa/apod
🛎️ Route: /nasa/apod
🐙 Source Code: /nasa/apod.ts
NGA
分区帖子
🔴 Failed Test
💡 Example: https://rsshub.app/nga/forum/489
🛎️ Route: /nga/forum/:fid/:recommend?
🔗 Parameters:
fid
- Required
- Description: 分区 id, 可在分区主页 URL 找到, 没有 fid 时 stid 同样适用
recommend
- Optional
- Description: 是否只显示精华主题, 留空为否, 任意值为是
🐙 Source Code: /nga/forum.ts
pixiv
Keyword
🔴 Failed Test
💡 Example: https://rsshub.app/pixiv/search/Nezuko/popular
🛎️ Route: /pixiv/search/:keyword/:order?/:mode?/:include_ai?
🔗 Parameters:
keyword
- Required
- Description: keyword
order
- Optional
- Default: date
- Options:
- Description: rank mode, empty or other for time order, popular for popular order
mode
- Optional
- Default: no
- Options:
- Description: filte R18 content
include_ai
- Optional
- Default: yes
- Options:
- Description: whether AI-generated content is included
🐙 Source Code: /pixiv/search.ts
Rankings
🔴 Failed Test
💡 Example: https://rsshub.app/pixiv/ranking/week
🛎️ Route: /pixiv/ranking/:mode/:date?
🔗 Parameters:
mode
- Required
- Options:
- Description: rank type
date
- Optional
- Description: format:
2018-4-25
🐙 Source Code: /pixiv/ranking.ts
User Activity
🔴 Failed Test🔍 Support Radar
💡 Example: https://rsshub.app/pixiv/user/15288095
🛎️ Route: /pixiv/user/:id
🔗 Parameters:
id
- Required
- Description: user id, available in user's homepage URL
🐙 Source Code: /pixiv/user.ts
PornHub
Category
🟢 Passed Test
💡 Example: https://rsshub.app/pornhub/category/popular-with-women
🛎️ Route: /pornhub/category/:caty
🔗 Parameters:
caty
- Required
- Description: category, see categories
🐙 Source Code: /pornhub/category.ts
Keyword Search
🟢 Passed Test
💡 Example: https://rsshub.app/pornhub/search/stepsister
🛎️ Route: /pornhub/search/:keyword
🔗 Parameters:
keyword
- Required
- Description: keyword
🐙 Source Code: /pornhub/search.ts
Model
🟢 Passed Test🚨 Strict Anti-crawling🔍 Support Radar
💡 Example: https://rsshub.app/pornhub/model/stacy-starando
🛎️ Route: /pornhub/model/:username/:language?/:sort?
🔗 Parameters:
username
- Required
- Description: username, part of the url e.g.
pornhub.com/model/stacy-starando
language
- Optional
- Description: language, see below
sort
- Optional
- Description: sorting method, see below
🐙 Source Code: /pornhub/model.ts
Pornstar
🔴 Failed Test🚨 Strict Anti-crawling🔍 Support Radar
💡 Example: https://rsshub.app/pornhub/pornstar/june-liu
🛎️ Route: /pornhub/pornstar/:username/:language?/:sort?
🔗 Parameters:
username
- Required
- Description: username, part of the url e.g.
pornhub.com/pornstar/june-liu
language
- Optional
- Description: language, see below
sort
- Optional
- Description: sorting method, see below
🐙 Source Code: /pornhub/pornstar.ts
sort
Most Recent | Most Viewed | Top Rated | Longest | Best |
---|---|---|---|---|
mr | mv | tr | lg |
PlayStation Store
PlayStation Monthly Games
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/ps/monthly-games
🛎️ Route: /ps/monthly-games
🐙 Source Code: /ps/monthly-games.ts
Reuters
TIP
You can use sophi=true
query parameter to invoke the experimental method, which can, if possible, fetch more articles(between 20 and 100) with limit
given. But some articles from the old method might not be available.
Category/Topic/Author
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/reuters/world/us
🛎️ Route: /reuters/:category/:topic?
🔗 Parameters:
category
- Required
- Description: find it in the URL, or tables below
topic
- Optional
- Description: find it in the URL, or tables below
🐙 Source Code: /reuters/common.ts
:category
:World Business Legal Markets Breakingviews Technology Graphics world business legal markets breakingviews technology graphics world/:topic
:All Africa Americas Asia Pacific China Europe India Middle East United Kingdom United States The Great Reboot Reuters Next africa americas asia-pacific china europe india middle-east uk us the-great-reboot reuters-next business/:topic
:All Aerospace & Defense Autos & Transportation Energy Environment Finance Healthcare & Pharmaceuticals Media & Telecom Retail & Consumer Sustainable Business Charged Future of Health Future of Money Take Five Reuters Impact aerospace-defense autos-transportation energy environment finance healthcare-pharmaceuticals media-telecom retail-consumer sustainable-business charged future-of-health future-of-money take-five reuters-impact legal/:topic
:All Government Legal Industry Litigation Transactional government legalindustry litigation transactional authors/:topic
:Default Jonathan Landay any other authors reuters jonathan-landay their name in URL
More could be found in the URL of the category/topic page.
RSSHub
New routes
🔴 Failed Test🔍 Support Radar
💡 Example: https://rsshub.app/rsshub/routes/en
🛎️ Route: /rsshub/routes/:lang?
🔗 Parameters:
lang
- Optional
- Default: en
- Options:
- Description: Language
🐙 Source Code: /rsshub/routes.ts
Spotify
Artist Albums
🟡 Missing Test⚙️ Config Required🔍 Support Radar
💡 Example: https://rsshub.app/spotify/artist/6k9TBCxyr4bXwZ8Y21Kwn1
🛎️ Route: /spotify/artist/:id
🔗 Parameters:
id
- Required
- Description: Artist ID
⚙️ Deployment Configs:
SPOTIFY_CLIENT_ID
, required -SPOTIFY_CLIENT_SECRET
, required -
🐙 Source Code: /spotify/artist.ts
Playlist
🟡 Missing Test⚙️ Config Required🔍 Support Radar
💡 Example: https://rsshub.app/spotify/playlist/4UBVy1LttvodwivPUuwJk2
🛎️ Route: /spotify/playlist/:id
🔗 Parameters:
id
- Required
- Description: Playlist ID
⚙️ Deployment Configs:
SPOTIFY_CLIENT_ID
, required -SPOTIFY_CLIENT_SECRET
, required -
🐙 Source Code: /spotify/playlist.ts
Telegram
Channel
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/telegram/channel/awesomeRSSHub
🛎️ Route: /telegram/channel/:username/:routeParams?
🔗 Parameters:
username
- Required
- Description: channel username
routeParams
- Optional
- Description:
extra parameters, see the table below
Key Description Accepts Defaults to showLinkPreview Show the link preview from Telegram 0/1/true/false true showViaBot For messages sent via bot, show the bot 0/1/true/false true showReplyTo For reply messages, show the target of the reply 0/1/true/false true showFwdFrom For forwarded messages, show the forwarding source 0/1/true/false true showFwdFromAuthor For forwarded messages, show the author of the forwarding source 0/1/true/false true showInlineButtons Show inline buttons 0/1/true/false false showMediaTagInTitle Show media tags in the title 0/1/true/false true showMediaTagAsEmoji Show media tags as emoji 0/1/true/false true showHashtagAsHyperlink Show hashtags as hyperlinks ( https://t.me/s/channel?q=%23hashtag
)0/1/true/false true includeFwd Include forwarded messages 0/1/true/false true includeReply Include reply messages 0/1/true/false true includeServiceMsg Include service messages (e.g. message pinned, channel photo updated) 0/1/true/false true includeUnsupportedMsg Include messages unsupported by t.me 0/1/true/false false searchQuery search query keywords; replace #hashtag
with%23hashtag
(no keyword) Specify different option values than default values can meet different needs, URL
https://rsshub.app/telegram/channel/NewlearnerChannel/showLinkPreview=0&showViaBot=0&showReplyTo=0&showFwdFrom=0&showFwdFromAuthor=0&showInlineButtons=0&showMediaTagInTitle=1&showMediaTagAsEmoji=1&includeFwd=0&includeReply=1&includeServiceMsg=0&includeUnsupportedMsg=0
generates an RSS without any link previews and annoying metadata, with emoji media tags in the title, without forwarded messages (but with reply messages), and without messages you don't care about (service messages and unsupported messages), for people who prefer pure subscriptions.
For backward compatibility reasons, invalid
routeParams
will be treated assearchQuery
.
🐙 Source Code: /telegram/channel.ts
TIP
Due to Telegram restrictions, some channels involving pornography, copyright, and politics cannot be subscribed. You can confirm by visiting https://t.me/s/:username
.
Sticker Pack
🔴 Failed Test
💡 Example: https://rsshub.app/telegram/stickerpack/DIYgod
🛎️ Route: /telegram/stickerpack/:name
🔗 Parameters:
name
- Required
- Description: Sticker Pack name, available in the sharing URL
🐙 Source Code: /telegram/stickerpack.ts
Telegram Blog
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/telegram/blog
🛎️ Route: /telegram/blog
🐙 Source Code: /telegram/blog.ts
Threads
User timeline
🔴 Failed Test
💡 Example: https://rsshub.app/threads/zuck
🛎️ Route: /threads/:user/:routeParams?
🔗 Parameters:
user
- Required
- Description: Username
routeParams
- Optional
- Description:
Extra parameters, see the table below Specify options (in the format of query string) in parameter
routeParams
to control some extra features for threadsKey Description Accepts Defaults to showAuthorInTitle
Show author name in title 0
/1
/true
/false
true
showAuthorInDesc
Show author name in description (RSS body) 0
/1
/true
/false
true
showQuotedAuthorAvatarInDesc
Show avatar of quoted author in description (RSS body) (Not recommended if your RSS reader extracts images from description) 0
/1
/true
/false
false
showAuthorAvatarInDesc
Show avatar of author in description (RSS body) (Not recommended if your RSS reader extracts images from description) 0
/1
/true
/false
falseP
showEmojiForQuotesAndReply
Use "🔁" instead of "QT", "↩️" instead of "Re" 0
/1
/true
/false
true
showQuotedInTitle
Show quoted tweet in title 0
/1
/true
/false
true
replies
Show replies 0
/1
/true
/false
true
Specify different option values than default values to improve readability. The URL
https://rsshub.app/threads/zuck/showAuthorInTitle=1&showAuthorInDesc=1&showQuotedAuthorAvatarInDesc=1&showAuthorAvatarInDesc=1&showEmojiForQuotesAndReply=1&showQuotedInTitle=1
🐙 Source Code: /threads/index.ts
Twitch
Channel Video
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/twitch/video/riotgames/highlights
🛎️ Route: /twitch/video/:login/:filter?
🔗 Parameters:
login
- Required
- Description: Twitch username
filter
- Optional
- Description: Video type, Default to all
🐙 Source Code: /twitch/video.ts
archive | highlights | all |
---|---|---|
Recent broadcasts | Recent highlights and uploads | All videos |
Live
🟢 Passed Test
💡 Example: https://rsshub.app/twitch/live/riotgames
🛎️ Route: /twitch/live/:login
🔗 Parameters:
login
- Required
- Description: Twitch username
🐙 Source Code: /twitch/live.ts
V2EX
标签
🟢 Passed Test
💡 Example: https://rsshub.app/v2ex/tab/hot
🛎️ Route: /v2ex/tab/:tabid
🔗 Parameters:
tabid
- Required
- Description: tab标签ID,在 URL 可以找到
🐙 Source Code: /v2ex/tab.ts
最热 / 最新主题
🟢 Passed Test
💡 Example: https://rsshub.app/v2ex/topics/latest
🛎️ Route: /v2ex/topics/:type
🔗 Parameters:
type
- Required
- Options:
- Description: 主题类型
🐙 Source Code: /v2ex/topics.ts
X (Twitter)
Specify options (in the format of query string) in parameter routeParams
to control some extra features for Tweets
Key | Description | Accepts | Defaults to |
---|---|---|---|
readable | Enable readable layout | 0 /1 /true /false | false |
authorNameBold | Display author name in bold | 0 /1 /true /false | false |
showAuthorInTitle | Show author name in title | 0 /1 /true /false | false (true in /twitter/followings ) |
showAuthorInDesc | Show author name in description (RSS body) | 0 /1 /true /false | false (true in /twitter/followings ) |
showQuotedAuthorAvatarInDesc | Show avatar of quoted Tweet's author in description (RSS body) (Not recommended if your RSS reader extracts images from description) | 0 /1 /true /false | false |
showAuthorAvatarInDesc | Show avatar of author in description (RSS body) (Not recommended if your RSS reader extracts images from description) | 0 /1 /true /false | false |
showEmojiForRetweetAndReply | Use "🔁" instead of "RT", "↩️" & "💬" instead of "Re" | 0 /1 /true /false | false |
showSymbolForRetweetAndReply | Use " RT " instead of "", " Re " instead of "" | 0 /1 /true /false | true |
showRetweetTextInTitle | Show quote comments in title (if false , only the retweeted tweet will be shown in the title) | 0 /1 /true /false | true |
addLinkForPics | Add clickable links for Tweet pictures | 0 /1 /true /false | false |
showTimestampInDescription | Show timestamp in description | 0 /1 /true /false | false |
showQuotedInTitle | Show quoted tweet in title | 0 /1 /true /false | false |
widthOfPics | Width of Tweet pictures | Unspecified/Integer | Unspecified |
heightOfPics | Height of Tweet pictures | Unspecified/Integer | Unspecified |
sizeOfAuthorAvatar | Size of author's avatar | Integer | 48 |
sizeOfQuotedAuthorAvatar | Size of quoted tweet's author's avatar | Integer | 24 |
excludeReplies | Exclude replies, only available in /twitter/user | 0 /1 /true /false | false |
includeRts | Include retweets, only available in /twitter/user | 0 /1 /true /false | true |
forceWebApi | Force using Web API even if Developer API is configured, only available in /twitter/user and /twitter/keyword | 0 /1 /true /false | false |
count | count parameter passed to Twitter API, only available in /twitter/user | Unspecified/Integer | Unspecified |
Specify different option values than default values to improve readability. The URL
https://rsshub.app/twitter/user/durov/readable=1&authorNameBold=1&showAuthorInTitle=1&showAuthorInDesc=1&showQuotedAuthorAvatarInDesc=1&showAuthorAvatarInDesc=1&showEmojiForRetweetAndReply=1&showRetweetTextInTitle=0&addLinkForPics=1&showTimestampInDescription=1&showQuotedInTitle=1&heightOfPics=150
generates
Currently supports two authentication methods:
Using
TWITTER_AUTH_TOKEN
(recommended): Configure a comma-separated list ofauth_token
cookies of logged-in Twitter Web. RSSHub will use this information to directly access Twitter's web API to obtain data.Using
TWITTER_USERNAME
TWITTER_PASSWORD
andTWITTER_AUTHENTICATION_SECRET
: Configure a comma-separated list of Twitter username and password. RSSHub will use this information to log in to Twitter and obtain data using the mobile API. Please note that if you have not logged in with the current IP address before, it is easy to trigger Twitter's risk control mechanism.
Keyword
🟡 Missing Test⚙️ Config Required🔍 Support Radar
💡 Example: https://rsshub.app/twitter/keyword/RSSHub
🛎️ Route: /twitter/keyword/:keyword/:routeParams?
🔗 Parameters:
keyword
- Required
- Description: keyword
routeParams
- Optional
- Description: extra parameters, see the table above
⚙️ Deployment Configs:
TWITTER_USERNAME
, required - Please see above for details.TWITTER_PASSWORD
, required - Please see above for details.TWITTER_AUTH_TOKEN
, required - Please see above for details.
🐙 Source Code: /twitter/keyword.ts
User media
🟡 Missing Test⚙️ Config Required🔍 Support Radar
💡 Example: https://rsshub.app/twitter/media/_RSSHub
🛎️ Route: /twitter/media/:id/:routeParams?
🔗 Parameters:
id
- Required
- Description: username; in particular, if starts with
+
, it will be recognized as a unique ID, e.g.+44196397
routeParams
- Optional
- Description: extra parameters, see the table above.
⚙️ Deployment Configs:
TWITTER_USERNAME
, required - Please see above for details.TWITTER_PASSWORD
, required - Please see above for details.TWITTER_AUTH_TOKEN
, required - Please see above for details.
🐙 Source Code: /twitter/media.ts
User timeline
🟡 Missing Test⚙️ Config Required🔍 Support Radar
💡 Example: https://rsshub.app/twitter/user/_RSSHub
🛎️ Route: /twitter/user/:id/:routeParams?
🔗 Parameters:
id
- Required
- Description: username; in particular, if starts with
+
, it will be recognized as a unique ID, e.g.+44196397
routeParams
- Optional
- Description: extra parameters, see the table above; particularly when
routeParams=exclude_replies
, replies are excluded;routeParams=exclude_rts
excludes retweets,routeParams=exclude_rts_replies
exclude replies and retweets; for default include all.
⚙️ Deployment Configs:
TWITTER_USERNAME
, required - Please see above for details.TWITTER_PASSWORD
, required - Please see above for details.TWITTER_AUTHENTICATION_SECRET
, optional - TOTP 2FA secret, please see above for details.TWITTER_AUTH_TOKEN
, required - Please see above for details.
🐙 Source Code: /twitter/user.ts
YouTube
Channel with username
🟡 Missing Test⚙️ Config Required🔍 Support Radar
💡 Example: https://rsshub.app/youtube/user/@JFlaMusic
🛎️ Route: /youtube/user/:username/:embed?
🔗 Parameters:
username
- Required
- Description: YouTuber username with @
embed
- Optional
- Description: Default to embed the video, set to any value to disable embedding
⚙️ Deployment Configs:
YOUTUBE_KEY
, required - YouTube API Key, support multiple keys, split them with,
, API Key application
🐙 Source Code: /youtube/user.ts
哔哩哔哩 bilibili
UP 主动态
🔴 Failed Test⚙️ Config Required🔍 Support Radar
💡 Example: https://rsshub.app/bilibili/user/dynamic/2267573
🛎️ Route: /bilibili/user/dynamic/:uid/:routeParams?
🔗 Parameters:
uid
- Required
- Description: 用户 id, 可在 UP 主主页中找到
routeParams
- Optional
- Description:
键 含义 接受的值 默认值 showEmoji 显示或隐藏表情图片 0/1/true/false false disableEmbed 关闭内嵌视频 0/1/true/false false useAvid 视频链接使用 AV 号 (默认为 BV 号) 0/1/true/false false directLink 使用内容直链 0/1/true/false false hideGoods 隐藏带货动态 0/1/true/false false 用例:
/bilibili/user/dynamic/2267573/showEmoji=1&disableEmbed=1&useAvid=1
⚙️ Deployment Configs:
BILIBILI_COOKIE_*
, optional - 如果没有此配置,那么必须开启 puppeteer 支持;BILIBILI_COOKIE_{uid}: 用于用户关注动态系列路由,对应 uid 的 b 站用户登录后的 Cookie 值,{uid}
替换为 uid,如BILIBILI_COOKIE_2267573
,获取方式: 1. 打开 https://api.vc.bilibili.com/dynamic_svr/v1/dynamic_svr/dynamic_new?uid=0&type=8 2. 打开控制台,切换到 Network 面板,刷新 3. 点击 dynamic_new 请求,找到 Cookie 4. 视频和专栏,UP 主粉丝及关注只要求SESSDATA
字段,动态需复制整段 Cookie
🐙 Source Code: /bilibili/dynamic.ts
UP 主投稿
🔴 Failed Test🔍 Support Radar
💡 Example: https://rsshub.app/bilibili/user/video/2267573
🛎️ Route: /bilibili/user/video/:uid/:disableEmbed?
🔗 Parameters:
uid
- Required
- Description: 用户 id, 可在 UP 主主页中找到
disableEmbed
- Optional
- Description: 默认为开启内嵌视频, 任意值为关闭
🐙 Source Code: /bilibili/video.ts
排行榜
🟢 Passed Test
💡 Example: https://rsshub.app/bilibili/ranking/0/3/1
🛎️ Route: /bilibili/ranking/:rid?/:day?/:arc_type?/:disableEmbed?
🔗 Parameters:
rid
- Optional
- Default: 0
- Options:
- Description: 排行榜分区 id
day
- Optional
- Default: 3
- Options:
- Description: 时间跨度
arc_type
- Optional
- Default: 1
- Options:
- Description: 投稿时间
disableEmbed
- Optional
- Description: 默认为开启内嵌视频, 任意值为关闭
🐙 Source Code: /bilibili/ranking.ts
豆瓣
豆瓣小组
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/douban/group/648102
🛎️ Route: /douban/group/:groupid/:type?
🔗 Parameters:
groupid
- Required
- Description: 豆瓣小组的 id
type
- Optional
- Default: latest
- Options:
- Description: 类型
🐙 Source Code: /douban/other/group.ts
晋江文学城
作品章节
🟢 Passed Test
💡 Example: https://rsshub.app/jjwxc/book/7013024
🛎️ Route: /jjwxc/book/:id?
🔗 Parameters:
id
- Optional
- Description: 作品 id,可在对应作品页中找到
🐙 Source Code: /jjwxc/book.ts
起点
作品章节
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/qidian/chapter/1010400217
🛎️ Route: /qidian/chapter/:id
🔗 Parameters:
id
- Required
- Description: 小说 id, 可在对应小说页 URL 中找到
🐙 Source Code: /qidian/chapter.ts
少数派 sspai
首页
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/sspai/index
🛎️ Route: /sspai/index
🐙 Source Code: /sspai/index.ts
什么值得买
TIP
网站也提供了部分 RSS: https://www.smzdm.com/dingyue
关键词
🟢 Passed Test
💡 Example: https://rsshub.app/smzdm/keyword/女装
🛎️ Route: /smzdm/keyword/:keyword
🔗 Parameters:
keyword
- Required
- Description: 你想订阅的关键词
🐙 Source Code: /smzdm/keyword.ts
排行榜
🔴 Failed Test
💡 Example: https://rsshub.app/smzdm/ranking/pinlei/11/3
🛎️ Route: /smzdm/ranking/:rank_type/:rank_id/:hour
🔗 Parameters:
rank_type
- Required
- Options:
- Description: 榜单类型
rank_id
- Required
- Options:
- Description: 榜单ID
hour
- Required
- Options:
- Description: 时间跨度
🐙 Source Code: /smzdm/ranking.ts
微博
WARNING
微博会针对请求的来源地区返回不同的结果。一个已知的例子为:部分视频因未知原因仅限中国大陆境内访问 (CDN 域名为 locallimit.us.sinaimg.cn
而非 f.video.weibocdn.com
)。若一条微博含有这种视频且 RSSHub 实例部署在境外,抓取到的微博可能不含视频。将 RSSHub 部署在境内有助于抓取这种视频,但阅读器也必须处于境内网络环境以加载视频。
对于微博内容,在 routeParams
参数中以 query string 格式指定选项,可以控制输出的样式
键 | 含义 | 接受的值 | 默认值 |
---|---|---|---|
readable | 是否开启细节排版可读性优化 | 0/1/true/false | false |
authorNameBold | 是否加粗作者名字 | 0/1/true/false | false |
showAuthorInTitle | 是否在标题处显示作者 | 0/1/true/false | false(/weibo/keyword/ 中为 true) |
showAuthorInDesc | 是否在正文处显示作者 | 0/1/true/false | false(/weibo/keyword/ 中为 true) |
showAuthorAvatarInDesc | 是否在正文处显示作者头像(若阅读器会提取正文图片,不建议开启) | 0/1/true/false | false |
showEmojiForRetweet | 显示 “🔁” 取代 “转发” 两个字 | 0/1/true/false | false |
showRetweetTextInTitle | 在标题出显示转发评论(置为 false 则在标题只显示被转发微博) | 0/1/true/false | true |
addLinkForPics | 为图片添加可点击的链接 | 0/1/true/false | false |
showTimestampInDescription | 在正文处显示被转发微博的时间戳 | 0/1/true/false | false |
widthOfPics | 微博配图宽(生效取决于阅读器) | 不指定 / 数字 | 不指定 |
heightOfPics | 微博配图高(生效取决于阅读器) | 不指定 / 数字 | 不指定 |
sizeOfAuthorAvatar | 作者头像大小 | 数字 | 48 |
displayVideo | 是否直接显示微博视频和 Live Photo,只在博主或个人时间线 RSS 中有效 | 0/1/true/false | true |
displayArticle | 是否直接显示微博文章,只在博主或个人时间线 RSS 中有效 | 0/1/true/false | false |
displayComments | 是否直接显示热门评论,只在博主或个人时间线 RSS 中有效 | 0/1/true/false | false |
showEmojiInDescription | 是否展示正文中的微博表情,关闭则替换为 [表情名] | 0/1/true/false | true |
showLinkIconInDescription | 是否展示正文中的链接图标 | 0/1/true/false | true |
preferMobileLink | 是否使用移动版链接(默认使用 PC 版) | 0/1/true/false | false |
showRetweeted | 是否显示转发的微博 | 0/1/true/false | true |
指定更多与默认值不同的参数选项可以改善 RSS 的可读性,如
的效果为
博主
🟢 Passed Test🚨 Strict Anti-crawling⚙️ Config Required🔍 Support Radar
💡 Example: https://rsshub.app/weibo/user/1195230310
🛎️ Route: /weibo/user/:uid/:routeParams?
🔗 Parameters:
uid
- Required
- Description: 用户 id, 博主主页打开控制台执行
$CONFIG.oid
获取
routeParams
- Optional
- Description: 额外参数;请参阅上面的说明和表格;特别地,当
routeParams=1
时开启微博视频显示
⚙️ Deployment Configs:
WEIBO_COOKIES
, optional -
🐙 Source Code: /weibo/user.ts
WARNING
部分博主仅登录可见,未提供 Cookie 的情况下不支持订阅,可以通过打开 https://m.weibo.cn/u/:uid
验证
关键词
🟢 Passed Test
💡 Example: https://rsshub.app/weibo/keyword/RSSHub
🛎️ Route: /weibo/keyword/:keyword/:routeParams?
🔗 Parameters:
keyword
- Required
- Description: 你想订阅的微博关键词
routeParams
- Optional
- Description: 额外参数;请参阅上面的说明和表格
🐙 Source Code: /weibo/keyword.ts
热搜榜
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/weibo/search/hot
🛎️ Route: /weibo/search/hot/:fulltext?
🔗 Parameters:
fulltext
- Optional
- Description:
- 使用
/weibo/search/hot
可以获取热搜条目列表; - 使用/weibo/search/hot/fulltext
可以进一步获取热搜条目下的摘要信息(不含图片视频); - 使用/weibo/search/hot/fulltext?pic=true
可以获取图片缩略(但需要配合额外的手段,例如浏览器上的 Header Editor 等来修改 referer 参数为https://weibo.com
,以规避微博的外链限制,否则图片无法显示。) - 使用/weibo/search/hot/fulltext?pic=true&fullpic=true
可以获取 Original 图片(但需要配合额外的手段,例如浏览器上的 Header Editor 等来修改 referer 参数为https://weibo.com
,以规避微博的外链限制,否则图片无法显示。)
🐙 Source Code: /weibo/search/hot.ts
小宇宙
播客
🟢 Passed Test🔍 Support Radar
💡 Example: https://rsshub.app/xiaoyuzhou/podcast/6021f949a789fca4eff4492c
🛎️ Route: /xiaoyuzhou/podcast/:id
🔗 Parameters:
id
- Required
- Description: 播客id,可以在小宇宙播客的 URL 中找到
🐙 Source Code: /xiaoyuzhou/podcast.ts
知乎
TIP
自2024年7月,未登录状态下大部分路由无法获取全文。若有需要请在登陆知乎后寻找并添加包含z_c0
的Cookies至环境变量ZHIHU_COOKIES
。
用户动态
🔴 Failed Test🚨 Strict Anti-crawling🔍 Support Radar
💡 Example: https://rsshub.app/zhihu/people/activities/diygod
🛎️ Route: /zhihu/people/activities/:id
🔗 Parameters:
id
- Required
- Description: 作者 id,可在用户主页 URL 中找到
🐙 Source Code: /zhihu/activities.ts
知乎热榜
🔴 Failed Test🚨 Strict Anti-crawling
💡 Example: https://rsshub.app/zhihu/hot
🛎️ Route: /zhihu/hot/:category?
🔗 Parameters:
category
- Optional
- Default: total
- Options:
- Description: 分类
🐙 Source Code: /zhihu/hot.ts