X API v2

X API v2 available endpoints

This Motoko client was generated by the OpenAPI Generator project.

• API version: 2.160
• Generator version: 7.20.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.MotokoClientCodegen

Models

• ActivityStreamingResponse
• ActivityStreamingResponseData
• ActivityStreamingResponsePayload
• ActivitySubscription
• ActivitySubscriptionCreateRequest
• ActivitySubscriptionCreateRequestEventType
• ActivitySubscriptionCreateResponse
• ActivitySubscriptionCreateResponseData
• ActivitySubscriptionCreateResponseMeta
• ActivitySubscriptionDeleteResponse
• ActivitySubscriptionDeleteResponseData
• ActivitySubscriptionDeleteResponseMeta
• ActivitySubscriptionFilter
• ActivitySubscriptionFilterDirection
• ActivitySubscriptionGetResponse
• ActivitySubscriptionGetResponseMeta
• ActivitySubscriptionUpdateRequest
• ActivitySubscriptionUpdateResponse
• ActivitySubscriptionUpdateResponseData
• AddOrDeleteRulesRequest
• AddOrDeleteRulesResponse
• AddRulesRequest
• AllowDownloadStatus
• AltText
• Analytics
• AnalyticsDataInner
• AnimatedGif
• AppRulesCount
• AudiencePolicy
• AudiencePolicyCreatorSubscriptionsInner
• BookmarkAddRequest
• BookmarkFolderPostsResponse
• BookmarkFolderPostsResponseDataInner
• BookmarkFolderPostsResponseMeta
• BookmarkFoldersResponse
• BookmarkFoldersResponseDataInner
• BookmarkMutationResponse
• BookmarkMutationResponseData
• CashtagEntity
• CashtagFields
• ChatActionSignature
• ChatAddGroupMembersRequest
• ChatAddGroupMembersResponse
• ChatAddPublicKeyRequest
• ChatAddPublicKeyRequestPublicKey
• ChatAddPublicKeyResponse
• ChatConversation
• ChatConversationParticipantKey
• ChatConversationType
• ChatCreateConversationRequest
• ChatCreateConversationResponse
• ChatCreateConversationResponseData
• ChatGetConversationResponse
• ChatGetConversationResponseMeta
• ChatGetConversationsResponse
• ChatGetConversationsResponseMeta
• ChatInitializeConversationKeysRequest
• ChatInitializeConversationKeysResponse
• ChatInitializeConversationKeysResponseData
• ChatInitializeGroupResponse
• ChatInitializeGroupResponseData
• ChatJuiceboxConfig
• ChatJuiceboxConfigTokenMapInner
• ChatJuiceboxConfigTokenMapInnerValue
• ChatMarkConversationReadRequest
• ChatMarkConversationReadResponse
• ChatMarkConversationReadResponseData
• ChatMediaUploadAppendRequest
• ChatMediaUploadAppendRequestAnyOf
• ChatMediaUploadAppendRequestAnyOf1
• ChatMediaUploadFinalizeRequest
• ChatMediaUploadFinalizeResponse
• ChatMediaUploadFinalizeResponseData
• ChatMediaUploadInitializeRequest
• ChatMediaUploadInitializeResponse
• ChatMediaUploadInitializeResponseData
• ChatMessageEvent
• ChatMessageEventSignature
• ChatMessageSigningKeyInfo
• ChatPublicKey
• ChatSendMessageRequest
• ChatSendMessageResponse
• ChatSendMessageResponseData
• ChatSendTypingIndicatorResponse
• ChatSendTypingIndicatorResponseData
• ClientAppUsage
• ClientDisconnectedProblem
• ClientForbiddenProblem
• ClientForbiddenProblemAllOfReason
• Community
• ComplianceJob
• ComplianceJobStatus
• ComplianceJobType
• ConflictProblem
• Connection
• ConnectionExceptionProblem
• ConnectionExceptionProblemAllOfConnectionIssue
• ContentExpiration
• ContextAnnotation
• ContextAnnotationDomainFields
• ContextAnnotationEntityFields
• CreateAttachmentsMessageRequest
• CreateComplianceJobRequest
• CreateComplianceJobRequestType
• CreateComplianceJobResponse
• CreateDmConversationRequest
• CreateDmConversationRequestConversationType
• CreateDmEventResponse
• CreateDmEventResponseData
• CreateMessageRequest
• CreateNoteRequest
• CreateNoteResponse
• CreateNoteResponseData
• CreateTextMessageRequest
• DeleteDmResponse
• DeleteNoteResponse
• DeleteNoteResponseData
• DeleteRulesRequest
• DeleteRulesRequestDelete
• DisallowedResourceProblem
• DisallowedResourceProblemAllOfResourceType
• DisallowedResourceProblemAllOfSection
• DmEvent
• DmEventAttachments
• DmEventReferencedTweetsInner
• DmMediaAttachment
• DomainRestrictions
• DuplicateRuleProblem
• Engagement
• EngagementErrorsInner
• EngagementMeasurement
• EngagementMeasurementMetricsTimeSeriesInner
• EngagementMeasurementMetricsTimeSeriesInnerValue
• EngagementMeasurementMetricsTimeSeriesInnerValueMetricValuesInner
• EngagementMeasurementMetricsTimeSeriesInnerValueTimestamp
• EngagementMeasurementMetricsTotalInner
• EntityIndicesInclusiveExclusive
• EntityIndicesInclusiveInclusive
• Error_
• EvaluateNoteRequest
• EvaluateNoteResponse
• EvaluateNoteResponseData
• Expansions
• FieldUnauthorizedProblem
• FilteredStreamingTweetResponse
• FilteredStreamingTweetResponseMatchingRulesInner
• FollowActivityResponsePayload
• FoundMediaOrigin
• FullTextEntities
• FullTextEntitiesAnnotationsInner
• GenericProblem
• Geo
• GeoRestrictions
• GeoRestrictionsOneOf
• GeoRestrictionsOneOf1
• GeoType
• Get2ChatConversationsIdResponse
• Get2ChatConversationsIdResponseMeta
• Get2ChatConversationsResponse
• Get2CommunitiesIdResponse
• Get2CommunitiesSearchResponse
• Get2ComplianceJobsIdResponse
• Get2ComplianceJobsResponse
• Get2ComplianceJobsResponseMeta
• Get2ConnectionsResponse
• Get2DmConversationsIdDmEventsResponse
• Get2DmConversationsIdDmEventsResponseMeta
• Get2DmConversationsWithParticipantIdDmEventsResponse
• Get2DmEventsEventIdResponse
• Get2DmEventsResponse
• Get2FdxAccountsAccountidContactResponse
• Get2FdxAccountsAccountidPaymentNetworksResponse
• Get2FdxAccountsAccountidResponse
• Get2FdxAccountsAccountidTransactionsResponse
• Get2FdxCustomersCurrentResponse
• Get2Insights28hrResponse
• Get2InsightsHistoricalResponse
• Get2LikesFirehoseStreamResponse
• Get2LikesSample10StreamResponse
• Get2ListsIdFollowersResponse
• Get2ListsIdMembersResponse
• Get2ListsIdResponse
• Get2ListsIdTweetsResponse
• Get2MarketplaceHandlesHandleAvailabilityResponse
• Get2MediaAnalyticsResponse
• Get2MediaMediaKeyResponse
• Get2MediaResponse
• Get2NewsIdResponse
• Get2NewsSearchResponse
• Get2NotesSearchNotesWrittenResponse
• Get2NotesSearchPostsEligibleForNotesResponse
• Get2SpacesByCreatorIdsResponse
• Get2SpacesIdBuyersResponse
• Get2SpacesIdResponse
• Get2SpacesIdTweetsResponse
• Get2SpacesResponse
• Get2SpacesSearchResponse
• Get2TrendsByWoeidWoeidResponse
• Get2TweetsAnalyticsResponse
• Get2TweetsCountsAllResponse
• Get2TweetsCountsAllResponseMeta
• Get2TweetsCountsRecentResponse
• Get2TweetsFirehoseStreamLangEnResponse
• Get2TweetsFirehoseStreamLangJaResponse
• Get2TweetsFirehoseStreamLangKoResponse
• Get2TweetsFirehoseStreamLangPtResponse
• Get2TweetsFirehoseStreamResponse
• Get2TweetsIdLikingUsersResponse
• Get2TweetsIdQuoteTweetsResponse
• Get2TweetsIdResponse
• Get2TweetsIdRetweetedByResponse
• Get2TweetsIdRetweetsResponse
• Get2TweetsResponse
• Get2TweetsSample10StreamResponse
• Get2TweetsSampleStreamResponse
• Get2TweetsSearchAllResponse
• Get2TweetsSearchAllResponseMeta
• Get2TweetsSearchRecentResponse
• Get2TweetsSearchStreamResponse
• Get2TweetsSearchStreamRulesCountsResponse
• Get2UsageTweetsResponse
• Get2UsersByResponse
• Get2UsersByUsernameUsernameResponse
• Get2UsersIdAffiliatesResponse
• Get2UsersIdBlockingResponse
• Get2UsersIdBookmarksResponse
• Get2UsersIdFollowedListsResponse
• Get2UsersIdFollowersResponse
• Get2UsersIdFollowingResponse
• Get2UsersIdLikedTweetsResponse
• Get2UsersIdListMembershipsResponse
• Get2UsersIdMentionsResponse
• Get2UsersIdMentionsResponseMeta
• Get2UsersIdMutingResponse
• Get2UsersIdOwnedListsResponse
• Get2UsersIdPinnedListsResponse
• Get2UsersIdPublicKeysResponse
• Get2UsersIdResponse
• Get2UsersIdTimelinesReverseChronologicalResponse
• Get2UsersIdTweetsResponse
• Get2UsersMeResponse
• Get2UsersPersonalizedTrendsResponse
• Get2UsersPublicKeysResponse
• Get2UsersRepostsOfMeResponse
• Get2UsersResponse
• Get2UsersSearchResponse
• Get2UsersSearchResponseMeta
• Get2WebhooksResponse
• GetChatConversationChatMessageEventFieldsParameterInner
• GetChatConversationsChatConversationFieldsParameterInner
• GetChatConversationsExpansionsParameterInner
• GetChatConversationsUserFieldsParameterInner
• GetComplianceJobsComplianceJobFieldsParameterInner
• GetComplianceJobsStatusParameter
• GetComplianceJobsTypeParameter
• GetConnectionHistoryConnectionFieldsParameterInner
• GetConnectionHistoryEndpointsParameterInner
• GetConnectionHistoryStatusParameter
• GetDirectMessagesEventsByParticipantIdDmEventFieldsParameterInner
• GetDirectMessagesEventsByParticipantIdEventTypesParameterInner
• GetDirectMessagesEventsByParticipantIdExpansionsParameterInner
• GetDirectMessagesEventsByParticipantIdMediaFieldsParameterInner
• GetDirectMessagesEventsByParticipantIdTweetFieldsParameterInner
• GetInsights28HrEngagementFieldsParameterInner
• GetInsights28HrGranularityParameter
• GetInsights28HrRequestedMetricsParameterInner
• GetListsByIdExpansionsParameterInner
• GetListsByIdListFieldsParameterInner
• GetListsFollowersExpansionsParameterInner
• GetListsPostsExpansionsParameterInner
• GetListsPostsPlaceFieldsParameterInner
• GetListsPostsPollFieldsParameterInner
• GetMediaAnalyticsGranularityParameter
• GetMediaAnalyticsMediaAnalyticsFieldsParameterInner
• GetMediaUploadStatusCommandParameter
• GetPostsAnalyticsAnalyticsFieldsParameterInner
• GetPostsAnalyticsGranularityParameter
• GetPostsCountsAllGranularityParameter
• GetPostsCountsAllSearchCountFieldsParameterInner
• GetPostsQuotedPostsExcludeParameterInner
• GetRuleCountsRulesCountFieldsParameterInner
• GetSpacesByIdsExpansionsParameterInner
• GetSpacesByIdsSpaceFieldsParameterInner
• GetSpacesByIdsTopicFieldsParameterInner
• GetTrendsByWoeidTrendFieldsParameterInner
• GetTrendsPersonalizedTrendsPersonalizedTrendFieldsParameterInner
• GetUsageUsageFieldsParameterInner
• GetUsersPublicKeysPublicKeyFieldsParameterInner
• GetWebhooksWebhookConfigFieldsParameterInner
• HashtagEntity
• HashtagFields
• InvalidRequestProblem
• InvalidRequestProblemAllOfErrors
• InvalidRuleProblem
• KillAllConnectionsResponse
• KillAllConnectionsResponseData
• KillAllConnectionsResponseDataResultsInner
• KillConnectionsByEndpointResponse
• KillConnectionsByUuidsRequest
• KillConnectionsByUuidsResponse
• LikeComplianceSchema
• LikeWithTweetAuthor
• LikesComplianceStreamResponse
• LikesComplianceStreamResponseOneOf
• LikesComplianceStreamResponseOneOf1
• List
• ListAddUserRequest
• ListCreateRequest
• ListCreateResponse
• ListCreateResponseData
• ListDeleteResponse
• ListFollowedRequest
• ListFollowedResponse
• ListFollowedResponseData
• ListMutateResponse
• ListMutateResponseData
• ListPinnedRequest
• ListPinnedResponse
• ListPinnedResponseData
• ListUnpinResponse
• ListUpdateRequest
• ListUpdateResponse
• ListUpdateResponseData
• ManagementInfo
• MarketplaceHandleAvailability
• Media
• MediaAnalytics
• MediaAnalyticsDataInner
• MediaCategory
• MediaCategoryOneShot
• MediaCategorySubtitles
• MediaMetrics
• MediaSegments
• MediaTimestampedMetrics
• MediaUploadAppendRequest
• MediaUploadAppendRequestAnyOf
• MediaUploadAppendRequestAnyOf1
• MediaUploadAppendResponse
• MediaUploadAppendResponseData
• MediaUploadConfigRequest
• MediaUploadConfigRequestMediaType
• MediaUploadRequestOneShot
• MediaUploadRequestOneShotMedia
• MediaUploadRequestOneShotMediaType
• MediaUploadResponse
• MediaUploadResponseData
• MentionEntity
• MentionFields
• MetadataCreateRequest
• MetadataCreateRequestMetadata
• MetadataCreateResponse
• MetadataCreateResponseData
• Metrics
• MisleadingTags
• MuteUserMutationResponse
• MuteUserMutationResponseData
• MuteUserRequest
• News
• NewsActivityResponsePayload
• NewsClusterPostsResultsInner
• NewsContexts
• NewsContextsEntities
• NewsContextsFinance
• NewsContextsSports
• NonCompliantRulesProblem
• Note
• NoteClassification
• NoteInfo
• NoteRatingStatus
• NoteTestResult
• Oauth1PermissionsProblem
• OperationalDisconnectProblem
• OperationalDisconnectProblemAllOfDisconnectType
• PersonalizedTrend
• Photo
• Place
• PlaceType
• PlaidAccount
• PlaidAccountContact
• PlaidAccountPaymentNetwork
• PlaidAccountTransaction
• PlaidAddress
• PlaidCurrency
• PlaidCustomer
• PlaidName
• PlaidTelephone
• Point
• PointType
• Poll
• PollOption
• PollVotingStatus
• PreviewImage
• PreviewImageMediaKey
• PreviewImageMediaKeyMediaCategory
• Problem
• ProcessingInfo
• ProcessingInfoState
• ProfileUpdateActivityResponsePayload
• PublicKey
• PublicKeyTokenMap
• PublicKeyTokenMapRealmsInner
• ReplayJobCreateResponse
• ReplySettings
• ReplySettingsWithVerifiedUsers
• ResourceNotFoundProblem
• ResourceUnauthorizedProblem
• ResourceUnavailableProblem
• Rule
• RuleNoId
• RulesCapProblem
• RulesCount
• RulesLookupResponse
• RulesRequestSummary
• RulesRequestSummaryOneOf
• RulesRequestSummaryOneOf1
• RulesResponseMetadata
• SearchCommunitiesCommunityFieldsParameterInner
• SearchCommunityNotesWrittenNoteFieldsParameterInner
• SearchCount
• SearchNewsNewsFieldsParameterInner
• SearchPostsAllSortOrderParameter
• SearchSpacesStateParameter
• SensitiveMediaWarning
• SharedInfo
• Space
• SpaceState
• SpaceTopicsInner
• Sticker
• StickerInfo
• StreamLikesFirehoseExpansionsParameterInner
• StreamLikesFirehoseLikeWithTweetAuthorFieldsParameterInner
• StreamingLikeResponseV2
• StreamingTweetResponse
• SubscriptionsCountGetResponse
• SubscriptionsCountGetResponseData
• SubscriptionsCreateResponse
• SubscriptionsCreateResponseData
• SubscriptionsDeleteResponse
• SubscriptionsGetResponse
• SubscriptionsListGetResponse
• SubscriptionsListGetResponseData
• SubscriptionsListGetResponseDataSubscriptionsInner
• Subtitles
• SubtitlesCreateRequest
• SubtitlesCreateResponse
• SubtitlesCreateResponseData
• SubtitlesDeleteRequest
• SubtitlesDeleteResponse
• TimestampedMetrics
• Topic
• Trend
• Tweet
• TweetAttachments
• TweetComplianceData
• TweetComplianceSchema
• TweetComplianceSchemaTweet
• TweetComplianceStreamResponse
• TweetComplianceStreamResponseOneOf
• TweetCreateRequest
• TweetCreateRequestEditOptions
• TweetCreateRequestGeo
• TweetCreateRequestMedia
• TweetCreateRequestPoll
• TweetCreateRequestPollReplySettings
• TweetCreateRequestReply
• TweetCreateResponse
• TweetCreateResponseData
• TweetDeleteComplianceSchema
• TweetDeleteResponse
• TweetDropComplianceSchema
• TweetEditComplianceObjectSchema
• TweetEditComplianceSchema
• TweetEditControls
• TweetGeo
• TweetHideRequest
• TweetHideResponse
• TweetHideResponseData
• TweetLabelData
• TweetLabelStreamResponse
• TweetLabelStreamResponseOneOf
• TweetNonPublicMetrics
• TweetNoteTweet
• TweetNoteTweetEntities
• TweetNotice
• TweetNoticeSchema
• TweetOrganicMetrics
• TweetPromotedMetrics
• TweetPublicMetrics
• TweetReferencedTweetsInner
• TweetReferencedTweetsInnerType
• TweetScopes
• TweetSuggestedSourceLinksWithCounts
• TweetTakedownComplianceSchema
• TweetUndropComplianceSchema
• TweetUnviewable
• TweetUnviewableSchema
• TweetWithheld
• TweetWithheldComplianceSchema
• TweetWithheldScope
• UnlikeComplianceSchema
• UnlikeComplianceSchemaFavorite
• UnsupportedAuthenticationProblem
• UploadSource
• UrlEntity
• UrlEntityDm
• UrlFields
• UrlImage
• Usage
• UsageCapExceededProblem
• UsageCapExceededProblemAllOfPeriod
• UsageCapExceededProblemAllOfScope
• UsageDailyProjectUsage
• UsageFields
• User
• UserAffiliation
• UserComplianceData
• UserComplianceSchema
• UserComplianceSchemaUser
• UserComplianceStreamResponse
• UserComplianceStreamResponseOneOf
• UserConnectionStatusInner
• UserDeleteComplianceSchema
• UserEntities
• UserEntitiesUrl
• UserProfileModificationComplianceSchema
• UserProfileModificationObjectSchema
• UserProtectComplianceSchema
• UserPublicMetrics
• UserScrubGeoObjectSchema
• UserScrubGeoSchema
• UserSubscriptionType
• UserSuspendComplianceSchema
• UserTakedownComplianceSchema
• UserUndeleteComplianceSchema
• UserUnprotectComplianceSchema
• UserUnsuspendComplianceSchema
• UserVerifiedType
• UserWithheld
• UserWithheldComplianceSchema
• UserWithheldScope
• UsersDMBlockCreateResponse
• UsersDMBlockCreateResponseData
• UsersDMUnBlockCreateResponse
• UsersFollowingCreateRequest
• UsersFollowingCreateResponse
• UsersFollowingCreateResponseData
• UsersFollowingDeleteResponse
• UsersLikesCreateRequest
• UsersLikesCreateResponse
• UsersLikesCreateResponseData
• UsersLikesDeleteResponse
• UsersRetweetsCreateRequest
• UsersRetweetsCreateResponse
• UsersRetweetsCreateResponseData
• UsersRetweetsDeleteResponse
• UsersRetweetsDeleteResponseData
• Variant
• Video
• VideoAllOfNonPublicMetrics
• VideoAllOfOrganicMetrics
• VideoAllOfPromotedMetrics
• VideoAllOfPublicMetrics
• WebhookConfig
• WebhookConfigCreateRequest
• WebhookConfigCreateResponse
• WebhookConfigDeleteResponse
• WebhookConfigPutResponse
• WebhookConfigPutResponseData
• WebhookLinksCreateResponse
• WebhookLinksCreateResponseData
• WebhookLinksDeleteResponse
• WebhookLinksGetResponse
• WebhookLinksGetResponseData
• WebhookLinksGetResponseDataLinksInner
• WebhookReplayCreateRequest

APIs

• AccountActivityApi
• ActivityApi
• BookmarksApi
• ChatApi
• CommunitiesApi
• CommunityNotesApi
• ComplianceApi
• ConnectionsApi
• DirectMessagesApi
• GeneralApi
• LikesApi
• ListsApi
• MediaApi
• NewsApi
• SpacesApi
• StreamApi
• TrendsApi
• TweetsApi
• UsageApi
• UsersApi
• WebhooksApi

Installation

This is a Motoko module that can be used in your Internet Computer project.

Usage

Import the generated API modules in your Motoko code:

import SomeApi "mo:x-client/Apis/SomeApi";
// or using destructuring for specific functions
import { someFunction } "mo:x-client/Apis/SomeApi";

Configure and call the API:

import { defaultConfig } "mo:x-client/Config";

// Use the default config as-is, or customize specific fields:
let config = { defaultConfig with auth = ?#bearer "my-token" };

let result = await* SomeApi.someFunction(config, ...);

The defaultConfig has baseUrl pre-set to the API's base URL, cycles = 30_000_000_000, and all optional fields set to null.

Alternatively, use the suite-based API to bind config once and call multiple functions without threading it through each call:

import { SomeApi } "mo:x-client/Apis/SomeApi";

let api = SomeApi(config);
let result = await api.someFunction(...);
let other = await api.anotherFunction(...);

HTTP Outcalls and Cycles

The generated API client makes HTTP outcalls using the Internet Computer's management canister. HTTP outcalls require cycles to execute.

Important: Before calling any API endpoints, ensure your canister has sufficient cycles:

For local development:

# Get your canister ID
CANISTER_ID=$(dfx canister id your_canister_name)

# Add cycles (100 trillion cycles for testing)
dfx ledger fabricate-cycles --canister "$CANISTER_ID" --amount 100000000000000

For production deployment, you'll need to fund your canister with cycles through the NNS or cycles wallet.

Each HTTP outcall typically costs around 20-50 million cycles depending on the request/response size.