twitter-openapi-typescript-generated
v0.1.3
Published
OpenAPI client for twitter-openapi-typescript-generated
Readme
[email protected]
A TypeScript SDK client for the x.com API.
Usage
First, install the SDK from npm.
npm install twitter-openapi-typescript-generated --saveNext, try it out.
import {
Configuration,
BirdwatchApi,
} from 'twitter-openapi-typescript-generated';
import type { GetBirdwatchFetchAliasSelfSelectStatusRequest } from 'twitter-openapi-typescript-generated';
async function example() {
console.log("🚀 Testing twitter-openapi-typescript-generated SDK...");
const config = new Configuration({
// To configure API key authorization: Accept
apiKey: "YOUR API KEY",
// To configure API key authorization: ClientLanguage
apiKey: "YOUR API KEY",
// To configure API key authorization: Priority
apiKey: "YOUR API KEY",
// To configure API key authorization: Referer
apiKey: "YOUR API KEY",
// To configure API key authorization: SecFetchDest
apiKey: "YOUR API KEY",
// To configure API key authorization: SecChUaPlatform
apiKey: "YOUR API KEY",
// To configure API key authorization: SecFetchMode
apiKey: "YOUR API KEY",
// To configure API key authorization: CsrfToken
apiKey: "YOUR API KEY",
// To configure API key authorization: ClientUuid
apiKey: "YOUR API KEY",
// Configure HTTP bearer authorization: BearerAuth
accessToken: "YOUR BEARER TOKEN",
// To configure API key authorization: GuestToken
apiKey: "YOUR API KEY",
// To configure API key authorization: SecChUa
apiKey: "YOUR API KEY",
// To configure API key authorization: CookieGt0
apiKey: "YOUR API KEY",
// To configure API key authorization: ClientTransactionId
apiKey: "YOUR API KEY",
// To configure API key authorization: ActiveUser
apiKey: "YOUR API KEY",
// To configure API key authorization: CookieCt0
apiKey: "YOUR API KEY",
// To configure API key authorization: UserAgent
apiKey: "YOUR API KEY",
// To configure API key authorization: AcceptLanguage
apiKey: "YOUR API KEY",
// To configure API key authorization: SecFetchSite
apiKey: "YOUR API KEY",
// To configure API key authorization: AuthType
apiKey: "YOUR API KEY",
// To configure API key authorization: CookieAuthToken
apiKey: "YOUR API KEY",
// To configure API key authorization: SecChUaMobile
apiKey: "YOUR API KEY",
// To configure API key authorization: AcceptEncoding
apiKey: "YOUR API KEY",
});
const api = new BirdwatchApi(config);
const body = {
// string
pathQueryId: LUEdtkcpBlGktUtms4BvwA,
// string
variables: {},
} satisfies GetBirdwatchFetchAliasSelfSelectStatusRequest;
try {
const data = await api.getBirdwatchFetchAliasSelfSelectStatus(body);
console.log(data);
} catch (error) {
console.error(error);
}
}
// Run the test
example().catch(console.error);Documentation
API Endpoints
All URIs are relative to https://x.com/i/api
| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- BirdwatchApi | getBirdwatchFetchAliasSelfSelectStatus | GET /graphql/{pathQueryId}/BirdwatchFetchAliasSelfSelectStatus | BirdwatchApi | getBirdwatchFetchAuthenticatedUserProfile | GET /graphql/{pathQueryId}/BirdwatchFetchAuthenticatedUserProfile | BirdwatchApi | getBirdwatchFetchBirdwatchProfile | GET /graphql/{pathQueryId}/BirdwatchFetchBirdwatchProfile | BirdwatchApi | getBirdwatchFetchGlobalTimeline | GET /graphql/{pathQueryId}/BirdwatchFetchGlobalTimeline | BirdwatchApi | getBirdwatchFetchPublicData | GET /graphql/{pathQueryId}/BirdwatchFetchPublicData | CommunityApi | getCommunitiesFetchOneQuery | GET /graphql/{pathQueryId}/CommunitiesFetchOneQuery | CommunityApi | getCommunitiesSearchQuery | GET /graphql/{pathQueryId}/CommunitiesSearchQuery | CommunityApi | getCommunityQuery | GET /graphql/{pathQueryId}/CommunityQuery | CommunityApi | getGlobalCommunitiesLatestPostSearchTimeline | GET /graphql/{pathQueryId}/GlobalCommunitiesLatestPostSearchTimeline | CommunityApi | getGlobalCommunitiesPostSearchTimeline | GET /graphql/{pathQueryId}/GlobalCommunitiesPostSearchTimeline | CommunityApi | getTopicCarouselQuery | GET /graphql/{pathQueryId}/TopicCarouselQuery | DefaultApi | getAudioSpaceById | GET /graphql/{pathQueryId}/AudioSpaceById | DefaultApi | getAuthenticatePeriscope | GET /graphql/{pathQueryId}/AuthenticatePeriscope | DefaultApi | getBroadcastQuery | GET /graphql/{pathQueryId}/BroadcastQuery | DefaultApi | getCreatorStudioTabBarItemQuery | GET /graphql/{pathQueryId}/CreatorStudioTabBarItemQuery | DefaultApi | getDataSaverMode | GET /graphql/{pathQueryId}/DataSaverMode | DefaultApi | getGrokAccountJwtQuery | GET /graphql/{pathQueryId}/grokAccountJwtQuery | DefaultApi | getGrokHome | GET /graphql/{pathQueryId}/GrokHome | DefaultApi | getPinnedTimelines | GET /graphql/{pathQueryId}/PinnedTimelines | DefaultApi | getProfileSpotlightsQuery | GET /graphql/{pathQueryId}/ProfileSpotlightsQuery | DefaultApi | getTweetResultByRestId | GET /graphql/{pathQueryId}/TweetResultByRestId | DefaultApi | getUseStoryTopicQuery | GET /graphql/{pathQueryId}/useStoryTopicQuery | OtherApi | other | GET /other | PostApi | postCreateBookmark | POST /graphql/{pathQueryId}/CreateBookmark | PostApi | postCreateDraftTweet | POST /graphql/{pathQueryId}/CreateDraftTweet | PostApi | postCreateList | POST /graphql/{pathQueryId}/CreateList | PostApi | postCreateRetweet | POST /graphql/{pathQueryId}/CreateRetweet | PostApi | postCreateTweet | POST /graphql/{pathQueryId}/CreateTweet | PostApi | postDeleteBookmark | POST /graphql/{pathQueryId}/DeleteBookmark | PostApi | postDeleteDraftTweets | POST /graphql/{pathQueryId}/DeleteDraftTweets | PostApi | postDeleteList | POST /graphql/{pathQueryId}/DeleteList | PostApi | postDeleteRetweet | POST /graphql/{pathQueryId}/DeleteRetweet | PostApi | postDeleteTweet | POST /graphql/{pathQueryId}/DeleteTweet | PostApi | postFavoriteTweet | POST /graphql/{pathQueryId}/FavoriteTweet | PostApi | postListAddMember | POST /graphql/{pathQueryId}/ListAddMember | PostApi | postListRemoveMember | POST /graphql/{pathQueryId}/ListRemoveMember | PostApi | postUnfavoriteTweet | POST /graphql/{pathQueryId}/UnfavoriteTweet | TweetApi | getBookmarkSearchTimeline | GET /graphql/{pathQueryId}/BookmarkSearchTimeline | TweetApi | getBookmarks | GET /graphql/{pathQueryId}/Bookmarks | TweetApi | getCommunityAboutTimeline | GET /graphql/{pathQueryId}/CommunityAboutTimeline | TweetApi | getCommunityDiscoveryTimeline | GET /graphql/{pathQueryId}/CommunityDiscoveryTimeline | TweetApi | getCommunityMediaTimeline | GET /graphql/{pathQueryId}/CommunityMediaTimeline | TweetApi | getCommunityTweetsTimeline | GET /graphql/{pathQueryId}/CommunityTweetsTimeline | TweetApi | getConnectTabTimeline | GET /graphql/{pathQueryId}/ConnectTabTimeline | TweetApi | getExplorePage | GET /graphql/{pathQueryId}/ExplorePage | TweetApi | getExploreSidebar | GET /graphql/{pathQueryId}/ExploreSidebar | TweetApi | getGenericTimelineById | GET /graphql/{pathQueryId}/GenericTimelineById | TweetApi | getHomeLatestTimeline | GET /graphql/{pathQueryId}/HomeLatestTimeline | TweetApi | getHomeTimeline | GET /graphql/{pathQueryId}/HomeTimeline | TweetApi | getLikes | GET /graphql/{pathQueryId}/Likes | TweetApi | getListLatestTweetsTimeline | GET /graphql/{pathQueryId}/ListLatestTweetsTimeline | TweetApi | getNotificationsTimeline | GET /graphql/{pathQueryId}/NotificationsTimeline | TweetApi | getSearchTimeline | GET /graphql/{pathQueryId}/SearchTimeline | TweetApi | getTweetDetail | GET /graphql/{pathQueryId}/TweetDetail | TweetApi | getUserHighlightsTweets | GET /graphql/{pathQueryId}/UserHighlightsTweets | TweetApi | getUserMedia | GET /graphql/{pathQueryId}/UserMedia | TweetApi | getUserOriginalsTimeline | GET /graphql/{pathQueryId}/UserOriginalsTimeline | TweetApi | getUserRepliesTimeline | GET /graphql/{pathQueryId}/UserRepliesTimeline | TweetApi | getUserRepostsTimeline | GET /graphql/{pathQueryId}/UserRepostsTimeline | TweetApi | getUserSuperFollowTweets | GET /graphql/{pathQueryId}/UserSuperFollowTweets | TweetApi | getUserTweets | GET /graphql/{pathQueryId}/UserTweets | TweetApi | getUserTweetsAndReplies | GET /graphql/{pathQueryId}/UserTweetsAndReplies | TweetApi | getUserVideoTimeline | GET /graphql/{pathQueryId}/UserVideoTimeline | UserApi | getAboutAccountQuery | GET /graphql/{pathQueryId}/AboutAccountQuery | UserApi | getFetchDraftTweets | GET /graphql/{pathQueryId}/FetchDraftTweets | UserApi | getFetchScheduledTweets | GET /graphql/{pathQueryId}/FetchScheduledTweets | UserApi | getUserByRestId | GET /graphql/{pathQueryId}/UserByRestId | UserApi | getUserByScreenName | GET /graphql/{pathQueryId}/UserByScreenName | UserApi | getViewerBadgeCounts | GET /graphql/{pathQueryId}/ViewerBadgeCounts | UserListApi | getBlueVerifiedFollowers | GET /graphql/{pathQueryId}/BlueVerifiedFollowers | UserListApi | getCombinedLists | GET /graphql/{pathQueryId}/CombinedLists | UserListApi | getFavoriters | GET /graphql/{pathQueryId}/Favoriters | UserListApi | getFollowers | GET /graphql/{pathQueryId}/Followers | UserListApi | getFollowersYouKnow | GET /graphql/{pathQueryId}/FollowersYouKnow | UserListApi | getFollowing | GET /graphql/{pathQueryId}/Following | UserListApi | getListByRestId | GET /graphql/{pathQueryId}/ListByRestId | UserListApi | getListCreationRecommendedUsers | GET /graphql/{pathQueryId}/ListCreationRecommendedUsers | UserListApi | getListEditRecommendedUsers | GET /graphql/{pathQueryId}/ListEditRecommendedUsers | UserListApi | getListMembers | GET /graphql/{pathQueryId}/ListMembers | UserListApi | getListOwnerships | GET /graphql/{pathQueryId}/ListOwnerships | UserListApi | getListSearchTimeline | GET /graphql/{pathQueryId}/ListSearchTimeline | UserListApi | getListSubscribers | GET /graphql/{pathQueryId}/ListSubscribers | UserListApi | getListsManagementPageTimeline | GET /graphql/{pathQueryId}/ListsManagementPageTimeline | UserListApi | getRetweeters | GET /graphql/{pathQueryId}/Retweeters | UsersApi | getSidebarUserRecommendations | GET /graphql/{pathQueryId}/SidebarUserRecommendations | UsersApi | getUsersByRestIds | GET /graphql/{pathQueryId}/UsersByRestIds | UsersApi | getUsersVerifiedAvatars | GET /graphql/{pathQueryId}/UsersVerifiedAvatars | V11GetApi | getFriendsFollowingList | GET /1.1/friends/following/list.json | V11GetApi | getSearchTypeahead | GET /1.1/search/typeahead.json | V11PostApi | postCreateFriendships | POST /1.1/friendships/create.json | V11PostApi | postDestroyFriendships | POST /1.1/friendships/destroy.json | V20GetApi | getSearchAdaptive | GET /2/search/adaptive.json |
Models
- AboutAccountData
- AboutAccountResponse
- AboutAccountUser
- AboutAccountUserResult
- AboutAccountVerificationInfo
- AboutAccountVerificationInfoReason
- AboutCommunityResult
- AboutCommunityResults
- AboutCommunityTweetData
- AboutProfile
- AboutProfileUsernameChanges
- AdMetadataContainer
- AdditionalMediaInfo
- AdditionalMediaInfoCallToActions
- AdditionalMediaInfoCallToActionsUrl
- AffiliatesHighlightedLabel
- AiTrend
- AiTrendCore
- AiTrendResults
- AiTrendSocialProof
- AllowDownloadStatus
- AnalysisResults
- ApiImage
- ApiMedia
- Article
- ArticleContentBlock
- ArticleContentBlockData
- ArticleContentEntity
- ArticleContentEntityData
- ArticleContentEntityRange
- ArticleContentEntityValue
- ArticleContentInlineStyleRange
- ArticleContentMediaItem
- ArticleContentState
- ArticleContentTextRange
- ArticleCoverMedia
- ArticleCoverMediaInfo
- ArticleLifecycleState
- ArticleMetadata
- ArticlePreview
- ArticleResult
- ArticleResults
- AudioSpace
- AudioSpaceData
- AudioSpaceMentionedUser
- AudioSpaceMetadata
- AudioSpaceParticipant
- AudioSpaceParticipantUser
- AudioSpaceParticipantUserResults
- AudioSpaceParticipantVerification
- AudioSpaceParticipants
- AudioSpaceResponse
- AudioSpaceSharings
- AuthenticatePeriscopeResponse
- AuthenticatePeriscopeResponseData
- AuthorCommunityRelationship
- BadgeCounts
- BirdwatchAliasSelfSelectStatus
- BirdwatchEntity
- BirdwatchEntityRef
- BirdwatchFetchAliasSelfSelectStatusResponse
- BirdwatchFetchAliasSelfSelectStatusResponseData
- BirdwatchFetchAuthenticatedUserProfileResponse
- BirdwatchFetchAuthenticatedUserProfileResponseData
- BirdwatchFetchBirdwatchProfileResponse
- BirdwatchFetchBirdwatchProfileResponseData
- BirdwatchFetchGlobalTimelineResponse
- BirdwatchFetchGlobalTimelineResponseData
- BirdwatchFetchPublicDataResponse
- BirdwatchFetchPublicDataResponseData
- BirdwatchHomePage
- BirdwatchHomePageBody
- BirdwatchHomeTimeline
- BirdwatchPivot
- BirdwatchPivotCallToAction
- BirdwatchPivotFooter
- BirdwatchPivotNote
- BirdwatchPivotSubtitle
- BirdwatchProfile
- BirdwatchPublicDataFile
- BirdwatchPublicDataFileBundle
- BirdwatchViewer
- BookmarkSearch
- BookmarkSearchTimelineResponse
- BookmarkSearchTimelineResponseData
- BookmarksResponse
- BookmarksResponseData
- BookmarksTimeline
- Broadcast
- BroadcastData
- BroadcastEditedReplay
- BroadcastPeriscopeUser
- BroadcastResponse
- Callback
- CashtagAttachment
- CashtagInfo
- ClickTrackingInfo
- ClientEventInfo
- ClientEventInfoDetails
- CommunitiesActions
- CommunitiesFetchOneQueryResponse
- CommunitiesFetchOneQueryResponseData
- CommunitiesSearchQueryResponse
- CommunitiesSearchQueryResponseData
- CommunitiesSearchSlice
- Community
- CommunityAboutTimelineResponse
- CommunityActions
- CommunityBannerMedia
- CommunityBannerMediaInfo
- CommunityDeleteActionResult
- CommunityDiscoveryTimelineResponse
- CommunityDiscoveryTimelineResponseData
- CommunityDiscoveryTimelineViewer
- CommunityFacepileUser
- CommunityFacepileUserResults
- CommunityHashtag
- CommunityHashtagSlice
- CommunityIdUserResults
- CommunityInvitesResult
- CommunityJoinAction
- CommunityJoinActionResultUnion
- CommunityJoinActionUnavailable
- CommunityJoinRequestsResult
- CommunityLeaveActionResult
- CommunityListMembersActionResult
- CommunityMediaTimelineResponse
- CommunityModerationState
- CommunityPageActions
- CommunityPageCommunity
- CommunityPageDeleteActionResult
- CommunityPageInvitesResult
- CommunityPageJoinActionResult
- CommunityPageLeaveActionResult
- CommunityPagePinActionResult
- CommunityPageResults
- CommunityPinActionResult
- CommunityPrimaryTopicName
- CommunityQueryResponse
- CommunityQueryResponseData
- CommunityRelationship
- CommunityRelayRule
- CommunityResult
- CommunityRule
- CommunitySearchCommunity
- CommunitySearchResults
- CommunitySettingsActions
- CommunitySettingsCommunity
- CommunitySettingsCreator
- CommunitySettingsCreatorCore
- CommunitySettingsCreatorResults
- CommunitySettingsCreatorVerification
- CommunitySettingsInvitesResult
- CommunitySettingsResults
- CommunitySubtopic
- CommunityTopic
- CommunityTopicResults
- CommunityTweetsTimelineResponse
- CommunityUnavailable
- CommunityUnion
- CommunityUnpinActionResult
- CommunityUrls
- CommunityUrlsPermalink
- CommunityViewerRelationship
- ConnectTabTimelineResponse
- ConnectTabTimelineResponseData
- ContentDisclosure
- ContentDisclosureAdvertisingDisclosure
- ContentDisclosureAiGeneratedDisclosure
- ContentEntryType
- ContentItemType
- ContentUnion
- ConversationControl
- ConversationDetails
- ConversationMetadata
- ConversationOwner
- ConversationOwnerCore
- ConversationOwnerResults
- CoverCta
- CreateBookmarkResponse
- CreateBookmarkResponseData
- CreateDraftTweetResponse
- CreateDraftTweetResponseData
- CreateDraftTweetResponseTweet
- CreateRetweet
- CreateRetweetResponse
- CreateRetweetResponseData
- CreateRetweetResponseResult
- CreateTweet
- CreateTweetResponse
- CreateTweetResponseData
- CreateTweetResponseResult
- CreatorStudioTabBarItemQueryResponse
- CreatorStudioTabBarItemQueryResponseData
- CtaClientEventInfo
- CtaLimitedActionPrompt
- CtaLimitedActionPromptText
- CursorType
- DataSaverModeResponse
- DataSaverModeResponseData
- DeepsearchHeader
- DeepsearchStep
- DeepsearchWebResult
- DeleteBookmarkResponse
- DeleteBookmarkResponseData
- DeleteDraftTweetsResponse
- DeleteDraftTweetsResponseData
- DeleteListResponse
- DeleteListResponseData
- DeleteRetweet
- DeleteRetweetResponse
- DeleteRetweetResponseData
- DeleteRetweetResponseResult
- DeleteTweetResponse
- DeleteTweetResponseData
- DeleteTweetResponseResult
- DisplayTreatment
- DisplayType
- DraftList
- DraftTweet
- DraftTweetCreateRequest
- DraftTweetUser
- DraftTweetUserResults
- DraftTweetsViewer
- Entities
- ErrorExtensions
- ErrorResponse
- ErrorResponsePathInner
- EventSummaryAdMetadataContainer
- EventSummaryEvent
- EventSummaryMedia
- EventSummaryMediaEntity
- EventSummaryMediaKey
- EventSummaryPromotedMetadata
- ExplorePage
- ExplorePageBody
- ExplorePageResponse
- ExplorePageResponseData
- ExploreSidebarResponse
- ExploreSidebarResponseData
- ExploreTimeline
- ExploreTimelineScribeConfig
- ExtMediaAvailability
- ExtendedEntities
- FavoriteTweet
- FavoriteTweetResponse
- FeedbackAction
- FeedbackActionEntry
- FeedbackClientEventInfo
- FeedbackInfo
- FetchDraftTweetsResponse
- FetchDraftTweetsResponseData
- FetchScheduledTweetsResponse
- FetchScheduledTweetsResponseData
- FollowResponse
- FollowResponseData
- FollowResponseResult
- FollowResponseUser
- FollowTimeline
- GenericTimelineByIdResponse
- GenericTimelineByIdResponseData
- GlobalCommunitiesLatestPostSearch
- GlobalCommunitiesLatestPostSearchTimelineResponse
- GlobalCommunitiesLatestPostSearchTimelineResponseData
- GlobalCommunitiesPostSearch
- GlobalCommunitiesPostSearchTimelineResponse
- GlobalCommunitiesPostSearchTimelineResponseData
- GrokAccountJwt
- GrokAccountJwtData
- GrokAccountJwtResponse
- GrokAnnotation
- GrokEntity
- GrokEntityRef
- GrokHome
- GrokHomeLayout
- GrokHomeLayoutSection
- GrokHomePrompt
- GrokHomeResponse
- GrokHomeResponseData
- GrokImageAnnotation
- GrokModelOption
- GrokShareAttachment
- GrokShareAttachmentItem
- GrokTranslatedBio
- GrokTranslatedBioWithAvailability
- GrokTranslatedCommunityNote
- GrokTranslatedCommunityNoteWithAvailability
- GrokTranslatedPost
- GrokTranslatedPostWithAvailability
- GroupedTrend
- Hashtag
- Highlight
- HomeTimelineHome
- HomeTimelineResponseData
- IdentityProfileLabelsHighlightedLabel
- InstructionType
- InstructionUnion
- ItemContentUnion
- ItemResult
- JetfuelAttachment
- KeyValue
- LandingUrl
- LimitedAction
- LimitedActionResults
- LimitedActionResultsData
- ListBannerMedia
- ListBannerMediaInfo
- ListBannerMediaResults
- ListLatestTweetsTimelineResponse
- ListMembersList
- ListMembersResponse
- ListMembersResponseData
- ListRecommendedUsersList
- ListRecommendedUsersResponse
- ListRecommendedUsersResponseData
- ListResponse
- ListResponseData
- ListSearch
- ListSearchTimelineResponse
- ListSearchTimelineResponseData
- ListSubscribersList
- ListSubscribersResponse
- ListSubscribersResponseData
- ListTweetsTimelineData
- ListTweetsTimelineList
- ListsManagementPageTimelineResponse
- ListsManagementPageTimelineResponseData
- ListsManagementViewer
- Location
- Media
- MediaColorInfo
- MediaColorInfoPalette
- MediaColorInfoPaletteRGB
- MediaCommunityResult
- MediaCommunityResults
- MediaCommunityTweetData
- MediaExtended
- MediaOriginalInfo
- MediaOriginalInfoFocusRect
- MediaResult
- MediaResults
- MediaSalientRect
- MediaSize
- MediaSizes
- MediaStats
- MediaVideoInfo
- MediaVideoInfoVariant
- MediaVisibilityResults
- MediaVisibilityResultsBlurredImageInterstitial
- ModuleEntry
- ModuleFooter
- ModuleHeader
- ModuleItem
- ModuleMetadata
- NoteTweet
- NoteTweetResult
- NoteTweetResultData
- NoteTweetResultMedia
- NoteTweetResultMediaInlineMedia
- NoteTweetResultRichText
- NoteTweetResultRichTextTag
- NotificationDetails
- NotificationTemplate
- NotificationsResult
- NotificationsTimelineData
- NotificationsTimelineResponse
- NotificationsUserResults
- NotificationsViewerV2
- OneFactorLoginEligibility
- OtherObjectAll
- PinnedTimelines
- PinnedTimelinesResponse
- PinnedTimelinesResponseData
- PostCreateBookmarkRequest
- PostCreateBookmarkRequestVariables
- PostCreateDraftTweetRequest
- PostCreateDraftTweetRequestVariables
- PostCreateDraftTweetRequestVariablesPostTweetRequest
- PostCreateListRequest
- PostCreateListRequestFeatures
- PostCreateListRequestVariables
- PostCreateRetweetRequest
- PostCreateRetweetRequestVariables
- PostCreateTweetRequest
- PostCreateTweetRequestFeatures
- PostCreateTweetRequestVariables
- PostCreateTweetRequestVariablesConversationControl
- PostCreateTweetRequestVariablesMedia
- PostCreateTweetRequestVariablesMediaMediaEntitiesInner
- PostCreateTweetRequestVariablesReply
- PostCta
- PostCtaTitleText
- PostCtaTitleTextEntity
- PostCtaTitleTextEntityRef
- PostCtaUserResults
- PostCtaUserResultsAvatar
- PostCtaUserResultsResult
- PostDeleteBookmarkRequest
- PostDeleteDraftTweetsRequest
- PostDeleteDraftTweetsRequestVariables
- PostDeleteListRequest
- PostDeleteListRequestVariables
- PostDeleteRetweetRequest
- PostDeleteRetweetRequestVariables
- PostDeleteTweetRequest
- PostFavoriteTweetRequest
- PostListAddMemberRequest
- PostListAddMemberRequestVariables
- PostListRemoveMemberRequest
- PostUnfavoriteTweetRequest
- PrimaryCommunityTopic
- ProfileBio
- ProfileBioEntities
- ProfileBioEntitiesUrls
- ProfileResponse
- ProfileResponseData
- PromotedMetadata
- PromotedTrend
- QuotedRefResult
- QuotedStatusPermalink
- RankedCommunityResult
- RankedCommunityResults
- RankedCommunityTweetData
- ReaderModeConfig
- Retweet
- RetweetLegacy
- RichMessage
- RichMessageEntity
- RichMessageEntityRef
- ScheduledTweetsViewer
- ScribeConfig
- SearchByRawQuery
- SearchTimeline
- SearchTimelineData
- SearchTimelineResponse
- SelfThread
- SensitiveMediaWarning
- Session
- SidebarUserRecommendation
- SidebarUserRecommendationsData
- SidebarUserRecommendationsResponse
- SliceInfo
- Smarttag
- SmarttagTag
- SmarttagTagInfo
- SocialContextLandingUrl
- SocialContextUnion
- SocialContextUnionType
- StoryTopic
- StoryTopicData
- StoryTopicItem
- StoryTopicResponse
- StoryTopicStories
- SuperFollowUserProfile
- SuperFollowsReplyUserResult
- SuperFollowsReplyUserResultCore
- SuperFollowsReplyUserResultData
- SuperFollowsReplyUserResultLegacy
- Symbol
- Text
- TextEntity
- TextEntityRef
- TextHighlight
- ThumbnailImage
- Timeline
- TimelineAddEntries
- TimelineAddEntry
- TimelineAddToModule
- TimelineClearCache
- TimelineClearEntriesUnreadState
- TimelineCommunity
- TimelineCoverBehavior
- TimelineCoverBehaviorUrl
- TimelineEventSummary
- TimelineFrame
- TimelineGeneralContext
- TimelineHalfCover
- TimelineLabel
- TimelineMarkEntriesUnreadGreaterThanSortIndex
- TimelineMessagePrompt
- TimelineMessagePromptButton
- TimelineMessagePromptButtonAction
- TimelineMessagePromptContent
- TimelineMessagePromptRichText
- TimelineMessagePromptRichTextEntity
- TimelineMessagePromptRichTextEntityRef
- TimelineMetadata
- TimelineNotification
- TimelinePinEntry
- TimelinePrompt
- TimelinePromptCallback
- TimelinePromptContent
- TimelineReplaceEntry
- TimelineResponse
- TimelineResponseObjects
- TimelineResult
- TimelineShowAlert
- TimelineShowAlertColorConfig
- TimelineShowAlertIconDisplayInfo
- TimelineShowAlertRichText
- TimelineShowCover
- TimelineTerminateTimeline
- TimelineTimelineCursor
- TimelineTimelineItem
- TimelineTimelineModule
- TimelineTombstone
- TimelineTopicContext
- TimelineTrend
- TimelineTweet
- TimelineTwitterList
- TimelineUser
- TimelinesDetails
- Timestamp
- TombstoneEntity
- TombstoneInfo
- TombstoneRef
- TombstoneRichText
- TopicCarouselQueryResponse
- TopicCarouselQueryResponseData
- TopicContext
- Tracing
- TrendImage
- TrendMetadata
- TrendPromotedMetadata
- TrendResults
- Tweet
- TweetCard
- TweetCardLegacy
- TweetCardLegacyBindingValue
- TweetCardLegacyBindingValueData
- TweetCardLegacyBindingValueDataImage
- TweetCardPlatform
- TweetCardPlatformAudience
- TweetCardPlatformData
- TweetCardPlatformDevice
- TweetDetailResponse
- TweetDetailResponseData
- TweetEditControl
- TweetEditControlInitial
- TweetEditPrespective
- TweetFavoritersResponse
- TweetFavoritersResponseData
- TweetInterstitial
- TweetInterstitialRevealText
- TweetInterstitialText
- TweetInterstitialTextEntity
- TweetInterstitialTextEntityRef
- TweetLegacy
- TweetLegacyPlace
- TweetLegacyPlaceBoundingBox
- TweetLegacyPoint
- TweetLegacyScopes
- TweetLimitedActionResults
- TweetPostCta
- TweetPreviewDisplay
- TweetPreviewDisplayCta
- TweetPreviewDisplayCtaUrl
- TweetPreviewDisplayTweet
- TweetPreviewDisplayTweetViewCount
- TweetPreviousCounts
- TweetResultByRestIdData
- TweetResultByRestIdResponse
- TweetRetweetersResponse
- TweetRetweetersResponseData
- TweetTombstone
- TweetUnavailable
- TweetUnion
- TweetView
- TweetWithVisibilityResults
- TwitterList
- TypeName
- UnfavoriteTweet
- UnfavoriteTweetResponse
- UnifiedCard
- Url
- UrtEndpointOptions
- UrtEndpointRequestParams
- User
- UserActionCounts
- UserAvatar
- UserBanner
- UserCore
- UserDmPermissions
- UserFeatures
- UserHighlightsInfo
- UserHighlightsTweetsData
- UserHighlightsTweetsResponse
- UserHighlightsTweetsResult
- UserHighlightsTweetsTimeline
- UserHighlightsTweetsUser
- UserLabel
- UserLabelBadge
- UserLabelMentionResults
- UserLabelMentionUser
- UserLabelMentionUserCore
- UserLabelText
- UserLabelTextEntity
- UserLabelTextEntityRef
- UserLabelUrl
- UserLegacy
- UserLegacyExtendedProfile
- UserLegacyExtendedProfileBirthdate
- UserLocation
- UserMediaPermissions
- UserMention
- UserNotificationsSettings
- UserPinnedItems
- UserPrivacy
- UserProfessional
- UserProfessionalCategory
- UserProfile
- UserProfileMetadata
- UserProfileTranslation
- UserRelationshipCounts
- UserRelationshipPerspectives
- UserResponse
- UserResponseData
- UserResultByScreenName
- UserResultByScreenNameCore
- UserResultByScreenNameLegacy
- UserResultByScreenNameResult
- UserResultCore
- UserResultPrivacy
- UserResultRelationshipPerspectives
- UserResults
- UserTipJarSettings
- UserTweetCounts
- UserTweetsData
- UserTweetsResponse
- UserTweetsResultV1
- UserTweetsResultV2
- UserTweetsUser
- UserUnavailable
- UserUnion
- UserValue
- UserVerification
- UserVerificationInfo
- UserVerificationInfoReason
- UserVerificationInfoReasonDescription
- UserVerificationInfoReasonDescriptionEntities
- UserVerificationInfoReasonDescriptionEntitiesRef
- UserWebsite
- UsersResponse
- UsersResponseData
- UsersVerifiedAvatarsResponse
- UsersVerifiedAvatarsResponseData
- VerifiedAvatarUser
- VerifiedAvatarUserResults
- ViewerBadgeCountsResponse
- ViewerBadgeCountsResponseData
- ViewerBadgeCountsResult
- ViewerBadgeCountsUserResults
- ViewerBadgeCountsViewer
Authorization
Authentication schemes defined for the API:
Accept
- Type: API key
- API key parameter name:
Accept - Location: HTTP header
AcceptEncoding
- Type: API key
- API key parameter name:
Accept-Encoding - Location: HTTP header
AcceptLanguage
- Type: API key
- API key parameter name:
Accept-Language - Location: HTTP header
ActiveUser
- Type: API key
- API key parameter name:
x-twitter-active-user - Location: HTTP header
AuthType
- Type: API key
- API key parameter name:
x-twitter-auth-type - Location: HTTP header
BearerAuth
- Type: HTTP Bearer Token authentication
ClientLanguage
- Type: API key
- API key parameter name:
x-twitter-client-language - Location: HTTP header
ClientTransactionId
- Type: API key
- API key parameter name:
x-client-transaction-id - Location: HTTP header
ClientUuid
- Type: API key
- API key parameter name:
x-client-uuid - Location: HTTP header
CookieAuthToken
- Type: API key
- API key parameter name:
auth_token - Location:
CookieCt0
- Type: API key
- API key parameter name:
ct0 - Location:
CookieGt0
- Type: API key
- API key parameter name:
gt0 - Location:
CsrfToken
- Type: API key
- API key parameter name:
x-csrf-token - Location: HTTP header
GuestToken
- Type: API key
- API key parameter name:
x-guest-token - Location: HTTP header
Priority
- Type: API key
- API key parameter name:
Priority - Location: HTTP header
Referer
- Type: API key
- API key parameter name:
Referer - Location: HTTP header
SecChUa
- Type: API key
- API key parameter name:
Sec-Ch-Ua - Location: HTTP header
SecChUaMobile
- Type: API key
- API key parameter name:
Sec-Ch-Ua-Mobile - Location: HTTP header
SecChUaPlatform
- Type: API key
- API key parameter name:
Sec-Ch-Ua-Platform - Location: HTTP header
SecFetchDest
- Type: API key
- API key parameter name:
Sec-Fetch-Dest - Location: HTTP header
SecFetchMode
- Type: API key
- API key parameter name:
Sec-Fetch-Mode - Location: HTTP header
SecFetchSite
- Type: API key
- API key parameter name:
Sec-Fetch-Site - Location: HTTP header
UserAgent
- Type: API key
- API key parameter name:
user-agent - Location: HTTP header
About
This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:
- API version:
0.0.1 - Package version:
0.1.3 - Generator version:
7.26.0 - Build package:
org.openapitools.codegen.languages.TypeScriptFetchClientCodegen
The generated npm module supports the following:
- Environments
- Node.js
- Webpack
- Browserify
- Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
- Module systems
- CommonJS
- ES6 module system
Development
Building
To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:
npm install
npm run buildPublishing
Once you've built the package, you can publish it to npm:
npm publish