api.md

TwexAPI TypeScript SDK API

TwexAPI is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp.

Account

Types:

• StandardResponse

Methods:

• client.account.balance() -> StandardResponse

Analysis

Types:

• SentimentAnalysisQuery
• SentimentAnalysisResponse

Methods:

• client.analysis.sentiment({ ...params }) -> SentimentAnalysisResponse

Articles

Types:

• XArticleResponse
• ArticlesMarkdownRequest

Methods:

• client.articles.fetch({ ...params }) -> XArticleResponse
• client.articles.markdown({ ...params }) -> string

Communities

Types:

• SearchUserResponse
• GetCommunityMembersCursorQuery
• GetCommunityMembersCursorResponse
• CommunityTweetsResponse
• GetCommunityTweetsCursorQuery
• GetCommunityTweetsCursorResponse
• SearchCommunityQuery
• SearchCommunityResponse
• GetCommunityResponse
• SearchCommunityTweetsQuery

Methods:

• client.communities.members({ ...params }) -> SearchUserResponse
• client.communities.membersPage({ ...params }) -> GetCommunityMembersCursorResponse
• client.communities.tweets({ ...params }) -> CommunityTweetsResponse
• client.communities.tweetsPage({ ...params }) -> GetCommunityTweetsCursorResponse
• client.communities.search({ ...params }) -> SearchCommunityResponse
• client.communities.get({ ...params }) -> GetCommunityResponse
• client.communities.searchTweets({ ...params }) -> CommunityTweetsResponse

Dm

Types:

• DMStatusResponseV2
• SendDmV3Query
• SendDmResponse
• GetDmHistoryV3Query
• GetDmHistoryV3Response
• GetDmMediaV3Query
• GetDmMediaV3Response
• GetConversationsV3Query
• GetConversationsV3Response

Methods:

• client.dm.status({ ...params }) -> DMStatusResponseV2
• client.dm.send({ ...params }) -> SendDmResponse
• client.dm.history({ ...params }) -> GetDmHistoryV3Response
• client.dm.media({ ...params }) -> GetDmMediaV3Response
• client.dm.conversations({ ...params }) -> GetConversationsV3Response

Lists

Types:

• ListTweetsResponse
• GetListTweetsCursorQuery
• GetListTweetsCursorResponse
• ListSubscribersResponse
• ListMembersResponse
• GetListMembersCursorQuery
• GetListMembersCursorResponse
• SearchListQuery
• SearchListResponse

Methods:

• client.lists.tweets({ ...params }) -> ListTweetsResponse
• client.lists.tweetsPage({ ...params }) -> GetListTweetsCursorResponse
• client.lists.subscribers({ ...params }) -> ListSubscribersResponse
• client.lists.members({ ...params }) -> ListMembersResponse
• client.lists.membersPage({ ...params }) -> GetListMembersCursorResponse
• client.lists.search({ ...params }) -> SearchListResponse

Search

Types:

• AdvancedSearchCursorQuery
• AdvancedSearchCursorResponse
• CashtagsQuery
• HashtagsQuery
• SearchResponse

Methods:

• client.search.advanced({ ...params }) -> AdvancedSearchCursorResponse
• client.search.cashtags({ ...params }) -> SearchResponse
• client.search.hashtags({ ...params }) -> SearchResponse

Timelines

Types:

• SearchResponse
• UserTimelinePageResponse
• UserTimelineResponse
• GetAllTweetsRepliesCursorQuery
• GetAllTweetsRepliesCursorResponse

Methods:

• client.timelines.tweetsAndReplies({ ...params }) -> SearchResponse
• client.timelines.userPage({ ...params }) -> UserTimelinePageResponse
• client.timelines.user({ ...params }) -> UserTimelineResponse
• client.timelines.tweetsAndRepliesPage({ ...params }) -> GetAllTweetsRepliesCursorResponse

Trending

Types:

• StandardResponse
• SearchResponse

Methods:

• client.trending.countries() -> StandardResponse
• client.trending.topics() -> StandardResponse
• client.trending.contents({ ...params }) -> StandardResponse
• client.trending.tweets({ ...params }) -> SearchResponse
• client.trending.byCountry({ ...params }) -> StandardResponse

Tweets

Types:

• TweetThreadByIdBody
• GetTweetsByIdResponse

Methods:

• client.tweets.detail({ ...params }) -> any
• client.tweets.thread({ ...params }) -> any
• client.tweets.lookup({ ...params }) -> GetTweetsByIdResponse
• client.tweets.similar({ ...params }) -> GetTweetsByIdResponse

Actions

Types:

• TweetActionResponse
• CreateThreadQuery
• CreateThreadResponse
• PostTweetQuery
• PostTweetResponse
• QuoteTweetQuery
• PostTweetWithoutCookieQuery
• DeleteTweetQuery
• DeleteTweetResponse

Methods:

• client.tweets.actions.like({ ...params }) -> TweetActionResponse
• client.tweets.actions.unlike({ ...params }) -> TweetActionResponse
• client.tweets.actions.retweet({ ...params }) -> TweetActionResponse
• client.tweets.actions.unretweet({ ...params }) -> TweetActionResponse
• client.tweets.actions.createThread({ ...params }) -> CreateThreadResponse
• client.tweets.actions.create({ ...params }) -> PostTweetResponse
• client.tweets.actions.quote({ ...params }) -> PostTweetResponse
• client.tweets.actions.createWithoutCookie({ ...params }) -> PostTweetResponse
• client.tweets.actions.bookmark({ ...params }) -> TweetActionResponse
• client.tweets.actions.unbookmark({ ...params }) -> TweetActionResponse
• client.tweets.actions.deleteBatch({ ...params }) -> DeleteTweetResponse

Engagement

Types:

• SearchUserResponse
• GetRetweetersCursorQuery
• GetRetweetersCursorResponse
• GetQuotesQuery
• GetQuotesResponse
• GetQuotesCursorQuery
• GetQuotesCursorResponse

Methods:

• client.tweets.engagement.retweeters({ ...params }) -> SearchUserResponse
• client.tweets.engagement.retweetersPage({ ...params }) -> GetRetweetersCursorResponse
• client.tweets.engagement.quotes({ ...params }) -> GetQuotesResponse
• client.tweets.engagement.quotesPage({ ...params }) -> GetQuotesCursorResponse

Replies

Types:

• GetRepliesPageResponse

Methods:

• client.tweets.replies.page({ ...params }) -> GetRepliesPageResponse

Users

Types:

• UsersDetailsResponse
• AccountVerifyResponse
• SearchUserResponse
• FollowUserQuery
• BlockUserResponse
• UnfollowUserQuery
• UnfollowUserResponse
• TwitterAccountBasedStandardResponse
• TwitterUserAboutStandardResponse

Methods:

• client.users.getByUsernames({ ...params }) -> any
• client.users.getByIds({ ...params }) -> UsersDetailsResponse
• client.users.verifyAccount({ ...params }) -> AccountVerifyResponse
• client.users.getStatuses({ ...params }) -> any
• client.users.search({ ...params }) -> SearchUserResponse
• client.users.follow({ ...params }) -> BlockUserResponse
• client.users.unfollow({ ...params }) -> UnfollowUserResponse
• client.users.getAccountBased({ ...params }) -> TwitterAccountBasedStandardResponse
• client.users.getAbout({ ...params }) -> TwitterUserAboutStandardResponse

Followers

Types:

• FollowersFollowingV3Query
• VerifiedFollowersResponse

Methods:

• client.users.followers.list({ ...params }) -> VerifiedFollowersResponse
• client.users.followers.verified({ ...params }) -> VerifiedFollowersResponse

Following

Types:

• FollowersFollowingV3Query
• VerifiedFollowersResponse

Methods:

• client.users.following.list({ ...params }) -> VerifiedFollowersResponse