Social Media

# CuriousCat

# User

Author: @lucasew

Example: https://rsshub.app/curiouscat/user/username

Route: /curiouscat/user/:name

Parameters:

  • name, required -

    name, username that is in the URL

# Dev.to

# Top Posts

Author: @dwemerx

Example: https://rsshub.app/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

Author: @DIYgod

Example: https://rsshub.app/disqus/posts/diygod-me

Route: /disqus/posts/:forum

Parameters:

  • forum, required -

    forum, disqus name of the target website

# Facebook

# Page

strict anti-crawler policy

Author: @maple3142

Example: https://rsshub.app/facebook/page/SonetPCR

Route: /facebook/page/:id

Parameters:

  • id, required -

    page id

# Instagram

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

support browser extension

Author: @oppilate @DIYgod

Example: https://rsshub.app/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

Author: @hoilc

Example: https://rsshub.app/lofter/user/tingtingtingtingzhi

Route: /lofter/user/:name

Parameters:

  • name, required -

    Lofter user name, in the URL

# Tag

Author: @hoilc

Example: https://rsshub.app/lofter/tag/名侦探柯南/date

Route: /lofter/tag/:name/:type?

Parameters:

  • name, required -

    tag name

  • type, optional -

    ranking type, default to new, can be new date week month total

# Mastodon

TIP

Official user RSS:

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

Author: @notofoe

Example: https://rsshub.app/mastodon/acct/[email protected]/statuses

Route: /mastodon/acct/:acct/statuses/:only_media?

Parameters:

  • acct, required -

    Webfinger account URI

  • only_media, optional -

    whether only display media content, default to false, any value to true

# Instance timeline (local)

Author: @hoilc

Example: https://rsshub.app/mastodon/timeline/pawoo.net/true

Route: /mastodon/timeline/:site/:only_media?

Parameters:

  • site, required -

    instance address, only domain, no http:// or https:// protocol header

  • only_media, optional -

    whether only display media content, default to false, any value to true

# Instance timeline (federated)

Author: @hoilc

Example: https://rsshub.app/mastodon/remote/pawoo.net/true

Route: /mastodon/remote/:site/:only_media?

Parameters:

  • site, required -

    instance address, only domain, no http:// or https:// protocol header

  • only_media, optional -

    whether only display media content, default to false, any value to true

# User timeline (backup)

Author: @notofoe

Example: https://rsshub.app/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, no http:// or https:// protocol header

  • account_id, required -

    account id. login your instance, then search for the user profile; the account id is in the url

  • only_media, optional -

    whether only display media content, default to false, any value to true

# piapro

# User latest works

Author: @hoilc

Example: https://rsshub.app/piapro/user/shine_longer

Route: /piapro/user/:pid

Parameters:

  • pid, required -

    User ID, can be found in url

# Website latest works

Author: @hoilc

Example: https://rsshub.app/piapro/public/music/miku/2

Route: /piapro/public/:type/:tag?/:category?

Parameters:

  • type, required -

    work type, can be music,illust,text

  • tag, optional -

    tag parameter in url

  • category, optional -

    category ID, categoryId parameter in url

# Picuki

# User Profile

Author: @hoilc

Example: https://rsshub.app/picuki/profile/stefaniejoosten

Route: /picuki/profile/:id/:displayVideo?

Parameters:

  • id, required -

    Instagram id

  • displayVideo, optional -

    Default to disable the embedded video, set to any value to enable embedding

# pixiv

# User Bookmark

support browser extension support rssbud

Author: @EYHN

Example: https://rsshub.app/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

Author: @EYHN

Example: https://rsshub.app/pixiv/user/15288095

Route: /pixiv/user/:id

Parameters:

  • id, required -

    user id, available in user's homepage URL

# Rankings

support browser extension support rssbud

Author: @EYHN

Example: https://rsshub.app/pixiv/ranking/week

Route: /pixiv/ranking/:mode/:date?

Parameters:

  • mode, required -

    rank type

  • date, 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

Author: @DIYgod

Example: https://rsshub.app/pixiv/search/麻衣/popular/2

Route: /pixiv/search/:keyword/:order?/:r18?

Parameters:

  • keyword, required -

    keyword

  • order, optional -

    rank mode, empty or other for time order, popular for popular order

  • r18, optional -

    filte R18 content, 0 to no filter, 1 to only not R18, 2 to only R18, default to 0

# Following timeline

WARNING

Only for self-hosted

# pixiv-fanbox

Author: @sgqy

Example: https://rsshub.app/fanbox/otomeoto

Route: /fanbox/:user?

Parameters:

  • user, optional -

    User name. Can be found in URL. Default is official news

# Telegram

# Channel

support browser extension support rssbud

Author: @DIYgod

Example: https://rsshub.app/telegram/channel/awesomeDIYgod/%23DIYgod的豆瓣动态

Route: /telegram/channel/:username/:searchQuery?

Parameters:

  • username, required -

    channel name

  • searchQuery, optional -

    search query; replace # by %23 for tag searching

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

Author: @DIYgod

Example: https://rsshub.app/telegram/stickerpack/DIYgod

Route: /telegram/stickerpack/:name

Parameters:

  • name, required -

    Sticker Pack name, available in the sharing URL

# Telegram Blog

Author: @fengkx

Example: https://rsshub.app/telegram/blog

Route: /telegram/blog

Parameters: N/A

# Twitter

WARNING

Due to Twitter API restrictions, the Twitter Routes currently supports tweets within 7 days

Specify options (in query string's format) 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 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 "User timeline" 0/1/true/false false
includeRts Include retweets, only available in "User timeline" 0/1/true/false true
count count parameter passed to Twitter API, only available in "User timeline" Unspecified/Integer Unspecified

Specify different option values than default values to improve readablility. 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

Readable Twitter RSS of Durov

# User timeline

support browser extension support rssbud

Author: @DIYgod

Example: https://rsshub.app/twitter/user/DIYgod

Route: /twitter/user/:id/:routeParams?

Parameters:

  • id, required -

    user id

  • routeParams, optional -

    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.

# User following timeline

support browser extension support rssbud self-host only

Author: @DIYgod

Example: https://rsshub.app/twitter/followings/DIYgod

Route: /twitter/followings/:id/:routeParams?

Parameters:

  • id, required -

    user id

  • routeParams, 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

Author: @xyqfer

Example: https://rsshub.app/twitter/list/ladyleet/javascript

Route: /twitter/list/:id/:name/:routeParams?

Parameters:

  • id, required -

    user name

  • name, required -

    list name

  • routeParams, optional -

    extra parameters, see the table above

# User likes

support browser extension support rssbud

Author: @xyqfer

Example: https://rsshub.app/twitter/likes/DIYgod

Route: /twitter/likes/:id/:routeParams?

Parameters:

  • id, required -

    user name

  • routeParams, optional -

    extra parameters, see the table above

# Keyword

support browser extension support rssbud

Author: @DIYgod

Example: https://rsshub.app/twitter/keyword/RSSHub

Route: /twitter/keyword/:keyword/:routeParams?

Parameters:

  • keyword, required -

    keyword

  • routeParams, optional -

    extra parameters, see the table above

support browser extension support rssbud

Author: @sakamossan

Example: https://rsshub.app/twitter/trends/23424856

Route: /twitter/trends/:woeid?

Parameters:

  • woeid, optional -

    Yahoo! Where On Earth ID. default to woeid=1 (World Wide)

# 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

Author: @DIYgod

Example: https://rsshub.app/youtube/user/JFlaMusic

Route: /youtube/user/:username/:embed?

Parameters:

  • username, required -

    YouTuber id

  • embed, optional -

    Default to embed the video, set to any value to disable embedding

# Channel

support browser extension support rssbud

Author: @DIYgod

Example: https://rsshub.app/youtube/channel/UCDwDMPOZfxVV0x_dz0eQ8KQ

Route: /youtube/channel/:id/:embed?

Parameters:

  • id, required -

    YouTube channel id

  • embed, optional -

    Default to embed the video, set to any value to disable embedding

# Playlist

support browser extension support rssbud

Author: @DIYgod

Example: https://rsshub.app/youtube/playlist/PLqQ1RwlxOgeLTJ1f3fNMSwhjVgaWKo_9Z

Route: /youtube/playlist/:id/:embed?

Parameters:

  • id, required -

    YouTube playlist id

  • embed, optional -

    Default to embed the video, set to any value to disable embedding