RuleNoId
{
"type": "object",
"required": [
"value"
],
"properties": {
"tag": {
"$ref": "#/components/schemas/RuleTag"
},
"value": {
"$ref": "#/components/schemas/RuleValue"
}
},
"description": "A user-provided stream filtering rule."
}
RuleTag
{
"type": "string",
"example": "Non-retweeted coffee Tweets",
"description": "A tag meant for the labeling of user provided rules."
}
RuleValue
{
"type": "string",
"example": "coffee -is:retweet",
"description": "The filterlang value of the rule."
}
RulesLookupResponse
{
"type": "object",
"required": [
"meta"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Rule"
}
},
"meta": {
"$ref": "#/components/schemas/RulesResponseMetadata"
}
}
}
RulesRequestSummary
{
"oneOf": [
{
"type": "object",
"required": [
"created",
"not_created",
"valid",
"invalid"
],
"properties": {
"valid": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "Number of valid user-specified stream filtering rules."
},
"created": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "Number of user-specified stream filtering rules that were created."
},
"invalid": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "Number of invalid user-specified stream filtering rules."
},
"not_created": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "Number of user-specified stream filtering rules that were not created."
}
},
"description": "A summary of the results of the addition of user-specified stream filtering rules."
},
{
"type": "object",
"required": [
"deleted",
"not_deleted"
],
"properties": {
"deleted": {
"type": "integer",
"format": "int32",
"description": "Number of user-specified stream filtering rules that were deleted."
},
"not_deleted": {
"type": "integer",
"format": "int32",
"description": "Number of user-specified stream filtering rules that were not deleted."
}
}
}
]
}
RulesResponseMetadata
{
"type": "object",
"required": [
"sent"
],
"properties": {
"sent": {
"type": "string"
},
"summary": {
"$ref": "#/components/schemas/RulesRequestSummary"
},
"next_token": {
"$ref": "#/components/schemas/NextToken"
},
"result_count": {
"type": "integer",
"format": "int32",
"description": "Number of Rules in result set."
}
}
}
SearchCount
{
"type": "object",
"required": [
"end",
"start",
"tweet_count"
],
"properties": {
"end": {
"$ref": "#/components/schemas/End"
},
"start": {
"$ref": "#/components/schemas/Start"
},
"tweet_count": {
"$ref": "#/components/schemas/TweetCount"
}
},
"description": "Represent a Search Count Result."
}
Space
{
"type": "object",
"required": [
"id",
"state"
],
"properties": {
"id": {
"$ref": "#/components/schemas/SpaceId"
},
"lang": {
"type": "string",
"example": "en",
"description": "The language of the Space."
},
"state": {
"enum": [
"live",
"scheduled",
"ended"
],
"type": "string",
"example": "live",
"description": "The current state of the Space."
},
"title": {
"type": "string",
"example": "Spaces are Awesome",
"description": "The title of the Space."
},
"topics": {
"type": "array",
"items": {
"type": "object",
"example": {
"id": "848920371311001600",
"name": "Technology",
"description": "All about technology"
},
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "An ID suitable for use in the REST API."
},
"name": {
"type": "string",
"description": "The name of the given topic."
},
"description": {
"type": "string",
"description": "The description of the given topic."
}
},
"description": "The Twitter Topic object."
},
"description": "The topics of a Space, as selected by its creator."
},
"ended_at": {
"type": "string",
"format": "date-time",
"example": "2021-07-06T18:40:40.000Z",
"description": "End time of the Space."
},
"host_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserId"
},
"description": "The user ids for the hosts of the Space."
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2021-07-06T18:40:40.000Z",
"description": "Creation time of the Space."
},
"creator_id": {
"$ref": "#/components/schemas/UserId"
},
"started_at": {
"type": "string",
"format": "date-time",
"example": "2021-07-14T04:35:55.000Z",
"description": "When the Space was started as a date string."
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2021-07-14T04:35:55.000Z",
"description": "When the Space was last updated."
},
"is_ticketed": {
"type": "boolean",
"example": false,
"description": "Denotes if the Space is a ticketed Space."
},
"speaker_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserId"
},
"description": "An array of user ids for people who were speakers in a Space."
},
"scheduled_start": {
"type": "string",
"format": "date-time",
"example": "2021-07-06T18:40:40.000Z",
"description": "A date time stamp for when a Space is scheduled to begin."
},
"invited_user_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserId"
},
"description": "An array of user ids for people who were invited to a Space."
},
"subscriber_count": {
"type": "integer",
"format": "int32",
"example": 10,
"description": "The number of people who have either purchased a ticket or set a reminder for this Space."
},
"participant_count": {
"type": "integer",
"format": "int32",
"example": 10,
"description": "The number of participants in a Space."
}
},
"description": ""
}
SpaceId
{
"type": "string",
"example": "1SLjjRYNejbKM",
"pattern": "^[a-zA-Z0-9]{1,13}$",
"description": "The unique identifier of this Space."
}
Start
{
"type": "string",
"format": "date-time",
"description": "The start time of the bucket."
}
StreamingTweetResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Tweet"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Problem"
},
"minItems": 1
},
"includes": {
"$ref": "#/components/schemas/Expansions"
}
}
}
Topic
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"$ref": "#/components/schemas/TopicId"
},
"name": {
"type": "string",
"example": "Technology",
"description": "The name of the given topic."
},
"description": {
"type": "string",
"example": "All about technology",
"description": "The description of the given topic."
}
},
"description": "The topic of a Space, as selected by its creator."
}
TopicId
{
"type": "string",
"description": "Unique identifier of this Topic."
}
Tweet
{
"type": "object",
"example": {
"id": "1346889436626259968",
"text": "Learn how to use the user Tweet timeline and user mention timeline endpoints in the Twitter API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i",
"author_id": "2244994945",
"created_at": "Wed Jan 06 18:40:40 +0000 2021"
},
"required": [
"id",
"text",
"edit_history_tweet_ids"
],
"properties": {
"id": {
"$ref": "#/components/schemas/TweetId"
},
"geo": {
"type": "object",
"properties": {
"place_id": {
"$ref": "#/components/schemas/PlaceId"
},
"coordinates": {
"$ref": "#/components/schemas/Point"
}
},
"description": "The location tagged on the Tweet, if the user provided one."
},
"lang": {
"type": "string",
"example": "en",
"description": "Language of the Tweet, if detected by Twitter. Returned as a BCP47 language tag."
},
"text": {
"$ref": "#/components/schemas/TweetText"
},
"source": {
"type": "string",
"description": "This is deprecated."
},
"entities": {
"$ref": "#/components/schemas/FullTextEntities"
},
"withheld": {
"$ref": "#/components/schemas/TweetWithheld"
},
"author_id": {
"$ref": "#/components/schemas/UserId"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2021-01-06T18:40:40.000Z",
"description": "Creation time of the Tweet."
},
"attachments": {
"type": "object",
"properties": {
"poll_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PollId"
},
"minItems": 1,
"description": "A list of poll IDs (if polls are attached)."
},
"media_keys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaKey"
},
"minItems": 1,
"description": "A list of Media Keys for each one of the media attachments (if media are attached)."
}
},
"description": "Specifies the type of attachments (if any) present in this Tweet."
},
"edit_controls": {
"type": "object",
"required": [
"is_edit_eligible",
"editable_until",
"edits_remaining"
],
"properties": {
"editable_until": {
"type": "string",
"format": "date-time",
"example": "2021-01-06T18:40:40.000Z",
"description": "Time when Tweet is no longer editable."
},
"edits_remaining": {
"type": "integer",
"description": "Number of times this Tweet can be edited."
},
"is_edit_eligible": {
"type": "boolean",
"example": false,
"description": "Indicates if this Tweet is eligible to be edited."
}
}
},
"public_metrics": {
"type": "object",
"required": [
"retweet_count",
"reply_count",
"like_count",
"impression_count"
],
"properties": {
"like_count": {
"type": "integer",
"description": "Number of times this Tweet has been liked."
},
"quote_count": {
"type": "integer",
"description": "Number of times this Tweet has been quoted."
},
"reply_count": {
"type": "integer",
"description": "Number of times this Tweet has been replied to."
},
"retweet_count": {
"type": "integer",
"description": "Number of times this Tweet has been Retweeted."
},
"impression_count": {
"type": "integer",
"format": "int32",
"description": "Number of times this Tweet has been viewed."
}
},
"description": "Engagement metrics for the Tweet at the time of the request."
},
"reply_settings": {
"$ref": "#/components/schemas/ReplySettings"
},
"conversation_id": {
"$ref": "#/components/schemas/TweetId"
},
"organic_metrics": {
"type": "object",
"required": [
"impression_count",
"retweet_count",
"reply_count",
"like_count"
],
"properties": {
"like_count": {
"type": "integer",
"description": "Number of times this Tweet has been liked."
},
"reply_count": {
"type": "integer",
"description": "Number of times this Tweet has been replied to."
},
"retweet_count": {
"type": "integer",
"description": "Number of times this Tweet has been Retweeted."
},
"impression_count": {
"type": "integer",
"description": "Number of times this Tweet has been viewed."
}
},
"description": "Organic nonpublic engagement metrics for the Tweet at the time of the request."
},
"promoted_metrics": {
"type": "object",
"properties": {
"like_count": {
"type": "integer",
"format": "int32",
"description": "Number of times this Tweet has been liked."
},
"reply_count": {
"type": "integer",
"format": "int32",
"description": "Number of times this Tweet has been replied to."
},
"retweet_count": {
"type": "integer",
"format": "int32",
"description": "Number of times this Tweet has been Retweeted."
},
"impression_count": {
"type": "integer",
"format": "int32",
"description": "Number of times this Tweet has been viewed."
}
},
"description": "Promoted nonpublic engagement metrics for the Tweet at the time of the request."
},
"referenced_tweets": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/TweetId"
},
"type": {
"enum": [
"retweeted",
"quoted",
"replied_to"
],
"type": "string"
}
}
},
"minItems": 1,
"description": "A list of Tweets 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."
},
"non_public_metrics": {
"type": "object",
"properties": {
"impression_count": {
"type": "integer",
"format": "int32",
"description": "Number of times this Tweet has been viewed."
}
},
"description": "Nonpublic engagement metrics for the Tweet at the time of the request."
},
"possibly_sensitive": {
"type": "boolean",
"example": false,
"description": "Indicates if this Tweet contains URLs marked as sensitive, for example content suitable for mature audiences."
},
"context_annotations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextAnnotation"
},
"minItems": 1
},
"in_reply_to_user_id": {
"$ref": "#/components/schemas/UserId"
},
"edit_history_tweet_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TweetId"
},
"minItems": 1,
"description": "A list of Tweet Ids in this Tweet chain."
}
}
}
TweetComplianceData
{
"oneOf": [
{
"$ref": "#/components/schemas/TweetDeleteComplianceSchema"
},
{
"$ref": "#/components/schemas/TweetWithheldComplianceSchema"
},
{
"$ref": "#/components/schemas/TweetDropComplianceSchema"
},
{
"$ref": "#/components/schemas/TweetUndropComplianceSchema"
},
{
"$ref": "#/components/schemas/TweetEditComplianceSchema"
}
],
"description": "Tweet compliance data."
}
TweetComplianceSchema
{
"type": "object",
"required": [
"tweet",
"event_at"
],
"properties": {
"tweet": {
"type": "object",
"required": [
"id",
"author_id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/TweetId"
},
"author_id": {
"$ref": "#/components/schemas/UserId"
}
}
},
"event_at": {
"type": "string",
"format": "date-time",
"example": "2021-07-06T18:40:40.000Z",
"description": "Event time."
},
"quote_tweet_id": {
"$ref": "#/components/schemas/TweetId"
}
}
}
TweetComplianceStreamResponse
{
"oneOf": [
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/TweetComplianceData"
}
},
"description": "Compliance event."
},
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Problem"
},
"minItems": 1
}
}
}
],
"description": "Tweet compliance stream events."
}
TweetCount
{
"type": "integer",
"description": "The count for the bucket."
}
TweetCreateRequest
{
"type": "object",
"properties": {
"geo": {
"type": "object",
"properties": {
"place_id": {
"type": "string"
}
},
"description": "Place ID being attached to the Tweet for geo location."
},
"poll": {
"type": "object",
"required": [
"options",
"duration_minutes"
],
"properties": {
"options": {
"type": "array",
"items": {
"type": "string",
"maxLength": 25,
"minLength": 1,
"description": "The text of a poll choice."
},
"maxItems": 4,
"minItems": 2
},
"reply_settings": {
"enum": [
"following",
"mentionedUsers"
],
"type": "string",
"description": "Settings to indicate who can reply to the Tweet."
},
"duration_minutes": {
"type": "integer",
"format": "int32",
"maximum": 10080,
"minimum": 5,
"description": "Duration of the poll in minutes."
}
},
"description": "Poll options for a Tweet with a poll. This is mutually exclusive from Media, Quote Tweet Id, and Card URI."
},
"text": {
"$ref": "#/components/schemas/TweetText"
},
"media": {
"type": "object",
"required": [
"media_ids"
],
"properties": {
"media_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaId"
},
"maxItems": 4,
"minItems": 1,
"description": "A list of Media Ids to be attached to a created Tweet."
},
"tagged_user_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserId"
},
"maxItems": 10,
"minItems": 0,
"description": "A list of User Ids to be tagged in the media for created Tweet."
}
},
"description": "Media information being attached to created Tweet. This is mutually exclusive from Quote Tweet Id, Poll, and Card URI."
},
"reply": {
"type": "object",
"required": [
"in_reply_to_tweet_id"
],
"properties": {
"in_reply_to_tweet_id": {
"$ref": "#/components/schemas/TweetId"
},
"exclude_reply_user_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserId"
},
"description": "A list of User Ids to be excluded from the reply Tweet."
}
},
"description": "Tweet information of the Tweet being replied to."
},
"card_uri": {
"type": "string",
"description": "Card Uri Parameter. This is mutually exclusive from Quote Tweet Id, Poll, Media, and Direct Message Deep Link."
},
"nullcast": {
"type": "boolean",
"default": false,
"description": "Nullcasted (promoted-only) Tweets do not appear in the public timeline and are not served to followers."
},
"quote_tweet_id": {
"$ref": "#/components/schemas/TweetId"
},
"reply_settings": {
"enum": [
"following",
"mentionedUsers"
],
"type": "string",
"description": "Settings to indicate who can reply to the Tweet."
},
"direct_message_deep_link": {
"type": "string",
"description": "Link to take the conversation from the public timeline to a private Direct Message."
},
"for_super_followers_only": {
"type": "boolean",
"default": false,
"description": "Exclusive Tweet for super followers."
}
}
}
TweetCreateResponse
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"id",
"text"
],
"properties": {
"id": {
"$ref": "#/components/schemas/TweetId"
},
"text": {
"$ref": "#/components/schemas/TweetText"
}
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Problem"
},
"minItems": 1
}
}
}
TweetDeleteComplianceSchema
{
"type": "object",
"required": [
"delete"
],
"properties": {
"delete": {
"$ref": "#/components/schemas/TweetComplianceSchema"
}
}
}
TweetDeleteResponse
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"deleted"
],
"properties": {
"deleted": {
"type": "boolean"
}
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Problem"
},
"minItems": 1
}
}
}
TweetDropComplianceSchema
{
"type": "object",
"required": [
"drop"
],
"properties": {
"drop": {
"$ref": "#/components/schemas/TweetComplianceSchema"
}
}
}
TweetEditComplianceObjectSchema
{
"type": "object",
"required": [
"tweet",
"event_at",
"initial_tweet_id",
"edit_tweet_ids"
],
"properties": {
"tweet": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/TweetId"
}
}
},
"event_at": {
"type": "string",
"format": "date-time",
"example": "2021-07-06T18:40:40.000Z",
"description": "Event time."
},
"edit_tweet_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TweetId"
},
"minItems": 1
},
"initial_tweet_id": {
"$ref": "#/components/schemas/TweetId"
}
}
}
TweetEditComplianceSchema
{
"type": "object",
"required": [
"tweet_edit"
],
"properties": {
"tweet_edit": {
"$ref": "#/components/schemas/TweetEditComplianceObjectSchema"
}
}
}
TweetHideRequest
{
"type": "object",
"required": [
"hidden"
],
"properties": {
"hidden": {
"type": "boolean"
}
}
}
TweetHideResponse
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"hidden": {
"type": "boolean"
}
}
}
}
}
TweetId
{
"type": "string",
"example": "1346889436626259968",
"pattern": "^[0-9]{1,19}$",
"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."
}
TweetLabelData
{
"oneOf": [
{
"$ref": "#/components/schemas/TweetNoticeSchema"
},
{
"$ref": "#/components/schemas/TweetUnviewableSchema"
}
],
"description": "Tweet label data."
}
TweetLabelStreamResponse
{
"oneOf": [
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/TweetLabelData"
}
},
"description": "Tweet Label event."
},
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Problem"
},
"minItems": 1
}
}
}
],
"description": "Tweet label stream events."
}
TweetNotice
{
"type": "object",
"required": [
"tweet",
"event_type",
"event_at",
"application"
],
"properties": {
"tweet": {
"type": "object",
"required": [
"id",
"author_id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/TweetId"
},
"author_id": {
"$ref": "#/components/schemas/UserId"
}
}
},
"details": {
"type": "string",
"description": "Information shown on the Tweet label"
},
"event_at": {
"type": "string",
"format": "date-time",
"example": "2021-07-06T18:40:40.000Z",
"description": "Event time."
},
"event_type": {
"type": "string",
"example": "misleading",
"description": "The type of label on the Tweet"
},
"application": {
"type": "string",
"example": "apply",
"description": "If the label is being applied or removed. Possible values are ‘apply’ or ‘remove’."
},
"label_title": {
"type": "string",
"description": "Title/header of the Tweet label"
},
"extended_details_url": {
"type": "string",
"description": "Link to more information about this kind of label"
}
}
}
TweetNoticeSchema
{
"type": "object",
"required": [
"public_tweet_notice"
],
"properties": {
"public_tweet_notice": {
"$ref": "#/components/schemas/TweetNotice"
}
}
}
TweetTakedownComplianceSchema
{
"type": "object",
"required": [
"tweet",
"withheld_in_countries",
"event_at"
],
"properties": {
"tweet": {
"type": "object",
"required": [
"id",
"author_id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/TweetId"
},
"author_id": {
"$ref": "#/components/schemas/UserId"
}
}
},
"event_at": {
"type": "string",
"format": "date-time",
"example": "2021-07-06T18:40:40.000Z",
"description": "Event time."
},
"quote_tweet_id": {
"$ref": "#/components/schemas/TweetId"
},
"withheld_in_countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryCode"
},
"minItems": 1
}
}
}
TweetText
{
"type": "string",
"example": "Learn how to use the user Tweet timeline and user mention timeline endpoints in the Twitter API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i",
"description": "The content of the Tweet."
}
TweetUndropComplianceSchema
{
"type": "object",
"required": [
"undrop"
],
"properties": {
"undrop": {
"$ref": "#/components/schemas/TweetComplianceSchema"
}
}
}
TweetUnviewable
{
"type": "object",
"required": [
"tweet",
"event_at",
"application"
],
"properties": {
"tweet": {
"type": "object",
"required": [
"id",
"author_id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/TweetId"
},
"author_id": {
"$ref": "#/components/schemas/UserId"
}
}
},
"event_at": {
"type": "string",
"format": "date-time",
"example": "2021-07-06T18:40:40.000Z",
"description": "Event time."
},
"application": {
"type": "string",
"example": "apply",
"description": "If the label is being applied or removed. Possible values are ‘apply’ or ‘remove’."
}
}
}
TweetUnviewableSchema
{
"type": "object",
"required": [
"public_tweet_unviewable"
],
"properties": {
"public_tweet_unviewable": {
"$ref": "#/components/schemas/TweetUnviewable"
}
}
}
TweetWithheld
{
"type": "object",
"required": [
"copyright",
"country_codes"
],
"properties": {
"scope": {
"enum": [
"tweet",
"user"
],
"type": "string",
"description": "Indicates whether the content being withheld is the `tweet` or a `user`."
},
"copyright": {
"type": "boolean",
"description": "Indicates if the content is being withheld for on the basis of copyright infringement."
},
"country_codes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryCode"
},
"minItems": 1,
"description": "Provides a list of countries where this content is not available.",
"uniqueItems": true
}
},
"description": "Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country)."
}
TweetWithheldComplianceSchema
{
"type": "object",
"required": [
"withheld"
],
"properties": {
"withheld": {
"$ref": "#/components/schemas/TweetTakedownComplianceSchema"
}
}
}
UploadExpiration
{
"type": "string",
"format": "date-time",
"example": "2021-01-06T18:40:40.000Z",
"description": "Expiration time of the upload URL."
}
UploadUrl
{
"type": "string",
"format": "uri",
"description": "URL to which the user will upload their Tweet or user IDs."
}
Url
{
"type": "string",
"format": "uri",
"example": "https://developer.twitter.com/en/docs/twitter-api",
"description": "A validly formatted URL."
}
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."
}
UrlFields
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"$ref": "#/components/schemas/Url"
},
"title": {
"type": "string",
"example": "Introducing the v2 follow lookup endpoints",
"description": "Title of the page the URL points to."
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UrlImage"
},
"minItems": 1
},
"status": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"media_key": {
"$ref": "#/components/schemas/MediaKey"
},
"description": {
"type": "string",
"example": "This is a description of the website.",
"description": "Description of the URL landing page."
},
"display_url": {
"type": "string",
"example": "twittercommunity.com/t/introducing-…",
"description": "The URL as displayed in the Twitter client."
},
"unwound_url": {
"type": "string",
"format": "uri",
"example": "https://twittercommunity.com/t/introducing-the-v2-follow-lookup-endpoints/147118",
"description": "Fully resolved url."
},
"expanded_url": {
"$ref": "#/components/schemas/Url"
}
},
"description": "Represent the portion of text recognized as a URL."
}
UrlImage
{
"type": "object",
"properties": {
"url": {
"$ref": "#/components/schemas/Url"
},
"width": {
"$ref": "#/components/schemas/MediaWidth"
},
"height": {
"$ref": "#/components/schemas/MediaHeight"
}
},
"description": "Represent the information for the URL image."
}
UsageCapExceededProblem
{
"allOf": [
{
"$ref": "#/components/schemas/Problem"
},
{
"type": "object",
"properties": {
"scope": {
"enum": [
"Account",
"Product"
],
"type": "string"
},
"period": {
"enum": [
"Daily",
"Monthly"
],
"type": "string"
}
}
}
],
"description": "A problem that indicates that a usage cap has been exceeded."
}
User
{
"type": "object",
"example": {
"id": "2244994945",
"name": "Twitter Dev",
"username": "TwitterDev",
"protected": false,
"created_at": "2013-12-14T04:35:55.000Z"
},
"required": [
"id",
"name",
"username"
],
"properties": {
"id": {
"$ref": "#/components/schemas/UserId"
},
"url": {
"type": "string",
"description": "The URL specified in the User's profile."
},
"name": {
"type": "string",
"description": "The friendly name of this User, as shown on their profile."
},
"entities": {
"type": "object",
"properties": {
"url": {
"type": "object",
"properties": {
"urls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UrlEntity"
},
"minItems": 1
}
},
"description": "Expanded details for the URL specified in the User's profile, with start and end indices."
},
"description": {
"$ref": "#/components/schemas/FullTextEntities"
}
},
"description": "A list of metadata found in the User's profile description."
},
"location": {
"type": "string",
"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."
},
"username": {
"$ref": "#/components/schemas/UserName"
},
"verified": {
"type": "boolean",
"description": "Indicate if this User is a verified Twitter User."
},
"withheld": {
"$ref": "#/components/schemas/UserWithheld"
},
"protected": {
"type": "boolean",
"description": "Indicates if this User has chosen to protect their Tweets (in other words, if this User's Tweets are private)."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation time of this User."
},
"description": {
"type": "string",
"description": "The text of this User's profile description (also known as bio), if the User provided one."
},
"verified_type": {
"type": "string",
"description": "The Twitter Blue verified type of the user, eg: blue, government, business or none."
},
"public_metrics": {
"type": "object",
"required": [
"followers_count",
"following_count",
"tweet_count",
"listed_count"
],
"properties": {
"tweet_count": {
"type": "integer",
"description": "The number of Tweets (including Retweets) posted by this User."
},
"listed_count": {
"type": "integer",
"description": "The number of lists that include this User."
},
"followers_count": {
"type": "integer",
"description": "Number of Users who are following this User."
},
"following_count": {
"type": "integer",
"description": "Number of Users this User is following."
}
},
"description": "A list of metrics for this User."
},
"pinned_tweet_id": {
"$ref": "#/components/schemas/TweetId"
},
"profile_image_url": {
"type": "string",
"format": "uri",
"description": "The URL to the profile image for this User."
}
},
"description": "The Twitter User object."
}
UserComplianceData
{
"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"
}
],
"description": "User compliance data."
}
UserComplianceSchema
{
"type": "object",
"required": [
"user",
"event_at"
],
"properties": {
"user": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/UserId"
}
}
},
"event_at": {
"type": "string",
"format": "date-time",
"example": "2021-07-06T18:40:40.000Z",
"description": "Event time."
}
}
}
UserComplianceStreamResponse
{
"oneOf": [
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/UserComplianceData"
}
},
"description": "User compliance event."
},
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Problem"
},
"minItems": 1
}
}
}
],
"description": "User compliance stream events."
}