rsshub
Version:
Make RSS Great Again!
52 lines (42 loc) âĸ 7.64 kB
text/typescript
import type { Namespace } from '@/types';
export const namespace: Namespace = {
name: 'X (Twitter)',
url: 'x.com',
description: `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\`) |
| \`showAuthorAsTitleOnly\` | Show only author name as title | \`0\`/\`1\`/\`true\`/\`false\` | \`false\` |
| \`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\` |
| \`includeReplies\` | Include 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 |
| \`onlyMedia\` | Only get tweets with a media | \`0\`/\`1\`/\`true\`/\`false\` | \`false\` |
| \`mediaNumber \` | Number the medias | \`0\`/\`1\`/\`true\`/\`false\` | \`false\` |
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
<img loading="lazy" src="/img/readable-twitter.png" alt="Readable Twitter RSS of Durov" />
Currently supports two authentication methods:
- Using \`TWITTER_AUTH_TOKEN\` (recommended): Configure a comma-separated list of \`auth_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\` and \`TWITTER_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.
`,
lang: 'en',
};