api.md

Shared Types

from x_twitter_scraper.types import Error, EventType, PaginatedTweets, PaginatedUsers

Account

Types:

from x_twitter_scraper.types import (
    AccountRetrieveResponse,
    AccountSetXUsernameResponse,
    AccountUpdateLocaleResponse,
)

Methods:

• client.account.retrieve() -> AccountRetrieveResponse
• client.account.set_x_username(**params) -> AccountSetXUsernameResponse
• client.account.update_locale(**params) -> AccountUpdateLocaleResponse

APIKeys

Types:

from x_twitter_scraper.types import (
    APIKey,
    APIKeyCreateResponse,
    APIKeyListResponse,
    APIKeyRevokeResponse,
)

Methods:

• client.api_keys.create(**params) -> APIKeyCreateResponse
• client.api_keys.list() -> APIKeyListResponse
• client.api_keys.revoke(id) -> APIKeyRevokeResponse

Subscribe

Types:

from x_twitter_scraper.types import SubscribeCreateResponse

Methods:

• client.subscribe.create() -> SubscribeCreateResponse

Compose

Types:

from x_twitter_scraper.types import ComposeCreateResponse

Methods:

• client.compose.create(**params) -> ComposeCreateResponse

Drafts

Types:

from x_twitter_scraper.types import Draft, DraftDetail, DraftListResponse

Methods:

• client.drafts.create(**params) -> DraftDetail
• client.drafts.retrieve(id) -> DraftDetail
• client.drafts.list(**params) -> DraftListResponse
• client.drafts.delete(id) -> None

Styles

Types:

from x_twitter_scraper.types import (
    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) -> None
• client.styles.analyze(**params) -> StyleProfile
• client.styles.compare(**params) -> StyleCompareResponse
• client.styles.get_performance(id) -> StyleGetPerformanceResponse

Radar

Types:

from x_twitter_scraper.types import RadarItem, RadarRetrieveTrendingTopicsResponse

Methods:

• client.radar.retrieve_trending_topics(**params) -> RadarRetrieveTrendingTopicsResponse

Monitors

Types:

from x_twitter_scraper.types import (
    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

Events

Types:

from x_twitter_scraper.types import Event, EventDetail, EventListResponse

Methods:

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

Extractions

Types:

from x_twitter_scraper.types import (
    ExtractionJob,
    ExtractionRetrieveResponse,
    ExtractionListResponse,
    ExtractionEstimateCostResponse,
    ExtractionRunResponse,
)

Methods:

• client.extractions.retrieve(id, **params) -> ExtractionRetrieveResponse
• client.extractions.list(**params) -> ExtractionListResponse
• client.extractions.estimate_cost(**params) -> ExtractionEstimateCostResponse
• client.extractions.export_results(id, **params) -> BinaryAPIResponse
• client.extractions.run(**params) -> ExtractionRunResponse

Draws

Types:

from x_twitter_scraper.types import (
    DrawDetail,
    DrawListItem,
    Winner,
    DrawRetrieveResponse,
    DrawListResponse,
    DrawRunResponse,
)

Methods:

• client.draws.retrieve(id) -> DrawRetrieveResponse
• client.draws.list(**params) -> DrawListResponse
• client.draws.export(id, **params) -> BinaryAPIResponse
• client.draws.run(**params) -> DrawRunResponse

Webhooks

Types:

from x_twitter_scraper.types import (
    Delivery,
    Webhook,
    WebhookCreateResponse,
    WebhookListResponse,
    WebhookDeactivateResponse,
    WebhookListDeliveriesResponse,
    WebhookTestResponse,
)

Methods:

• client.webhooks.create(**params) -> WebhookCreateResponse
• client.webhooks.update(id, **params) -> Webhook
• client.webhooks.list() -> WebhookListResponse
• client.webhooks.deactivate(id) -> WebhookDeactivateResponse
• client.webhooks.list_deliveries(id) -> WebhookListDeliveriesResponse
• client.webhooks.test(id) -> WebhookTestResponse

Integrations

Types:

from x_twitter_scraper.types import (
    Integration,
    IntegrationDelivery,
    IntegrationListResponse,
    IntegrationDeleteResponse,
    IntegrationListDeliveriesResponse,
    IntegrationSendTestResponse,
)

Methods:

• client.integrations.create(**params) -> Integration
• client.integrations.retrieve(id) -> Integration
• client.integrations.update(id, **params) -> Integration
• client.integrations.list() -> IntegrationListResponse
• client.integrations.delete(id) -> IntegrationDeleteResponse
• client.integrations.list_deliveries(id, **params) -> IntegrationListDeliveriesResponse
• client.integrations.send_test(id) -> IntegrationSendTestResponse

X

Types:

from x_twitter_scraper.types import (
    XGetArticleResponse,
    XGetNotificationsResponse,
    XGetTrendsResponse,
)

Methods:

• client.x.get_article(tweet_id) -> XGetArticleResponse
• client.x.get_home_timeline(**params) -> PaginatedTweets
• client.x.get_notifications(**params) -> XGetNotificationsResponse
• client.x.get_trends() -> XGetTrendsResponse

Tweets

Types:

from x_twitter_scraper.types.x import (
    SearchTweet,
    TweetAuthor,
    TweetDetail,
    TweetCreateResponse,
    TweetRetrieveResponse,
    TweetDeleteResponse,
)

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.get_favoriters(id, **params) -> PaginatedUsers
• client.x.tweets.get_quotes(id, **params) -> PaginatedTweets
• client.x.tweets.get_replies(id, **params) -> PaginatedTweets
• client.x.tweets.get_retweeters(id, **params) -> PaginatedUsers
• client.x.tweets.get_thread(id, **params) -> PaginatedTweets
• client.x.tweets.search(**params) -> PaginatedTweets

Like

Types:

from x_twitter_scraper.types.x.tweets import LikeCreateResponse, LikeDeleteResponse

Methods:

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

Retweet

Types:

from x_twitter_scraper.types.x.tweets import RetweetCreateResponse, RetweetDeleteResponse

Methods:

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

Users

Types:

from x_twitter_scraper.types.x import UserProfile

Methods:

• client.x.users.retrieve(id) -> UserProfile
• client.x.users.retrieve_batch(**params) -> PaginatedUsers
• client.x.users.retrieve_followers(id, **params) -> PaginatedUsers
• client.x.users.retrieve_followers_you_know(id, **params) -> PaginatedUsers
• client.x.users.retrieve_following(id, **params) -> PaginatedUsers
• client.x.users.retrieve_likes(id, **params) -> PaginatedTweets
• client.x.users.retrieve_media(id, **params) -> PaginatedTweets
• client.x.users.retrieve_mentions(id, **params) -> PaginatedTweets
• client.x.users.retrieve_search(**params) -> PaginatedUsers
• client.x.users.retrieve_tweets(id, **params) -> PaginatedTweets
• client.x.users.retrieve_verified_followers(id, **params) -> PaginatedUsers

Follow

Types:

from x_twitter_scraper.types.x.users import FollowCreateResponse, FollowDeleteAllResponse

Methods:

• client.x.users.follow.create(id, **params) -> FollowCreateResponse
• client.x.users.follow.delete_all(id, **params) -> FollowDeleteAllResponse

Followers

Types:

from x_twitter_scraper.types.x import FollowerCheckResponse

Methods:

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

Dm

Types:

from x_twitter_scraper.types.x import DmRetrieveHistoryResponse, DmSendResponse

Methods:

• client.x.dm.retrieve_history(user_id, **params) -> DmRetrieveHistoryResponse
• client.x.dm.send(user_id, **params) -> DmSendResponse

Media

Types:

from x_twitter_scraper.types.x import MediaDownloadResponse, MediaUploadResponse

Methods:

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

Profile

Types:

from x_twitter_scraper.types.x import (
    ProfileUpdateResponse,
    ProfileUpdateAvatarResponse,
    ProfileUpdateBannerResponse,
)

Methods:

• client.x.profile.update(**params) -> ProfileUpdateResponse
• client.x.profile.update_avatar(**params) -> ProfileUpdateAvatarResponse
• client.x.profile.update_banner(**params) -> ProfileUpdateBannerResponse

Communities

Types:

from x_twitter_scraper.types.x import (
    CommunityActionResult,
    CommunityCreateResponse,
    CommunityDeleteResponse,
    CommunityRetrieveInfoResponse,
)

Methods:

• client.x.communities.create(**params) -> CommunityCreateResponse
• client.x.communities.delete(id, **params) -> CommunityDeleteResponse
• client.x.communities.retrieve_info(id) -> CommunityRetrieveInfoResponse
• client.x.communities.retrieve_members(id, **params) -> PaginatedUsers
• client.x.communities.retrieve_moderators(id, **params) -> PaginatedUsers
• client.x.communities.retrieve_search(**params) -> PaginatedTweets

Join

Methods:

• client.x.communities.join.create(id, **params) -> CommunityActionResult
• client.x.communities.join.delete_all(id, **params) -> CommunityActionResult

Tweets

Methods:

• client.x.communities.tweets.list(**params) -> PaginatedTweets
• client.x.communities.tweets.list_by_community(id, **params) -> PaginatedTweets

Accounts

Types:

from x_twitter_scraper.types.x import (
    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.bulk_retry() -> AccountBulkRetryResponse
• client.x.accounts.reauth(id, **params) -> AccountReauthResponse

Bookmarks

Types:

from x_twitter_scraper.types.x import BookmarkRetrieveFoldersResponse

Methods:

• client.x.bookmarks.list(**params) -> PaginatedTweets
• client.x.bookmarks.retrieve_folders() -> BookmarkRetrieveFoldersResponse

Lists

Methods:

• client.x.lists.retrieve_followers(id, **params) -> PaginatedUsers
• client.x.lists.retrieve_members(id, **params) -> PaginatedUsers
• client.x.lists.retrieve_tweets(id, **params) -> PaginatedTweets

Trends

Types:

from x_twitter_scraper.types import TrendListResponse

Methods:

• client.trends.list(**params) -> TrendListResponse

Support

Tickets

Types:

from x_twitter_scraper.types.support import (
    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:

from x_twitter_scraper.types import CreditRetrieveBalanceResponse, CreditTopupBalanceResponse

Methods:

• client.credits.retrieve_balance() -> CreditRetrieveBalanceResponse
• client.credits.topup_balance(**params) -> CreditTopupBalanceResponse