components: parameters: AnalyticsFieldsParameter: description: A comma separated list of Analytics fields to display. explode: false in: query name: analytics.fields required: false schema: description: The fields available for a Analytics object. example: - app_install_attempts - app_opens - bookmarks - detail_expands - email_tweet - engagements - follows - hashtag_clicks - id - impressions - likes - media_views - permalink_clicks - quote_tweets - replies - retweets - shares - timestamp - unfollows - unlikes - url_clicks - user_profile_clicks items: enum: - app_install_attempts - app_opens - bookmarks - detail_expands - email_tweet - engagements - follows - hashtag_clicks - id - impressions - likes - media_views - permalink_clicks - quote_tweets - replies - retweets - shares - timestamp - unfollows - unlikes - url_clicks - user_profile_clicks type: string minItems: 1 type: array uniqueItems: true style: form CommunityFieldsParameter: description: A comma separated list of Community fields to display. explode: false in: query name: community.fields required: false schema: description: The fields available for a Community object. example: - access - created_at - description - id - join_policy - member_count - name items: enum: - access - created_at - description - id - join_policy - member_count - name type: string minItems: 1 type: array uniqueItems: true style: form ComplianceJobFieldsParameter: description: A comma separated list of ComplianceJob fields to display. explode: false in: query name: compliance_job.fields required: false schema: description: The fields available for a ComplianceJob object. example: - created_at - download_expires_at - download_url - id - name - resumable - status - type - upload_expires_at - upload_url items: enum: - created_at - download_expires_at - download_url - id - name - resumable - status - type - upload_expires_at - upload_url type: string minItems: 1 type: array uniqueItems: true style: form ConnectionFieldsParameter: description: A comma separated list of Connection fields to display. explode: false in: query name: connection.fields required: false schema: description: The fields available for a Connection object. example: - client_ip - connected_at - disconnect_reason - disconnected_at - endpoint_name - id items: enum: - client_ip - connected_at - disconnect_reason - disconnected_at - endpoint_name - id type: string minItems: 1 type: array uniqueItems: true style: form DmConversationFieldsParameter: description: A comma separated list of DmConversation fields to display. explode: false in: query name: dm_conversation.fields required: false schema: description: The fields available for a DmConversation object. example: - id items: enum: - id type: string minItems: 1 type: array uniqueItems: true style: form DmEventExpansionsParameter: description: A comma separated list of fields to expand. explode: false in: query name: expansions schema: description: The list of fields you can expand for a [DmEvent](#DmEvent) object. If the field has an ID, it can be expanded into a full object. example: - attachments.media_keys - participant_ids - referenced_tweets.id - sender_id items: enum: - attachments.media_keys - participant_ids - referenced_tweets.id - sender_id type: string minItems: 1 type: array uniqueItems: true style: form DmEventFieldsParameter: description: A comma separated list of DmEvent fields to display. explode: false in: query name: dm_event.fields required: false schema: description: The fields available for a DmEvent object. example: - attachments - created_at - dm_conversation_id - entities - event_type - id - participant_ids - referenced_tweets - sender_id - text items: enum: - attachments - created_at - dm_conversation_id - entities - event_type - id - participant_ids - referenced_tweets - sender_id - text type: string minItems: 1 type: array uniqueItems: true style: form EngagementFieldsParameter: description: A comma separated list of Engagement fields to display. explode: false in: query name: engagement.fields required: false schema: description: The fields available for a Engagement object. example: - errors - measurement items: enum: - errors - measurement type: string minItems: 1 type: array uniqueItems: true style: form LikeExpansionsParameter: description: A comma separated list of fields to expand. explode: false in: query name: expansions schema: description: The list of fields you can expand for a [Like](#Like) object. If the field has an ID, it can be expanded into a full object. example: - liked_tweet_id items: enum: - liked_tweet_id type: string minItems: 1 type: array uniqueItems: true style: form LikeFieldsParameter: description: A comma separated list of Like fields to display. explode: false in: query name: like.fields required: false schema: description: The fields available for a Like object. example: - created_at - id - liked_tweet_id - timestamp_ms items: enum: - created_at - id - liked_tweet_id - timestamp_ms type: string minItems: 1 type: array uniqueItems: true style: form LikeWithTweetAuthorExpansionsParameter: description: A comma separated list of fields to expand. explode: false in: query name: expansions schema: description: The list of fields you can expand for a [LikeWithTweetAuthor](#LikeWithTweetAuthor) object. If the field has an ID, it can be expanded into a full object. example: - liked_tweet_author_id - liked_tweet_id items: enum: - liked_tweet_author_id - liked_tweet_id type: string minItems: 1 type: array uniqueItems: true style: form LikeWithTweetAuthorFieldsParameter: description: A comma separated list of LikeWithTweetAuthor fields to display. explode: false in: query name: like_with_tweet_author.fields required: false schema: description: The fields available for a LikeWithTweetAuthor object. example: - created_at - id - liked_tweet_author_id - liked_tweet_id - timestamp_ms items: enum: - created_at - id - liked_tweet_author_id - liked_tweet_id - timestamp_ms type: string minItems: 1 type: array uniqueItems: true style: form ListExpansionsParameter: description: A comma separated list of fields to expand. explode: false in: query name: expansions schema: description: The list of fields you can expand for a [List](#List) object. If the field has an ID, it can be expanded into a full object. example: - owner_id items: enum: - owner_id type: string minItems: 1 type: array uniqueItems: true style: form ListFieldsParameter: description: A comma separated list of List fields to display. explode: false in: query name: list.fields required: false schema: description: The fields available for a List object. example: - created_at - description - follower_count - id - member_count - name - owner_id - private items: enum: - created_at - description - follower_count - id - member_count - name - owner_id - private type: string minItems: 1 type: array uniqueItems: true style: form MediaAnalyticsFieldsParameter: description: A comma separated list of MediaAnalytics fields to display. explode: false in: query name: media_analytics.fields required: false schema: description: The fields available for a MediaAnalytics object. example: - cta_url_clicks - cta_watch_clicks - media_key - play_from_tap - playback25 - playback50 - playback75 - playback_complete - playback_start - timestamp - video_views - watch_time_ms items: enum: - cta_url_clicks - cta_watch_clicks - media_key - play_from_tap - playback25 - playback50 - playback75 - playback_complete - playback_start - timestamp - video_views - watch_time_ms type: string minItems: 1 type: array uniqueItems: true style: form MediaFieldsParameter: description: A comma separated list of Media fields to display. explode: false in: query name: media.fields required: false schema: description: The fields available for a Media object. example: - alt_text - duration_ms - height - media_key - non_public_metrics - organic_metrics - preview_image_url - promoted_metrics - public_metrics - type - url - variants - width items: enum: - alt_text - duration_ms - height - media_key - non_public_metrics - organic_metrics - preview_image_url - promoted_metrics - public_metrics - type - url - variants - width type: string minItems: 1 type: array uniqueItems: true style: form NewsFieldsParameter: description: A comma separated list of News fields to display. explode: false in: query name: news.fields required: false schema: description: The fields available for a News object. example: - category - cluster_posts_results - contexts - disclaimer - hook - id - keywords - name - summary - updated_at items: enum: - category - cluster_posts_results - contexts - disclaimer - hook - id - keywords - name - summary - updated_at type: string minItems: 1 type: array uniqueItems: true style: form NoteFieldsParameter: description: A comma separated list of Note fields to display. explode: false in: query name: note.fields required: false schema: description: The fields available for a Note object. example: - id - info - status - test_result items: enum: - id - info - status - test_result type: string minItems: 1 type: array uniqueItems: true style: form PersonalizedTrendFieldsParameter: description: A comma separated list of PersonalizedTrend fields to display. explode: false in: query name: personalized_trend.fields required: false schema: description: The fields available for a PersonalizedTrend object. example: - category - post_count - trend_name - trending_since items: enum: - category - post_count - trend_name - trending_since type: string minItems: 1 type: array uniqueItems: true style: form PlaceFieldsParameter: description: A comma separated list of Place fields to display. explode: false in: query name: place.fields required: false schema: description: The fields available for a Place object. example: - contained_within - country - country_code - full_name - geo - id - name - place_type items: enum: - contained_within - country - country_code - full_name - geo - id - name - place_type type: string minItems: 1 type: array uniqueItems: true style: form PlaidAccountContactFieldsParameter: description: A comma separated list of PlaidAccountContact fields to display. explode: false in: query name: plaid_account_contact.fields required: false schema: description: The fields available for a PlaidAccountContact object. example: - addresses - emails - holders - telephones items: enum: - addresses - emails - holders - telephones type: string minItems: 1 type: array uniqueItems: true style: form PlaidAccountFieldsParameter: description: A comma separated list of PlaidAccount fields to display. explode: false in: query name: plaid_account.fields required: false schema: description: The fields available for a PlaidAccount object. example: - accountCategory - accountId - accountNumberDisplay - accountType - availableBalance - currency - currentBalance - nickname - productName - status items: enum: - accountCategory - accountId - accountNumberDisplay - accountType - availableBalance - currency - currentBalance - nickname - productName - status type: string minItems: 1 type: array uniqueItems: true style: form PlaidAccountPaymentNetworkFieldsParameter: description: A comma separated list of PlaidAccountPaymentNetwork fields to display. explode: false in: query name: plaid_account_payment_network.fields required: false schema: description: The fields available for a PlaidAccountPaymentNetwork object. example: - bankId - identifier - transferIn - transferOut - type items: enum: - bankId - identifier - transferIn - transferOut - type type: string minItems: 1 type: array uniqueItems: true style: form PlaidAccountTransactionFieldsParameter: description: A comma separated list of PlaidAccountTransaction fields to display. explode: false in: query name: plaid_account_transaction.fields required: false schema: description: The fields available for a PlaidAccountTransaction object. example: - accountCategory - amount - debitCreditMemo - description - postedTimestamp - status - transactionId - transactionTimestamp items: enum: - accountCategory - amount - debitCreditMemo - description - postedTimestamp - status - transactionId - transactionTimestamp type: string minItems: 1 type: array uniqueItems: true style: form PlaidCustomerFieldsParameter: description: A comma separated list of PlaidCustomer fields to display. explode: false in: query name: plaid_customer.fields required: false schema: description: The fields available for a PlaidCustomer object. example: - customerId items: enum: - customerId type: string minItems: 1 type: array uniqueItems: true style: form PollFieldsParameter: description: A comma separated list of Poll fields to display. explode: false in: query name: poll.fields required: false schema: description: The fields available for a Poll object. example: - duration_minutes - end_datetime - id - options - voting_status items: enum: - duration_minutes - end_datetime - id - options - voting_status type: string minItems: 1 type: array uniqueItems: true style: form RulesCountFieldsParameter: description: A comma separated list of RulesCount fields to display. explode: false in: query name: rules_count.fields required: false schema: description: The fields available for a RulesCount object. example: - all_project_client_apps - cap_per_client_app - cap_per_project - client_app_rules_count - project_rules_count items: enum: - all_project_client_apps - cap_per_client_app - cap_per_project - client_app_rules_count - project_rules_count type: string minItems: 1 type: array uniqueItems: true style: form SearchCountFieldsParameter: description: A comma separated list of SearchCount fields to display. explode: false in: query name: search_count.fields required: false schema: description: The fields available for a SearchCount object. example: - end - start - tweet_count items: enum: - end - start - tweet_count type: string minItems: 1 type: array uniqueItems: true style: form SpaceExpansionsParameter: description: A comma separated list of fields to expand. explode: false in: query name: expansions schema: description: The list of fields you can expand for a [Space](#Space) object. If the field has an ID, it can be expanded into a full object. example: - creator_id - host_ids - invited_user_ids - speaker_ids - topic_ids items: enum: - creator_id - host_ids - invited_user_ids - speaker_ids - topic_ids type: string minItems: 1 type: array uniqueItems: true style: form SpaceFieldsParameter: description: A comma separated list of Space fields to display. explode: false in: query name: space.fields required: false schema: description: The fields available for a Space object. example: - created_at - creator_id - ended_at - host_ids - id - invited_user_ids - is_ticketed - lang - participant_count - scheduled_start - speaker_ids - started_at - state - subscriber_count - title - topic_ids - updated_at items: enum: - created_at - creator_id - ended_at - host_ids - id - invited_user_ids - is_ticketed - lang - participant_count - scheduled_start - speaker_ids - started_at - state - subscriber_count - title - topic_ids - updated_at type: string minItems: 1 type: array uniqueItems: true style: form TopicFieldsParameter: description: A comma separated list of Topic fields to display. explode: false in: query name: topic.fields required: false schema: description: The fields available for a Topic object. example: - description - id - name items: enum: - description - id - name type: string minItems: 1 type: array uniqueItems: true style: form TrendFieldsParameter: description: A comma separated list of Trend fields to display. explode: false in: query name: trend.fields required: false schema: description: The fields available for a Trend object. example: - trend_name - tweet_count items: enum: - trend_name - tweet_count type: string minItems: 1 type: array uniqueItems: true style: form TweetExpansionsParameter: description: A comma separated list of fields to expand. explode: false in: query name: expansions schema: description: The list of fields you can expand for a [Tweet](#Tweet) object. If the field has an ID, it can be expanded into a full object. example: - article.cover_media - article.media_entities - attachments.media_keys - attachments.media_source_tweet - attachments.poll_ids - author_id - edit_history_tweet_ids - entities.mentions.username - geo.place_id - in_reply_to_user_id - entities.note.mentions.username - referenced_tweets.id - referenced_tweets.id.attachments.media_keys - referenced_tweets.id.author_id items: enum: - article.cover_media - article.media_entities - attachments.media_keys - attachments.media_source_tweet - attachments.poll_ids - author_id - edit_history_tweet_ids - entities.mentions.username - geo.place_id - in_reply_to_user_id - entities.note.mentions.username - referenced_tweets.id - referenced_tweets.id.attachments.media_keys - referenced_tweets.id.author_id type: string minItems: 1 type: array uniqueItems: true style: form TweetFieldsParameter: description: A comma separated list of Tweet fields to display. explode: false in: query name: tweet.fields required: false schema: description: The fields available for a Tweet object. example: - article - attachments - author_id - card_uri - community_id - context_annotations - conversation_id - created_at - display_text_range - edit_controls - edit_history_tweet_ids - entities - geo - id - in_reply_to_user_id - lang - media_metadata - non_public_metrics - note_tweet - organic_metrics - possibly_sensitive - promoted_metrics - public_metrics - referenced_tweets - reply_settings - scopes - source - suggested_source_links - suggested_source_links_with_counts - text - withheld items: enum: - article - attachments - author_id - card_uri - community_id - context_annotations - conversation_id - created_at - display_text_range - edit_controls - edit_history_tweet_ids - entities - geo - id - in_reply_to_user_id - lang - media_metadata - non_public_metrics - note_tweet - organic_metrics - possibly_sensitive - promoted_metrics - public_metrics - referenced_tweets - reply_settings - scopes - source - suggested_source_links - suggested_source_links_with_counts - text - withheld type: string minItems: 1 type: array uniqueItems: true style: form UsageFieldsParameter: description: A comma separated list of Usage fields to display. explode: false in: query name: usage.fields required: false schema: description: The fields available for a Usage object. example: - cap_reset_day - daily_client_app_usage - daily_project_usage - project_cap - project_id - project_usage items: enum: - cap_reset_day - daily_client_app_usage - daily_project_usage - project_cap - project_id - project_usage type: string minItems: 1 type: array uniqueItems: true style: form UserExpansionsParameter: description: A comma separated list of fields to expand. explode: false in: query name: expansions schema: description: The list of fields you can expand for a [User](#User) object. If the field has an ID, it can be expanded into a full object. example: - affiliation.user_id - most_recent_tweet_id - pinned_tweet_id items: enum: - affiliation.user_id - most_recent_tweet_id - pinned_tweet_id type: string minItems: 1 type: array uniqueItems: true style: form UserFieldsParameter: description: A comma separated list of User fields to display. explode: false in: query name: user.fields required: false schema: description: The fields available for a User object. example: - affiliation - confirmed_email - connection_status - created_at - description - entities - id - is_identity_verified - location - most_recent_tweet_id - name - parody - pinned_tweet_id - profile_banner_url - profile_image_url - protected - public_metrics - receives_your_dm - subscription - subscription_type - url - username - verified - verified_followers_count - verified_type - withheld items: enum: - affiliation - confirmed_email - connection_status - created_at - description - entities - id - is_identity_verified - location - most_recent_tweet_id - name - parody - pinned_tweet_id - profile_banner_url - profile_image_url - protected - public_metrics - receives_your_dm - subscription - subscription_type - url - username - verified - verified_followers_count - verified_type - withheld type: string minItems: 1 type: array uniqueItems: true style: form WebhookConfigFieldsParameter: description: A comma separated list of WebhookConfig fields to display. explode: false in: query name: webhook_config.fields required: false schema: description: The fields available for a WebhookConfig object. example: - created_at - id - url - valid items: enum: - created_at - id - url - valid type: string minItems: 1 type: array uniqueItems: true style: form schemas: ActivityEventId: description: The unique identifier of an Activity event. example: '1146654567674912769' pattern: ^[0-9]{1,19}$ type: string ActivityStreamingResponse: description: An activity event or error that can be returned by the x activity streaming API. properties: data: properties: event_type: type: string event_uuid: $ref: '#/components/schemas/ActivityEventId' filter: $ref: '#/components/schemas/ActivitySubscriptionFilter' payload: $ref: '#/components/schemas/ActivityStreamingResponsePayload' tag: type: string type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object ActivityStreamingResponsePayload: discriminator: mapping: follow.follow: '#/components/schemas/FollowActivityResponsePayload' follow.unfollow: '#/components/schemas/FollowActivityResponsePayload' news.new: '#/components/schemas/NewsActivityResponsePayload' profile.update.affiliate_badge: '#/components/schemas/ProfileUpdateActivityResponsePayload' profile.update.banner_picture: '#/components/schemas/ProfileUpdateActivityResponsePayload' profile.update.bio: '#/components/schemas/ProfileUpdateActivityResponsePayload' profile.update.geo: '#/components/schemas/ProfileUpdateActivityResponsePayload' profile.update.profile_picture: '#/components/schemas/ProfileUpdateActivityResponsePayload' profile.update.screenname: '#/components/schemas/ProfileUpdateActivityResponsePayload' profile.update.url: '#/components/schemas/ProfileUpdateActivityResponsePayload' profile.update.verified_badge: '#/components/schemas/ProfileUpdateActivityResponsePayload' propertyName: ../event_type oneOf: - $ref: '#/components/schemas/ProfileUpdateActivityResponsePayload' - $ref: '#/components/schemas/NewsActivityResponsePayload' - $ref: '#/components/schemas/FollowActivityResponsePayload' ActivitySubscription: description: An XActivity subscription. properties: created_at: format: date-time type: string event_type: type: string filter: $ref: '#/components/schemas/ActivitySubscriptionFilter' subscription_id: $ref: '#/components/schemas/ActivitySubscriptionId' tag: type: string updated_at: format: date-time type: string webhook_id: $ref: '#/components/schemas/WebhookConfigId' required: - subscription_id - event_type - filter - created_at - updated_at type: object ActivitySubscriptionCreateRequest: additionalProperties: false properties: event_type: enum: - profile.update.bio - profile.update.profile_picture - profile.update.banner_picture - profile.update.screenname - profile.update.geo - profile.update.url - profile.update.verified_badge - profile.update.affiliate_badge - news.new - follow.follow - follow.unfollow - chat.received - chat.sent - ProfileBioUpdate - ProfilePictureUpdate - ProfileBannerPictureUpdate - ProfileScreennameUpdate - ProfileGeoUpdate - ProfileUrlUpdate - ProfileVerifiedBadgeUpdate - NewsNew - FollowFollow - FollowUnfollow type: string filter: $ref: '#/components/schemas/ActivitySubscriptionFilter' tag: maxLength: 200 minLength: 1 type: string webhook_id: $ref: '#/components/schemas/WebhookConfigId' required: - event_type - filter type: object ActivitySubscriptionCreateResponse: properties: data: properties: subscription: $ref: '#/components/schemas/ActivitySubscription' total_subscriptions_for_instance_id: type: integer type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array meta: properties: total_subscriptions: description: Number of active subscriptions. format: int32 type: integer type: object type: object ActivitySubscriptionDeleteResponse: properties: data: properties: deleted: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array meta: properties: total_subscriptions: description: Number of active subscriptions remaining. format: int32 type: integer type: object type: object ActivitySubscriptionFilter: additionalProperties: false description: An XAA subscription. properties: keyword: $ref: '#/components/schemas/Keyword' user_id: $ref: '#/components/schemas/UserId' type: object ActivitySubscriptionGetResponse: properties: data: items: $ref: '#/components/schemas/ActivitySubscription' type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array meta: properties: total_subscriptions: description: Number of active subscriptions. format: int32 type: integer type: object type: object ActivitySubscriptionId: description: The unique identifier of this subscription. example: '1146654567674912769' pattern: ^[0-9]{1,19}$ type: string ActivitySubscriptionUpdateRequest: additionalProperties: false properties: tag: maxLength: 200 minLength: 1 type: string webhook_id: $ref: '#/components/schemas/WebhookConfigId' type: object ActivitySubscriptionUpdateResponse: properties: data: properties: subscription: $ref: '#/components/schemas/ActivitySubscription' total_subscriptions: description: Number of active subscriptions. format: int32 type: integer type: object type: object AddOrDeleteRulesRequest: oneOf: - $ref: '#/components/schemas/AddRulesRequest' - $ref: '#/components/schemas/DeleteRulesRequest' AddOrDeleteRulesResponse: description: A response from modifying user-specified stream filtering rules. properties: data: description: All user-specified stream filtering rules that were created. items: $ref: '#/components/schemas/Rule' type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array meta: $ref: '#/components/schemas/RulesResponseMetadata' required: - meta type: object AddRulesRequest: description: A request to add a user-specified stream filtering rule. properties: add: items: $ref: '#/components/schemas/RuleNoId' type: array required: - add type: object Aggregate: description: The sum of results returned in this response. format: int32 type: integer AllProjectClientApps: description: Client App Rule Counts for all applications in the project items: $ref: '#/components/schemas/AppRulesCount' type: array AllowDownloadStatus: properties: allow_download: example: true type: boolean type: object AltText: properties: text: description: Description of media ( <= 1000 characters ) example: A dancing cat maxLength: 1000 type: string required: - text type: object Analytics: properties: data: items: properties: id: $ref: '#/components/schemas/TweetId' timestamped_metrics: description: Array containing metrics data along with the timestamps of their recording. items: $ref: '#/components/schemas/TimestampedMetrics' title: Timestamped Metrics type: array type: object type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object AnimatedGif: allOf: - $ref: '#/components/schemas/Media' - properties: preview_image_url: format: uri type: string variants: $ref: '#/components/schemas/Variants' type: object AppRulesCount: description: A count of user-provided stream filtering rules at the client application level. properties: client_app_id: $ref: '#/components/schemas/ClientAppId' rule_count: description: Number of rules for client application format: int32 type: integer type: object AudiencePolicy: properties: creator_subscriptions: items: enum: - Any type: string type: array x_subscriptions: items: enum: - Any type: string type: array type: object BookmarkAddRequest: properties: tweet_id: $ref: '#/components/schemas/TweetId' required: - tweet_id type: object BookmarkFolderId: description: The unique identifier of this Bookmark folder. example: '1146654567674912769' pattern: ^[0-9]{1,19}$ type: string BookmarkFolderPostsResponse: properties: data: items: properties: id: $ref: '#/components/schemas/TweetId' type: object type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array meta: properties: next_token: $ref: '#/components/schemas/NextToken' type: object type: object BookmarkFoldersResponse: properties: data: items: properties: id: $ref: '#/components/schemas/BookmarkFolderId' name: type: string type: object type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array meta: properties: next_token: $ref: '#/components/schemas/NextToken' type: object type: object BookmarkMutationResponse: properties: data: properties: bookmarked: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object CashtagEntity: allOf: - $ref: '#/components/schemas/EntityIndicesInclusiveExclusive' - $ref: '#/components/schemas/CashtagFields' CashtagFields: description: Represent the portion of text recognized as a Cashtag, and its start and end position within the text. properties: tag: example: TWTR type: string required: - tag type: object ClientAppId: description: The ID of the client application maxLength: 19 minLength: 1 type: string ClientAppUsage: description: Usage per client app properties: client_app_id: description: The unique identifier for this project format: ^[0-9]{1,19}$ type: string usage: description: The usage value items: $ref: '#/components/schemas/UsageFields' minItems: 1 type: array usage_result_count: description: The number of results returned format: int32 type: integer type: object ClientDisconnectedProblem: allOf: - $ref: '#/components/schemas/Problem' description: Your client has gone away. ClientForbiddenProblem: allOf: - $ref: '#/components/schemas/Problem' - properties: reason: enum: - official-client-forbidden - client-not-enrolled type: string registration_url: format: uri type: string type: object description: A problem that indicates your client is forbidden from making this request. Community: description: A X Community is a curated group of Posts. properties: created_at: format: date-time type: string id: $ref: '#/components/schemas/CommunityId' name: description: The name of this Community. type: string required: - id - name type: object CommunityId: description: The unique identifier of this Community. example: '1146654567674912769' pattern: ^[0-9]{1,19}$ type: string ComplianceJob: properties: created_at: $ref: '#/components/schemas/CreatedAt' download_expires_at: $ref: '#/components/schemas/DownloadExpiration' download_url: $ref: '#/components/schemas/DownloadUrl' id: $ref: '#/components/schemas/JobId' name: $ref: '#/components/schemas/ComplianceJobName' status: $ref: '#/components/schemas/ComplianceJobStatus' type: $ref: '#/components/schemas/ComplianceJobType' upload_expires_at: $ref: '#/components/schemas/UploadExpiration' upload_url: $ref: '#/components/schemas/UploadUrl' required: - id - type - created_at - upload_url - download_url - upload_expires_at - download_expires_at - status type: object ComplianceJobName: description: User-provided name for a compliance job. example: my-job maxLength: 64 type: string ComplianceJobStatus: description: Status of a compliance job. enum: - created - in_progress - failed - complete - expired type: string ComplianceJobType: description: Type of compliance job to list. enum: - tweets - users type: string ConflictProblem: allOf: - $ref: '#/components/schemas/Problem' description: You cannot create a new job if one is already in progress. Connection: properties: client_ip: description: The IP address of the connected client. type: string connected_at: description: The timestamp when the connection was established. format: date-time type: string disconnect_reason: description: The reason for disconnection, if the connection is inactive. example: operator_disconnect type: string disconnected_at: description: The timestamp when the connection was disconnected, if applicable. format: date-time type: string endpoint_name: description: The name of the streaming endpoint. example: sample_stream type: string required: - connected_at - endpoint_name type: object ConnectionExceptionProblem: allOf: - $ref: '#/components/schemas/Problem' - properties: connection_issue: enum: - TooManyConnections - ProvisioningSubscription - RuleConfigurationIssue - RulesInvalidIssue type: string type: object description: A problem that indicates something is wrong with the connection. ContentExpiration: properties: timestamp_sec: description: Expiration time for content as a Unix timestamp in seconds example: 1740787200 format: long type: number required: - timestamp_sec type: object ContextAnnotation: description: Annotation inferred from the Tweet text. properties: domain: $ref: '#/components/schemas/ContextAnnotationDomainFields' entity: $ref: '#/components/schemas/ContextAnnotationEntityFields' required: - domain - entity type: object ContextAnnotationDomainFields: description: Represents the data for the context annotation domain. properties: description: description: Description of the context annotation domain. type: string id: description: The unique id for a context annotation domain. pattern: ^[0-9]{1,19}$ type: string name: description: Name of the context annotation domain. type: string required: - id type: object ContextAnnotationEntityFields: description: Represents the data for the context annotation entity. properties: description: description: Description of the context annotation entity. type: string id: description: The unique id for a context annotation entity. pattern: ^[0-9]{1,19}$ type: string name: description: Name of the context annotation entity. type: string required: - id type: object CountryCode: description: A two-letter ISO 3166-1 alpha-2 country code. example: US pattern: ^[A-Z]{2}$ type: string CreateAttachmentsMessageRequest: properties: attachments: $ref: '#/components/schemas/DmAttachments' text: description: Text of the message. minLength: 1 type: string required: - attachments type: object CreateComplianceJobRequest: description: A request to create a new batch compliance job. properties: name: $ref: '#/components/schemas/ComplianceJobName' resumable: description: If true, this endpoint will return a pre-signed URL with resumable uploads enabled. type: boolean type: description: Type of compliance job to list. enum: - tweets - users type: string required: - type type: object CreateComplianceJobResponse: properties: data: $ref: '#/components/schemas/ComplianceJob' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object CreateDmConversationRequest: additionalProperties: false properties: conversation_type: description: The conversation type that is being created. enum: - Group type: string message: $ref: '#/components/schemas/CreateMessageRequest' participant_ids: $ref: '#/components/schemas/DmParticipants' required: - conversation_type - participant_ids - message type: object CreateDmEventResponse: properties: data: properties: dm_conversation_id: $ref: '#/components/schemas/DmConversationId' dm_event_id: $ref: '#/components/schemas/DmEventId' required: - dm_conversation_id - dm_event_id type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object CreateMessageRequest: anyOf: - $ref: '#/components/schemas/CreateTextMessageRequest' - $ref: '#/components/schemas/CreateAttachmentsMessageRequest' CreateNoteRequest: additionalProperties: false properties: info: $ref: '#/components/schemas/NoteInfo' post_id: $ref: '#/components/schemas/TweetId' test_mode: description: If true, the note being submitted is only for testing the capability of the bot, and won't be publicly visible. If false, the note being submitted will be a new proposed note on the product. type: boolean required: - test_mode - post_id - info title: Note type: object CreateNoteResponse: properties: data: properties: id: $ref: '#/components/schemas/NoteId' type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object CreateTextMessageRequest: properties: attachments: $ref: '#/components/schemas/DmAttachments' text: description: Text of the message. minLength: 1 type: string required: - text type: object CreatedAt: description: Creation time of the compliance job. example: '2021-01-06T18:40:40.000Z' format: date-time type: string DeleteDmResponse: properties: data: properties: deleted: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object DeleteNoteResponse: properties: data: properties: deleted: type: boolean required: - deleted type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object DeleteRulesRequest: description: A response from deleting user-specified stream filtering rules. properties: delete: description: IDs and values of all deleted user-specified stream filtering rules. properties: ids: description: IDs of all deleted user-specified stream filtering rules. items: $ref: '#/components/schemas/RuleId' type: array values: description: Values of all deleted user-specified stream filtering rules. items: $ref: '#/components/schemas/RuleValue' type: array type: object required: - delete type: object DisallowedResourceProblem: allOf: - $ref: '#/components/schemas/Problem' - properties: resource_id: type: string resource_type: enum: - user - tweet - media - list - space type: string section: enum: - data - includes type: string required: - resource_id - resource_type - section type: object description: A problem that indicates that the resource requested violates the precepts of this API. DisplayTextRange: description: Represent a boundary range (start and end zero-based indices) for the portion of text that is displayed for a post. `start` must be smaller than `end`. The start index is inclusive, the end index is exclusive. items: minimum: 0 type: integer maxItems: 2 minItems: 2 type: array DmAttachments: description: Attachments to a DM Event. items: $ref: '#/components/schemas/DmMediaAttachment' type: array DmConversationId: description: Unique identifier of a DM conversation. This can either be a numeric string, or a pair of numeric strings separated by a '-' character in the case of one-on-one DM Conversations. example: 123123123-456456456 pattern: ^([0-9]{1,19}-[0-9]{1,19}|[0-9]{15,19})$ type: string DmEvent: properties: attachments: description: Specifies the type of attachments (if any) present in this DM. properties: card_ids: description: A list of card IDs (if cards are attached). items: type: string minItems: 1 type: array media_keys: description: A list of Media Keys for each one of the media attachments (if media are attached). items: $ref: '#/components/schemas/MediaKey' minItems: 1 type: array type: object cashtags: items: $ref: '#/components/schemas/CashtagEntity' minItems: 1 type: array created_at: format: date-time type: string dm_conversation_id: $ref: '#/components/schemas/DmConversationId' event_type: example: MessageCreate type: string hashtags: items: $ref: '#/components/schemas/HashtagEntity' minItems: 1 type: array id: $ref: '#/components/schemas/DmEventId' mentions: items: $ref: '#/components/schemas/MentionEntity' minItems: 1 type: array participant_ids: description: A list of participants for a ParticipantsJoin or ParticipantsLeave event_type. items: $ref: '#/components/schemas/UserId' minItems: 1 type: array referenced_tweets: description: A list of Posts this DM refers to. items: properties: id: $ref: '#/components/schemas/TweetId' required: - id type: object minItems: 1 type: array sender_id: $ref: '#/components/schemas/UserId' text: type: string urls: items: $ref: '#/components/schemas/UrlEntityDm' minItems: 1 type: array required: - id - event_type type: object DmEventId: description: Unique identifier of a DM Event. example: '1146654567674912769' pattern: ^[0-9]{1,19}$ type: string DmMediaAttachment: properties: media_id: $ref: '#/components/schemas/MediaId' required: - media_id type: object DmParticipants: description: Participants for the DM Conversation. items: $ref: '#/components/schemas/UserId' maxItems: 49 minItems: 2 type: array DomainRestrictions: properties: whitelist: description: List of whitelisted domains items: type: string type: array required: - whitelist type: object DownloadExpiration: description: Expiration time of the download URL. example: '2021-01-06T18:40:40.000Z' format: date-time type: string DownloadUrl: description: URL from which the user will retrieve their compliance results. format: uri type: string DuplicateRuleProblem: allOf: - $ref: '#/components/schemas/Problem' - properties: id: type: string value: type: string type: object description: The rule you have submitted is a duplicate. End: description: The end time of the bucket. format: date-time type: string Engagement: description: An Engagement Api Response. properties: errors: items: properties: error: type: string tweets: items: type: string type: array type: object minItems: 1 type: array measurement: properties: metrics_time_series: items: properties: tweet_id: $ref: '#/components/schemas/TweetId' value: properties: metric_values: items: properties: metric_type: type: string metric_value: type: number type: object type: array timestamp: properties: iso8601_time: type: string type: object type: object type: object minItems: 1 type: array metrics_total: items: properties: tweet_id: $ref: '#/components/schemas/TweetId' value: items: properties: metric_type: type: string metric_value: type: number type: object minItems: 1 type: array type: object minItems: 1 type: array type: object type: object EntityIndicesInclusiveExclusive: description: Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). `start` must be smaller than `end`. The start index is inclusive, the end index is exclusive. properties: end: description: Index (zero-based) at which position this entity ends. The index is exclusive. example: 61 minimum: 0 type: integer start: description: Index (zero-based) at which position this entity starts. The index is inclusive. example: 50 minimum: 0 type: integer required: - start - end type: object EntityIndicesInclusiveInclusive: description: Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). `start` must be smaller than `end`. The start index is inclusive, the end index is inclusive. properties: end: description: Index (zero-based) at which position this entity ends. The index is inclusive. example: 61 minimum: 0 type: integer start: description: Index (zero-based) at which position this entity starts. The index is inclusive. example: 50 minimum: 0 type: integer required: - start - end type: object Error: properties: code: format: int32 type: integer message: type: string required: - code - message type: object EvaluateNoteRequest: additionalProperties: false properties: note_text: description: Text for the community note. type: string post_id: $ref: '#/components/schemas/TweetId' required: - post_id - note_text type: object EvaluateNoteResponse: properties: data: properties: claim_opinion_score: description: Claim opinion model score for the note. format: double type: number type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Expansions: properties: media: items: $ref: '#/components/schemas/Media' minItems: 1 type: array places: items: $ref: '#/components/schemas/Place' minItems: 1 type: array polls: items: $ref: '#/components/schemas/Poll' minItems: 1 type: array topics: items: $ref: '#/components/schemas/Topic' minItems: 1 type: array tweets: items: $ref: '#/components/schemas/Tweet' minItems: 1 type: array users: items: $ref: '#/components/schemas/User' minItems: 1 type: array type: object FieldUnauthorizedProblem: allOf: - $ref: '#/components/schemas/Problem' - properties: field: type: string resource_type: enum: - user - tweet - media - list - space type: string section: enum: - data - includes type: string required: - resource_type - field - section type: object description: A problem that indicates that you are not allowed to see a particular field on a Tweet, User, etc. FilteredStreamingTweetResponse: description: A Tweet or error that can be returned by the streaming Tweet API. The values returned with a successful streamed Tweet includes the user provided rules that the Tweet matched. properties: data: $ref: '#/components/schemas/Tweet' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' matching_rules: description: The list of rules which matched the Tweet items: properties: id: $ref: '#/components/schemas/RuleId' tag: $ref: '#/components/schemas/RuleTag' required: - id type: object type: array type: object FollowActivityResponsePayload: additionalProperties: false properties: source: $ref: '#/components/schemas/User' target: $ref: '#/components/schemas/User' type: object FoundMediaOrigin: properties: id: description: Unique Identifier of media within provider ( <= 24 characters )) example: u5BzatR15TZ04 type: string provider: description: The media provider (e.g., 'giphy') that sourced the media ( <= 8 Characters ) example: giphy type: string required: - provider - id type: object FullTextEntities: properties: annotations: items: allOf: - $ref: '#/components/schemas/EntityIndicesInclusiveInclusive' - description: Represents the data for the annotation. properties: normalized_text: description: Text used to determine annotation. example: Barack Obama type: string probability: description: Confidence factor for annotation type. format: double maximum: 1 minimum: 0 type: number type: description: Annotation type. example: Person type: string type: object description: Annotation for entities based on the Tweet text. minItems: 1 type: array cashtags: items: $ref: '#/components/schemas/CashtagEntity' minItems: 1 type: array hashtags: items: $ref: '#/components/schemas/HashtagEntity' minItems: 1 type: array mentions: items: $ref: '#/components/schemas/MentionEntity' minItems: 1 type: array urls: items: $ref: '#/components/schemas/UrlEntity' minItems: 1 type: array type: object GenericProblem: allOf: - $ref: '#/components/schemas/Problem' description: A generic problem with no additional information beyond that provided by the HTTP status code. Geo: properties: bbox: example: - -105.193475 - 39.60973 - -105.053164 - 39.761974 items: format: double maximum: 180 minimum: -180 type: number maxItems: 4 minItems: 4 type: array geometry: $ref: '#/components/schemas/Point' properties: type: object type: enum: - Feature type: string required: - type - bbox - properties type: object GeoRestrictions: oneOf: - properties: blacklisted_country_codes: description: List of blacklisted country codes items: description: Country code in ISO 3166-1 alpha-2 format example: us pattern: ^[a-zA-Z]{2}$ type: string maxItems: 0 minItems: 0 type: array whitelisted_country_codes: description: List of whitelisted country codes items: description: Country code in ISO 3166-1 alpha-2 format example: us pattern: ^[a-zA-Z]{2}$ type: string minItems: 1 type: array required: - whitelisted_country_codes - blacklisted_country_codes type: object - properties: blacklisted_country_codes: description: List of blacklisted country codes items: description: Country code in ISO 3166-1 alpha-2 format example: us pattern: ^[a-zA-Z]{2}$ type: string minItems: 1 type: array whitelisted_country_codes: description: List of whitelisted country codes items: description: Country code in ISO 3166-1 alpha-2 format example: us pattern: ^[a-zA-Z]{2}$ type: string maxItems: 0 minItems: 0 type: array required: - whitelisted_country_codes - blacklisted_country_codes type: object Get2CommunitiesIdResponse: properties: data: $ref: '#/components/schemas/Community' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2CommunitiesSearchResponse: properties: data: items: $ref: '#/components/schemas/Community' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array meta: properties: next_token: $ref: '#/components/schemas/NextToken' type: object type: object Get2ComplianceJobsIdResponse: properties: data: $ref: '#/components/schemas/ComplianceJob' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2ComplianceJobsResponse: properties: data: items: $ref: '#/components/schemas/ComplianceJob' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array meta: properties: result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2ConnectionsResponse: properties: data: items: $ref: '#/components/schemas/Connection' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array meta: properties: next_token: $ref: '#/components/schemas/NextToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2DmConversationsIdDmEventsResponse: properties: data: items: $ref: '#/components/schemas/DmEvent' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2DmConversationsWithParticipantIdDmEventsResponse: properties: data: items: $ref: '#/components/schemas/DmEvent' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2DmEventsEventIdResponse: properties: data: $ref: '#/components/schemas/DmEvent' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2DmEventsResponse: properties: data: items: $ref: '#/components/schemas/DmEvent' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2FdxAccountsAccountidContactResponse: properties: data: $ref: '#/components/schemas/PlaidAccountContact' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2FdxAccountsAccountidPayment-networksResponse: properties: data: items: $ref: '#/components/schemas/PlaidAccountPaymentNetwork' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2FdxAccountsAccountidResponse: properties: data: $ref: '#/components/schemas/PlaidAccount' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2FdxAccountsAccountidTransactionsResponse: properties: data: items: $ref: '#/components/schemas/PlaidAccountTransaction' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2FdxCustomersCurrentResponse: properties: data: $ref: '#/components/schemas/PlaidCustomer' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2Insights28hrResponse: properties: data: items: $ref: '#/components/schemas/Engagement' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2InsightsHistoricalResponse: properties: data: items: $ref: '#/components/schemas/Engagement' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2LikesFirehoseStreamResponse: properties: data: $ref: '#/components/schemas/LikeWithTweetAuthor' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2LikesSample10StreamResponse: properties: data: $ref: '#/components/schemas/LikeWithTweetAuthor' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2ListsIdFollowersResponse: properties: data: items: $ref: '#/components/schemas/User' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2ListsIdMembersResponse: properties: data: items: $ref: '#/components/schemas/User' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2ListsIdResponse: properties: data: $ref: '#/components/schemas/List' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2ListsIdTweetsResponse: properties: data: items: $ref: '#/components/schemas/Tweet' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2MediaAnalyticsResponse: properties: data: $ref: '#/components/schemas/MediaAnalytics' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2MediaMediaKeyResponse: properties: data: $ref: '#/components/schemas/Media' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2MediaResponse: properties: data: items: $ref: '#/components/schemas/Media' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2NewsIdResponse: properties: data: $ref: '#/components/schemas/News' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2NewsSearchResponse: properties: data: items: $ref: '#/components/schemas/News' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array meta: properties: result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2NotesSearchNotesWrittenResponse: properties: data: items: $ref: '#/components/schemas/Note' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array meta: properties: next_token: $ref: '#/components/schemas/NextToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2NotesSearchPostsEligibleForNotesResponse: properties: data: items: $ref: '#/components/schemas/Tweet' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2SpacesByCreatorIdsResponse: properties: data: items: $ref: '#/components/schemas/Space' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2SpacesIdBuyersResponse: properties: data: items: $ref: '#/components/schemas/User' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2SpacesIdResponse: properties: data: $ref: '#/components/schemas/Space' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2SpacesIdTweetsResponse: properties: data: items: $ref: '#/components/schemas/Tweet' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2SpacesResponse: properties: data: items: $ref: '#/components/schemas/Space' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2SpacesSearchResponse: properties: data: items: $ref: '#/components/schemas/Space' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2TrendsByWoeidWoeidResponse: properties: data: items: $ref: '#/components/schemas/Trend' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2TweetsAnalyticsResponse: properties: data: $ref: '#/components/schemas/Analytics' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2TweetsCountsAllResponse: properties: data: items: $ref: '#/components/schemas/SearchCount' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array meta: properties: newest_id: $ref: '#/components/schemas/NewestId' next_token: $ref: '#/components/schemas/NextToken' oldest_id: $ref: '#/components/schemas/OldestId' total_tweet_count: $ref: '#/components/schemas/Aggregate' type: object type: object Get2TweetsCountsRecentResponse: properties: data: items: $ref: '#/components/schemas/SearchCount' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array meta: properties: newest_id: $ref: '#/components/schemas/NewestId' next_token: $ref: '#/components/schemas/NextToken' oldest_id: $ref: '#/components/schemas/OldestId' total_tweet_count: $ref: '#/components/schemas/Aggregate' type: object type: object Get2TweetsFirehoseStreamLangEnResponse: properties: data: $ref: '#/components/schemas/Tweet' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2TweetsFirehoseStreamLangJaResponse: properties: data: $ref: '#/components/schemas/Tweet' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2TweetsFirehoseStreamLangKoResponse: properties: data: $ref: '#/components/schemas/Tweet' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2TweetsFirehoseStreamLangPtResponse: properties: data: $ref: '#/components/schemas/Tweet' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2TweetsFirehoseStreamResponse: properties: data: $ref: '#/components/schemas/Tweet' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2TweetsIdLikingUsersResponse: properties: data: items: $ref: '#/components/schemas/User' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2TweetsIdQuoteTweetsResponse: properties: data: items: $ref: '#/components/schemas/Tweet' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2TweetsIdResponse: properties: data: $ref: '#/components/schemas/Tweet' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2TweetsIdRetweetedByResponse: properties: data: items: $ref: '#/components/schemas/User' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2TweetsIdRetweetsResponse: properties: data: items: $ref: '#/components/schemas/Tweet' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2TweetsResponse: properties: data: items: $ref: '#/components/schemas/Tweet' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2TweetsSample10StreamResponse: properties: data: $ref: '#/components/schemas/Tweet' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2TweetsSampleStreamResponse: properties: data: $ref: '#/components/schemas/Tweet' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2TweetsSearchAllResponse: properties: data: items: $ref: '#/components/schemas/Tweet' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: newest_id: $ref: '#/components/schemas/NewestId' next_token: $ref: '#/components/schemas/NextToken' oldest_id: $ref: '#/components/schemas/OldestId' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2TweetsSearchRecentResponse: properties: data: items: $ref: '#/components/schemas/Tweet' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: newest_id: $ref: '#/components/schemas/NewestId' next_token: $ref: '#/components/schemas/NextToken' oldest_id: $ref: '#/components/schemas/OldestId' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2TweetsSearchStreamResponse: properties: data: $ref: '#/components/schemas/Tweet' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2TweetsSearchStreamRulesCountsResponse: properties: data: $ref: '#/components/schemas/RulesCount' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2UsageTweetsResponse: properties: data: $ref: '#/components/schemas/Usage' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2UsersByResponse: properties: data: items: $ref: '#/components/schemas/User' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2UsersByUsernameUsernameResponse: properties: data: $ref: '#/components/schemas/User' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2UsersIdBlockingResponse: properties: data: items: $ref: '#/components/schemas/User' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2UsersIdBookmarksResponse: properties: data: items: $ref: '#/components/schemas/Tweet' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2UsersIdFollowedListsResponse: properties: data: items: $ref: '#/components/schemas/List' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2UsersIdFollowersResponse: properties: data: items: $ref: '#/components/schemas/User' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2UsersIdFollowingResponse: properties: data: items: $ref: '#/components/schemas/User' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2UsersIdLikedTweetsResponse: properties: data: items: $ref: '#/components/schemas/Tweet' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2UsersIdListMembershipsResponse: properties: data: items: $ref: '#/components/schemas/List' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2UsersIdMentionsResponse: properties: data: items: $ref: '#/components/schemas/Tweet' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: newest_id: $ref: '#/components/schemas/NewestId' next_token: $ref: '#/components/schemas/NextToken' oldest_id: $ref: '#/components/schemas/OldestId' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2UsersIdMutingResponse: properties: data: items: $ref: '#/components/schemas/User' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2UsersIdOwnedListsResponse: properties: data: items: $ref: '#/components/schemas/List' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2UsersIdPinnedListsResponse: properties: data: items: $ref: '#/components/schemas/List' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2UsersIdResponse: properties: data: $ref: '#/components/schemas/User' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2UsersIdTimelinesReverseChronologicalResponse: properties: data: items: $ref: '#/components/schemas/Tweet' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: newest_id: $ref: '#/components/schemas/NewestId' next_token: $ref: '#/components/schemas/NextToken' oldest_id: $ref: '#/components/schemas/OldestId' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2UsersIdTweetsResponse: properties: data: items: $ref: '#/components/schemas/Tweet' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: newest_id: $ref: '#/components/schemas/NewestId' next_token: $ref: '#/components/schemas/NextToken' oldest_id: $ref: '#/components/schemas/OldestId' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2UsersMeResponse: properties: data: $ref: '#/components/schemas/User' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2UsersPersonalizedTrendsResponse: properties: data: items: $ref: '#/components/schemas/PersonalizedTrend' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Get2UsersRepostsOfMeResponse: properties: data: items: $ref: '#/components/schemas/Tweet' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' result_count: $ref: '#/components/schemas/ResultCount' type: object type: object Get2UsersResponse: properties: data: items: $ref: '#/components/schemas/User' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object Get2UsersSearchResponse: properties: data: items: $ref: '#/components/schemas/User' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' meta: properties: next_token: $ref: '#/components/schemas/NextToken' previous_token: $ref: '#/components/schemas/PreviousToken' type: object type: object Get2WebhooksResponse: properties: data: items: $ref: '#/components/schemas/WebhookConfig' minItems: 1 type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array meta: properties: result_count: $ref: '#/components/schemas/ResultCount' type: object type: object HashtagEntity: allOf: - $ref: '#/components/schemas/EntityIndicesInclusiveExclusive' - $ref: '#/components/schemas/HashtagFields' HashtagFields: description: Represent the portion of text recognized as a Hashtag, and its start and end position within the text. properties: tag: description: The text of the Hashtag. example: MondayMotivation type: string required: - tag type: object HttpStatusCode: description: HTTP Status Code. maximum: 599 minimum: 100 type: integer InvalidRequestProblem: allOf: - $ref: '#/components/schemas/Problem' - properties: errors: items: properties: message: type: string parameters: additionalProperties: items: type: string type: array type: object type: object minItems: 1 type: array type: object description: A problem that indicates this request is invalid. InvalidRuleProblem: allOf: - $ref: '#/components/schemas/Problem' description: The rule you have submitted is invalid. JobId: description: Compliance Job ID. example: '1372966999991541762' pattern: ^[0-9]{1,19}$ type: string Keyword: description: A keyword to filter on. example: The President maxLength: 150 minLength: 1 type: string KillAllConnectionsResponse: properties: data: properties: killed_connections: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object LikeComplianceSchema: properties: delete: $ref: '#/components/schemas/UnlikeComplianceSchema' required: - delete type: object LikeId: description: The unique identifier of this Like. example: 8ba4f34e6235d905a46bac021d98e923 pattern: ^[A-Za-z0-9_]{1,40}$ type: string LikeWithTweetAuthor: description: A Like event, with the tweet author user and the tweet being liked properties: created_at: description: Creation time of the Tweet. example: '2021-01-06T18:40:40.000Z' format: date-time type: string id: $ref: '#/components/schemas/LikeId' liked_tweet_id: $ref: '#/components/schemas/TweetId' timestamp_ms: description: Timestamp in milliseconds of creation. format: int32 type: integer tweet_author_id: $ref: '#/components/schemas/UserId' type: object LikesComplianceStreamResponse: description: Likes compliance stream events. oneOf: - description: Compliance event. properties: data: $ref: '#/components/schemas/LikeComplianceSchema' required: - data type: object - properties: errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array required: - errors type: object List: description: A X List is a curated group of accounts. properties: created_at: format: date-time type: string description: type: string follower_count: type: integer id: $ref: '#/components/schemas/ListId' member_count: type: integer name: description: The name of this List. type: string owner_id: $ref: '#/components/schemas/UserId' private: type: boolean required: - id - name type: object ListAddUserRequest: properties: user_id: $ref: '#/components/schemas/UserId' required: - user_id type: object ListCreateRequest: properties: description: maxLength: 100 minLength: 0 type: string name: maxLength: 25 minLength: 1 type: string private: default: false type: boolean required: - name type: object ListCreateResponse: properties: data: description: A X List is a curated group of accounts. properties: id: $ref: '#/components/schemas/ListId' name: description: The name of this List. type: string required: - id - name type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object ListDeleteResponse: properties: data: properties: deleted: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object ListFollowedRequest: properties: list_id: $ref: '#/components/schemas/ListId' required: - list_id type: object ListFollowedResponse: properties: data: properties: following: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object ListId: description: The unique identifier of this List. example: '1146654567674912769' pattern: ^[0-9]{1,19}$ type: string ListMutateResponse: properties: data: properties: is_member: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object ListPinnedRequest: properties: list_id: $ref: '#/components/schemas/ListId' required: - list_id type: object ListPinnedResponse: properties: data: properties: pinned: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object ListUnpinResponse: properties: data: properties: pinned: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object ListUpdateRequest: properties: description: maxLength: 100 minLength: 0 type: string name: maxLength: 25 minLength: 1 type: string private: type: boolean type: object ListUpdateResponse: properties: data: properties: updated: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object ManagementInfo: properties: managed: description: Indicates if the media is managed by Media Studio example: false type: boolean required: - managed type: object Media: discriminator: mapping: animated_gif: '#/components/schemas/AnimatedGif' photo: '#/components/schemas/Photo' video: '#/components/schemas/Video' propertyName: type properties: height: $ref: '#/components/schemas/MediaHeight' media_key: $ref: '#/components/schemas/MediaKey' type: type: string width: $ref: '#/components/schemas/MediaWidth' required: - type type: object MediaAnalytics: properties: data: items: properties: media_key: $ref: '#/components/schemas/MediaKey' timestamped_metrics: description: Array containing metrics data along with the timestamps of their recording. items: $ref: '#/components/schemas/MediaTimestampedMetrics' title: Timestamped Metrics type: array type: object type: array errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object MediaCategory: description: A string enum value which identifies a media use-case. This identifier is used to enforce use-case specific constraints (e.g. file size, video duration) and enable advanced features. enum: - amplify_video - tweet_gif - tweet_image - tweet_video - dm_gif - dm_image - dm_video - subtitles example: tweet_video type: string MediaCategoryOneShot: description: A string enum value which identifies a media use-case. This identifier is used to enforce use-case specific constraints (e.g. file size) and enable advanced features. enum: - tweet_image - dm_image - subtitles example: tweet_image type: string MediaCategorySubtitles: description: The media category of uploaded media to which subtitles should be added/deleted enum: - AmplifyVideo - TweetVideo example: TweetVideo type: string MediaHeight: description: The height of the media in pixels. minimum: 0 type: integer MediaId: description: The unique identifier of this Media. example: '1146654567674912769' pattern: ^[0-9]{1,19}$ type: string MediaKey: description: The Media Key identifier for this attachment. pattern: ^([0-9]+)_([0-9]+)$ type: string MediaMetrics: properties: cta_url_clicks: description: Tracks the number of clicks on a call-to-action URL title: CTA URL Clicks type: integer cta_watch_clicks: description: Tracks the number of clicks to watch a video or media content title: CTA Watch Clicks type: integer play_from_tap: description: Tracks the number of times a video or media is played from a user tap title: Play From Tap type: integer playback25: description: Tracks the number of times a video reaches 25% of its duration title: Playback 25% type: integer playback50: description: Tracks the number of times a video reaches 50% of its duration title: Playback 50% type: integer playback75: description: Tracks the number of times a video reaches 75% of its duration title: Playback 75% type: integer playback_complete: description: Tracks the number of times a video is played to completion title: Playback Complete type: integer playback_start: description: Tracks the number of times a video playback is initiated title: Playback Start type: integer video_views: description: Tracks the number of times a video is viewed title: Video Views type: integer watch_time_ms: description: Tracks the total time spent watching a video, measured in milliseconds title: Watch Time (ms) type: integer type: object MediaPayloadBinary: description: The file to upload. format: binary type: string MediaPayloadByte: description: The file to upload. format: byte type: string MediaSegments: oneOf: - description: An integer value representing the media upload segment. format: int32 maximum: 999 minimum: 0 type: integer - description: An integer value representing the media upload segment. format: integer pattern: ^[0-9]{1,3}$ type: string MediaTimestampedMetrics: properties: metrics: $ref: '#/components/schemas/MediaMetrics' timestamp: description: ISO8601 Time example: '2025-03-17T06:30:00Z' title: Timestamp type: string type: object MediaUploadAppendRequest: anyOf: - properties: media: $ref: '#/components/schemas/MediaPayloadBinary' segment_index: $ref: '#/components/schemas/MediaSegments' required: - media - segment_index type: object - properties: media: $ref: '#/components/schemas/MediaPayloadByte' segment_index: $ref: '#/components/schemas/MediaSegments' required: - media - segment_index type: object MediaUploadAppendResponse: description: A response from getting a media upload request status. properties: data: properties: expires_at: description: Unix epoch time in seconds after when the upload session expires. format: int64 type: integer type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array required: - meta type: object MediaUploadConfigRequest: additionalProperties: false properties: additional_owners: items: $ref: '#/components/schemas/UserId' type: array media_category: $ref: '#/components/schemas/MediaCategory' media_type: description: The type of media. enum: - video/mp4 - video/webm - video/mp2t - video/quicktime - text/srt - text/vtt - image/jpeg - image/gif - image/bmp - image/png - image/webp - image/pjpeg - image/tiff - model/gltf-binary - model/vnd.usdz+zip example: video/mp4 type: string shared: description: Whether this media is shared or not. type: boolean total_bytes: description: The total size of the media upload in bytes. maximum: 17179869184 minimum: 0 type: integer type: object MediaUploadRequestOneShot: additionalProperties: false properties: additional_owners: items: $ref: '#/components/schemas/UserId' type: array media: anyOf: - $ref: '#/components/schemas/MediaPayloadBinary' - $ref: '#/components/schemas/MediaPayloadByte' media_category: $ref: '#/components/schemas/MediaCategoryOneShot' media_type: description: The type of image or subtitle. enum: - text/srt - text/vtt - image/jpeg - image/bmp - image/png - image/webp - image/pjpeg - image/tiff example: image/png type: string shared: default: false description: Whether this media is shared or not. type: boolean required: - media - media_category type: object MediaUploadResponse: description: A response from getting a media upload request status. properties: data: properties: expires_after_secs: description: Number of seconds after which upload session expires. format: int32 type: integer id: $ref: '#/components/schemas/MediaId' media_key: $ref: '#/components/schemas/MediaKey' processing_info: $ref: '#/components/schemas/ProcessingInfo' size: description: Size of the upload format: int32 type: integer required: - id - media_key type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array required: - meta type: object MediaWidth: description: The width of the media in pixels. minimum: 0 type: integer MentionEntity: allOf: - $ref: '#/components/schemas/EntityIndicesInclusiveExclusive' - $ref: '#/components/schemas/MentionFields' MentionFields: description: Represent the portion of text recognized as a User mention, and its start and end position within the text. properties: id: $ref: '#/components/schemas/UserId' username: $ref: '#/components/schemas/UserName' required: - username type: object MetadataCreateRequest: properties: id: $ref: '#/components/schemas/MediaId' metadata: properties: allow_download_status: $ref: '#/components/schemas/AllowDownloadStatus' alt_text: $ref: '#/components/schemas/AltText' audience_policy: $ref: '#/components/schemas/AudiencePolicy' content_expiration: $ref: '#/components/schemas/ContentExpiration' domain_restrictions: $ref: '#/components/schemas/DomainRestrictions' found_media_origin: $ref: '#/components/schemas/FoundMediaOrigin' geo_restrictions: $ref: '#/components/schemas/GeoRestrictions' management_info: $ref: '#/components/schemas/ManagementInfo' preview_image: $ref: '#/components/schemas/PreviewImage' sensitive_media_warning: $ref: '#/components/schemas/SensitiveMediaWarning' shared_info: $ref: '#/components/schemas/SharedInfo' sticker_info: $ref: '#/components/schemas/StickerInfo' upload_source: $ref: '#/components/schemas/UploadSource' type: object required: - id type: object MetadataCreateResponse: properties: data: properties: associated_metadata: properties: allow_download_status: $ref: '#/components/schemas/AllowDownloadStatus' alt_text: $ref: '#/components/schemas/AltText' audience_policy: $ref: '#/components/schemas/AudiencePolicy' content_expiration: $ref: '#/components/schemas/ContentExpiration' domain_restrictions: $ref: '#/components/schemas/DomainRestrictions' found_media_origin: $ref: '#/components/schemas/FoundMediaOrigin' geo_restrictions: $ref: '#/components/schemas/GeoRestrictions' management_info: $ref: '#/components/schemas/ManagementInfo' preview_image: $ref: '#/components/schemas/PreviewImage' sensitive_media_warning: $ref: '#/components/schemas/SensitiveMediaWarning' shared_info: $ref: '#/components/schemas/SharedInfo' sticker_info: $ref: '#/components/schemas/StickerInfo' upload_source: $ref: '#/components/schemas/UploadSource' type: object id: $ref: '#/components/schemas/MediaId' type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Metrics: properties: app_install_attempts: description: Tracks number of App Install Attempts title: App Install Attempts type: integer app_opens: description: Tracks number of App opens title: App Opens type: integer detail_expands: description: Tracks number of Detail expands title: Detail Expands type: integer email_tweet: description: Tracks number of Email Tweet actions title: Email Tweet type: integer engagements: description: Tracks total Engagements title: Engagements type: integer follows: description: Tracks number of Follows title: Follows type: integer hashtag_clicks: description: Tracks number of Hashtag clicks title: Hashtag Clicks type: integer impressions: description: Tracks number of Impressions title: Impressions type: integer likes: description: Tracks number of Likes title: Likes type: integer link_clicks: description: Tracks number of Link clicks title: Link Clicks type: integer media_engagements: description: Tracks number of Media engagements title: Media Engagements type: integer media_views: description: Tracks number of Media views title: Media Views type: integer permalink_clicks: description: Tracks number of Permalink clicks title: Permalink Clicks type: integer profile_visits: description: Tracks number of Profile visits title: Profile Visits type: integer quote_tweets: description: Tracks number of Quote Tweets title: Quote Tweets type: integer replies: description: Tracks number of Replies title: Replies type: integer retweets: description: Tracks number of Retweets title: Retweets type: integer url_clicks: description: Tracks number of URL clicks title: URL Clicks type: integer user_profile_clicks: description: Tracks number of User Profile clicks title: User Profile Clicks type: integer type: object MisleadingTags: description: Community Note misleading tags type. enum: - disputed_claim_as_fact - factual_error - manipulated_media - misinterpreted_satire - missing_important_context - other - outdated_information type: string MuteUserMutationResponse: properties: data: properties: muting: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object MuteUserRequest: properties: target_user_id: $ref: '#/components/schemas/UserId' required: - target_user_id type: object NewestId: description: The newest id in this response. type: string News: description: An AI generated news story. properties: category: description: The news category. type: string cluster_posts_results: items: properties: post_id: $ref: '#/components/schemas/TweetId' type: object type: array contexts: properties: entities: properties: events: items: type: string type: array organizations: items: type: string type: array people: items: type: string type: array places: items: type: string type: array products: items: type: string type: array type: object finance: properties: tickers: items: type: string type: array type: object sports: properties: teams: items: type: string type: array type: object topics: items: type: string type: array type: object disclaimer: type: string hook: description: The news hook. type: string keywords: items: type: string type: array last_updated_at_ms: example: '2025-7-14T04:35:55Z' format: date-time type: string name: description: The headline. type: string rest_id: $ref: '#/components/schemas/NewsId' summary: description: The news summary. type: string required: - rest_id type: object NewsActivityResponsePayload: additionalProperties: false properties: category: type: string headline: type: string hook: type: string summary: type: string type: object NewsId: description: Unique identifier of news story. example: '2244994945' pattern: ^[0-9]{1,19}$ type: string NextToken: description: The next token. minLength: 1 type: string NonCompliantRulesProblem: allOf: - $ref: '#/components/schemas/Problem' description: A problem that indicates the user's rule set is not compliant. Note: description: A X Community Note is a note on a Post. properties: id: $ref: '#/components/schemas/NoteId' info: $ref: '#/components/schemas/NoteInfo' post_id: $ref: '#/components/schemas/TweetId' status: $ref: '#/components/schemas/NoteRatingStatus' test_result: $ref: '#/components/schemas/NoteTestResult' required: - id - post_id - note_info type: object NoteClassification: description: Community Note classification type. enum: - misinformed_or_potentially_misleading - not_misleading type: string NoteId: description: The unique identifier of this Community Note. example: '1146654567674912769' pattern: ^[0-9]{1,19}$ type: string NoteInfo: additionalProperties: false description: A X Community Note is a note on a Post. properties: classification: $ref: '#/components/schemas/NoteClassification' misleading_tags: items: $ref: '#/components/schemas/MisleadingTags' type: array text: description: The text summary in the Community Note. pattern: ^(?=[\s\S]*https?://\S+)[\s\S]+$ type: string trustworthy_sources: description: Whether the note provided trustworthy links. type: boolean required: - text - classification - misleading_tags - trustworthy_sources type: object NoteRatingStatus: description: Community Note rating status enum: - currently_rated_helpful - currently_rated_not_helpful - firm_reject - insufficient_consensus - minimum_ratings_not_met - needs_more_ratings - needs_your_help type: string NoteTestResult: description: The evaluation result of a community note. properties: evaluator_score_bucket: description: Score bucket from the evaluator result. type: string evaluator_type: description: The type of the evaluator. type: string type: object NoteTweetText: description: The note content of the Tweet. example: Learn how to use the user Tweet timeline and user mention timeline endpoints in the X API v2 to explore Tweet\u2026 https:\/\/t.co\/56a0vZUx7i type: string Oauth1PermissionsProblem: allOf: - $ref: '#/components/schemas/Problem' description: A problem that indicates your client application does not have the required OAuth1 permissions for the requested endpoint. OldestId: description: The oldest id in this response. type: string OperationalDisconnectProblem: allOf: - $ref: '#/components/schemas/Problem' - properties: disconnect_type: enum: - OperationalDisconnect - UpstreamOperationalDisconnect - ForceDisconnect - UpstreamUncleanDisconnect - SlowReader - InternalError - ClientApplicationStateDegraded - InvalidRules type: string type: object description: You have been disconnected for operational reasons. PaginationToken32: description: A base32 pagination token. minLength: 16 type: string PaginationToken36: description: A base36 pagination token. minLength: 1 type: string PaginationTokenLong: description: A 'long' pagination token. maxLength: 19 minLength: 1 type: string PersonalizedTrend: description: A trend. properties: category: description: Category of this trend. type: string post_count: description: Number of posts pertaining to this trend. type: integer trend_name: description: Name of the trend. type: string trending_since: description: Time since this is trending. type: string type: object Photo: allOf: - $ref: '#/components/schemas/Media' - properties: alt_text: type: string url: format: uri type: string type: object Place: properties: contained_within: items: $ref: '#/components/schemas/PlaceId' minItems: 1 type: array country: description: The full name of the county in which this place exists. example: United States type: string country_code: $ref: '#/components/schemas/CountryCode' full_name: description: The full name of this place. example: Lakewood, CO type: string geo: $ref: '#/components/schemas/Geo' id: $ref: '#/components/schemas/PlaceId' name: description: The human readable name of this place. example: Lakewood type: string place_type: $ref: '#/components/schemas/PlaceType' required: - id - full_name type: object PlaceId: description: The identifier for this place. example: f7eb2fa2fea288b1 type: string PlaceType: enum: - poi - neighborhood - city - admin - country - unknown example: city type: string PlaidAccount: description: Descriptor for a Plaid account. properties: accountCategory: description: The category of the account (e.g., personal, business). type: string accountId: description: The Plaid account ID. type: string accountNumberDisplay: description: The last 2-4 digits of the account number. type: string accountType: description: The type of the account (e.g., checking, savings). type: string availableBalance: description: The available balance of the account. type: number currency: $ref: '#/components/schemas/PlaidCurrency' currentBalance: description: The current balance of the account. type: number nickname: description: The nickname of the account. type: string productName: description: The name of the product associated with the account. type: string status: description: The status of the account. type: string required: - accountId - accountCategory - accountNumberDisplay - accountType - currency - productName - status type: object PlaidAccountContact: description: Contact information associated with a Plaid account. properties: addresses: description: List of addresses associated with the account holder. items: $ref: '#/components/schemas/PlaidAddress' type: array emails: description: List of email addresses associated with the account holder. items: type: string type: array name: $ref: '#/components/schemas/PlaidName' relationship: description: Relationship of the contact to the account. type: string telephones: description: List of telephone numbers associated with the account holder. items: $ref: '#/components/schemas/PlaidTelephone' type: array required: - name - addresses - emails - telephones type: object PlaidAccountPaymentNetwork: description: Payment network details associated with the account. properties: bankId: description: The bank ID associated with the account. type: string identifier: description: The payment network identifier. type: string transferIn: description: Indicates if transfers into the account are supported. type: boolean transferOut: description: Indicates if transfers out of the account are supported. type: boolean type: description: The type of payment network (e.g., ACH, SEPA). type: string required: - identifier - type - transferIn - transferOut - bankId type: object PlaidAccountTransaction: description: Descriptor for a Plaid account. properties: accountCategory: description: The category of the account (e.g., personal, business). type: string amount: description: The amount transacted. type: number debitCreditMemo: description: Memo for transaction (e.g. CREDIT) type: string description: description: The transaction description type: string postedTimestamp: description: The timestamp when the transaction was posted. type: string status: description: The status of the transaction. type: string transactionId: description: The identifier for the transaction. type: string transactionTimestamp: description: The timestamp when the transaction occurred. type: string required: - accountCategory - amount - debitCreditMemo - description - status - transactionId - transactionTimestamp type: object PlaidAddress: description: Address information for the account holder. properties: city: description: The city of the address. type: string country: description: The country of the address (ISO 3166-1 alpha-2 code). type: string line1: description: The first line of the address. type: string line2: description: The second line of the address. type: string postalCode: description: The postal code of the address. type: string region: description: The region or state of the address. type: string required: - city - country - line1 type: object PlaidCurrency: description: Currency information. properties: currencyCode: description: The ISO 4217 currency code. type: string required: - currencyCode type: object PlaidCustomer: description: A user id for the plaid customer properties: customerId: $ref: '#/components/schemas/UserId' type: object PlaidName: description: Name information for the account holder. properties: first: description: The first name of the account holder. type: string last: description: The last name of the account holder. type: string required: - first - last type: object PlaidTelephone: description: Telephone information for the account holder. properties: country: description: The country code for the phone number (e.g., '+1'). type: string number: description: The phone number. type: string type: description: The type of phone number (e.g., 'mobile'). type: string required: - country - number - type type: object Point: description: A [GeoJson Point](https://tools.ietf.org/html/rfc7946#section-3.1.2) geometry object. properties: coordinates: $ref: '#/components/schemas/Position' type: enum: - Point example: Point type: string required: - type - coordinates type: object Poll: description: Represent a Poll attached to a Tweet. properties: duration_minutes: format: int32 maximum: 10080 minimum: 5 type: integer end_datetime: format: date-time type: string id: $ref: '#/components/schemas/PollId' options: items: $ref: '#/components/schemas/PollOption' maxItems: 4 minItems: 2 type: array voting_status: enum: - open - closed type: string required: - id - options type: object PollId: description: Unique identifier of this poll. example: '1365059861688410112' pattern: ^[0-9]{1,19}$ type: string PollOption: description: Describes a choice in a Poll object. properties: label: $ref: '#/components/schemas/PollOptionLabel' position: description: Position of this choice in the poll. type: integer votes: description: Number of users who voted for this choice. type: integer required: - position - label - votes type: object PollOptionLabel: description: The text of a poll choice. maxLength: 25 minLength: 1 type: string Position: description: A [GeoJson Position](https://tools.ietf.org/html/rfc7946#section-3.1.1) in the format `[longitude,latitude]`. example: - -105.18816086351444 - 40.247749999999996 items: type: number maxItems: 2 minItems: 2 type: array PreviewImage: properties: media_key: properties: media: $ref: '#/components/schemas/MediaId' media_category: default: TweetImage description: The media category of media enum: - TweetImage example: TweetImage type: string type: object required: - media_key type: object PreviousToken: description: The previous token. minLength: 1 type: string Problem: description: An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807). discriminator: mapping: about:blank: '#/components/schemas/GenericProblem' https://api.twitter.com/2/problems/client-disconnected: '#/components/schemas/ClientDisconnectedProblem' https://api.twitter.com/2/problems/client-forbidden: '#/components/schemas/ClientForbiddenProblem' https://api.twitter.com/2/problems/conflict: '#/components/schemas/ConflictProblem' https://api.twitter.com/2/problems/disallowed-resource: '#/components/schemas/DisallowedResourceProblem' https://api.twitter.com/2/problems/duplicate-rules: '#/components/schemas/DuplicateRuleProblem' https://api.twitter.com/2/problems/invalid-request: '#/components/schemas/InvalidRequestProblem' https://api.twitter.com/2/problems/invalid-rules: '#/components/schemas/InvalidRuleProblem' https://api.twitter.com/2/problems/noncompliant-rules: '#/components/schemas/NonCompliantRulesProblem' https://api.twitter.com/2/problems/not-authorized-for-field: '#/components/schemas/FieldUnauthorizedProblem' https://api.twitter.com/2/problems/not-authorized-for-resource: '#/components/schemas/ResourceUnauthorizedProblem' https://api.twitter.com/2/problems/operational-disconnect: '#/components/schemas/OperationalDisconnectProblem' https://api.twitter.com/2/problems/resource-not-found: '#/components/schemas/ResourceNotFoundProblem' https://api.twitter.com/2/problems/resource-unavailable: '#/components/schemas/ResourceUnavailableProblem' https://api.twitter.com/2/problems/rule-cap: '#/components/schemas/RulesCapProblem' https://api.twitter.com/2/problems/streaming-connection: '#/components/schemas/ConnectionExceptionProblem' https://api.twitter.com/2/problems/unsupported-authentication: '#/components/schemas/UnsupportedAuthenticationProblem' https://api.twitter.com/2/problems/usage-capped: '#/components/schemas/UsageCapExceededProblem' propertyName: type properties: detail: type: string status: type: integer title: type: string type: type: string required: - type - title type: object ProcessingInfo: properties: check_after_secs: description: Number of seconds to check again for status format: int32 type: integer progress_percent: description: Percent of upload progress format: int32 type: integer state: description: State of upload enum: - succeeded - in_progress - pending - failed type: string required: - type type: object ProfileUpdateActivityResponsePayload: additionalProperties: false properties: after: type: string before: type: string type: object ReplayJobCreateResponse: description: Confirmation that the replay job request was accepted. properties: created_at: description: The UTC timestamp indicating when the replay job was created. example: '2025-04-24T20:57:15.242Z' format: date-time type: string job_id: description: The unique identifier for the initiated replay job. example: '1915510368169844736' type: string required: - job_id - created_at type: object ReplySettings: description: Shows who can reply a Tweet. Fields returned are everyone, mentioned_users, and following. enum: - everyone - mentionedUsers - following - other pattern: ^[A-Za-z]{1,12}$ type: string ReplySettingsWithVerifiedUsers: description: Shows who can reply a Tweet. Fields returned are everyone, mentioned_users, subscribers, verified and following. enum: - everyone - mentionedUsers - following - other - subscribers - verified pattern: ^[A-Za-z]{1,12}$ type: string ResourceNotFoundProblem: allOf: - $ref: '#/components/schemas/Problem' - properties: parameter: minLength: 1 type: string resource_id: type: string resource_type: enum: - user - tweet - media - list - space type: string value: description: Value will match the schema of the field. type: string required: - parameter - value - resource_id - resource_type type: object description: A problem that indicates that a given Tweet, User, etc. does not exist. ResourceUnauthorizedProblem: allOf: - $ref: '#/components/schemas/Problem' - properties: parameter: type: string resource_id: type: string resource_type: enum: - user - tweet - media - list - space type: string section: enum: - data - includes type: string value: type: string required: - value - resource_id - resource_type - section - parameter type: object description: A problem that indicates you are not allowed to see a particular Tweet, User, etc. ResourceUnavailableProblem: allOf: - $ref: '#/components/schemas/Problem' - properties: parameter: minLength: 1 type: string resource_id: type: string resource_type: enum: - user - tweet - media - list - space type: string required: - parameter - resource_id - resource_type type: object description: A problem that indicates a particular Tweet, User, etc. is not available to you. ResultCount: description: The number of results returned in this response. format: int32 type: integer Rule: description: A user-provided stream filtering rule. properties: id: $ref: '#/components/schemas/RuleId' tag: $ref: '#/components/schemas/RuleTag' value: $ref: '#/components/schemas/RuleValue' required: - value type: object RuleId: description: Unique identifier of this rule. example: '120897978112909812' pattern: ^[0-9]{1,19}$ type: string RuleNoId: description: A user-provided stream filtering rule. properties: tag: $ref: '#/components/schemas/RuleTag' value: $ref: '#/components/schemas/RuleValue' required: - value type: object RuleTag: description: A tag meant for the labeling of user provided rules. example: Non-retweeted coffee Posts type: string RuleValue: description: The filterlang value of the rule. example: coffee -is:retweet type: string RulesCapProblem: allOf: - $ref: '#/components/schemas/Problem' description: You have exceeded the maximum number of rules. RulesCount: description: A count of user-provided stream filtering rules at the application and project levels. properties: all_project_client_apps: $ref: '#/components/schemas/AllProjectClientApps' cap_per_client_app: description: Cap of number of rules allowed per client application format: int32 type: integer cap_per_project: description: Cap of number of rules allowed per project format: int32 type: integer client_app_rules_count: $ref: '#/components/schemas/AppRulesCount' project_rules_count: description: Number of rules for project format: int32 type: integer type: object RulesLookupResponse: properties: data: items: $ref: '#/components/schemas/Rule' type: array meta: $ref: '#/components/schemas/RulesResponseMetadata' required: - meta type: object RulesRequestSummary: oneOf: - description: A summary of the results of the addition of user-specified stream filtering rules. properties: created: description: Number of user-specified stream filtering rules that were created. example: 1 format: int32 type: integer invalid: description: Number of invalid user-specified stream filtering rules. example: 1 format: int32 type: integer not_created: description: Number of user-specified stream filtering rules that were not created. example: 1 format: int32 type: integer valid: description: Number of valid user-specified stream filtering rules. example: 1 format: int32 type: integer required: - created - not_created - valid - invalid type: object - properties: deleted: description: Number of user-specified stream filtering rules that were deleted. format: int32 type: integer not_deleted: description: Number of user-specified stream filtering rules that were not deleted. format: int32 type: integer required: - deleted - not_deleted type: object RulesResponseMetadata: properties: next_token: $ref: '#/components/schemas/NextToken' result_count: description: Number of Rules in result set. format: int32 type: integer sent: type: string summary: $ref: '#/components/schemas/RulesRequestSummary' required: - sent type: object SearchCount: description: Represent a Search Count Result. properties: end: $ref: '#/components/schemas/End' start: $ref: '#/components/schemas/Start' tweet_count: $ref: '#/components/schemas/TweetCount' required: - end - start - tweet_count type: object SensitiveMediaWarning: properties: adult_content: description: Indicates if the content contains adult material example: true type: boolean graphic_violence: description: Indicates if the content depicts graphic violence example: true type: boolean other: description: Indicates if the content has other sensitive characteristics example: false type: boolean type: object SharedInfo: properties: shared: description: Indicates if the media is shared in direct messages example: false type: boolean required: - shared type: object Space: description: '' properties: created_at: description: Creation time of the Space. example: '2021-07-06T18:40:40.000Z' format: date-time type: string creator_id: $ref: '#/components/schemas/UserId' ended_at: description: End time of the Space. example: '2021-07-06T18:40:40.000Z' format: date-time type: string host_ids: description: The user ids for the hosts of the Space. items: $ref: '#/components/schemas/UserId' type: array id: $ref: '#/components/schemas/SpaceId' invited_user_ids: description: An array of user ids for people who were invited to a Space. items: $ref: '#/components/schemas/UserId' type: array is_ticketed: description: Denotes if the Space is a ticketed Space. example: 'false' type: boolean lang: description: The language of the Space. example: en type: string participant_count: description: The number of participants in a Space. example: 10 format: int32 type: integer scheduled_start: description: A date time stamp for when a Space is scheduled to begin. example: '2021-07-06T18:40:40.000Z' format: date-time type: string speaker_ids: description: An array of user ids for people who were speakers in a Space. items: $ref: '#/components/schemas/UserId' type: array started_at: description: When the Space was started as a date string. example: '2021-7-14T04:35:55Z' format: date-time type: string state: description: The current state of the Space. enum: - live - scheduled - ended example: live type: string subscriber_count: description: The number of people who have either purchased a ticket or set a reminder for this Space. example: 10 format: int32 type: integer title: description: The title of the Space. example: Spaces are Awesome type: string topics: description: The topics of a Space, as selected by its creator. items: description: The X Topic object. example: description: All about technology id: '848920371311001600' name: Technology properties: description: description: The description of the given topic. type: string id: description: An ID suitable for use in the REST API. type: string name: description: The name of the given topic. type: string required: - id - name type: object type: array updated_at: description: When the Space was last updated. example: '2021-7-14T04:35:55Z' format: date-time type: string required: - id - state type: object SpaceId: description: The unique identifier of this Space. example: 1SLjjRYNejbKM pattern: ^[a-zA-Z0-9]{1,13}$ type: string Start: description: The start time of the bucket. format: date-time type: string Sticker: properties: aspect_ratio: description: width-to-height ratio of the media example: 1.78 format: double type: number group_annotation_id: description: A unique identifier for the group of annotations associated with the media example: 987654321098765 format: long type: number id: description: Unique identifier for sticker example: '12345' type: string sticker_set_annotation_id: description: A unique identifier for the sticker set associated with the media example: 123456789012345 format: long type: number transform_a: description: Scale or rotate the media on the x-axis example: 1.0 format: double type: number transform_b: description: Skew the media on the x-axis example: 0.0 format: double type: number transform_c: description: Skew the media on the y-axis example: 0.0 format: double type: number transform_d: description: Scale or rotate the media on the y-axis example: 1.0 format: double type: number transform_tx: description: Scale or rotate the media on the x-axis example: 10.5 format: double type: number transform_ty: description: The vertical translation (shift) value for the media example: -5.2 format: double type: number type: object StickerInfo: properties: stickers: description: Stickers list must not be empty and should not exceed 25 items: $ref: '#/components/schemas/Sticker' type: array required: - stickers type: object StreamingLikeResponseV2: properties: data: $ref: '#/components/schemas/LikeWithTweetAuthor' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object StreamingTweetResponse: properties: data: $ref: '#/components/schemas/Tweet' errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array includes: $ref: '#/components/schemas/Expansions' type: object SubscriptionsCountGetResponse: properties: data: description: The count of active subscriptions across all webhooks properties: account_name: description: The account name type: string provisioned_count: description: The limit for subscriptions for this app type: string subscriptions_count_all: description: The number of active subscriptions across all webhooks type: string subscriptions_count_direct_messages: description: The number of active direct message subscriptions type: string required: - account_name - provisioned_count - subscriptions_count_all - subscriptions_count_direct_messages type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object SubscriptionsCreateRequest: type: object SubscriptionsCreateResponse: properties: data: properties: subscribed: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object SubscriptionsDeleteResponse: properties: data: properties: subscribed: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object SubscriptionsGetResponse: properties: data: properties: subscribed: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object SubscriptionsListGetResponse: properties: data: description: The list of active subscriptions for a specified webhook properties: application_id: description: The application ID type: string subscriptions: description: List of active subscriptions for the webhook items: properties: user_id: description: The ID of the user the webhook is subscribed to type: string type: object type: array webhook_id: description: The associated webhook ID type: string webhook_url: description: The url for the associated webhook type: string required: - application_id - webhook_id - webhook_url - subscriptions type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object SubtitleLanguageCode: description: The language code should be a BCP47 code (e.g. 'EN", "SP") example: EN pattern: ^[A-Z]{2}$ type: string Subtitles: properties: display_name: description: Language name in a human readable form example: English type: string id: $ref: '#/components/schemas/MediaId' language_code: $ref: '#/components/schemas/SubtitleLanguageCode' type: object SubtitlesCreateRequest: properties: id: $ref: '#/components/schemas/MediaId' media_category: $ref: '#/components/schemas/MediaCategorySubtitles' subtitles: $ref: '#/components/schemas/Subtitles' type: object SubtitlesCreateResponse: properties: data: properties: associated_subtitles: items: $ref: '#/components/schemas/Subtitles' minItems: 1 type: array id: $ref: '#/components/schemas/MediaId' media_category: $ref: '#/components/schemas/MediaCategorySubtitles' required: - id - media_category - associated_subtitles type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object SubtitlesDeleteRequest: properties: id: $ref: '#/components/schemas/MediaId' language_code: $ref: '#/components/schemas/SubtitleLanguageCode' media_category: $ref: '#/components/schemas/MediaCategorySubtitles' type: object SubtitlesDeleteResponse: properties: data: properties: deleted: type: boolean required: - deleted type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object TimestampedMetrics: properties: metrics: $ref: '#/components/schemas/Metrics' timestamp: description: ISO8601 Time example: '2025-03-17T06:30:00Z' title: Timestamp type: string type: object Topic: description: The topic of a Space, as selected by its creator. properties: description: description: The description of the given topic. example: All about technology type: string id: $ref: '#/components/schemas/TopicId' name: description: The name of the given topic. example: Technology type: string required: - id - name type: object TopicId: description: Unique identifier of this Topic. type: string Trend: description: A trend. properties: trend_name: description: Name of the trend. type: string tweet_count: description: Number of Posts in this trend. format: int32 type: integer type: object Tweet: example: author_id: '2244994945' created_at: Wed Jan 06 18:40:40 +0000 2021 id: '1346889436626259968' text: Learn how to use the user Tweet timeline and user mention timeline endpoints in the X API v2 to explore Tweet\u2026 https:\/\/t.co\/56a0vZUx7i username: XDevelopers properties: attachments: description: Specifies the type of attachments (if any) present in this Tweet. properties: media_keys: description: A list of Media Keys for each one of the media attachments (if media are attached). items: $ref: '#/components/schemas/MediaKey' minItems: 1 type: array media_source_tweet_id: description: A list of Posts the media on this Tweet was originally posted in. For example, if the media on a tweet is re-used in another Tweet, this refers to the original, source Tweet.. items: $ref: '#/components/schemas/TweetId' minItems: 1 type: array poll_ids: description: A list of poll IDs (if polls are attached). items: $ref: '#/components/schemas/PollId' minItems: 1 type: array type: object author_id: $ref: '#/components/schemas/UserId' community_id: $ref: '#/components/schemas/CommunityId' context_annotations: items: $ref: '#/components/schemas/ContextAnnotation' minItems: 1 type: array conversation_id: $ref: '#/components/schemas/TweetId' created_at: description: Creation time of the Tweet. example: '2021-01-06T18:40:40.000Z' format: date-time type: string display_text_range: $ref: '#/components/schemas/DisplayTextRange' edit_controls: properties: editable_until: description: Time when Tweet is no longer editable. example: '2021-01-06T18:40:40.000Z' format: date-time type: string edits_remaining: description: Number of times this Tweet can be edited. type: integer is_edit_eligible: description: Indicates if this Tweet is eligible to be edited. example: false type: boolean required: - is_edit_eligible - editable_until - edits_remaining type: object edit_history_tweet_ids: description: A list of Tweet Ids in this Tweet chain. items: $ref: '#/components/schemas/TweetId' minItems: 1 type: array entities: $ref: '#/components/schemas/FullTextEntities' geo: description: The location tagged on the Tweet, if the user provided one. properties: coordinates: $ref: '#/components/schemas/Point' place_id: $ref: '#/components/schemas/PlaceId' type: object id: $ref: '#/components/schemas/TweetId' in_reply_to_user_id: $ref: '#/components/schemas/UserId' lang: description: Language of the Tweet, if detected by X. Returned as a BCP47 language tag. example: en type: string non_public_metrics: description: Nonpublic engagement metrics for the Tweet at the time of the request. properties: impression_count: description: Number of times this Tweet has been viewed. format: int32 type: integer type: object note_tweet: description: The full-content of the Tweet, including text beyond 280 characters. properties: entities: properties: cashtags: items: $ref: '#/components/schemas/CashtagEntity' minItems: 1 type: array hashtags: items: $ref: '#/components/schemas/HashtagEntity' minItems: 1 type: array mentions: items: $ref: '#/components/schemas/MentionEntity' minItems: 1 type: array urls: items: $ref: '#/components/schemas/UrlEntity' minItems: 1 type: array type: object text: $ref: '#/components/schemas/NoteTweetText' type: object organic_metrics: description: Organic nonpublic engagement metrics for the Tweet at the time of the request. properties: impression_count: description: Number of times this Tweet has been viewed. type: integer like_count: description: Number of times this Tweet has been liked. type: integer reply_count: description: Number of times this Tweet has been replied to. type: integer retweet_count: description: Number of times this Tweet has been Retweeted. type: integer required: - impression_count - retweet_count - reply_count - like_count type: object possibly_sensitive: description: Indicates if this Tweet contains URLs marked as sensitive, for example content suitable for mature audiences. example: false type: boolean promoted_metrics: description: Promoted nonpublic engagement metrics for the Tweet at the time of the request. properties: impression_count: description: Number of times this Tweet has been viewed. format: int32 type: integer like_count: description: Number of times this Tweet has been liked. format: int32 type: integer reply_count: description: Number of times this Tweet has been replied to. format: int32 type: integer retweet_count: description: Number of times this Tweet has been Retweeted. format: int32 type: integer type: object public_metrics: description: Engagement metrics for the Tweet at the time of the request. properties: bookmark_count: description: Number of times this Tweet has been bookmarked. format: int32 type: integer impression_count: description: Number of times this Tweet has been viewed. format: int32 type: integer like_count: description: Number of times this Tweet has been liked. type: integer quote_count: description: Number of times this Tweet has been quoted. type: integer reply_count: description: Number of times this Tweet has been replied to. type: integer retweet_count: description: Number of times this Tweet has been Retweeted. type: integer required: - retweet_count - reply_count - like_count - impression_count - bookmark_count type: object referenced_tweets: description: A list of Posts this Tweet refers to. For example, if the parent Tweet is a Retweet, a Quoted Tweet or a Reply, it will include the related Tweet referenced to by its parent. items: properties: id: $ref: '#/components/schemas/TweetId' type: enum: - retweeted - quoted - replied_to type: string required: - type - id type: object minItems: 1 type: array reply_settings: $ref: '#/components/schemas/ReplySettingsWithVerifiedUsers' scopes: description: The scopes for this tweet properties: followers: description: Indicates if this Tweet is viewable by followers without the Tweet ID example: false type: boolean type: object source: description: This is deprecated. type: string suggested_source_links: items: $ref: '#/components/schemas/UrlEntity' minItems: 0 type: array suggested_source_links_with_counts: description: Suggested source links and the number of requests that included each link. properties: count: description: Number of note requests that included the source link. type: integer url: $ref: '#/components/schemas/UrlEntity' type: object text: $ref: '#/components/schemas/TweetText' username: $ref: '#/components/schemas/UserName' withheld: $ref: '#/components/schemas/TweetWithheld' type: object TweetComplianceData: description: Tweet compliance data. oneOf: - $ref: '#/components/schemas/TweetDeleteComplianceSchema' - $ref: '#/components/schemas/TweetWithheldComplianceSchema' - $ref: '#/components/schemas/TweetDropComplianceSchema' - $ref: '#/components/schemas/TweetUndropComplianceSchema' - $ref: '#/components/schemas/TweetEditComplianceSchema' TweetComplianceSchema: properties: event_at: description: Event time. example: '2021-07-06T18:40:40.000Z' format: date-time type: string quote_tweet_id: $ref: '#/components/schemas/TweetId' tweet: properties: author_id: $ref: '#/components/schemas/UserId' id: $ref: '#/components/schemas/TweetId' required: - id - author_id type: object required: - tweet - event_at type: object TweetComplianceStreamResponse: description: Tweet compliance stream events. oneOf: - description: Compliance event. properties: data: $ref: '#/components/schemas/TweetComplianceData' required: - data type: object - properties: errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array required: - errors type: object TweetCount: description: The count for the bucket. type: integer TweetCreateRequest: additionalProperties: false properties: card_uri: description: Card Uri Parameter. This is mutually exclusive from Quote Tweet Id, Poll, Media, and Direct Message Deep Link. type: string community_id: $ref: '#/components/schemas/CommunityId' direct_message_deep_link: description: Link to take the conversation from the public timeline to a private Direct Message. type: string edit_options: additionalProperties: false description: Options for editing an existing Post. When provided, this request will edit the specified Post instead of creating a new one. properties: previous_post_id: $ref: '#/components/schemas/TweetId' required: - previous_post_id type: object for_super_followers_only: default: false description: Exclusive Tweet for super followers. type: boolean geo: additionalProperties: false description: Place ID being attached to the Tweet for geo location. properties: place_id: type: string type: object media: additionalProperties: false description: Media information being attached to created Tweet. This is mutually exclusive from Quote Tweet Id, Poll, and Card URI. properties: media_ids: description: A list of Media Ids to be attached to a created Tweet. items: $ref: '#/components/schemas/MediaId' maxItems: 4 minItems: 1 type: array tagged_user_ids: description: A list of User Ids to be tagged in the media for created Tweet. items: $ref: '#/components/schemas/UserId' maxItems: 10 minItems: 0 type: array required: - media_ids type: object nullcast: default: false description: Nullcasted (promoted-only) Posts do not appear in the public timeline and are not served to followers. type: boolean poll: additionalProperties: false description: Poll options for a Tweet with a poll. This is mutually exclusive from Media, Quote Tweet Id, and Card URI. properties: duration_minutes: description: Duration of the poll in minutes. format: int32 maximum: 10080 minimum: 5 type: integer options: items: description: The text of a poll choice. maxLength: 25 minLength: 1 type: string maxItems: 4 minItems: 2 type: array reply_settings: description: Settings to indicate who can reply to the Tweet. enum: - following - mentionedUsers - subscribers - verified type: string required: - options - duration_minutes type: object quote_tweet_id: $ref: '#/components/schemas/TweetId' reply: additionalProperties: false description: Tweet information of the Tweet being replied to. properties: auto_populate_reply_metadata: description: If set to true, reply metadata will be automatically populated. type: boolean exclude_reply_user_ids: description: A list of User Ids to be excluded from the reply Tweet. items: $ref: '#/components/schemas/UserId' type: array in_reply_to_tweet_id: $ref: '#/components/schemas/TweetId' required: - in_reply_to_tweet_id type: object reply_settings: description: Settings to indicate who can reply to the Tweet. enum: - following - mentionedUsers - subscribers - verified type: string share_with_followers: default: false description: Share community post with followers too. type: boolean text: $ref: '#/components/schemas/TweetText' type: object TweetCreateResponse: properties: data: properties: id: $ref: '#/components/schemas/TweetId' text: $ref: '#/components/schemas/TweetText' required: - id - text type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object TweetDeleteComplianceSchema: properties: delete: $ref: '#/components/schemas/TweetComplianceSchema' required: - delete type: object TweetDeleteResponse: properties: data: properties: deleted: type: boolean required: - deleted type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object TweetDropComplianceSchema: properties: drop: $ref: '#/components/schemas/TweetComplianceSchema' required: - drop type: object TweetEditComplianceObjectSchema: properties: edit_tweet_ids: items: $ref: '#/components/schemas/TweetId' minItems: 1 type: array event_at: description: Event time. example: '2021-07-06T18:40:40.000Z' format: date-time type: string initial_tweet_id: $ref: '#/components/schemas/TweetId' tweet: properties: id: $ref: '#/components/schemas/TweetId' required: - id type: object required: - tweet - event_at - initial_tweet_id - edit_tweet_ids type: object TweetEditComplianceSchema: properties: tweet_edit: $ref: '#/components/schemas/TweetEditComplianceObjectSchema' required: - tweet_edit type: object TweetHideRequest: properties: hidden: type: boolean required: - hidden type: object TweetHideResponse: properties: data: properties: hidden: type: boolean type: object type: object TweetId: description: Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers. example: '1346889436626259968' pattern: ^[0-9]{1,19}$ type: string TweetLabelData: description: Tweet label data. oneOf: - $ref: '#/components/schemas/TweetNoticeSchema' - $ref: '#/components/schemas/TweetUnviewableSchema' TweetLabelStreamResponse: description: Tweet label stream events. oneOf: - description: Tweet Label event. properties: data: $ref: '#/components/schemas/TweetLabelData' required: - data type: object - properties: errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array required: - errors type: object TweetNotice: properties: application: description: "If the label is being applied or removed. Possible values\ \ are \u2018apply\u2019 or \u2018remove\u2019." example: apply type: string details: description: Information shown on the Tweet label type: string event_at: description: Event time. example: '2021-07-06T18:40:40.000Z' format: date-time type: string event_type: description: The type of label on the Tweet example: misleading type: string extended_details_url: description: Link to more information about this kind of label type: string label_title: description: Title/header of the Tweet label type: string tweet: properties: author_id: $ref: '#/components/schemas/UserId' id: $ref: '#/components/schemas/TweetId' required: - id - author_id type: object required: - tweet - event_type - event_at - application type: object TweetNoticeSchema: properties: public_tweet_notice: $ref: '#/components/schemas/TweetNotice' required: - public_tweet_notice type: object TweetTakedownComplianceSchema: properties: event_at: description: Event time. example: '2021-07-06T18:40:40.000Z' format: date-time type: string quote_tweet_id: $ref: '#/components/schemas/TweetId' tweet: properties: author_id: $ref: '#/components/schemas/UserId' id: $ref: '#/components/schemas/TweetId' required: - id - author_id type: object withheld_in_countries: items: $ref: '#/components/schemas/CountryCode' minItems: 1 type: array required: - tweet - withheld_in_countries - event_at type: object TweetText: description: The content of the Tweet. example: Learn how to use the user Tweet timeline and user mention timeline endpoints in the X API v2 to explore Tweet\u2026 https:\/\/t.co\/56a0vZUx7i type: string TweetUndropComplianceSchema: properties: undrop: $ref: '#/components/schemas/TweetComplianceSchema' required: - undrop type: object TweetUnviewable: properties: application: description: "If the label is being applied or removed. Possible values\ \ are \u2018apply\u2019 or \u2018remove\u2019." example: apply type: string event_at: description: Event time. example: '2021-07-06T18:40:40.000Z' format: date-time type: string tweet: properties: author_id: $ref: '#/components/schemas/UserId' id: $ref: '#/components/schemas/TweetId' required: - id - author_id type: object required: - tweet - event_at - application type: object TweetUnviewableSchema: properties: public_tweet_unviewable: $ref: '#/components/schemas/TweetUnviewable' required: - public_tweet_unviewable type: object TweetWithheld: description: Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country). properties: copyright: description: Indicates if the content is being withheld for on the basis of copyright infringement. type: boolean country_codes: description: Provides a list of countries where this content is not available. items: $ref: '#/components/schemas/CountryCode' minItems: 1 type: array uniqueItems: true scope: description: Indicates whether the content being withheld is the `tweet` or a `user`. enum: - tweet - user type: string required: - copyright - country_codes type: object TweetWithheldComplianceSchema: properties: withheld: $ref: '#/components/schemas/TweetTakedownComplianceSchema' required: - withheld type: object UnlikeComplianceSchema: properties: event_at: description: Event time. example: '2021-07-06T18:40:40.000Z' format: date-time type: string favorite: properties: id: $ref: '#/components/schemas/TweetId' user_id: $ref: '#/components/schemas/UserId' required: - id - user_id type: object required: - favorite - event_at type: object UnsupportedAuthenticationProblem: allOf: - $ref: '#/components/schemas/Problem' description: A problem that indicates that the authentication used is not supported. UploadExpiration: description: Expiration time of the upload URL. example: '2021-01-06T18:40:40.000Z' format: date-time type: string UploadSource: properties: upload_source: description: Records the source (e.g., app, device) from which the media was uploaded example: gallery type: string required: - upload_source type: object UploadUrl: description: URL to which the user will upload their Tweet or user IDs. format: uri type: string Url: description: A validly formatted URL. example: https://developer.twitter.com/en/docs/twitter-api format: uri type: string UrlEntity: allOf: - $ref: '#/components/schemas/EntityIndicesInclusiveExclusive' - $ref: '#/components/schemas/UrlFields' description: Represent the portion of text recognized as a URL, and its start and end position within the text. UrlEntityDm: allOf: - $ref: '#/components/schemas/EntityIndicesInclusiveExclusive' - $ref: '#/components/schemas/UrlFields' description: Represent the portion of text recognized as a URL, and its start and end position within the text. UrlFields: description: Represent the portion of text recognized as a URL. properties: description: description: Description of the URL landing page. example: This is a description of the website. type: string display_url: description: The URL as displayed in the X client. example: "twittercommunity.com/t/introducing-\u2026" type: string expanded_url: $ref: '#/components/schemas/Url' images: items: $ref: '#/components/schemas/UrlImage' minItems: 1 type: array media_key: $ref: '#/components/schemas/MediaKey' status: $ref: '#/components/schemas/HttpStatusCode' title: description: Title of the page the URL points to. example: Introducing the v2 follow lookup endpoints type: string unwound_url: description: Fully resolved url. example: https://twittercommunity.com/t/introducing-the-v2-follow-lookup-endpoints/147118 format: uri type: string url: $ref: '#/components/schemas/Url' required: - url type: object UrlImage: description: Represent the information for the URL image. properties: height: $ref: '#/components/schemas/MediaHeight' url: $ref: '#/components/schemas/Url' width: $ref: '#/components/schemas/MediaWidth' type: object Usage: description: Usage per client app properties: cap_reset_day: description: Number of days left for the Tweet cap to reset format: int32 type: integer daily_client_app_usage: description: The daily usage breakdown for each Client Application a project items: $ref: '#/components/schemas/ClientAppUsage' minItems: 1 type: array daily_project_usage: description: The daily usage breakdown for a project properties: project_id: description: The unique identifier for this project format: int32 type: integer usage: description: The usage value items: $ref: '#/components/schemas/UsageFields' minItems: 1 type: array type: object project_cap: description: Total number of Posts that can be read in this project per month format: int32 type: integer project_id: description: The unique identifier for this project format: ^[0-9]{1,19}$ type: string project_usage: description: The number of Posts read in this project format: int32 type: integer type: object UsageCapExceededProblem: allOf: - $ref: '#/components/schemas/Problem' - properties: period: enum: - Daily - Monthly type: string scope: enum: - Account - Product type: string type: object description: A problem that indicates that a usage cap has been exceeded. UsageFields: description: Represents the data for Usage properties: date: description: The time period for the usage example: '2021-01-06T18:40:40.000Z' format: date-time type: string usage: description: The usage value format: int32 type: integer type: object User: description: The X User object. example: created_at: '2013-12-14T04:35:55Z' id: '2244994945' name: X Dev protected: false username: TwitterDev properties: affiliation: description: Metadata about a user's affiliation. properties: badge_url: description: The badge URL corresponding to the affiliation. format: uri type: string description: description: The description of the affiliation. type: string url: description: The URL, if available, to details about an affiliation. format: uri type: string user_id: items: $ref: '#/components/schemas/UserId' minItems: 1 type: array type: object connection_status: description: Returns detailed information about the relationship between two users. items: description: Type of connection between users. enum: - follow_request_received - follow_request_sent - blocking - followed_by - following - muting type: string minItems: 0 type: array created_at: description: Creation time of this User. format: date-time type: string description: description: The text of this User's profile description (also known as bio), if the User provided one. type: string entities: description: A list of metadata found in the User's profile description. properties: description: $ref: '#/components/schemas/FullTextEntities' url: description: Expanded details for the URL specified in the User's profile, with start and end indices. properties: urls: items: $ref: '#/components/schemas/UrlEntity' minItems: 1 type: array type: object type: object id: $ref: '#/components/schemas/UserId' location: description: The location specified in the User's profile, if the User provided one. As this is a freeform value, it may not indicate a valid location, but it may be fuzzily evaluated when performing searches with location queries. type: string most_recent_tweet_id: $ref: '#/components/schemas/TweetId' name: description: The friendly name of this User, as shown on their profile. type: string pinned_tweet_id: $ref: '#/components/schemas/TweetId' profile_banner_url: description: The URL to the profile banner for this User. format: uri type: string profile_image_url: description: The URL to the profile image for this User. format: uri type: string protected: description: Indicates if this User has chosen to protect their Posts (in other words, if this User's Posts are private). type: boolean public_metrics: description: A list of metrics for this User. properties: followers_count: description: Number of Users who are following this User. type: integer following_count: description: Number of Users this User is following. type: integer like_count: description: The number of likes created by this User. type: integer listed_count: description: The number of lists that include this User. type: integer tweet_count: description: The number of Posts (including Retweets) posted by this User. type: integer required: - followers_count - following_count - tweet_count - listed_count type: object receives_your_dm: description: Indicates if you can send a DM to this User type: boolean subscription_type: description: 'The X Blue subscription type of the user, eg: Basic, Premium, PremiumPlus or None.' enum: - Basic - Premium - PremiumPlus - None type: string url: description: The URL specified in the User's profile. type: string username: $ref: '#/components/schemas/UserName' verified: description: Indicate if this User is a verified X User. type: boolean verified_type: description: 'The X Blue verified type of the user, eg: blue, government, business or none.' enum: - blue - government - business - none type: string withheld: $ref: '#/components/schemas/UserWithheld' required: - id - name - username type: object UserComplianceData: description: User compliance data. oneOf: - $ref: '#/components/schemas/UserProtectComplianceSchema' - $ref: '#/components/schemas/UserUnprotectComplianceSchema' - $ref: '#/components/schemas/UserDeleteComplianceSchema' - $ref: '#/components/schemas/UserUndeleteComplianceSchema' - $ref: '#/components/schemas/UserSuspendComplianceSchema' - $ref: '#/components/schemas/UserUnsuspendComplianceSchema' - $ref: '#/components/schemas/UserWithheldComplianceSchema' - $ref: '#/components/schemas/UserScrubGeoSchema' - $ref: '#/components/schemas/UserProfileModificationComplianceSchema' UserComplianceSchema: properties: event_at: description: Event time. example: '2021-07-06T18:40:40.000Z' format: date-time type: string user: properties: id: $ref: '#/components/schemas/UserId' required: - id type: object required: - user - event_at type: object UserComplianceStreamResponse: description: User compliance stream events. oneOf: - description: User compliance event. properties: data: $ref: '#/components/schemas/UserComplianceData' required: - data type: object - properties: errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array required: - errors type: object UserDeleteComplianceSchema: properties: user_delete: $ref: '#/components/schemas/UserComplianceSchema' required: - user_delete type: object UserId: description: Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers. example: '2244994945' pattern: ^[0-9]{1,19}$ type: string UserIdMatchesAuthenticatedUser: description: Unique identifier of this User. The value must be the same as the authenticated user. example: '2244994945' type: string UserName: description: The X handle (screen name) of this user. pattern: ^[A-Za-z0-9_]{1,15}$ type: string UserProfileModificationComplianceSchema: properties: user_profile_modification: $ref: '#/components/schemas/UserProfileModificationObjectSchema' required: - user_profile_modification type: object UserProfileModificationObjectSchema: properties: event_at: description: Event time. example: '2021-07-06T18:40:40.000Z' format: date-time type: string new_value: type: string profile_field: type: string user: properties: id: $ref: '#/components/schemas/UserId' required: - id type: object required: - user - profile_field - new_value - event_at type: object UserProtectComplianceSchema: properties: user_protect: $ref: '#/components/schemas/UserComplianceSchema' required: - user_protect type: object UserScrubGeoObjectSchema: properties: event_at: description: Event time. example: '2021-07-06T18:40:40.000Z' format: date-time type: string up_to_tweet_id: $ref: '#/components/schemas/TweetId' user: properties: id: $ref: '#/components/schemas/UserId' required: - id type: object required: - user - up_to_tweet_id - event_at type: object UserScrubGeoSchema: properties: scrub_geo: $ref: '#/components/schemas/UserScrubGeoObjectSchema' required: - scrub_geo type: object UserSearchQueryVnext: description: The the search string by which to query for users. pattern: ^[A-Za-z0-9_' ]{1,50}$ type: string UserSuspendComplianceSchema: properties: user_suspend: $ref: '#/components/schemas/UserComplianceSchema' required: - user_suspend type: object UserTakedownComplianceSchema: properties: event_at: description: Event time. example: '2021-07-06T18:40:40.000Z' format: date-time type: string user: properties: id: $ref: '#/components/schemas/UserId' required: - id type: object withheld_in_countries: items: $ref: '#/components/schemas/CountryCode' minItems: 1 type: array required: - user - withheld_in_countries - event_at type: object UserUndeleteComplianceSchema: properties: user_undelete: $ref: '#/components/schemas/UserComplianceSchema' required: - user_undelete type: object UserUnprotectComplianceSchema: properties: user_unprotect: $ref: '#/components/schemas/UserComplianceSchema' required: - user_unprotect type: object UserUnsuspendComplianceSchema: properties: user_unsuspend: $ref: '#/components/schemas/UserComplianceSchema' required: - user_unsuspend type: object UserWithheld: description: Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country). properties: country_codes: description: Provides a list of countries where this content is not available. items: $ref: '#/components/schemas/CountryCode' minItems: 1 type: array uniqueItems: true scope: description: Indicates that the content being withheld is a `user`. enum: - user type: string required: - country_codes type: object UserWithheldComplianceSchema: properties: user_withheld: $ref: '#/components/schemas/UserTakedownComplianceSchema' required: - user_withheld type: object UsersDMBlockCreateResponse: properties: data: properties: blocked: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object UsersDMUnBlockCreateResponse: properties: data: properties: blocked: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object UsersFollowingCreateRequest: properties: target_user_id: $ref: '#/components/schemas/UserId' required: - target_user_id type: object UsersFollowingCreateResponse: properties: data: properties: following: type: boolean pending_follow: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object UsersFollowingDeleteResponse: properties: data: properties: following: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object UsersLikesCreateRequest: properties: tweet_id: $ref: '#/components/schemas/TweetId' required: - tweet_id type: object UsersLikesCreateResponse: properties: data: properties: liked: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object UsersLikesDeleteResponse: properties: data: properties: liked: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object UsersRetweetsCreateRequest: additionalProperties: false properties: tweet_id: $ref: '#/components/schemas/TweetId' required: - tweet_id type: object UsersRetweetsCreateResponse: properties: data: properties: id: $ref: '#/components/schemas/TweetId' retweeted: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object UsersRetweetsDeleteResponse: properties: data: properties: retweeted: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object Variant: properties: bit_rate: description: The bit rate of the media. type: integer content_type: description: The content type of the media. type: string url: description: The url to the media. format: uri type: string type: object Variants: description: An array of all available variants of the media. items: $ref: '#/components/schemas/Variant' type: array Video: allOf: - $ref: '#/components/schemas/Media' - properties: duration_ms: type: integer non_public_metrics: description: Nonpublic engagement metrics for the Media at the time of the request. properties: playback_0_count: description: Number of users who made it through 0% of the video. format: int32 type: integer playback_100_count: description: Number of users who made it through 100% of the video. format: int32 type: integer playback_25_count: description: Number of users who made it through 25% of the video. format: int32 type: integer playback_50_count: description: Number of users who made it through 50% of the video. format: int32 type: integer playback_75_count: description: Number of users who made it through 75% of the video. format: int32 type: integer type: object organic_metrics: description: Organic nonpublic engagement metrics for the Media at the time of the request. properties: playback_0_count: description: Number of users who made it through 0% of the video. format: int32 type: integer playback_100_count: description: Number of users who made it through 100% of the video. format: int32 type: integer playback_25_count: description: Number of users who made it through 25% of the video. format: int32 type: integer playback_50_count: description: Number of users who made it through 50% of the video. format: int32 type: integer playback_75_count: description: Number of users who made it through 75% of the video. format: int32 type: integer view_count: description: Number of times this video has been viewed. format: int32 type: integer type: object preview_image_url: format: uri type: string promoted_metrics: description: Promoted nonpublic engagement metrics for the Media at the time of the request. properties: playback_0_count: description: Number of users who made it through 0% of the video. format: int32 type: integer playback_100_count: description: Number of users who made it through 100% of the video. format: int32 type: integer playback_25_count: description: Number of users who made it through 25% of the video. format: int32 type: integer playback_50_count: description: Number of users who made it through 50% of the video. format: int32 type: integer playback_75_count: description: Number of users who made it through 75% of the video. format: int32 type: integer view_count: description: Number of times this video has been viewed. format: int32 type: integer type: object public_metrics: description: Engagement metrics for the Media at the time of the request. properties: view_count: description: Number of times this video has been viewed. format: int32 type: integer type: object variants: $ref: '#/components/schemas/Variants' type: object WebhookConfig: description: A Webhook Configuration properties: created_at: format: date-time type: string id: $ref: '#/components/schemas/WebhookConfigId' url: description: The callback URL of the webhook. type: string valid: type: boolean required: - id - url - valid - created_at type: object WebhookConfigCreateRequest: properties: url: maxLength: 200 minLength: 1 type: string required: - url type: object WebhookConfigCreateResponse: description: A Webhook Configuration properties: created_at: format: date-time type: string id: $ref: '#/components/schemas/WebhookConfigId' url: description: The callback URL of the webhook. type: string valid: type: boolean required: - id - url - valid - created_at type: object WebhookConfigDeleteResponse: properties: data: properties: deleted: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object WebhookConfigId: description: The unique identifier of this webhook config. example: '1146654567674912769' pattern: ^[0-9]{1,19}$ type: string WebhookConfigPutResponse: properties: data: properties: attempted: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object WebhookLinksCreateResponse: properties: data: properties: provisioned: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object WebhookLinksDeleteResponse: properties: data: properties: deleted: type: boolean type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object WebhookLinksGetResponse: properties: data: description: The list of active webhook links for a given stream properties: links: description: list of links items: properties: application_id: description: The application ID type: string business_user_id: description: The user ID type: string created_at: description: The datetime the webhook was linked to the stream format: data-time type: string fields: description: Requested fields to be rendered items: description: A query-parameter formatted field or expansion, e.g., 'expansions=author_id' or 'user.fields=name,username' type: string type: array instance_id: description: The stream ID associated with the FilteredStream instance type: string webhook_id: description: The unique identifier for the webhook type: string type: object type: array required: - links type: object errors: items: $ref: '#/components/schemas/Problem' minItems: 1 type: array type: object WebhookReplayCreateRequest: properties: from_date: description: The oldest (starting) UTC timestamp (inclusive) from which events will be provided, in yyyymmddhhmm format. example: '202504242000' pattern: ^[0-9]{12}$ type: string to_date: description: The oldest (starting) UTC timestamp (inclusive) from which events will be provided, in yyyymmddhhmm format. example: '202504242000' pattern: ^[0-9]{12}$ type: string webhook_id: $ref: '#/components/schemas/WebhookConfigId' required: - webhook_id - from_date - to_date type: object securitySchemes: BearerToken: scheme: bearer type: http OAuth2UserToken: flows: authorizationCode: authorizationUrl: https://api.x.com/2/oauth2/authorize scopes: block.read: View accounts you have blocked. bookmark.read: Read your bookmarked Posts. bookmark.write: Create and delete your bookmarks. dm.read: Read all your Direct Messages. dm.write: Send and manage your Direct Messages. follows.read: View accounts you follow and accounts following you. follows.write: Follow and unfollow accounts on your behalf. like.read: View Posts you have liked and likes you can see. like.write: Like and unlike Posts on your behalf. list.read: View Lists, members, and followers of Lists you created or are a member of, including private Lists. list.write: Create and manage Lists on your behalf. media.write: Upload media, such as photos and videos, on your behalf. mute.read: View accounts you have muted. mute.write: Mute and unmute accounts on your behalf. offline.access: Request a refresh token for the app. space.read: View all Spaces you have access to. timeline.read: View all Custom Timelines you can see, including public Custom Timelines from other developers. tweet.moderate.write: Hide and unhide replies to your Posts. tweet.read: View all Posts you can see, including those from protected accounts. tweet.write: Post and repost on your behalf. users.read: View any account you can see, including protected accounts. tokenUrl: https://api.x.com/2/oauth2/token type: oauth2 UserToken: scheme: OAuth type: http info: contact: name: X Developers url: https://developer.x.com/ description: X API v2 available endpoints license: name: X Developer Agreement and Policy url: https://developer.x.com/en/developer-terms/agreement-and-policy.html termsOfService: https://developer.x.com/en/developer-terms/agreement-and-policy.html title: X API v2 version: '2.157' openapi: 3.0.0 paths: /2/account_activity/replay/webhooks/{webhook_id}/subscriptions/all: post: description: Creates a replay job to retrieve activities from up to the past 5 days for all subscriptions associated with a given webhook. externalDocs: url: https://docs.x.com/x-api/account-activity/introduction operationId: createAccountActivityReplayJob parameters: - description: The unique identifier for the webhook configuration. in: path name: webhook_id required: true schema: $ref: '#/components/schemas/WebhookConfigId' style: simple - description: The oldest (starting) UTC timestamp (inclusive) from which events will be provided, in `yyyymmddhhmm` format. in: query name: from_date required: true schema: example: '202504242000' pattern: ^\d{12}$ type: string style: form - description: The latest (ending) UTC timestamp (exclusive) up to which events will be provided, in `yyyymmddhhmm` format. in: query name: to_date required: true schema: example: '202504242200' pattern: ^\d{12}$ type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReplayJobCreateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Create replay job tags: - Account Activity /2/account_activity/subscriptions/count: get: description: Retrieves a count of currently active Account Activity subscriptions. externalDocs: url: https://docs.x.com/x-api/account-activity/introduction operationId: getAccountActivitySubscriptionCount parameters: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionsCountGetResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Get subscription count tags: - Account Activity /2/account_activity/webhooks/{webhook_id}/subscriptions/all: get: description: "Checks a user\u2019s Account Activity subscription for a given\ \ webhook." externalDocs: url: https://docs.x.com/x-api/account-activity/introduction operationId: validateAccountActivitySubscription parameters: - description: The webhook ID to check subscription against. in: path name: webhook_id required: true schema: $ref: '#/components/schemas/WebhookConfigId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionsGetResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - dm.read - dm.write - tweet.read - users.read - UserToken: [] summary: Validate subscription tags: - Account Activity post: description: Creates an Account Activity subscription for the user and the given webhook. externalDocs: url: https://docs.x.com/x-api/account-activity/introduction operationId: createAccountActivitySubscription parameters: - description: The webhook ID to check subscription against. in: path name: webhook_id required: true schema: $ref: '#/components/schemas/WebhookConfigId' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionsCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionsCreateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - dm.read - dm.write - tweet.read - users.read - UserToken: [] summary: Create subscription tags: - Account Activity /2/account_activity/webhooks/{webhook_id}/subscriptions/all/list: get: description: Retrieves a list of all active subscriptions for a given webhook. externalDocs: url: https://docs.x.com/x-api/account-activity/introduction operationId: getAccountActivitySubscriptions parameters: - description: The webhook ID to pull subscriptions for. in: path name: webhook_id required: true schema: $ref: '#/components/schemas/WebhookConfigId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionsListGetResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Get subscriptions tags: - Account Activity /2/account_activity/webhooks/{webhook_id}/subscriptions/{user_id}/all: delete: description: Deletes an Account Activity subscription for the given webhook and user ID. externalDocs: url: https://docs.x.com/x-api/account-activity/introduction operationId: deleteAccountActivitySubscription parameters: - description: The webhook ID to check subscription against. in: path name: webhook_id required: true schema: $ref: '#/components/schemas/WebhookConfigId' style: simple - description: User ID to unsubscribe from. in: path name: user_id required: true schema: $ref: '#/components/schemas/UserId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionsDeleteResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Delete subscription tags: - Account Activity /2/activity/stream: get: description: Stream of X Activities externalDocs: url: https://docs.x.com/x-api/activity/activity-stream operationId: activityStream parameters: - description: The number of minutes of backfill requested. in: query name: backfill_minutes required: false schema: format: int32 maximum: 5 minimum: 0 type: integer style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post labels will be provided. example: '2021-02-01T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Post labels will be provided. example: '2021-02-01T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ActivityStreamingResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Activity Stream tags: - Activity - Stream x-twitter-streaming: true /2/activity/subscriptions: get: description: Get a list of active subscriptions for XAA externalDocs: url: https://docs.x.com/x-api/activity/get-x-activity-subscriptions operationId: getActivitySubscriptions parameters: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ActivitySubscriptionGetResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Get X activity subscriptions tags: - Activity post: description: Creates a subscription for an X activity event externalDocs: url: https://docs.x.com/x-api/activity/create-x-activity-subscription operationId: createActivitySubscription parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivitySubscriptionCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ActivitySubscriptionCreateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - dm.read - tweet.read - UserToken: [] summary: Create X activity subscription tags: - Activity - Stream /2/activity/subscriptions/{subscription_id}: delete: description: Deletes a subscription for an X activity event externalDocs: url: https://docs.x.com/x-api/activity/deletes-x-activity-subscription operationId: deleteActivitySubscription parameters: - description: The ID of the subscription to delete. in: path name: subscription_id required: true schema: $ref: '#/components/schemas/ActivitySubscriptionId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/ActivitySubscriptionDeleteResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Deletes X activity subscription tags: - Activity put: description: Updates a subscription for an X activity event externalDocs: url: https://docs.x.com/x-api/activity/update-x-activity-subscription operationId: updateActivitySubscription parameters: - description: The ID of the subscription to update. in: path name: subscription_id required: true schema: $ref: '#/components/schemas/ActivitySubscriptionId' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivitySubscriptionUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ActivitySubscriptionUpdateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Update X activity subscription tags: - Activity /2/communities/search: get: description: Retrieves a list of Communities matching the specified search query. externalDocs: url: https://developer.x.com operationId: searchCommunities parameters: - description: Query to search communities. in: query name: query required: true schema: example: Love maxLength: 4096 minLength: 1 type: string style: form - description: The maximum number of search results to be returned by a request. in: query name: max_results required: false schema: default: 10 format: int32 maximum: 100 minimum: 10 type: integer style: form - description: This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. in: query name: next_token required: false schema: $ref: '#/components/schemas/NextToken' style: form - description: This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/NextToken' style: form - $ref: '#/components/parameters/CommunityFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2CommunitiesSearchResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Search Communities tags: - Communities /2/communities/{id}: get: description: Retrieves details of a specific Community by its ID. externalDocs: url: https://developer.x.com/en/docs/x-api/communities/api-reference/get-communities-id operationId: getCommunitiesById parameters: - description: The ID of the Community. in: path name: id required: true schema: $ref: '#/components/schemas/CommunityId' style: simple - $ref: '#/components/parameters/CommunityFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2CommunitiesIdResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - list.read - tweet.read - users.read - UserToken: [] summary: Get Community by ID tags: - Communities /2/compliance/jobs: get: description: Retrieves a list of Compliance Jobs filtered by job type and optional status. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/get-compliance-jobs operationId: getComplianceJobs parameters: - description: Type of Compliance Job to list. in: query name: type required: true schema: enum: - tweets - users type: string style: form - description: Status of Compliance Job to list. in: query name: status required: false schema: enum: - created - in_progress - failed - complete type: string style: form - $ref: '#/components/parameters/ComplianceJobFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2ComplianceJobsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Get Compliance Jobs tags: - Compliance post: description: Creates a new Compliance Job for the specified job type. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/post-compliance-jobs operationId: createComplianceJobs parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateComplianceJobRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateComplianceJobResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Create Compliance Job tags: - Compliance /2/compliance/jobs/{id}: get: description: Retrieves details of a specific Compliance Job by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/get-compliance-jobs-id operationId: getComplianceJobsById parameters: - description: The ID of the Compliance Job to retrieve. in: path name: id required: true schema: $ref: '#/components/schemas/JobId' style: simple - $ref: '#/components/parameters/ComplianceJobFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2ComplianceJobsIdResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Get Compliance Job by ID tags: - Compliance /2/connections: get: description: Returns active and historical streaming connections with disconnect reasons for the authenticated application. operationId: getConnectionHistory parameters: - description: Filter by connection status. Use 'active' for current connections, 'inactive' for historical/disconnected connections, or 'all' for both. in: query name: status required: false schema: default: active enum: - active - inactive - all type: string style: form - description: Filter by streaming endpoint. Specify one or more endpoint names to filter results. explode: false in: query name: endpoints required: false schema: items: enum: - filter_stream - sample_stream - sample10_stream - firehose_stream - tweets_compliance_stream - users_compliance_stream - tweet_label_stream - firehose_stream_lang_en - firehose_stream_lang_ja - firehose_stream_lang_ko - firehose_stream_lang_pt - likes_firehose_stream - likes_sample10_stream - likes_compliance_stream type: string type: array uniqueItems: true style: form - description: The maximum number of results to return per page. in: query name: max_results required: false schema: default: 10 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: Token for paginating through results. Use the value from 'next_token' in the previous response. in: query name: pagination_token required: false schema: type: string style: form - $ref: '#/components/parameters/ConnectionFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2ConnectionsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Get Connection History tags: - Connections /2/connections/all: delete: description: Terminates all active streaming connections for the authenticated application. externalDocs: url: https://docs.x.com/x-api/connections/terminate-all-connections operationId: deleteAllConnections parameters: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/KillAllConnectionsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Terminate all connections tags: - Connections /2/dm_conversations: post: description: Initiates a new direct message conversation with specified participants. operationId: createDirectMessagesConversation parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDmConversationRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateDmEventResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - dm.write - tweet.read - users.read - UserToken: [] summary: Create DM conversation tags: - Direct Messages /2/dm_conversations/with/{participant_id}/dm_events: get: description: Retrieves direct message events for a specific conversation. operationId: getDirectMessagesEventsByParticipantId parameters: - description: The ID of the participant user for the One to One DM conversation. in: path name: participant_id required: true schema: $ref: '#/components/schemas/UserId' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get a specified 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken32' style: form - description: The set of event_types to include in the results. explode: false in: query name: event_types required: false schema: default: - MessageCreate - ParticipantsLeave - ParticipantsJoin example: - MessageCreate - ParticipantsLeave items: enum: - MessageCreate - ParticipantsJoin - ParticipantsLeave type: string minItems: 1 type: array uniqueItems: true style: form - $ref: '#/components/parameters/DmEventFieldsParameter' - $ref: '#/components/parameters/DmEventExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2DmConversationsWithParticipantIdDmEventsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - dm.read - tweet.read - users.read - UserToken: [] summary: Get DM events for a DM conversation tags: - Direct Messages /2/dm_conversations/with/{participant_id}/messages: post: description: Sends a new direct message to a specific participant by their ID. operationId: createDirectMessagesByParticipantId parameters: - description: The ID of the recipient user that will receive the DM. in: path name: participant_id required: true schema: $ref: '#/components/schemas/UserId' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMessageRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateDmEventResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - dm.write - tweet.read - users.read - UserToken: [] summary: Create DM message by participant ID tags: - Direct Messages /2/dm_conversations/{dm_conversation_id}/messages: post: description: Sends a new direct message to a specific conversation by its ID. operationId: createDirectMessagesByConversationId parameters: - description: The DM Conversation ID. in: path name: dm_conversation_id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMessageRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateDmEventResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - dm.write - tweet.read - users.read - UserToken: [] summary: Create DM message by conversation ID tags: - Direct Messages /2/dm_conversations/{id}/dm_events: get: description: Retrieves direct message events for a specific conversation. operationId: getDirectMessagesEventsByConversationId parameters: - description: The DM conversation ID. in: path name: id required: true schema: $ref: '#/components/schemas/DmConversationId' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get a specified 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken32' style: form - description: The set of event_types to include in the results. explode: false in: query name: event_types required: false schema: default: - MessageCreate - ParticipantsLeave - ParticipantsJoin example: - MessageCreate - ParticipantsLeave items: enum: - MessageCreate - ParticipantsJoin - ParticipantsLeave type: string minItems: 1 type: array uniqueItems: true style: form - $ref: '#/components/parameters/DmEventFieldsParameter' - $ref: '#/components/parameters/DmEventExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2DmConversationsIdDmEventsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - dm.read - tweet.read - users.read - UserToken: [] summary: Get DM events for a DM conversation tags: - Direct Messages /2/dm_events: get: description: Retrieves a list of recent direct message events across all conversations. operationId: getDirectMessagesEvents parameters: - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get a specified 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken32' style: form - description: The set of event_types to include in the results. explode: false in: query name: event_types required: false schema: default: - MessageCreate - ParticipantsLeave - ParticipantsJoin example: - MessageCreate - ParticipantsLeave items: enum: - MessageCreate - ParticipantsJoin - ParticipantsLeave type: string minItems: 1 type: array uniqueItems: true style: form - $ref: '#/components/parameters/DmEventFieldsParameter' - $ref: '#/components/parameters/DmEventExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2DmEventsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - dm.read - tweet.read - users.read - UserToken: [] summary: Get DM events tags: - Direct Messages /2/dm_events/{event_id}: delete: description: Deletes a specific direct message event by its ID, if owned by the authenticated user. operationId: deleteDirectMessagesEvents parameters: - description: The ID of the direct-message event to delete. in: path name: event_id required: true schema: $ref: '#/components/schemas/DmEventId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeleteDmResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - dm.read - dm.write - UserToken: [] summary: Delete DM event tags: - Direct Messages get: description: Retrieves details of a specific direct message event by its ID. operationId: getDirectMessagesEventsById parameters: - description: dm event id. in: path name: event_id required: true schema: $ref: '#/components/schemas/DmEventId' style: simple - $ref: '#/components/parameters/DmEventFieldsParameter' - $ref: '#/components/parameters/DmEventExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2DmEventsEventIdResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - dm.read - tweet.read - users.read - UserToken: [] summary: Get DM event by ID tags: - Direct Messages /2/evaluate_note: post: description: Endpoint to evaluate a community note. externalDocs: url: https://communitynotes.x.com/guide/api/overview operationId: evaluateCommunityNotes parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/EvaluateNoteRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/EvaluateNoteResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.write - UserToken: [] summary: Evaluate a Community Note tags: - Community Notes /2/insights/28hr: get: description: Retrieves engagement metrics for specified Posts over the last 28 hours. operationId: getInsights28Hr parameters: - description: List of PostIds for 28hr metrics. in: query name: tweet_ids required: true schema: example: - '20' items: $ref: '#/components/schemas/TweetId' maxItems: 25 minItems: 1 type: array uniqueItems: true style: form - description: granularity of metrics response. in: query name: granularity required: true schema: enum: - Daily - Hourly - Weekly - Total example: Total type: string style: form - description: request metrics for historical request. in: query name: requested_metrics required: true schema: items: enum: - AppInstallAttempts - AppOpens - DetailExpands - EmailTweet - Engagements - Follows - HashtagClicks - Impressions - Likes - LinkClicks - MediaEngagements - MediaViews - PermalinkClicks - ProfileVisits - QuoteTweets - Replies - Retweets - UniqueVideoViews - UrlClicks - UserProfileClicks - VideoCompletions - VideoPlayed25Percent - VideoPlayed50Percent - VideoPlayed75Percent - VideoStarts - VideoViews type: string minItems: 1 type: array uniqueItems: true style: form - $ref: '#/components/parameters/EngagementFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2Insights28hrResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.read - UserToken: [] summary: Get 28-hour Post insights tags: - Tweets /2/insights/historical: get: description: Retrieves historical engagement metrics for specified Posts within a defined time range. operationId: getInsightsHistorical parameters: - description: List of PostIds for historical metrics. in: query name: tweet_ids required: true schema: example: - '20' items: $ref: '#/components/schemas/TweetId' maxItems: 25 minItems: 1 type: array uniqueItems: true style: form - description: YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the end of the time range. example: '2021-02-01T18:40:40.000Z' in: query name: end_time required: true schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the start of the time range. example: '2021-02-01T18:40:40.000Z' in: query name: start_time required: true schema: format: date-time type: string style: form - description: granularity of metrics response. in: query name: granularity required: true schema: enum: - Daily - Hourly - Weekly - Total example: Total type: string style: form - description: request metrics for historical request. in: query name: requested_metrics required: true schema: items: enum: - AppInstallAttempts - AppOpens - DetailExpands - EmailTweet - Engagements - Follows - HashtagClicks - Impressions - Likes - LinkClicks - MediaEngagements - MediaViews - PermalinkClicks - ProfileVisits - QuoteTweets - Replies - Retweets - UniqueVideoViews - UrlClicks - UserProfileClicks - VideoCompletions - VideoPlayed25Percent - VideoPlayed50Percent - VideoPlayed75Percent - VideoStarts - VideoViews type: string minItems: 1 type: array uniqueItems: true style: form - $ref: '#/components/parameters/EngagementFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2InsightsHistoricalResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.read - UserToken: [] summary: Get historical Post insights tags: - Tweets /2/likes/compliance/stream: get: description: Streams all compliance data related to Likes for Users. operationId: streamLikesCompliance parameters: - description: The number of minutes of backfill requested. in: query name: backfill_minutes required: false schema: format: int32 maximum: 5 minimum: 0 type: integer style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Likes Compliance events will be provided. example: '2021-02-01T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Likes Compliance events will be provided. example: '2021-02-01T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/LikesComplianceStreamResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Stream Likes compliance data tags: - Stream - Compliance x-twitter-streaming: true /2/likes/firehose/stream: get: description: Streams all public Likes in real-time. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/get-likes-firehose-stream operationId: streamLikesFirehose parameters: - description: The number of minutes of backfill requested. in: query name: backfill_minutes required: false schema: format: int32 maximum: 5 minimum: 0 type: integer style: form - description: The partition number. in: query name: partition required: true schema: format: int32 maximum: 20 minimum: 1 type: integer style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form - $ref: '#/components/parameters/LikeWithTweetAuthorFieldsParameter' - $ref: '#/components/parameters/LikeWithTweetAuthorExpansionsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/StreamingLikeResponseV2' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Stream all Likes tags: - Stream - Likes x-twitter-streaming: true /2/likes/sample10/stream: get: description: Streams a 10% sample of public Likes in real-time. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/likes/firehose/api-reference/get-likes-sample10-stream operationId: streamLikesSample10 parameters: - description: The number of minutes of backfill requested. in: query name: backfill_minutes required: false schema: format: int32 maximum: 5 minimum: 0 type: integer style: form - description: The partition number. in: query name: partition required: true schema: format: int32 maximum: 2 minimum: 1 type: integer style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form - $ref: '#/components/parameters/LikeWithTweetAuthorFieldsParameter' - $ref: '#/components/parameters/LikeWithTweetAuthorExpansionsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/StreamingLikeResponseV2' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Stream sampled Likes tags: - Stream - Likes x-twitter-streaming: true /2/lists: post: description: Creates a new List for the authenticated user. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/post-lists operationId: createLists parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/ListCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListCreateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - list.read - list.write - tweet.read - users.read - UserToken: [] summary: Create List tags: - Lists /2/lists/{id}: delete: description: Deletes a specific List owned by the authenticated user by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/delete-lists-id operationId: deleteLists parameters: - description: The ID of the List to delete. in: path name: id required: true schema: $ref: '#/components/schemas/ListId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListDeleteResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - list.write - tweet.read - users.read - UserToken: [] summary: Delete List tags: - Lists get: description: Retrieves details of a specific List by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/list-lookup/api-reference/get-lists-id operationId: getListsById parameters: - description: The ID of the List. in: path name: id required: true schema: $ref: '#/components/schemas/ListId' style: simple - $ref: '#/components/parameters/ListFieldsParameter' - $ref: '#/components/parameters/ListExpansionsParameter' - $ref: '#/components/parameters/UserFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2ListsIdResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - list.read - tweet.read - users.read - UserToken: [] summary: Get List by ID tags: - Lists put: description: Updates the details of a specific List owned by the authenticated user by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/put-lists-id operationId: updateLists parameters: - description: The ID of the List to modify. in: path name: id required: true schema: $ref: '#/components/schemas/ListId' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ListUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUpdateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - list.write - tweet.read - users.read - UserToken: [] summary: Update List tags: - Lists /2/lists/{id}/followers: get: description: Retrieves a list of Users who follow a specific List by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-followers operationId: getListsFollowers parameters: - description: The ID of the List. in: path name: id required: true schema: $ref: '#/components/schemas/ListId' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get a specified 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationTokenLong' style: form - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/UserExpansionsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2ListsIdFollowersResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - list.read - tweet.read - users.read - UserToken: [] summary: Get List followers tags: - Lists - Users /2/lists/{id}/members: get: description: Retrieves a list of Users who are members of a specific List by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/get-users-id-list_memberships operationId: getListsMembers parameters: - description: The ID of the List. in: path name: id required: true schema: $ref: '#/components/schemas/ListId' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get a specified 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationTokenLong' style: form - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/UserExpansionsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2ListsIdMembersResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - list.read - tweet.read - users.read - UserToken: [] summary: Get List members tags: - Lists - Users post: description: Adds a User to a specific List by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/post-lists-id-members operationId: addListsMember parameters: - description: The ID of the List for which to add a member. in: path name: id required: true schema: $ref: '#/components/schemas/ListId' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ListAddUserRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListMutateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - list.write - tweet.read - users.read - UserToken: [] summary: Add List member tags: - Lists /2/lists/{id}/members/{user_id}: delete: description: "Removes a User from a specific List by its ID and the User\u2019\ s ID." externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/delete-lists-id-members-user_id operationId: removeListsMemberByUserId parameters: - description: The ID of the List to remove a member. in: path name: id required: true schema: $ref: '#/components/schemas/ListId' style: simple - description: The ID of User that will be removed from the List. in: path name: user_id required: true schema: $ref: '#/components/schemas/UserId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListMutateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - list.write - tweet.read - users.read - UserToken: [] summary: Remove List member tags: - Lists /2/lists/{id}/tweets: get: description: Retrieves a list of Posts associated with a specific List by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/list-tweets/api-reference/get-lists-id-tweets operationId: getListsPosts parameters: - description: The ID of the List. in: path name: id required: true schema: $ref: '#/components/schemas/ListId' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get the next 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2ListsIdTweetsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - list.read - tweet.read - users.read - UserToken: [] summary: Get List Posts tags: - Lists - Tweets /2/media: get: description: Retrieves details of Media files by their media keys. externalDocs: url: https://developer.x.com operationId: getMediaByMediaKeys parameters: - description: A comma separated list of Media Keys. Up to 100 are allowed in a single request. explode: false in: query name: media_keys required: true schema: items: $ref: '#/components/schemas/MediaKey' maxItems: 100 minItems: 1 type: array style: form - $ref: '#/components/parameters/MediaFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2MediaResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - UserToken: [] summary: Get Media by media keys tags: - Media /2/media/analytics: get: description: Retrieves analytics data for media. operationId: getMediaAnalytics parameters: - description: A comma separated list of Media Keys. Up to 100 are allowed in a single request. explode: false in: query name: media_keys required: true schema: items: $ref: '#/components/schemas/MediaKey' maxItems: 100 minItems: 1 type: array style: form - description: YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the end of the time range. example: '2021-02-01T18:40:40.000Z' in: query name: end_time required: true schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the start of the time range. example: '2021-02-01T18:40:40.000Z' in: query name: start_time required: true schema: format: date-time type: string style: form - description: The granularity for the search counts results. in: query name: granularity required: true schema: default: daily enum: - hourly - daily - total type: string style: form - $ref: '#/components/parameters/MediaAnalyticsFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/MediaAnalytics' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.read - UserToken: [] summary: Get Media analytics tags: - Media /2/media/metadata: post: description: Creates metadata for a Media file. externalDocs: url: https://docs.x.com/x-api/media/media-metadata-create#metadata-create operationId: createMediaMetadata parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/MetadataCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/MetadataCreateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - media.write - UserToken: [] summary: Create Media metadata tags: - Media /2/media/subtitles: delete: description: Deletes subtitles for a specific Media file. externalDocs: url: https://docs.x.com/x-api/media/media-subtitles-delete operationId: deleteMediaSubtitles parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/SubtitlesDeleteRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubtitlesDeleteResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - media.write - UserToken: [] summary: Delete Media subtitles tags: - Media post: description: Creates subtitles for a specific Media file. externalDocs: url: https://docs.x.com/x-api/media/media-subtitles-create operationId: createMediaSubtitles parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/SubtitlesCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubtitlesCreateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - media.write - UserToken: [] summary: Create Media subtitles tags: - Media /2/media/upload: get: description: Retrieves the status of a Media upload by its ID. externalDocs: url: https://docs.x.com/x-api/media/media-upload-status#media-upload-status operationId: getMediaUploadStatus parameters: - description: Media id for the requested media upload status. in: query name: media_id required: true schema: $ref: '#/components/schemas/MediaId' style: form - description: The command for the media upload request. in: query name: command required: false schema: enum: - STATUS type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/MediaUploadResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - media.write - UserToken: [] summary: Get Media upload status tags: - Media post: description: Uploads a media file for use in posts or other content. externalDocs: url: https://docs.x.com/x-api/media/media-upload operationId: mediaUpload parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/MediaUploadRequestOneShot' multipart/form-data: schema: $ref: '#/components/schemas/MediaUploadRequestOneShot' responses: '200': content: application/json: schema: $ref: '#/components/schemas/MediaUploadResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - media.write - UserToken: [] summary: Upload media tags: - Media /2/media/upload/initialize: post: description: Initializes a media upload. externalDocs: url: https://docs.x.com/x-api/media/media-upload operationId: initializeMediaUpload parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/MediaUploadConfigRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/MediaUploadResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - media.write - UserToken: [] summary: Initialize media upload tags: - Media /2/media/upload/{id}/append: post: description: Appends data to a Media upload request. externalDocs: url: https://docs.x.com/x-api/media/media-upload operationId: appendMediaUpload parameters: - description: The media identifier for the media to perform the append operation. in: path name: id required: true schema: $ref: '#/components/schemas/MediaId' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/MediaUploadAppendRequest' multipart/form-data: schema: $ref: '#/components/schemas/MediaUploadAppendRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/MediaUploadAppendResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - media.write - UserToken: [] summary: Append Media upload tags: - Media /2/media/upload/{id}/finalize: post: description: Finalizes a Media upload request. externalDocs: url: https://docs.x.com/x-api/media/media-upload operationId: finalizeMediaUpload parameters: - description: The media id of the targeted media to finalize. in: path name: id required: true schema: $ref: '#/components/schemas/MediaId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/MediaUploadResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - media.write - UserToken: [] summary: Finalize Media upload tags: - Media /2/media/{media_key}: get: description: Retrieves details of a specific Media file by its media key. externalDocs: url: https://developer.x.com operationId: getMediaByMediaKey parameters: - description: A single Media Key. in: path name: media_key required: true schema: $ref: '#/components/schemas/MediaKey' style: simple - $ref: '#/components/parameters/MediaFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2MediaMediaKeyResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - UserToken: [] summary: Get Media by media key tags: - Media /2/news/search: get: description: Retrieves a list of News stories matching the specified search query. externalDocs: url: https://docs.x.com/x-api/news/introduction operationId: searchNews parameters: - description: The search query. example: crypto in: query name: query required: true schema: example: crypto maxLength: 2048 minLength: 1 type: string style: form - description: The number of results to return. in: query name: max_results required: false schema: default: 10 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: The maximum age of the News story to search for. in: query name: max_age_hours required: false schema: default: 168 format: int32 maximum: 720 minimum: 1 type: integer style: form - $ref: '#/components/parameters/NewsFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2NewsSearchResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - users.read summary: Search News tags: - News /2/news/{id}: get: description: Retrieves news story by its ID. externalDocs: url: https://docs.x.com/x-api/news/introduction operationId: getNews parameters: - description: The ID of the news story. example: '119929381293' in: path name: id required: true schema: $ref: '#/components/schemas/NewsId' style: simple - $ref: '#/components/parameters/NewsFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2NewsIdResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get news stories by ID tags: - News /2/notes: post: description: Creates a community note endpoint for LLM use case. externalDocs: url: https://communitynotes.x.com/guide/api/overview operationId: createCommunityNotes parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNoteRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateNoteResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.write - UserToken: [] summary: Create a Community Note tags: - Community Notes /2/notes/search/notes_written: get: description: Returns all the community notes written by the user. externalDocs: url: https://docs.x.com/x-api/community-notes/search-for-community-notes-written operationId: searchCommunityNotesWritten parameters: - description: If true, return the notes the caller wrote for the test. If false, return the notes the caller wrote on the product. in: query name: test_mode required: true schema: type: boolean style: form - description: Pagination token to get next set of posts eligible for notes. in: query name: pagination_token required: false schema: type: string style: form - description: Max results to return. in: query name: max_results required: false schema: default: 10 format: int32 maximum: 100 minimum: 1 type: integer style: form - $ref: '#/components/parameters/NoteFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2NotesSearchNotesWrittenResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.read - UserToken: [] summary: Search for Community Notes Written tags: - Community Notes /2/notes/search/posts_eligible_for_notes: get: description: Returns all the posts that are eligible for community notes. externalDocs: url: https://docs.x.com/x-api/community-notes/search-for-posts-eligible-for-community-notes operationId: searchEligiblePosts parameters: - description: If true, return a list of posts that are for the test. If false, return a list of posts that the bots can write proposed notes on the product. in: query name: test_mode required: true schema: type: boolean style: form - description: Pagination token to get next set of posts eligible for notes. in: query name: pagination_token required: false schema: type: string style: form - description: Max results to return. in: query name: max_results required: false schema: default: 10 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: 'The selection of posts to return. Valid values are ''feed_size: small'' and ''feed_size: large''. Default is ''feed_size: small'', only top AI writers have access to large size feed.' in: query name: post_selection required: false schema: type: string style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2NotesSearchPostsEligibleForNotesResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.read - UserToken: [] summary: Search for Posts Eligible for Community Notes tags: - Community Notes /2/notes/{id}: delete: description: Deletes a community note. externalDocs: url: https://communitynotes.x.com/guide/api/overview operationId: deleteCommunityNotes parameters: - description: The community note id to delete. in: path name: id required: true schema: $ref: '#/components/schemas/NoteId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeleteNoteResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.write - UserToken: [] summary: Delete a Community Note tags: - Community Notes /2/openapi.json: get: description: Retrieves the full OpenAPI Specification in JSON format. (See https://github.com/OAI/OpenAPI-Specification/blob/master/README.md) operationId: getOpenApiSpec parameters: [] responses: '200': content: application/json: schema: type: object description: The request was successful summary: Get OpenAPI Spec. tags: - General /2/spaces: get: description: Retrieves details of multiple Spaces by their IDs. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces operationId: getSpacesByIds parameters: - description: The list of Space IDs to return. in: query name: ids required: true schema: items: description: The unique identifier of this Space. example: 1SLjjRYNejbKM pattern: ^[a-zA-Z0-9]{1,13}$ type: string maxItems: 100 minItems: 1 type: array style: form - $ref: '#/components/parameters/SpaceFieldsParameter' - $ref: '#/components/parameters/SpaceExpansionsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/TopicFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2SpacesResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - space.read - tweet.read - users.read summary: Get Spaces by IDs tags: - Spaces /2/spaces/by/creator_ids: get: description: Retrieves details of Spaces created by specified User IDs. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-by-creator-ids operationId: getSpacesByCreatorIds parameters: - description: The IDs of Users to search through. in: query name: user_ids required: true schema: items: $ref: '#/components/schemas/UserId' maxItems: 100 minItems: 1 type: array style: form - $ref: '#/components/parameters/SpaceFieldsParameter' - $ref: '#/components/parameters/SpaceExpansionsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/TopicFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2SpacesByCreatorIdsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - space.read - tweet.read - users.read summary: Get Spaces by creator IDs tags: - Spaces /2/spaces/search: get: description: Retrieves a list of Spaces matching the specified search query. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/spaces/search/api-reference/get-spaces-search operationId: searchSpaces parameters: - description: The search query. example: crypto in: query name: query required: true schema: example: crypto maxLength: 2048 minLength: 1 type: string style: form - description: The state of Spaces to search for. in: query name: state required: false schema: default: all enum: - live - scheduled - all type: string style: form - description: The number of results to return. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 type: integer style: form - $ref: '#/components/parameters/SpaceFieldsParameter' - $ref: '#/components/parameters/SpaceExpansionsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/TopicFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2SpacesSearchResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - space.read - tweet.read - users.read summary: Search Spaces tags: - Spaces /2/spaces/{id}: get: description: Retrieves details of a specific space by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-id operationId: getSpacesById parameters: - description: The ID of the Space to be retrieved. example: 1YqKDqWqdPLsV in: path name: id required: true schema: description: The unique identifier of this Space. example: 1SLjjRYNejbKM pattern: ^[a-zA-Z0-9]{1,13}$ type: string style: simple - $ref: '#/components/parameters/SpaceFieldsParameter' - $ref: '#/components/parameters/SpaceExpansionsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/TopicFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2SpacesIdResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - space.read - tweet.read - users.read summary: Get space by ID tags: - Spaces /2/spaces/{id}/buyers: get: description: Retrieves a list of Users who purchased tickets to a specific Space by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-id-buyers operationId: getSpacesBuyers parameters: - description: The ID of the Space to be retrieved. example: 1YqKDqWqdPLsV in: path name: id required: true schema: description: The unique identifier of this Space. example: 1SLjjRYNejbKM pattern: ^[a-zA-Z0-9]{1,13}$ type: string style: simple - description: This parameter is used to get a specified 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken32' style: form - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 type: integer style: form - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/UserExpansionsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2SpacesIdBuyersResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - space.read - tweet.read - users.read summary: Get Space ticket buyers tags: - Spaces - Tweets /2/spaces/{id}/tweets: get: description: Retrieves a list of Posts shared in a specific Space by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-id-tweets operationId: getSpacesPosts parameters: - description: The ID of the Space to be retrieved. example: 1YqKDqWqdPLsV in: path name: id required: true schema: description: The unique identifier of this Space. example: 1SLjjRYNejbKM pattern: ^[a-zA-Z0-9]{1,13}$ type: string style: simple - description: The number of Posts to fetch from the provided space. If not provided, the value will default to the maximum of 100. in: query name: max_results required: false schema: default: 100 example: 25 format: int32 maximum: 100 minimum: 1 type: integer style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2SpacesIdTweetsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - space.read - tweet.read - users.read summary: Get Space Posts tags: - Spaces - Tweets /2/trends/by/woeid/{woeid}: get: description: Retrieves trending topics for a specific location identified by its WOEID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/trends/api-reference/get-trends-by-woeid operationId: getTrendsByWoeid parameters: - description: The WOEID of the place to lookup a trend for. example: '2244994945' in: path name: woeid required: true schema: format: int32 type: integer style: simple - description: The maximum number of results. in: query name: max_trends required: false schema: default: 20 format: int32 maximum: 50 minimum: 1 type: integer style: form - $ref: '#/components/parameters/TrendFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2TrendsByWoeidWoeidResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Get Trends by WOEID tags: - Trends /2/tweets: get: description: Retrieves details of multiple Posts by their IDs. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/lookup/api-reference/get-tweets operationId: getPostsByIds parameters: - description: A comma separated list of Post IDs. Up to 100 are allowed in a single request. explode: false in: query name: ids required: true schema: items: $ref: '#/components/schemas/TweetId' maxItems: 100 minItems: 1 type: array style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2TweetsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get Posts by IDs tags: - Tweets post: description: Creates a new Post for the authenticated user, or edits an existing Post when edit_options are provided. externalDocs: url: https://developer.x.com/en/docs/twitter-api/tweets/manage-tweets/api-reference/post-tweets operationId: createPosts parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/TweetCreateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/TweetCreateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.read - tweet.write - users.read - UserToken: [] summary: Create or Edit Post tags: - Tweets /2/tweets/analytics: get: description: Retrieves analytics data for specified Posts within a defined time range. operationId: getPostsAnalytics parameters: - description: A comma separated list of Post IDs. Up to 100 are allowed in a single request. explode: false in: query name: ids required: true schema: items: $ref: '#/components/schemas/TweetId' maxItems: 100 minItems: 1 type: array style: form - description: YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the end of the time range. example: '2021-02-01T18:40:40.000Z' in: query name: end_time required: true schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the start of the time range. example: '2021-02-01T18:40:40.000Z' in: query name: start_time required: true schema: format: date-time type: string style: form - description: The granularity for the search counts results. in: query name: granularity required: true schema: default: total enum: - hourly - daily - weekly - total type: string style: form - $ref: '#/components/parameters/AnalyticsFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Analytics' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get Post analytics tags: - Tweets /2/tweets/compliance/stream: get: description: Streams all compliance data related to Posts. operationId: streamPostsCompliance parameters: - description: The number of minutes of backfill requested. in: query name: backfill_minutes required: false schema: format: int32 maximum: 5 minimum: 0 type: integer style: form - description: The partition number. in: query name: partition required: true schema: format: int32 maximum: 4 minimum: 1 type: integer style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post Compliance events will be provided. example: '2021-02-01T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Post Compliance events will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/TweetComplianceStreamResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Stream Posts compliance data tags: - Stream - Compliance x-twitter-streaming: true /2/tweets/counts/all: get: description: Retrieves the count of Posts matching a search query from the full archive. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-all operationId: getPostsCountsAll parameters: - description: One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length. in: query name: query required: true schema: example: (from:TwitterDev OR from:TwitterAPI) has:media -is:retweet maxLength: 4096 minLength: 1 type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute). in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute). in: query name: end_time required: false schema: format: date-time type: string style: form - description: Returns results with a Post ID greater than (that is, more recent than) the specified ID. in: query name: since_id required: false schema: $ref: '#/components/schemas/TweetId' style: form - description: Returns results with a Post ID less than (that is, older than) the specified ID. in: query name: until_id required: false schema: $ref: '#/components/schemas/TweetId' style: form - description: This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. in: query name: next_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - description: This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - description: The granularity for the search counts results. in: query name: granularity required: false schema: default: hour enum: - minute - hour - day type: string style: form - $ref: '#/components/parameters/SearchCountFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2TweetsCountsAllResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Get count of all Posts tags: - Tweets /2/tweets/counts/recent: get: description: Retrieves the count of Posts from the last 7 days matching a search query. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/counts/api-reference/get-tweets-counts-recent operationId: getPostsCountsRecent parameters: - description: One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length. in: query name: query required: true schema: example: (from:TwitterDev OR from:TwitterAPI) has:media -is:retweet maxLength: 4096 minLength: 1 type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp (from most recent 7 days) from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute). in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute). in: query name: end_time required: false schema: format: date-time type: string style: form - description: Returns results with a Post ID greater than (that is, more recent than) the specified ID. in: query name: since_id required: false schema: $ref: '#/components/schemas/TweetId' style: form - description: Returns results with a Post ID less than (that is, older than) the specified ID. in: query name: until_id required: false schema: $ref: '#/components/schemas/TweetId' style: form - description: This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. in: query name: next_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - description: This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - description: The granularity for the search counts results. in: query name: granularity required: false schema: default: hour enum: - minute - hour - day type: string style: form - $ref: '#/components/parameters/SearchCountFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2TweetsCountsRecentResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Get count of recent Posts tags: - Tweets /2/tweets/firehose/stream: get: description: Streams all public Posts in real-time. operationId: streamPostsFirehose parameters: - description: The number of minutes of backfill requested. in: query name: backfill_minutes required: false schema: format: int32 maximum: 5 minimum: 0 type: integer style: form - description: The partition number. in: query name: partition required: true schema: format: int32 maximum: 20 minimum: 1 type: integer style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/StreamingTweetResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Stream all Posts tags: - Stream - Tweets x-twitter-streaming: true /2/tweets/firehose/stream/lang/en: get: description: Streams all public English-language Posts in real-time. operationId: streamPostsFirehoseEn parameters: - description: The number of minutes of backfill requested. in: query name: backfill_minutes required: false schema: format: int32 maximum: 5 minimum: 0 type: integer style: form - description: The partition number. in: query name: partition required: true schema: format: int32 maximum: 8 minimum: 1 type: integer style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/StreamingTweetResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Stream English Posts tags: - Stream - Tweets x-twitter-streaming: true /2/tweets/firehose/stream/lang/ja: get: description: Streams all public Japanese-language Posts in real-time. operationId: streamPostsFirehoseJa parameters: - description: The number of minutes of backfill requested. in: query name: backfill_minutes required: false schema: format: int32 maximum: 5 minimum: 0 type: integer style: form - description: The partition number. in: query name: partition required: true schema: format: int32 maximum: 2 minimum: 1 type: integer style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/StreamingTweetResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Stream Japanese Posts tags: - Stream - Tweets x-twitter-streaming: true /2/tweets/firehose/stream/lang/ko: get: description: Streams all public Korean-language Posts in real-time. operationId: streamPostsFirehoseKo parameters: - description: The number of minutes of backfill requested. in: query name: backfill_minutes required: false schema: format: int32 maximum: 5 minimum: 0 type: integer style: form - description: The partition number. in: query name: partition required: true schema: format: int32 maximum: 2 minimum: 1 type: integer style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/StreamingTweetResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Stream Korean Posts tags: - Stream - Tweets x-twitter-streaming: true /2/tweets/firehose/stream/lang/pt: get: description: Streams all public Portuguese-language Posts in real-time. operationId: streamPostsFirehosePt parameters: - description: The number of minutes of backfill requested. in: query name: backfill_minutes required: false schema: format: int32 maximum: 5 minimum: 0 type: integer style: form - description: The partition number. in: query name: partition required: true schema: format: int32 maximum: 2 minimum: 1 type: integer style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/StreamingTweetResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Stream Portuguese Posts tags: - Stream - Tweets x-twitter-streaming: true /2/tweets/label/stream: get: description: Streams all labeling events applied to Posts. operationId: streamLabelsCompliance parameters: - description: The number of minutes of backfill requested. in: query name: backfill_minutes required: false schema: format: int32 maximum: 5 minimum: 0 type: integer style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post labels will be provided. example: '2021-02-01T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Post labels will be provided. example: '2021-02-01T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/TweetLabelStreamResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Stream Post labels tags: - Stream - Compliance x-twitter-streaming: true /2/tweets/sample/stream: get: description: Streams a 1% sample of public Posts in real-time. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/volume-streams/api-reference/get-tweets-sample-stream operationId: streamPostsSample parameters: - description: The number of minutes of backfill requested. in: query name: backfill_minutes required: false schema: format: int32 maximum: 5 minimum: 0 type: integer style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/StreamingTweetResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Stream sampled Posts tags: - Stream - Tweets x-twitter-streaming: true /2/tweets/sample10/stream: get: description: Streams a 10% sample of public Posts in real-time. operationId: streamPostsSample10 parameters: - description: The number of minutes of backfill requested. in: query name: backfill_minutes required: false schema: format: int32 maximum: 5 minimum: 0 type: integer style: form - description: The partition number. in: query name: partition required: true schema: format: int32 maximum: 2 minimum: 1 type: integer style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2TweetsSample10StreamResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Stream 10% sampled Posts tags: - Stream - Tweets x-twitter-streaming: true /2/tweets/search/all: get: description: Retrieves Posts from the full archive matching a search query. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-all operationId: searchPostsAll parameters: - description: One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length. in: query name: query required: true schema: example: (from:TwitterDev OR from:TwitterAPI) has:media -is:retweet maxLength: 4096 minLength: 1 type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute). in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute). in: query name: end_time required: false schema: format: date-time type: string style: form - description: Returns results with a Post ID greater than (that is, more recent than) the specified ID. in: query name: since_id required: false schema: $ref: '#/components/schemas/TweetId' style: form - description: Returns results with a Post ID less than (that is, older than) the specified ID. in: query name: until_id required: false schema: $ref: '#/components/schemas/TweetId' style: form - description: The maximum number of search results to be returned by a request. in: query name: max_results required: false schema: default: 10 format: int32 maximum: 500 minimum: 10 type: integer style: form - description: This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. in: query name: next_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - description: This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - description: This order in which to return results. in: query name: sort_order required: false schema: enum: - recency - relevancy type: string style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2TweetsSearchAllResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Search all Posts tags: - Tweets /2/tweets/search/recent: get: description: Retrieves Posts from the last 7 days matching a search query. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-recent operationId: searchPostsRecent parameters: - description: One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length. in: query name: query required: true schema: example: (from:TwitterDev OR from:TwitterAPI) has:media -is:retweet maxLength: 4096 minLength: 1 type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute). in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute). in: query name: end_time required: false schema: format: date-time type: string style: form - description: Returns results with a Post ID greater than (that is, more recent than) the specified ID. in: query name: since_id required: false schema: $ref: '#/components/schemas/TweetId' style: form - description: Returns results with a Post ID less than (that is, older than) the specified ID. in: query name: until_id required: false schema: $ref: '#/components/schemas/TweetId' style: form - description: The maximum number of search results to be returned by a request. in: query name: max_results required: false schema: default: 10 format: int32 maximum: 100 minimum: 10 type: integer style: form - description: This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. in: query name: next_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - description: This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - description: This order in which to return results. in: query name: sort_order required: false schema: enum: - recency - relevancy type: string style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2TweetsSearchRecentResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Search recent Posts tags: - Tweets /2/tweets/search/stream: get: description: Streams Posts in real-time matching the active rule set. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/get-tweets-search-stream operationId: streamPosts parameters: - description: The number of minutes of backfill requested. in: query name: backfill_minutes required: false schema: format: int32 maximum: 5 minimum: 0 type: integer style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided. example: '2021-02-01T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. example: '2021-02-14T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/FilteredStreamingTweetResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Stream filtered Posts tags: - Stream - Tweets x-twitter-streaming: true /2/tweets/search/stream/rules: get: description: Retrieves the active rule set or a subset of rules for the filtered stream. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/get-tweets-search-stream-rules operationId: getRules parameters: - description: A comma-separated list of Rule IDs. in: query name: ids required: false schema: items: $ref: '#/components/schemas/RuleId' type: array style: form - description: The maximum number of results. in: query name: max_results required: false schema: default: 1000 format: int32 maximum: 1000 minimum: 1 type: integer style: form - description: This value is populated by passing the 'next_token' returned in a request to paginate through results. in: query name: pagination_token required: false schema: maxLength: 16 minLength: 16 type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/RulesLookupResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Get stream rules tags: - Stream - Tweets post: description: Adds or deletes rules from the active rule set for the filtered stream. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/post-tweets-search-stream-rules operationId: updateRules parameters: - description: Dry Run can be used with both the add and delete action, with the expected result given, but without actually taking any action in the system (meaning the end state will always be as it was when the request was submitted). This is particularly useful to validate rule changes. in: query name: dry_run required: false schema: type: boolean style: form - description: Delete All can be used to delete all of the rules associated this client app, it should be specified with no other parameters. Once deleted, rules cannot be recovered. in: query name: delete_all required: false schema: type: boolean style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/AddOrDeleteRulesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AddOrDeleteRulesResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Update stream rules tags: - Stream - Tweets /2/tweets/search/stream/rules/counts: get: description: Retrieves the count of rules in the active rule set for the filtered stream. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/get-tweets-search-stream-rules-counts operationId: getRuleCounts parameters: - $ref: '#/components/parameters/RulesCountFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2TweetsSearchStreamRulesCountsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Get stream rule counts tags: - Stream - Tweets /2/tweets/search/webhooks: get: description: Get a list of webhook links associated with a filtered stream ruleset. externalDocs: url: https://docs.x.com/x-api/webhooks/introduction operationId: getWebhooksStreamLinks parameters: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebhookLinksGetResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Get stream links tags: - Webhooks - Stream /2/tweets/search/webhooks/{webhook_id}: delete: description: Deletes a link from FilteredStream events to the given webhook. externalDocs: url: https://docs.x.com/x-api/webhooks/introduction operationId: deleteWebhooksStreamLink parameters: - description: The webhook ID to link to your FilteredStream ruleset. in: path name: webhook_id required: true schema: $ref: '#/components/schemas/WebhookConfigId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebhookLinksDeleteResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Delete stream link tags: - Webhooks - Stream post: description: Creates a link to deliver FilteredStream events to the given webhook. externalDocs: url: https://docs.x.com/x-api/webhooks/introduction operationId: createWebhooksStreamLink parameters: - description: The webhook ID to link to your FilteredStream ruleset. in: path name: webhook_id required: true schema: $ref: '#/components/schemas/WebhookConfigId' style: simple - description: A comma separated list of Tweet fields to display. in: query name: tweet.fields required: false schema: type: string style: form - description: A comma separated list of fields to expand. in: query name: expansions required: false schema: type: string style: form - description: A comma separated list of Media fields to display. in: query name: media.fields required: false schema: type: string style: form - description: A comma separated list of Poll fields to display. in: query name: poll.fields required: false schema: type: string style: form - description: A comma separated list of User fields to display. in: query name: user.fields required: false schema: type: string style: form - description: A comma separated list of Place fields to display. in: query name: place.fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebhookLinksCreateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Create stream link tags: - Webhooks - Stream /2/tweets/{id}: delete: description: Deletes a specific Post by its ID, if owned by the authenticated user. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/manage-tweets/api-reference/delete-tweets-id operationId: deletePosts parameters: - description: The ID of the Post to be deleted. in: path name: id required: true schema: $ref: '#/components/schemas/TweetId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/TweetDeleteResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.read - tweet.write - users.read - UserToken: [] summary: Delete Post tags: - Tweets get: description: Retrieves details of a specific Post by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/lookup/api-reference/get-tweets-id operationId: getPostsById parameters: - description: A single Post ID. in: path name: id required: true schema: $ref: '#/components/schemas/TweetId' style: simple - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2TweetsIdResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get Post by ID tags: - Tweets /2/tweets/{id}/liking_users: get: description: Retrieves a list of Users who liked a specific Post by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/get-tweets-id-liking_users operationId: getPostsLikingUsers parameters: - description: A single Post ID. in: path name: id required: true schema: $ref: '#/components/schemas/TweetId' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get the next 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/UserExpansionsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2TweetsIdLikingUsersResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - like.read - tweet.read - users.read - UserToken: [] summary: Get Liking Users tags: - Tweets - Users /2/tweets/{id}/quote_tweets: get: description: Retrieves a list of Posts that quote a specific Post by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/quote-tweets/api-reference/get-tweets-id-quote_tweets operationId: getPostsQuotedPosts parameters: - description: A single Post ID. in: path name: id required: true schema: $ref: '#/components/schemas/TweetId' style: simple - description: The maximum number of results to be returned. in: query name: max_results required: false schema: default: 10 format: int32 maximum: 100 minimum: 10 type: integer style: form - description: This parameter is used to get a specified 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - description: The set of entities to exclude (e.g. 'replies' or 'retweets'). explode: false in: query name: exclude required: false schema: example: - replies - retweets items: enum: - replies - retweets type: string minItems: 1 type: array uniqueItems: true style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2TweetsIdQuoteTweetsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get Quoted Posts tags: - Tweets /2/tweets/{id}/retweeted_by: get: description: Retrieves a list of Users who reposted a specific Post by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/get-tweets-id-retweeted_by operationId: getPostsRepostedBy parameters: - description: A single Post ID. in: path name: id required: true schema: $ref: '#/components/schemas/TweetId' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get the next 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/UserExpansionsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2TweetsIdRetweetedByResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get Reposted by tags: - Tweets - Users /2/tweets/{id}/retweets: get: description: Retrieves a list of Posts that repost a specific Post by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/get-tweets-id-retweets operationId: getPostsReposts parameters: - description: A single Post ID. in: path name: id required: true schema: $ref: '#/components/schemas/TweetId' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get the next 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2TweetsIdRetweetsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get Reposts tags: - Tweets /2/tweets/{tweet_id}/hidden: put: description: Hides or unhides a reply to a conversation owned by the authenticated user. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/hide-replies/api-reference/put-tweets-id-hidden operationId: hidePostsReply parameters: - description: The ID of the reply that you want to hide or unhide. in: path name: tweet_id required: true schema: $ref: '#/components/schemas/TweetId' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/TweetHideRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TweetHideResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.moderate.write - tweet.read - users.read - UserToken: [] summary: Hide reply tags: - Tweets /2/usage/tweets: get: description: Retrieves usage statistics for Posts over a specified number of days. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/usage/tweets/api-reference/get-usage-tweets operationId: getUsage parameters: - description: The number of days for which you need usage for. in: query name: days required: false schema: default: 7 format: int32 maximum: 90 minimum: 1 type: integer style: form - $ref: '#/components/parameters/UsageFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsageTweetsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Get usage tags: - Usage /2/users: get: description: Retrieves details of multiple Users by their IDs. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users operationId: getUsersByIds parameters: - description: A list of User IDs, comma-separated. You can specify up to 100 IDs. example: 2244994945,6253282,12 explode: false in: query name: ids required: true schema: items: $ref: '#/components/schemas/UserId' maxItems: 100 minItems: 1 type: array style: form - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/UserExpansionsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get Users by IDs tags: - Users /2/users/by: get: description: Retrieves details of multiple Users by their usernames. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by operationId: getUsersByUsernames parameters: - description: A list of usernames, comma-separated. explode: false in: query name: usernames required: true schema: example: TwitterDev,TwitterAPI items: description: The X handle (screen name) of this User. pattern: ^[A-Za-z0-9_]{1,15}$ type: string maxItems: 100 minItems: 1 type: array style: form - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/UserExpansionsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersByResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get Users by usernames tags: - Users /2/users/by/username/{username}: get: description: Retrieves details of a specific User by their username. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by-username-username operationId: getUsersByUsername parameters: - description: A username. example: TwitterDev in: path name: username required: true schema: pattern: ^[A-Za-z0-9_]{1,15}$ type: string style: simple - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/UserExpansionsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersByUsernameUsernameResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get User by username tags: - Users /2/users/compliance/stream: get: description: Streams all compliance data related to Users. operationId: streamUsersCompliance parameters: - description: The number of minutes of backfill requested. in: query name: backfill_minutes required: false schema: format: int32 maximum: 5 minimum: 0 type: integer style: form - description: The partition number. in: query name: partition required: true schema: format: int32 maximum: 4 minimum: 1 type: integer style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the User Compliance events will be provided. example: '2021-02-01T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the User Compliance events will be provided. example: '2021-02-01T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserComplianceStreamResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Stream Users compliance data tags: - Stream - Compliance x-twitter-streaming: true /2/users/me: get: description: Retrieves details of the authenticated user. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-me operationId: getUsersMe parameters: - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/UserExpansionsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersMeResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get my User tags: - Users /2/users/personalized_trends: get: description: Retrieves personalized trending topics for the authenticated user. externalDocs: url: https://developer.x.com/ operationId: getTrendsPersonalizedTrends parameters: - $ref: '#/components/parameters/PersonalizedTrendFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersPersonalizedTrendsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get personalized Trends tags: - Trends /2/users/reposts_of_me: get: description: Retrieves a list of Posts that repost content from the authenticated user. externalDocs: url: https://docs.x.com/x-api/posts/retweets/quickstart/retweets-of-me#retweets-of-me operationId: getUsersRepostsOfMe parameters: - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get the next 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersRepostsOfMeResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - timeline.read - tweet.read - UserToken: [] summary: Get Reposts of me tags: - Users /2/users/search: get: description: Retrieves a list of Users matching a search query. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-search operationId: searchUsers parameters: - description: TThe the query string by which to query for users. example: someXUser in: query name: query required: true schema: $ref: '#/components/schemas/UserSearchQueryVnext' style: form - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 1000 minimum: 1 type: integer style: form - description: This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. in: query name: next_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/UserExpansionsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersSearchResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Search Users tags: - Users /2/users/{id}: get: description: Retrieves details of a specific User by their ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-id operationId: getUsersById parameters: - description: The ID of the User to lookup. example: '2244994945' in: path name: id required: true schema: $ref: '#/components/schemas/UserId' style: simple - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/UserExpansionsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersIdResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get User by ID tags: - Users /2/users/{id}/blocking: get: description: Retrieves a list of Users blocked by the specified User ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/users/blocks/api-reference/get-users-blocking operationId: getUsersBlocking parameters: - description: The ID of the authenticated source User for whom to return results. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: format: int32 maximum: 1000 minimum: 1 type: integer style: form - description: This parameter is used to get a specified 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken32' style: form - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/UserExpansionsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersIdBlockingResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - block.read - tweet.read - users.read - UserToken: [] summary: Get blocking tags: - Users /2/users/{id}/bookmarks: get: description: Retrieves a list of Posts bookmarked by the authenticated user. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/bookmarks/api-reference/get-users-id-bookmarks operationId: getUsersBookmarks parameters: - description: The ID of the authenticated source User for whom to return results. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get the next 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersIdBookmarksResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - bookmark.read - tweet.read - users.read summary: Get Bookmarks tags: - Users - Bookmarks post: description: "Adds a post to the authenticated user\u2019s bookmarks." externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/bookmarks/api-reference/post-users-id-bookmarks operationId: createUsersBookmark parameters: - description: The ID of the authenticated source User for whom to add bookmarks. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/BookmarkAddRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BookmarkMutationResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - bookmark.write - tweet.read - users.read summary: Create Bookmark tags: - Users - Bookmarks /2/users/{id}/bookmarks/folders: get: description: Retrieves a list of Bookmark folders created by the authenticated user. externalDocs: url: https://developer.x.com operationId: getUsersBookmarkFolders parameters: - description: The ID of the authenticated source User for whom to return results. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get the next 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/BookmarkFoldersResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - bookmark.read - users.read summary: Get Bookmark folders tags: - Users - Bookmarks /2/users/{id}/bookmarks/folders/{folder_id}: get: description: Retrieves Posts in a specific Bookmark folder by its ID for the authenticated user. externalDocs: url: https://developer.x.com operationId: getUsersBookmarksByFolderId parameters: - description: The ID of the authenticated source User for whom to return results. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple - description: The ID of the Bookmark Folder that the authenticated User is trying to fetch Posts for. in: path name: folder_id required: true schema: $ref: '#/components/schemas/BookmarkFolderId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/BookmarkFolderPostsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - bookmark.read - tweet.read - users.read summary: Get Bookmarks by folder ID tags: - Users - Bookmarks /2/users/{id}/bookmarks/{tweet_id}: delete: description: "Removes a Post from the authenticated user\u2019s Bookmarks by\ \ its ID." externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/bookmarks/api-reference/delete-users-id-bookmarks-tweet_id operationId: deleteUsersBookmark parameters: - description: The ID of the authenticated source User whose bookmark is to be removed. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple - description: The ID of the Post that the source User is removing from bookmarks. in: path name: tweet_id required: true schema: $ref: '#/components/schemas/TweetId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/BookmarkMutationResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - bookmark.write - tweet.read - users.read summary: Delete Bookmark tags: - Users - Bookmarks /2/users/{id}/dm/block: post: description: Blocks direct messages to or from a specific User by their ID for the authenticated user. externalDocs: url: https://developer.x.com/ operationId: blockUsersDms parameters: - description: The ID of the target User that the authenticated user requesting to block dms for. in: path name: id required: true schema: $ref: '#/components/schemas/UserId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsersDMBlockCreateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - dm.write - tweet.read - users.read - UserToken: [] summary: Block DMs tags: - Users /2/users/{id}/dm/unblock: post: description: Unblocks direct messages to or from a specific User by their ID for the authenticated user. externalDocs: url: https://developer.x.com/ operationId: unblockUsersDms parameters: - description: The ID of the target User that the authenticated user requesting to unblock dms for. in: path name: id required: true schema: $ref: '#/components/schemas/UserId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsersDMUnBlockCreateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - dm.write - tweet.read - users.read - UserToken: [] summary: Unblock DMs tags: - Users /2/users/{id}/followed_lists: get: description: Retrieves a list of Lists followed by a specific User by their ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/list-follows/api-reference/get-users-id-followed_lists operationId: getUsersFollowedLists parameters: - description: The ID of the User to lookup. example: '2244994945' in: path name: id required: true schema: $ref: '#/components/schemas/UserId' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get a specified 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationTokenLong' style: form - $ref: '#/components/parameters/ListFieldsParameter' - $ref: '#/components/parameters/ListExpansionsParameter' - $ref: '#/components/parameters/UserFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersIdFollowedListsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - list.read - tweet.read - users.read - UserToken: [] summary: Get followed Lists tags: - Users - Lists post: description: Causes the authenticated user to follow a specific List by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/list-follows/api-reference/post-users-id-followed-lists operationId: followList parameters: - description: The ID of the authenticated source User that will follow the List. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ListFollowedRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListFollowedResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - list.write - tweet.read - users.read - UserToken: [] summary: Follow List tags: - Users - Lists /2/users/{id}/followed_lists/{list_id}: delete: description: Causes the authenticated user to unfollow a specific List by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/list-follows/api-reference/delete-users-id-followed-lists-list_id operationId: unfollowList parameters: - description: The ID of the authenticated source User that will unfollow the List. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple - description: The ID of the List to unfollow. in: path name: list_id required: true schema: $ref: '#/components/schemas/ListId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListFollowedResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - list.write - tweet.read - users.read - UserToken: [] summary: Unfollow List tags: - Users - Lists /2/users/{id}/followers: get: description: Retrieves a list of Users who follow a specific User by their ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-followers operationId: getUsersFollowers parameters: - description: The ID of the User to lookup. example: '2244994945' in: path name: id required: true schema: $ref: '#/components/schemas/UserId' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: format: int32 maximum: 1000 minimum: 1 type: integer style: form - description: This parameter is used to get a specified 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken32' style: form - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/UserExpansionsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersIdFollowersResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - follows.read - tweet.read - users.read - UserToken: [] summary: Get followers tags: - Users /2/users/{id}/following: get: description: Retrieves a list of Users followed by a specific User by their ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-following operationId: getUsersFollowing parameters: - description: The ID of the User to lookup. example: '2244994945' in: path name: id required: true schema: $ref: '#/components/schemas/UserId' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: format: int32 maximum: 1000 minimum: 1 type: integer style: form - description: This parameter is used to get a specified 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken32' style: form - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/UserExpansionsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersIdFollowingResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - follows.read - tweet.read - users.read - UserToken: [] summary: Get following tags: - Users post: description: Causes the authenticated user to follow a specific user by their ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/post-users-source_user_id-following operationId: followUser parameters: - description: The ID of the authenticated source User that is requesting to follow the target User. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UsersFollowingCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsersFollowingCreateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - follows.write - tweet.read - users.read - UserToken: [] summary: Follow User tags: - Users /2/users/{id}/liked_tweets: get: description: Retrieves a list of Posts liked by a specific User by their ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/get-users-id-liked_tweets operationId: getUsersLikedPosts parameters: - description: The ID of the User to lookup. example: '2244994945' in: path name: id required: true schema: $ref: '#/components/schemas/UserId' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: format: int32 maximum: 100 minimum: 5 type: integer style: form - description: This parameter is used to get the next 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersIdLikedTweetsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - like.read - tweet.read - users.read - UserToken: [] summary: Get liked Posts tags: - Users - Tweets /2/users/{id}/likes: post: description: Causes the authenticated user to Like a specific Post by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/post-users-id-likes operationId: likePost parameters: - description: The ID of the authenticated source User that is requesting to like the Post. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UsersLikesCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsersLikesCreateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - like.write - tweet.read - users.read - UserToken: [] summary: Like Post tags: - Users - Tweets /2/users/{id}/likes/{tweet_id}: delete: description: Causes the authenticated user to Unlike a specific Post by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/delete-users-id-likes-tweet_id operationId: unlikePost parameters: - description: The ID of the authenticated source User that is requesting to unlike the Post. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple - description: The ID of the Post that the User is requesting to unlike. in: path name: tweet_id required: true schema: $ref: '#/components/schemas/TweetId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsersLikesDeleteResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - like.write - tweet.read - users.read - UserToken: [] summary: Unlike Post tags: - Users - Tweets /2/users/{id}/list_memberships: get: description: Retrieves a list of Lists that a specific User is a member of by their ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/get-users-id-list_memberships operationId: getUsersListMemberships parameters: - description: The ID of the User to lookup. example: '2244994945' in: path name: id required: true schema: $ref: '#/components/schemas/UserId' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get a specified 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationTokenLong' style: form - $ref: '#/components/parameters/ListFieldsParameter' - $ref: '#/components/parameters/ListExpansionsParameter' - $ref: '#/components/parameters/UserFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersIdListMembershipsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - list.read - tweet.read - users.read - UserToken: [] summary: Get List memberships tags: - Users - Lists /2/users/{id}/mentions: get: description: Retrieves a list of Posts that mention a specific User by their ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-mentions operationId: getUsersMentions parameters: - description: The ID of the User to lookup. example: '2244994945' in: path name: id required: true schema: $ref: '#/components/schemas/UserId' style: simple - description: The minimum Post ID to be included in the result set. This parameter takes precedence over start_time if both are specified. in: query name: since_id required: false schema: $ref: '#/components/schemas/TweetId' style: form - description: The maximum Post ID to be included in the result set. This parameter takes precedence over end_time if both are specified. example: '1346889436626259968' in: query name: until_id required: false schema: $ref: '#/components/schemas/TweetId' style: form - description: The maximum number of results. in: query name: max_results required: false schema: format: int32 maximum: 100 minimum: 5 type: integer style: form - description: This parameter is used to get the next 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided. The since_id parameter takes precedence if it is also specified. example: '2021-02-01T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. The until_id parameter takes precedence if it is also specified. example: '2021-02-14T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersIdMentionsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get mentions tags: - Users - Tweets /2/users/{id}/muting: get: description: Retrieves a list of Users muted by the authenticated user. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/get-users-muting operationId: getUsersMuting parameters: - description: The ID of the authenticated source User for whom to return results. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 1000 minimum: 1 type: integer style: form - description: This parameter is used to get the next 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationTokenLong' style: form - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/UserExpansionsParameter' - $ref: '#/components/parameters/TweetFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersIdMutingResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - mute.read - tweet.read - users.read - UserToken: [] summary: Get muting tags: - Users post: description: Causes the authenticated user to mute a specific User by their ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/post-users-user_id-muting operationId: muteUser parameters: - description: The ID of the authenticated source User that is requesting to mute the target User. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/MuteUserRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/MuteUserMutationResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - mute.write - tweet.read - users.read - UserToken: [] summary: Mute User tags: - Users /2/users/{id}/owned_lists: get: description: Retrieves a list of Lists owned by a specific User by their ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/list-lookup/api-reference/get-users-id-owned_lists operationId: getUsersOwnedLists parameters: - description: The ID of the User to lookup. example: '2244994945' in: path name: id required: true schema: $ref: '#/components/schemas/UserId' style: simple - description: The maximum number of results. in: query name: max_results required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get a specified 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationTokenLong' style: form - $ref: '#/components/parameters/ListFieldsParameter' - $ref: '#/components/parameters/ListExpansionsParameter' - $ref: '#/components/parameters/UserFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersIdOwnedListsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - list.read - tweet.read - users.read - UserToken: [] summary: Get owned Lists tags: - Users - Lists /2/users/{id}/pinned_lists: get: description: Retrieves a list of Lists pinned by the authenticated user. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/pinned-lists/api-reference/get-users-id-pinned_lists operationId: getUsersPinnedLists parameters: - description: The ID of the authenticated source User for whom to return results. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple - $ref: '#/components/parameters/ListFieldsParameter' - $ref: '#/components/parameters/ListExpansionsParameter' - $ref: '#/components/parameters/UserFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersIdPinnedListsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - list.read - tweet.read - users.read - UserToken: [] summary: Get pinned Lists tags: - Users - Lists post: description: Causes the authenticated user to pin a specific List by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/pinned-lists/api-reference/post-users-id-pinned-lists operationId: pinList parameters: - description: The ID of the authenticated source User that will pin the List. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ListPinnedRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListPinnedResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - list.write - tweet.read - users.read - UserToken: [] summary: Pin List tags: - Users - Lists /2/users/{id}/pinned_lists/{list_id}: delete: description: Causes the authenticated user to unpin a specific List by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/lists/pinned-lists/api-reference/delete-users-id-pinned-lists-list_id operationId: unpinList parameters: - description: The ID of the authenticated source User for whom to return results. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple - description: The ID of the List to unpin. in: path name: list_id required: true schema: $ref: '#/components/schemas/ListId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUnpinResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - list.write - tweet.read - users.read - UserToken: [] summary: Unpin List tags: - Users - Lists /2/users/{id}/retweets: post: description: Causes the authenticated user to repost a specific Post by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/post-users-id-retweets operationId: repostPost parameters: - description: The ID of the authenticated source User that is requesting to repost the Post. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UsersRetweetsCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsersRetweetsCreateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.read - tweet.write - users.read - UserToken: [] summary: Repost Post tags: - Users - Tweets /2/users/{id}/retweets/{source_tweet_id}: delete: description: Causes the authenticated user to unrepost a specific Post by its ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/delete-users-id-retweets-tweet_id operationId: unrepostPost parameters: - description: The ID of the authenticated source User that is requesting to repost the Post. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple - description: The ID of the Post that the User is requesting to unretweet. in: path name: source_tweet_id required: true schema: $ref: '#/components/schemas/TweetId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsersRetweetsDeleteResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.read - tweet.write - users.read - UserToken: [] summary: Unrepost Post tags: - Users - Tweets /2/users/{id}/timelines/reverse_chronological: get: description: "Retrieves a reverse chronological list of Posts in the authenticated\ \ User\u2019s Timeline." externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-reverse-chronological operationId: getUsersTimeline parameters: - description: The ID of the authenticated source User to list Reverse Chronological Timeline Posts of. in: path name: id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple - description: The minimum Post ID to be included in the result set. This parameter takes precedence over start_time if both are specified. example: '791775337160081409' in: query name: since_id required: false schema: $ref: '#/components/schemas/TweetId' style: form - description: The maximum Post ID to be included in the result set. This parameter takes precedence over end_time if both are specified. example: '1346889436626259968' in: query name: until_id required: false schema: $ref: '#/components/schemas/TweetId' style: form - description: The maximum number of results. in: query name: max_results required: false schema: format: int32 maximum: 100 minimum: 1 type: integer style: form - description: This parameter is used to get the next 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - description: The set of entities to exclude (e.g. 'replies' or 'retweets'). explode: false in: query name: exclude required: false schema: example: - replies - retweets items: enum: - replies - retweets type: string type: array uniqueItems: true style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided. The since_id parameter takes precedence if it is also specified. example: '2021-02-01T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. The until_id parameter takes precedence if it is also specified. example: '2021-02-14T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersIdTimelinesReverseChronologicalResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get Timeline tags: - Users - Tweets /2/users/{id}/tweets: get: description: Retrieves a list of posts authored by a specific User by their ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-tweets operationId: getUsersPosts parameters: - description: The ID of the User to lookup. example: '2244994945' in: path name: id required: true schema: $ref: '#/components/schemas/UserId' style: simple - description: The minimum Post ID to be included in the result set. This parameter takes precedence over start_time if both are specified. example: '791775337160081409' in: query name: since_id required: false schema: $ref: '#/components/schemas/TweetId' style: form - description: The maximum Post ID to be included in the result set. This parameter takes precedence over end_time if both are specified. example: '1346889436626259968' in: query name: until_id required: false schema: $ref: '#/components/schemas/TweetId' style: form - description: The maximum number of results. in: query name: max_results required: false schema: format: int32 maximum: 100 minimum: 5 type: integer style: form - description: This parameter is used to get the next 'page' of results. in: query name: pagination_token required: false schema: $ref: '#/components/schemas/PaginationToken36' style: form - description: The set of entities to exclude (e.g. 'replies' or 'retweets'). explode: false in: query name: exclude required: false schema: example: - replies - retweets items: enum: - replies - retweets type: string minItems: 1 type: array uniqueItems: true style: form - description: YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided. The since_id parameter takes precedence if it is also specified. example: '2021-02-01T18:40:40.000Z' in: query name: start_time required: false schema: format: date-time type: string style: form - description: YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. The until_id parameter takes precedence if it is also specified. example: '2021-02-14T18:40:40.000Z' in: query name: end_time required: false schema: format: date-time type: string style: form - $ref: '#/components/parameters/TweetFieldsParameter' - $ref: '#/components/parameters/TweetExpansionsParameter' - $ref: '#/components/parameters/MediaFieldsParameter' - $ref: '#/components/parameters/PollFieldsParameter' - $ref: '#/components/parameters/UserFieldsParameter' - $ref: '#/components/parameters/PlaceFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2UsersIdTweetsResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - OAuth2UserToken: - tweet.read - users.read - UserToken: [] summary: Get Posts tags: - Users - Tweets /2/users/{source_user_id}/following/{target_user_id}: delete: description: Causes the authenticated user to unfollow a specific user by their ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/delete-users-source_id-following operationId: unfollowUser parameters: - description: The ID of the authenticated source User that is requesting to unfollow the target User. in: path name: source_user_id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple - description: The ID of the User that the source User is requesting to unfollow. in: path name: target_user_id required: true schema: $ref: '#/components/schemas/UserId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsersFollowingDeleteResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - follows.write - tweet.read - users.read - UserToken: [] summary: Unfollow User tags: - Users /2/users/{source_user_id}/muting/{target_user_id}: delete: description: Causes the authenticated user to unmute a specific user by their ID. externalDocs: url: https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/delete-users-user_id-muting operationId: unmuteUser parameters: - description: The ID of the authenticated source User that is requesting to unmute the target User. in: path name: source_user_id required: true schema: $ref: '#/components/schemas/UserIdMatchesAuthenticatedUser' style: simple - description: The ID of the User that the source User is requesting to unmute. in: path name: target_user_id required: true schema: $ref: '#/components/schemas/UserId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/MuteUserMutationResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - OAuth2UserToken: - mute.write - tweet.read - users.read - UserToken: [] summary: Unmute User tags: - Users /2/webhooks: get: description: Get a list of webhook configs associated with a client app. externalDocs: url: https://docs.x.com/x-api/webhooks/introduction operationId: getWebhooks parameters: - $ref: '#/components/parameters/WebhookConfigFieldsParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Get2WebhooksResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Get webhook tags: - Webhooks post: description: Creates a new webhook configuration. externalDocs: url: https://docs.x.com/x-api/webhooks/introduction operationId: createWebhooks parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/WebhookConfigCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebhookConfigCreateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - UserToken: [] summary: Create webhook tags: - Webhooks /2/webhooks/replay: post: description: Creates a replay job to retrieve events from up to the past 24 hours for all events delivered or attempted to be delivered to the webhook. externalDocs: url: https://docs.x.com/x-api/webhooks/introduction operationId: createWebhookReplayJob parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/WebhookReplayCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReplayJobCreateResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] summary: Create replay job for webhook tags: - Webhooks /2/webhooks/{webhook_id}: delete: description: Deletes an existing webhook configuration. externalDocs: url: https://docs.x.com/x-api/webhooks/introduction operationId: deleteWebhooks parameters: - description: The ID of the webhook to delete. in: path name: webhook_id required: true schema: $ref: '#/components/schemas/WebhookConfigId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebhookConfigDeleteResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - UserToken: [] summary: Delete webhook tags: - Webhooks put: description: Triggers a CRC check for a given webhook. externalDocs: url: https://docs.x.com/x-api/webhooks/introduction operationId: validateWebhooks parameters: - description: The ID of the webhook to check. in: path name: webhook_id required: true schema: $ref: '#/components/schemas/WebhookConfigId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebhookConfigPutResponse' description: The request has succeeded. default: content: application/json: schema: $ref: '#/components/schemas/Error' application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The request has failed. security: - BearerToken: [] - UserToken: [] summary: Validate webhook tags: - Webhooks servers: - description: X API url: https://api.x.com tags: - description: Endpoints relating to retrieving, managing AAA subscriptions externalDocs: description: Find out more url: https://docs.x.com/x-api/enterprise-gnip-2.0/fundamentals/account-activity name: Account Activity - description: Endpoints related to retrieving, managing bookmarks of a user externalDocs: description: Find out more url: https://developer.twitter.com/en/docs/twitter-api/bookmarks name: Bookmarks - description: Endpoints related to keeping X data in your systems compliant externalDocs: description: Find out more url: https://developer.twitter.com/en/docs/twitter-api/compliance/batch-tweet/introduction name: Compliance - description: Endpoints related to streaming connections externalDocs: description: Find out more url: https://developer.x.com/en/docs/x-api/connections name: Connections - description: Endpoints related to retrieving, managing Direct Messages externalDocs: description: Find out more url: https://developer.twitter.com/en/docs/twitter-api/direct-messages name: Direct Messages - description: Miscellaneous endpoints for general API functionality externalDocs: description: Find out more url: https://developer.twitter.com/en/docs/twitter-api name: General - description: Endpoints related to retrieving, managing Lists externalDocs: description: Find out more url: https://developer.twitter.com/en/docs/twitter-api/lists name: Lists - description: Endpoints related to Media externalDocs: description: Find out more url: https://developer.x.com name: Media - description: Endpoints related to uploading Media externalDocs: description: Find out more url: https://developer.x.com name: MediaUpload - description: Endpoint for retrieving news stories externalDocs: description: Find out more url: https://developer.twitter.com/en/docs/twitter-api/news name: News - description: Endpoints related to retrieving, managing Spaces externalDocs: description: Find out more url: https://developer.twitter.com/en/docs/twitter-api/spaces name: Spaces - description: Endpoints related to streaming externalDocs: description: Find out more url: https://developer.x.com name: Stream - description: Endpoints related to retrieving, searching, and modifying Tweets externalDocs: description: Find out more url: https://developer.twitter.com/en/docs/twitter-api/tweets/lookup name: Tweets - description: Endpoints related to retrieving, managing relationships of Users externalDocs: description: Find out more url: https://developer.twitter.com/en/docs/twitter-api/users/lookup name: Users