Social Media
# CuriousCat
# User
Example: https://rsshub.ranlychan.top/curiouscat/user/kretyn
Route: /curiouscat/user/:name
Parameters:
name
, required - name, username that is in the URL
# Dev.to
# Top Posts
Example: https://rsshub.ranlychan.top/dev.to/top/month
Route: /dev.to/top/:period
Parameters:
period
, required - period
dev.to weekly top | dev.to monthly top | dev.to yearly top | dev.to top posts of all time |
---|---|---|---|
week | month | year | infinity |
# Disqus
# Comment
Example: https://rsshub.ranlychan.top/disqus/posts/diygod-me
Route: /disqus/posts/:forum
Parameters:
forum
, required - forum, disqus name of the target website
# Page
Example: https://rsshub.ranlychan.top/facebook/page/SonetPCR
Route: /facebook/page/:id
Parameters:
id
, required - page id
# Fur Affinity
# Home
Example: https://rsshub.ranlychan.top/furaffinity/home
Route: /furaffinity/home/:type?/:nsfw?
Parameters:
type
, optional - Art Type, default to beartwork
nsfw
, optional - NSFW Mode, do not filter NSFW contents when value set to1
Type
artwork | crafts | music | writing |
---|---|---|---|
artwork | crafts | music | writing |
# Browse
Example: https://rsshub.ranlychan.top/furaffinity/browse
Route: /furaffinity/browse/:nsfw?
Parameters:
nsfw
, optional - NSFW Mode, do not filter NSFW contents when value set to1
# Website Status
# Userpage Profile
Example: https://rsshub.ranlychan.top/furaffinity/user/tiger-jungle
Route: /furaffinity/user/:username
Parameters:
username
, required - Username, can find in userpage
# Search
Example: https://rsshub.ranlychan.top/furaffinity/search/tiger
Route: /furaffinity/search/:keyword/:nsfw?
Parameters:
keyword
, required - Search keyword, enter any words you want to search, require Englishnsfw
, optional - NSFW Mode,do not filter NSFW contents when value set to1
# User's Watching List
Example: https://rsshub.ranlychan.top/furaffinity/watching/okami9312
Route: /furaffinity/watching/:username
Parameters:
username
, required - Username, can find in userpage
# User's Watcher List
Example: https://rsshub.ranlychan.top/furaffinity/watchers/malikshadowclaw
Route: /furaffinity/watchers/:username
Parameters:
username
, required - Username, can find in userpage
# User's Commission Information
Example: https://rsshub.ranlychan.top/furaffinity/commissions/flashlioness
Route: /furaffinity/commissions/:username
Parameters:
username
, required - Username, can find in userpage
# User's Shouts
Example: https://rsshub.ranlychan.top/furaffinity/shouts/redodgft
Route: /furaffinity/shouts/:username
Parameters:
username
, required - Username, can find in userpage
# User's Journals
Example: https://rsshub.ranlychan.top/furaffinity/journals/rukis
Route: /furaffinity/journals/:username
Parameters:
username
, required - Username, can find in userpage
# User's Gallery
Example: https://rsshub.ranlychan.top/furaffinity/gallery/flashlioness
Route: /furaffinity/gallery/:username/:nsfw?
Parameters:
username
, required - Username, can find in userpagensfw
, optional - NSFW Mode, do not filter NSFW contents when value set to1
# User's Scraps
Example: https://rsshub.ranlychan.top/furaffinity/scraps/flashlioness
Route: /furaffinity/scraps/:username/:nsfw?
Parameters:
username
, required - Username, can find in userpagensfw
, optional - NSFW Mode, do not filter NSFW contents when value set to1
# User's Favorites
Example: https://rsshub.ranlychan.top/furaffinity/favorites/tiger-jungle
Route: /furaffinity/favorites/:username/:nsfw?
Parameters:
username
, required - Username, can find in userpagensfw
, optional - NSFW Mode, do not filter NSFW contents when value set to1
# Submission Comments
Example: https://rsshub.ranlychan.top/furaffinity/submission_comments/34909983
Route: /furaffinity/submission_comments/:id
Parameters:
id
, required - Submission id, can find in URL of submission page
# Journal Comments
Example: https://rsshub.ranlychan.top/furaffinity/journal_comments/9750669
Route: /furaffinity/journal_comments/:id
Parameters:
id
, required - Journal id, can find in URL of journal page
# Gab
# User's Posts
Example: https://rsshub.ranlychan.top/gab/user/realdonaldtrump
Route: /gab/user/:username
Parameters:
username
, required - Username
# Popular Posts
Example: https://rsshub.ranlychan.top/gab/popular/hot
Route: /gab/popular/:sort?
Parameters:
sort
, optional - Sort by,hot
to be Hot Posts andtop
to be Top Posts. Default: hot
WARNING
Due to Instagram API restrictions, you have to setup your credentials on the server. See deployment guide for more.
If you don't want to setup credentials, use Picuki.
# User Profile
Strict anti-crawler policy Support browser extension
Example: https://rsshub.ranlychan.top/instagram/user/stefaniejoosten
Route: /instagram/:category/:key
Parameters:
category
, required - Feed category. Only user category is supported for now.key
, required - Key for such category. E.g. username/ID for user feed
# Lofter
# User
Example: https://rsshub.ranlychan.top/lofter/user/i
Route: /lofter/user/:name?
Parameters:
name
, optional - Lofter user name, can be found in the URL
# Tag
Example: https://rsshub.ranlychan.top/lofter/tag/摄影/date
Route: /lofter/tag/:name?/:type?
Parameters:
name
, optional - tag name, such as名侦探柯南
,摄影
by defaulttype
, optional - ranking type, see below, new by default
new | date | week | month | total |
---|---|---|---|---|
最新 | 日榜 | 周榜 | 月榜 | 总榜 |
# Mastodon
TIP
Official user RSS:
- RSS:
https://**:instance**/users/**:username**.rss
(Example (opens new window)) - Atom:
(Only for pawoo.net, example (opens new window))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 will need to create application on a Mastodon instance, and configure your RSSHub instance. Check the Deploy Guide for route-specific configurations.
# User timeline
Example: https://rsshub.ranlychan.top/mastodon/acct/CatWhitney@mastodon.social/statuses
Route: /mastodon/acct/:acct/statuses/:only_media?
Parameters:
acct
, required - Webfinger account URIonly_media
, optional - whether only display media content, default to false, any value to true
# Instance timeline (local)
Example: https://rsshub.ranlychan.top/mastodon/timeline/pawoo.net/true
Route: /mastodon/timeline/:site/:only_media?
Parameters:
site
, required - instance address, only domain, nohttp://
orhttps://
protocol headeronly_media
, optional - whether only display media content, default to false, any value to true
# Instance timeline (federated)
Example: https://rsshub.ranlychan.top/mastodon/remote/pawoo.net/true
Route: /mastodon/remote/:site/:only_media?
Parameters:
site
, required - instance address, only domain, nohttp://
orhttps://
protocol headeronly_media
, optional - whether only display media content, default to false, any value to true
# User timeline (backup)
Example: https://rsshub.ranlychan.top/mastodon/account_id/mastodon.social/23634/statuses/only_media
Route: /mastodon/account/:site/:account_id/statuses/:only_media?
Parameters:
site
, required - instance address, only domain, nohttp://
orhttps://
protocol headeraccount_id
, required - account id. login your instance, then search for the user profile; the account id is in the urlonly_media
, optional - whether only display media content, default to false, any value to true
# piapro
# User latest works
Example: https://rsshub.ranlychan.top/piapro/user/shine_longer
Route: /piapro/user/:pid
Parameters:
pid
, required - User ID, can be found in url
# Website latest works
Example: https://rsshub.ranlychan.top/piapro/public/music/miku/2
Route: /piapro/public/:type/:tag?/:category?
Parameters:
type
, required - work type, can bemusic
,illust
,text
tag
, optional -tag
parameter in urlcategory
, optional - category ID,categoryId
parameter in url
# Picuki
# User Profile
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/picuki/profile/stefaniejoosten
Route: /picuki/profile/:id/:functionalFlag?
Parameters:
id
, required - Instagram idfunctionalFlag
, optional - functional flag, see the table below
functionalFlag | Video embedding | Fetching Instagram Stories |
---|---|---|
0 | off, only show video poster as an image | off |
1 (default) | on | off |
10 | on | on |
WARNING
Instagram Stories do not have a reliable guid. It is possible that your RSS reader show the same story more than once. Though, every Story expires after 24 hours, so it may be not so serious.
# pixiv
# User Bookmark
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/pixiv/user/bookmarks/15288095
Route: /pixiv/user/bookmarks/:id
Parameters:
id
, required - user id, available in user's homepage URL
# User Activity
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/pixiv/user/15288095
Route: /pixiv/user/:id
Parameters:
id
, required - user id, available in user's homepage URL
# User Novels
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/pixiv/user/novels/27104704
Route: /pixiv/user/novels/:id
Parameters:
id
, required - User id, available in user's homepage URL
# Rankings
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/pixiv/ranking/week
Route: /pixiv/ranking/:mode/:date?
Parameters:
mode
, required - rank typedate
, 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 |
# Keyword
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/pixiv/search/麻衣/popular/2
Route: /pixiv/search/:keyword/:order?/:mode?
Parameters:
keyword
, required - keywordorder
, optional - rank mode, empty or other for time order, popular for popular ordermode
, optional - filte R18 content
only not R18 | only R18 | no filter |
---|---|---|
safe | r18 | empty or other |
# Following timeline
Self-host only Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/pixiv/user/illustfollows
Route: /pixiv/user/illustfollows
Parameters: N/A
WARNING
Only for self-hosted
# pixivFANBOX
# User
Example: https://rsshub.ranlychan.top/fanbox/otomeoto
Route: /fanbox/:user?
Parameters:
user
, optional - User name. Can be found in URL. Default is official news
# Plurk
# Topic
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/plurk/topic/standwithukraine
Route: /plurk/topic/:topic
Parameters:
topic
, required - Topic ID, can be found in URL
# Top
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/plurk/top/topReplurks
Route: /plurk/top/:category?/:lang?
Parameters:
category
, optional - Category, see the table below,topReplurks
by defaultlang
, optional - Language, see the table below,en
by default
Top Replurks | Top Favorites | Top Responded |
---|---|---|
topReplurks | topFavorites | topResponded |
English | 中文(繁體) |
---|---|
en | zh |
# Anonymous
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/plurk/anonymous
Route: /plurk/anonymous
Parameters: N/A
# Search
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/plurk/search/FGO
Route: /plurk/search/:keyword
Parameters:
keyword
, required - Search keyword
# Hotlinks
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/plurk/hotlinks
Route: /plurk/hotlinks
Parameters: N/A
# Plurk News
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/plurk/news/:lang?
Route: /plurk/news/:lang?
Parameters:
lang
, optional - Language, see the table above,en
by default
# User
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/plurk/user/plurkoffice
Route: /plurk/user/:user
Parameters:
user
, required - User ID, can be found in URL
# Telegram
# Channel
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/telegram/channel/awesomeDIYgod/searchQuery=%23DIYgod的豆瓣动态
Route: /telegram/channel/:username/:routeParams?
Parameters:
username
, required - channel usernamerouteParams
, optional - 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 |
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 # by %23 for hashtag searching | (search disabled) |
Specify different option values than default values can meet different needs, URL
https://rsshub.ranlychan.top/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.
TIP
For backward compatibility reasons, invalid routeParams
will be treated as searchQuery
.
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
Example: https://rsshub.ranlychan.top/telegram/stickerpack/DIYgod
Route: /telegram/stickerpack/:name
Parameters:
name
, required - Sticker Pack name, available in the sharing URL
# Telegram Blog
# TikTok
# User
Rely on Puppeteer Strict anti-crawler policy Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/tiktok/user/@linustech
Route: /tiktok/user/:user
Parameters:
user
, required - User ID, including @
WARNING
Due to restrictions from Twitter, currently only tweets within 7 days are available in some routes.
Some routes rely on the Twitter Developer API, which requires to be specially configured to enable.
There are two routes (/twitter/user
and /twitter/keyword
) comes with Web API implementation which does not require to be specially configured to enable along with the Developer API implementation. By default, the Developer API is prioritized, but if it is not configured or errors, the Web API will be used. However, there are some differences between the two APIs, e.g. excludeReplies
in the Developer API will treat threads (opens new window) (self-replied tweets) as replies and exclude them, while in the Web API it will not. If you would like to exclude replies but include threads, enable forceWebApi
in the /twitter/user
route.
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 |
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.ranlychan.top/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
# User timeline
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/twitter/user/DIYgod
Route: /twitter/user/:id/:routeParams?
Parameters:
id
, required - user idrouteParams
, optional - extra parameters, see the table above; particularly whenrouteParams=exclude_replies
, replies are excluded;routeParams=exclude_rts
excludes retweets,routeParams=exclude_rts_replies
exclude replies and retweets; for default include all.
# User media
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/twitter/media/DIYgod
Route: /twitter/media/:id/:routeParams?
Parameters:
id
, required - user idrouteParams
, optional - extra parameters, see the table above.
# User following timeline
Self-host only Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/twitter/followings/DIYgod
Route: /twitter/followings/:id/:routeParams?
Parameters:
id
, required - user idrouteParams
, optional - extra parameters, see the table above
WARNING
This route requires Twitter token's corresponding id, therefore it's only available when self-hosting, refer to the Deploy Guide for route-specific configurations.
# List timeline
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/twitter/list/ladyleet/javascript
Route: /twitter/list/:id/:name/:routeParams?
Parameters:
id
, required - user namename
, required - list namerouteParams
, optional - extra parameters, see the table above
# User likes
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/twitter/likes/DIYgod
Route: /twitter/likes/:id/:routeParams?
Parameters:
id
, required - user namerouteParams
, optional - extra parameters, see the table above
# Keyword
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/twitter/keyword/RSSHub
Route: /twitter/keyword/:keyword/:routeParams?
Parameters:
keyword
, required - keywordrouteParams
, optional - extra parameters, see the table above
# Trends
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/twitter/trends/23424856
Route: /twitter/trends/:woeid?
Parameters:
woeid
, optional - Yahoo! Where On Earth ID. default to woeid=1 (World Wide)
# Collection
Self-host only Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/twitter/collection/DIYgod/1527857429467172864
Route: /twitter/collection/:uid/:collectionId/:routeParams?
Parameters:
uid
, required - User name, should match the generated tokencollectionId
, required - Collection ID, can be found in URLrouteParams
, optional - extra parameters, see the table above
WARNING
This route requires Twitter token's corresponding id, therefore it's only available when self-hosting, refer to the Deploy Guide for route-specific configurations.
# Vimeo
# User Profile
Example: https://rsshub.ranlychan.top/vimeo/user/filmsupply/picks
Route: /vimeo/user/:username/:cat?
Parameters:
username
, required - In this example https://vimeo.com/filmsupply isfilmsupply
cat
, optional - deafult for all latest videos, others categories in this example such asDocmentary
,Narrative
,Drama
. Setpicks
for promote orders, just orderd like web page. Whenpicks
added, published date won't show up
Special category name attention
Some of the categories contain slash like 3D/CG
, must change the slash /
to the vertical bar|
.
# Channel
Example: https://rsshub.ranlychan.top/vimeo/channel/bestoftheyear
Route: /vimeo/channel/:channel
Parameters:
channel
, required - channel name can get from url likebestoftheyear
in https://vimeo.com/channels/bestoftheyear/videos .
# Category
Example: https://rsshub.ranlychan.top/vimeo/category/documentary/staffpicks
Route: /vimeo/category/:category/:staffpicks?
Parameters:
category
, required - Category name can get from url likedocumentary
in https://vimeo.com/categories/documentary/videosstaffpicks
, optional - typestaffpicks
to sort with staffpicks
# YouTube
Tiny Tiny RSS users please notice
Tiny Tiny RSS will add sandbox="allow-scripts"
to all iframe elements, as a result, YouTube embedded videos cannot be loaded. If you need to use embedded videos, please install plugin remove_iframe_sandbox (opens new window) for Tiny Tiny RSS.
# User
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/youtube/user/JFlaMusic
Route: /youtube/user/:username/:embed?
Parameters:
username
, required - YouTuber idembed
, optional - Default to embed the video, set to any value to disable embedding
# Channel
TIP
YouTube provides official RSS feeds for channels, for instance https://www.youtube.com/feeds/videos.xml?channel_id=UCDwDMPOZfxVV0x_dz0eQ8KQ (opens new window).
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/youtube/channel/UCDwDMPOZfxVV0x_dz0eQ8KQ
Route: /youtube/channel/:id/:embed?
Parameters:
id
, required - YouTube channel idembed
, optional - Default to embed the video, set to any value to disable embedding
# Playlist
Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/youtube/playlist/PLqQ1RwlxOgeLTJ1f3fNMSwhjVgaWKo_9Z
Route: /youtube/playlist/:id/:embed?
Parameters:
id
, required - YouTube playlist idembed
, optional - Default to embed the video, set to any value to disable embedding
# Subscriptions
Self-host only Support browser extension Support RSSBud
Example: https://rsshub.ranlychan.top/youtube/subscriptions
Route: /youtube/subscriptions/:embed?
Parameters:
embed
, optional - Default to embed the video, set to any value to disable embedding