api.md

Xquik TypeScript SDK API

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

Shared

Types:

• ContentDisclosure
• EmbeddedTweet
• Error
• EventType
• PaginatedTweets
• PaginatedUsers
• SearchTweet
• TweetMedia
• UserProfile

Account

Types:

• AccountRetrieveResponse
• AccountSetXUsernameResponse
• AccountUpdateLocaleResponse

Methods:

• client.account.retrieve() -> AccountRetrieveResponse
• client.account.setXUsername({ ...params }) -> AccountSetXUsernameResponse
• client.account.updateLocale({ ...params }) -> AccountUpdateLocaleResponse

Subscribe

Types:

• SubscribeCreateResponse

Methods:

• client.subscribe.create({ ...params }) -> SubscribeCreateResponse

Compose

Types:

• ComposeCreateResponse

Methods:

• client.compose.create({ ...params }) -> ComposeCreateResponse

Drafts

Types:

• Draft
• DraftDetail
• DraftListResponse

Methods:

• client.drafts.create({ ...params }) -> DraftDetail
• client.drafts.retrieve(id) -> DraftDetail
• client.drafts.list({ ...params }) -> DraftListResponse
• client.drafts.delete(id) -> void

Styles

Types:

• StyleProfile
• StyleProfileSummary
• StyleListResponse
• StyleCompareResponse
• StyleGetPerformanceResponse

Methods:

• client.styles.retrieve(id) -> StyleProfile
• client.styles.update(id, { ...params }) -> StyleProfile
• client.styles.list() -> StyleListResponse
• client.styles.delete(id) -> void
• client.styles.analyze({ ...params }) -> StyleProfile
• client.styles.compare({ ...params }) -> StyleCompareResponse
• client.styles.getPerformance(id) -> StyleGetPerformanceResponse

Radar

Types:

• RadarItem
• RadarRetrieveTrendingTopicsResponse

Methods:

• client.radar.retrieveTrendingTopics({ ...params }) -> RadarRetrieveTrendingTopicsResponse

Monitors

Types:

• Monitor
• MonitorCreateResponse
• MonitorListResponse
• MonitorDeactivateResponse

Methods:

• client.monitors.create({ ...params }) -> MonitorCreateResponse
• client.monitors.retrieve(id) -> Monitor
• client.monitors.update(id, { ...params }) -> Monitor
• client.monitors.list() -> MonitorListResponse
• client.monitors.deactivate(id) -> MonitorDeactivateResponse

Keywords

Types:

• KeywordCreateResponse
• KeywordRetrieveResponse
• KeywordUpdateResponse
• KeywordListResponse
• KeywordDeactivateResponse

Methods:

• client.monitors.keywords.create({ ...params }) -> KeywordCreateResponse
• client.monitors.keywords.retrieve(id) -> KeywordRetrieveResponse
• client.monitors.keywords.update(id, { ...params }) -> KeywordUpdateResponse
• client.monitors.keywords.list() -> KeywordListResponse
• client.monitors.keywords.deactivate(id) -> KeywordDeactivateResponse

Events

Types:

• Event
• EventDetail
• EventListResponse

Methods:

• client.events.retrieve(id) -> EventDetail
• client.events.list({ ...params }) -> EventListResponse

Extractions

Types:

• ExtractionJob
• ExtractionRetrieveResponse
• ExtractionListResponse
• ExtractionEstimateCostResponse
• ExtractionRunResponse

Methods:

• client.extractions.retrieve(id, { ...params }) -> ExtractionRetrieveResponse
• client.extractions.list({ ...params }) -> ExtractionListResponse
• client.extractions.estimateCost({ ...params }) -> ExtractionEstimateCostResponse
• client.extractions.exportResults(id, { ...params }) -> Response
• client.extractions.run({ ...params }) -> ExtractionRunResponse

Draws

Types:

• DrawDetail
• DrawListItem
• Winner
• DrawRetrieveResponse
• DrawListResponse
• DrawRunResponse

Methods:

• client.draws.retrieve(id) -> DrawRetrieveResponse
• client.draws.list({ ...params }) -> DrawListResponse
• client.draws.export(id, { ...params }) -> Response
• client.draws.run({ ...params }) -> DrawRunResponse

Webhooks

Types:

• Delivery
• Webhook
• WebhookCreateResponse
• WebhookListResponse
• WebhookDeactivateResponse
• WebhookListDeliveriesResponse
• WebhookResumeResponse
• WebhookTestResponse

Methods:

• client.webhooks.create({ ...params }) -> WebhookCreateResponse
• client.webhooks.update(id, { ...params }) -> Webhook
• client.webhooks.list() -> WebhookListResponse
• client.webhooks.deactivate(id) -> WebhookDeactivateResponse
• client.webhooks.listDeliveries(id) -> WebhookListDeliveriesResponse
• client.webhooks.resume(id) -> WebhookResumeResponse
• client.webhooks.test(id) -> WebhookTestResponse

X

Types:

• XGetArticleResponse
• XGetNotificationsResponse
• XGetTrendsResponse

Methods:

• client.x.getArticle(tweetID) -> XGetArticleResponse
• client.x.getHomeTimeline({ ...params }) -> PaginatedTweets
• client.x.getNotifications({ ...params }) -> XGetNotificationsResponse
• client.x.getTrends({ ...params }) -> XGetTrendsResponse

WriteActions

Types:

• WriteActionRetrieveResponse

Methods:

• client.x.writeActions.retrieve(id) -> WriteActionRetrieveResponse

Tweets

Types:

• TweetAuthor
• TweetDetail
• TweetCreateResponse
• TweetRetrieveResponse
• TweetDeleteResponse
• TweetGetRepliesResponse
• TweetSearchResponse

Methods:

• client.x.tweets.create({ ...params }) -> TweetCreateResponse
• client.x.tweets.retrieve(id) -> TweetRetrieveResponse
• client.x.tweets.list({ ...params }) -> PaginatedTweets
• client.x.tweets.delete(id, { ...params }) -> TweetDeleteResponse
• client.x.tweets.getFavoriters(id, { ...params }) -> PaginatedUsers
• client.x.tweets.getQuotes(id, { ...params }) -> PaginatedTweets
• client.x.tweets.getReplies(id, { ...params }) -> TweetGetRepliesResponse
• client.x.tweets.getRetweeters(id, { ...params }) -> PaginatedUsers
• client.x.tweets.getThread(id, { ...params }) -> PaginatedTweets
• client.x.tweets.search({ ...params }) -> TweetSearchResponse

Like

Types:

• LikeCreateResponse
• LikeDeleteResponse

Methods:

• client.x.tweets.like.create(id, { ...params }) -> LikeCreateResponse
• client.x.tweets.like.delete(id, { ...params }) -> LikeDeleteResponse

Retweet

Types:

• RetweetCreateResponse
• RetweetDeleteResponse

Methods:

• client.x.tweets.retweet.create(id, { ...params }) -> RetweetCreateResponse
• client.x.tweets.retweet.delete(id, { ...params }) -> RetweetDeleteResponse

Users

Types:

• UserRemoveFollowerResponse
• UserRetrieveBatchResponse
• UserRetrieveFollowersResponse
• UserRetrieveFollowingResponse
• UserRetrieveVerifiedFollowersResponse

Methods:

• client.x.users.retrieve(id) -> UserProfile
• client.x.users.removeFollower(id, { ...params }) -> UserRemoveFollowerResponse
• client.x.users.retrieveBatch({ ...params }) -> UserRetrieveBatchResponse
• client.x.users.retrieveFollowers(id, { ...params }) -> UserRetrieveFollowersResponse
• client.x.users.retrieveFollowersYouKnow(id, { ...params }) -> PaginatedUsers
• client.x.users.retrieveFollowing(id, { ...params }) -> UserRetrieveFollowingResponse
• client.x.users.retrieveLikes(id, { ...params }) -> PaginatedTweets
• client.x.users.retrieveMedia(id, { ...params }) -> PaginatedTweets
• client.x.users.retrieveMentions(id, { ...params }) -> PaginatedTweets
• client.x.users.retrieveReplies(id, { ...params }) -> PaginatedTweets
• client.x.users.retrieveSearch({ ...params }) -> PaginatedUsers
• client.x.users.retrieveTweets(id, { ...params }) -> PaginatedTweets
• client.x.users.retrieveVerifiedFollowers(id, { ...params }) -> UserRetrieveVerifiedFollowersResponse

Follow

Types:

• FollowCreateResponse
• FollowDeleteAllResponse

Methods:

• client.x.users.follow.create(id, { ...params }) -> FollowCreateResponse
• client.x.users.follow.deleteAll(id, { ...params }) -> FollowDeleteAllResponse

Followers

Types:

• FollowerCheckResponse

Methods:

• client.x.followers.check({ ...params }) -> FollowerCheckResponse

Dm

Types:

• DmRetrieveHistoryResponse
• DmSendResponse

Methods:

• client.x.dm.retrieveHistory(userID, { ...params }) -> DmRetrieveHistoryResponse
• client.x.dm.send(userID, { ...params }) -> DmSendResponse

Media

Types:

• MediaDownloadResponse
• MediaUploadResponse

Methods:

• client.x.media.download({ ...params }) -> MediaDownloadResponse
• client.x.media.upload({ ...params }) -> MediaUploadResponse

Profile

Types:

• ProfileUpdateResponse
• ProfileUpdateAvatarResponse
• ProfileUpdateBannerResponse

Methods:

• client.x.profile.update({ ...params }) -> ProfileUpdateResponse
• client.x.profile.updateAvatar({ ...params }) -> ProfileUpdateAvatarResponse
• client.x.profile.updateBanner({ ...params }) -> ProfileUpdateBannerResponse

Communities

Types:

• CommunityCreateResponse
• CommunityDeleteResponse
• CommunityRetrieveInfoResponse

Methods:

• client.x.communities.create({ ...params }) -> CommunityCreateResponse
• client.x.communities.delete(id, { ...params }) -> CommunityDeleteResponse
• client.x.communities.retrieveInfo(id) -> CommunityRetrieveInfoResponse
• client.x.communities.retrieveMembers(id, { ...params }) -> PaginatedUsers
• client.x.communities.retrieveModerators(id, { ...params }) -> PaginatedUsers
• client.x.communities.retrieveSearch({ ...params }) -> PaginatedTweets

Join

Types:

• JoinCreateResponse
• JoinDeleteAllResponse

Methods:

• client.x.communities.join.create(id, { ...params }) -> JoinCreateResponse
• client.x.communities.join.deleteAll(id, { ...params }) -> JoinDeleteAllResponse

Tweets

Methods:

• client.x.communities.tweets.list({ ...params }) -> PaginatedTweets
• client.x.communities.tweets.listByCommunity(id, { ...params }) -> PaginatedTweets

Accounts

Types:

• XAccount
• XAccountDetail
• AccountCreateResponse
• AccountListResponse
• AccountDeleteResponse
• AccountBulkRetryResponse
• AccountReauthResponse

Methods:

• client.x.accounts.create({ ...params }) -> AccountCreateResponse
• client.x.accounts.retrieve(id) -> XAccountDetail
• client.x.accounts.list() -> AccountListResponse
• client.x.accounts.delete(id) -> AccountDeleteResponse
• client.x.accounts.bulkRetry() -> AccountBulkRetryResponse
• client.x.accounts.reauth(id, { ...params }) -> AccountReauthResponse

AccountConnectionChallenges

Types:

• AccountConnectionChallengeSubmitResponse

Methods:

• client.x.accountConnectionChallenges.submit(id, { ...params }) -> AccountConnectionChallengeSubmitResponse

AccountConnectionAttempts

Types:

• AccountConnectionAttemptRetrieveResponse

Methods:

• client.x.accountConnectionAttempts.retrieve(id) -> AccountConnectionAttemptRetrieveResponse

Bookmarks

Types:

• BookmarkRetrieveFoldersResponse

Methods:

• client.x.bookmarks.list({ ...params }) -> PaginatedTweets
• client.x.bookmarks.retrieveFolders() -> BookmarkRetrieveFoldersResponse

Lists

Methods:

• client.x.lists.retrieveFollowers(id, { ...params }) -> PaginatedUsers
• client.x.lists.retrieveMembers(id, { ...params }) -> PaginatedUsers
• client.x.lists.retrieveTweets(id, { ...params }) -> PaginatedTweets

Trends

Types:

• TrendListResponse

Methods:

• client.trends.list({ ...params }) -> TrendListResponse

Support

Attachments

Methods:

• client.support.attachments.download(id, { ...params }) -> Response

Tickets

Types:

• TicketCreateResponse
• TicketRetrieveResponse
• TicketUpdateResponse
• TicketListResponse
• TicketReplyResponse

Methods:

• client.support.tickets.create({ ...params }) -> TicketCreateResponse
• client.support.tickets.retrieve(id) -> TicketRetrieveResponse
• client.support.tickets.update(id, { ...params }) -> TicketUpdateResponse
• client.support.tickets.list() -> TicketListResponse
• client.support.tickets.reply(id, { ...params }) -> TicketReplyResponse

Credits

Types:

• CreditRetrieveBalanceResponse
• CreditRetrieveTopupStatusResponse
• CreditTopupBalanceResponse

Methods:

• client.credits.redirectTopupCheckout({ ...params }) -> void
• client.credits.retrieveBalance() -> CreditRetrieveBalanceResponse
• client.credits.retrieveTopupStatus({ ...params }) -> CreditRetrieveTopupStatusResponse
• client.credits.topupBalance({ ...params }) -> CreditTopupBalanceResponse

GuestWallets

Types:

• GuestWalletAmount
• GuestWalletCreateResponse
• GuestWalletRetrieveStatusResponse
• GuestWalletTopupResponse

Methods:

• client.guestWallets.create({ ...params }) -> GuestWalletCreateResponse
• client.guestWallets.retrieveStatus() -> GuestWalletRetrieveStatusResponse
• client.guestWallets.topup({ ...params }) -> GuestWalletTopupResponse