Skip to content

Instantly share code, notes, and snippets.

@kinlane

kinlane/twitter-openapi-v2.json

Created January 19, 2023 00:06
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save kinlane/173d89eb8a9cd7dfc4e77fb3bb63dda2 to your computer and use it in GitHub Desktop.
Save kinlane/173d89eb8a9cd7dfc4e77fb3bb63dda2 to your computer and use it in GitHub Desktop.
Download ZIP
Twitter OpenAPI v2
Raw
twitter-openapi-v2.json
{
"openapi" : "3.0.0",
"info" : {
"description" : "Twitter API v2 available endpoints",
"version" : "2.60",
"title" : "Twitter API v2",
"termsOfService" : "https://developer.twitter.com/en/developer-terms/agreement-and-policy.html",
"contact" : {
"name" : "Twitter Developers",
"url" : "https://developer.twitter.com/"
},
"license" : {
"name" : "Twitter Developer Agreement and Policy",
"url" : "https://developer.twitter.com/en/developer-terms/agreement-and-policy.html"
}
},
"paths" : {
"/2/compliance/jobs" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
}
],
"tags" : [
"Compliance"
],
"summary" : "List Compliance Jobs",
"description" : "Returns recent Compliance Jobs for a given job type and optional job status",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/get-compliance-jobs"
},
"operationId" : "listBatchComplianceJobs",
"parameters" : [
{
"name" : "type",
"in" : "query",
"description" : "Type of Compliance Job to list.",
"required" : true,
"schema" : {
"type" : "string",
"enum" : [
"tweets",
"users"
]
},
"style" : "form"
},
{
"name" : "status",
"in" : "query",
"description" : "Status of Compliance Job to list.",
"required" : false,
"schema" : {
"type" : "string",
"enum" : [
"created",
"in_progress",
"failed",
"complete"
]
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/ComplianceJobFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2ComplianceJobsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
},
"post" : {
"security" : [
{
"BearerToken" : [ ]
}
],
"tags" : [
"Compliance"
],
"summary" : "Create compliance job",
"description" : "Creates a compliance for the given job type",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/post-compliance-jobs"
},
"operationId" : "createBatchComplianceJob",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateComplianceJobRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateComplianceJobResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/compliance/jobs/{id}" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
}
],
"tags" : [
"Compliance"
],
"summary" : "Get Compliance Job",
"description" : "Returns a single Compliance Job by ID",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/get-compliance-jobs-id"
},
"operationId" : "getBatchComplianceJob",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the Compliance Job to retrieve.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/JobId"
},
"style" : "simple"
},
{
"$ref" : "#/components/parameters/ComplianceJobFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2ComplianceJobsIdResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/dm_conversations" : {
"post" : {
"security" : [
{
"OAuth2UserToken" : [
"dm.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Direct Messages"
],
"summary" : "Create a new DM Conversation",
"description" : "Creates a new DM Conversation.",
"operationId" : "dmConversationIdCreate",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateDmConversationRequest"
}
}
}
},
"responses" : {
"201" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateDmEventResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/dm_conversations/with/{participant_id}/dm_events" : {
"get" : {
"security" : [
{
"OAuth2UserToken" : [
"dm.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Direct Messages"
],
"summary" : "Get DM Events for a DM Conversation",
"description" : "Returns DM Events for a DM Conversation",
"operationId" : "getDmConversationsWithParticipantIdDmEvents",
"parameters" : [
{
"name" : "participant_id",
"in" : "path",
"description" : "The ID of the participant user for the One to One DM conversation.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserId"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32",
"default" : 100
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get a specified 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken32"
},
"style" : "form"
},
{
"name" : "event_types",
"in" : "query",
"description" : "The set of event_types to include in the results.",
"required" : false,
"schema" : {
"type" : "array",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"MessageCreate",
"ParticipantsJoin",
"ParticipantsLeave"
]
},
"default" : [
"MessageCreate",
"ParticipantsLeave",
"ParticipantsJoin"
],
"example" : [
"MessageCreate",
"ParticipantsLeave"
]
},
"explode" : false,
"style" : "form"
},
{
"$ref" : "#/components/parameters/DmEventFieldsParameter"
},
{
"$ref" : "#/components/parameters/DmEventExpansionsParameter"
},
{
"$ref" : "#/components/parameters/MediaFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2DmConversationsWithParticipantIdDmEventsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/dm_conversations/with/{participant_id}/messages" : {
"post" : {
"security" : [
{
"OAuth2UserToken" : [
"dm.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Direct Messages"
],
"summary" : "Send a new message to a user",
"description" : "Creates a new message for a DM Conversation with a participant user by ID",
"operationId" : "dmConversationWithUserEventIdCreate",
"parameters" : [
{
"name" : "participant_id",
"in" : "path",
"description" : "The ID of the recipient user that will receive the DM.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserId"
},
"style" : "simple"
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateMessageRequest"
}
}
}
},
"responses" : {
"201" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateDmEventResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/dm_conversations/{dm_conversation_id}/messages" : {
"post" : {
"security" : [
{
"OAuth2UserToken" : [
"dm.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Direct Messages"
],
"summary" : "Send a new message to a DM Conversation",
"description" : "Creates a new message for a DM Conversation specified by DM Conversation ID",
"operationId" : "dmConversationByIdEventIdCreate",
"parameters" : [
{
"name" : "dm_conversation_id",
"in" : "path",
"description" : "The DM Conversation ID.",
"required" : true,
"schema" : {
"type" : "string"
},
"style" : "simple"
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateMessageRequest"
}
}
}
},
"responses" : {
"201" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateDmEventResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/dm_conversations/{id}/dm_events" : {
"get" : {
"security" : [
{
"OAuth2UserToken" : [
"dm.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Direct Messages"
],
"summary" : "Get DM Events for a DM Conversation",
"description" : "Returns DM Events for a DM Conversation",
"operationId" : "getDmConversationsIdDmEvents",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The DM Conversation ID.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/DmConversationId"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32",
"default" : 100
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get a specified 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken32"
},
"style" : "form"
},
{
"name" : "event_types",
"in" : "query",
"description" : "The set of event_types to include in the results.",
"required" : false,
"schema" : {
"type" : "array",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"MessageCreate",
"ParticipantsJoin",
"ParticipantsLeave"
]
},
"default" : [
"MessageCreate",
"ParticipantsLeave",
"ParticipantsJoin"
],
"example" : [
"MessageCreate",
"ParticipantsLeave"
]
},
"explode" : false,
"style" : "form"
},
{
"$ref" : "#/components/parameters/DmEventFieldsParameter"
},
{
"$ref" : "#/components/parameters/DmEventExpansionsParameter"
},
{
"$ref" : "#/components/parameters/MediaFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2DmConversationsIdDmEventsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/dm_events" : {
"get" : {
"security" : [
{
"OAuth2UserToken" : [
"dm.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Direct Messages"
],
"summary" : "Get recent DM Events",
"description" : "Returns recent DM Events across DM conversations",
"operationId" : "getDmEvents",
"parameters" : [
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32",
"default" : 100
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get a specified 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken32"
},
"style" : "form"
},
{
"name" : "event_types",
"in" : "query",
"description" : "The set of event_types to include in the results.",
"required" : false,
"schema" : {
"type" : "array",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"MessageCreate",
"ParticipantsJoin",
"ParticipantsLeave"
]
},
"default" : [
"MessageCreate",
"ParticipantsLeave",
"ParticipantsJoin"
],
"example" : [
"MessageCreate",
"ParticipantsLeave"
]
},
"explode" : false,
"style" : "form"
},
{
"$ref" : "#/components/parameters/DmEventFieldsParameter"
},
{
"$ref" : "#/components/parameters/DmEventExpansionsParameter"
},
{
"$ref" : "#/components/parameters/MediaFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2DmEventsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/lists" : {
"post" : {
"security" : [
{
"OAuth2UserToken" : [
"list.read",
"list.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Lists"
],
"summary" : "Create List",
"description" : "Creates a new List.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/post-lists"
},
"operationId" : "listIdCreate",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListCreateRequest"
}
}
}
},
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListCreateResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/lists/{id}" : {
"delete" : {
"security" : [
{
"OAuth2UserToken" : [
"list.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Lists"
],
"summary" : "Delete List",
"description" : "Delete a List that you own.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/delete-lists-id"
},
"operationId" : "listIdDelete",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the List to delete.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/ListId"
},
"style" : "simple"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListDeleteResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
},
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"list.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Lists"
],
"summary" : "List lookup by List ID.",
"description" : "Returns a List.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/list-lookup/api-reference/get-lists-id"
},
"operationId" : "listIdGet",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the List.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/ListId"
},
"style" : "simple"
},
{
"$ref" : "#/components/parameters/ListFieldsParameter"
},
{
"$ref" : "#/components/parameters/ListExpansionsParameter"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2ListsIdResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
},
"put" : {
"security" : [
{
"OAuth2UserToken" : [
"list.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Lists"
],
"summary" : "Update List.",
"description" : "Update a List that you own.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/put-lists-id"
},
"operationId" : "listIdUpdate",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the List to modify.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/ListId"
},
"style" : "simple"
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListUpdateRequest"
}
}
}
},
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListUpdateResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/lists/{id}/followers" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"list.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "Returns User objects that follow a List by the provided List ID",
"description" : "Returns a list of Users that follow a List by the provided List ID",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-followers"
},
"operationId" : "listGetFollowers",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the List.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/ListId"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32",
"default" : 100
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get a specified 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationTokenLong"
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserExpansionsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2ListsIdFollowersResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/lists/{id}/members" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"list.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "Returns User objects that are members of a List by the provided List ID.",
"description" : "Returns a list of Users that are members of a List by the provided List ID.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/get-users-id-list_memberships"
},
"operationId" : "listGetMembers",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the List.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/ListId"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32",
"default" : 100
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get a specified 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationTokenLong"
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserExpansionsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2ListsIdMembersResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
},
"post" : {
"security" : [
{
"OAuth2UserToken" : [
"list.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Lists"
],
"summary" : "Add a List member",
"description" : "Causes a User to become a member of a List.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/post-lists-id-members"
},
"operationId" : "listAddMember",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the List for which to add a member.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/ListId"
},
"style" : "simple"
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListAddUserRequest"
}
}
}
},
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListMutateResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/lists/{id}/members/{user_id}" : {
"delete" : {
"security" : [
{
"OAuth2UserToken" : [
"list.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Lists"
],
"summary" : "Remove a List member",
"description" : "Causes a User to be removed from the members of a List.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/delete-lists-id-members-user_id"
},
"operationId" : "listRemoveMember",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the List to remove a member.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/ListId"
},
"style" : "simple"
},
{
"name" : "user_id",
"in" : "path",
"description" : "The ID of User that will be removed from the List.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserId"
},
"style" : "simple"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListMutateResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/lists/{id}/tweets" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"list.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "List Tweets timeline by List ID.",
"description" : "Returns a list of Tweets associated with the provided List ID.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/list-tweets/api-reference/get-lists-id-tweets"
},
"operationId" : "listsIdTweets",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the List.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/ListId"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32",
"default" : 100
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get the next 'page' of results.",
"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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2ListsIdTweetsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/openapi.json" : {
"get" : {
"tags" : [
"General"
],
"summary" : "Returns the OpenAPI Specification document.",
"description" : "Full OpenAPI Specification in JSON format. (See https://github.com/OAI/OpenAPI-Specification/blob/master/README.md)",
"operationId" : "getOpenApiSpec",
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "The request was successful",
"content" : {
"application/json" : {
"schema" : {
"type" : "object"
}
}
}
}
}
}
},
"/2/spaces" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"space.read",
"tweet.read",
"users.read"
]
}
],
"tags" : [
"Spaces"
],
"summary" : "Space lookup up Space IDs",
"description" : "Returns a variety of information about the Spaces specified by the requested IDs",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces"
},
"operationId" : "findSpacesByIds",
"parameters" : [
{
"name" : "ids",
"in" : "query",
"description" : "The list of Space IDs to return.",
"required" : true,
"schema" : {
"type" : "array",
"minItems" : 1,
"maxItems" : 100,
"items" : {
"type" : "string",
"description" : "The unique identifier of this Space.",
"pattern" : "^[a-zA-Z0-9]{1,13}$",
"example" : "1SLjjRYNejbKM"
}
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/SpaceFieldsParameter"
},
{
"$ref" : "#/components/parameters/SpaceExpansionsParameter"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/TopicFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2SpacesResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/spaces/by/creator_ids" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"space.read",
"tweet.read",
"users.read"
]
}
],
"tags" : [
"Spaces"
],
"summary" : "Space lookup by their creators",
"description" : "Returns a variety of information about the Spaces created by the provided User IDs",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-by-creator-ids"
},
"operationId" : "findSpacesByCreatorIds",
"parameters" : [
{
"name" : "user_ids",
"in" : "query",
"description" : "The IDs of Users to search through.",
"required" : true,
"schema" : {
"type" : "array",
"minItems" : 1,
"maxItems" : 100,
"items" : {
"$ref" : "#/components/schemas/UserId"
}
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/SpaceFieldsParameter"
},
{
"$ref" : "#/components/parameters/SpaceExpansionsParameter"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/TopicFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2SpacesByCreatorIdsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/spaces/search" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"space.read",
"tweet.read",
"users.read"
]
}
],
"tags" : [
"Spaces"
],
"summary" : "Search for Spaces",
"description" : "Returns Spaces that match the provided query.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/spaces/search/api-reference/get-spaces-search"
},
"operationId" : "searchSpaces",
"parameters" : [
{
"name" : "query",
"in" : "query",
"description" : "The search query.",
"required" : true,
"example" : "crypto",
"schema" : {
"type" : "string",
"minLength" : 1,
"maxLength" : 2048,
"example" : "crypto"
},
"style" : "form"
},
{
"name" : "state",
"in" : "query",
"description" : "The state of Spaces to search for.",
"required" : false,
"schema" : {
"type" : "string",
"enum" : [
"live",
"scheduled",
"all"
],
"default" : "all"
},
"style" : "form"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The number of results to return.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32",
"default" : 100
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/SpaceFieldsParameter"
},
{
"$ref" : "#/components/parameters/SpaceExpansionsParameter"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/TopicFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2SpacesSearchResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/spaces/{id}" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"space.read",
"tweet.read",
"users.read"
]
}
],
"tags" : [
"Spaces"
],
"summary" : "Space lookup by Space ID",
"description" : "Returns a variety of information about the Space specified by the requested ID",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-id"
},
"operationId" : "findSpaceById",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the Space to be retrieved.",
"required" : true,
"example" : "1YqKDqWqdPLsV",
"schema" : {
"type" : "string",
"description" : "The unique identifier of this Space.",
"pattern" : "^[a-zA-Z0-9]{1,13}$",
"example" : "1SLjjRYNejbKM"
},
"style" : "simple"
},
{
"$ref" : "#/components/parameters/SpaceFieldsParameter"
},
{
"$ref" : "#/components/parameters/SpaceExpansionsParameter"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/TopicFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2SpacesIdResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/spaces/{id}/buyers" : {
"get" : {
"security" : [
{
"OAuth2UserToken" : [
"space.read",
"tweet.read",
"users.read"
]
}
],
"tags" : [
"Spaces",
"Tweets"
],
"summary" : "Retrieve the list of Users who purchased a ticket to the given space",
"description" : "Retrieves the list of Users who purchased a ticket to the given space",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-id-buyers"
},
"operationId" : "spaceBuyers",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the Space to be retrieved.",
"required" : true,
"example" : "1YqKDqWqdPLsV",
"schema" : {
"type" : "string",
"description" : "The unique identifier of this Space.",
"pattern" : "^[a-zA-Z0-9]{1,13}$",
"example" : "1SLjjRYNejbKM"
},
"style" : "simple"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get a specified 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken32"
},
"style" : "form"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32",
"default" : 100
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserExpansionsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2SpacesIdBuyersResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/spaces/{id}/tweets" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"space.read",
"tweet.read",
"users.read"
]
}
],
"tags" : [
"Spaces",
"Tweets"
],
"summary" : "Retrieve Tweets from a Space.",
"description" : "Retrieves Tweets shared in the specified Space.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-id-tweets"
},
"operationId" : "spaceTweets",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the Space to be retrieved.",
"required" : true,
"example" : "1YqKDqWqdPLsV",
"schema" : {
"type" : "string",
"description" : "The unique identifier of this Space.",
"pattern" : "^[a-zA-Z0-9]{1,13}$",
"example" : "1SLjjRYNejbKM"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The number of Tweets to fetch from the provided space. If not provided, the value will default to the maximum of 100.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32",
"default" : 100,
"example" : 25
},
"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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2SpacesIdTweetsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/tweets" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Tweet lookup by Tweet IDs",
"description" : "Returns a variety of information about the Tweet specified by the requested ID.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/lookup/api-reference/get-tweets"
},
"operationId" : "findTweetsById",
"parameters" : [
{
"name" : "ids",
"in" : "query",
"description" : "A comma separated list of Tweet IDs. Up to 100 are allowed in a single request.",
"required" : true,
"schema" : {
"type" : "array",
"minItems" : 1,
"maxItems" : 100,
"items" : {
"$ref" : "#/components/schemas/TweetId"
}
},
"explode" : false,
"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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2TweetsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
},
"post" : {
"security" : [
{
"OAuth2UserToken" : [
"tweet.read",
"tweet.write",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Creation of a Tweet",
"description" : "Causes the User to create a Tweet under the authorized account.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/manage-tweets/api-reference/post-tweets"
},
"operationId" : "createTweet",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TweetCreateRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TweetCreateResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/tweets/compliance/stream" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
}
],
"tags" : [
"Compliance"
],
"summary" : "Tweets Compliance stream",
"description" : "Streams 100% of compliance data for Tweets",
"operationId" : "getTweetsComplianceStream",
"parameters" : [
{
"name" : "backfill_minutes",
"in" : "query",
"description" : "The number of minutes of backfill requested.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 5,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "partition",
"in" : "query",
"description" : "The partition number.",
"required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 4,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "start_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Tweet Compliance events will be provided.",
"required" : false,
"example" : "2021-02-01T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "end_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Tweet Compliance events will be provided.",
"required" : false,
"example" : "2021-02-14T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TweetComplianceStreamResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
},
"x-twitter-streaming" : true
}
},
"/2/tweets/counts/all" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Full archive search counts",
"description" : "Returns Tweet Counts that match a search query.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-all"
},
"operationId" : "tweetCountsFullArchiveSearch",
"parameters" : [
{
"name" : "query",
"in" : "query",
"description" : "One query/rule/filter for matching Tweets. Refer to https://t.co/rulelength to identify the max query length.",
"required" : true,
"schema" : {
"type" : "string",
"minLength" : 1,
"maxLength" : 4096,
"example" : "(from:TwitterDev OR from:TwitterAPI) has:media -is:retweet"
},
"style" : "form"
},
{
"name" : "start_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp (from most recent 7 days) from which the Tweets will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "end_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Tweets will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "since_id",
"in" : "query",
"description" : "Returns results with a Tweet ID greater than (that is, more recent than) the specified ID.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "form"
},
{
"name" : "until_id",
"in" : "query",
"description" : "Returns results with a Tweet ID less than (that is, older than) the specified ID.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "form"
},
{
"name" : "next_token",
"in" : "query",
"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.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken36"
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"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.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken36"
},
"style" : "form"
},
{
"name" : "granularity",
"in" : "query",
"description" : "The granularity for the search counts results.",
"required" : false,
"schema" : {
"type" : "string",
"enum" : [
"minute",
"hour",
"day"
],
"default" : "hour"
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/SearchCountFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2TweetsCountsAllResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/tweets/counts/recent" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Recent search counts",
"description" : "Returns Tweet Counts from the last 7 days that match a search query.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/counts/api-reference/get-tweets-counts-recent"
},
"operationId" : "tweetCountsRecentSearch",
"parameters" : [
{
"name" : "query",
"in" : "query",
"description" : "One query/rule/filter for matching Tweets. Refer to https://t.co/rulelength to identify the max query length.",
"required" : true,
"schema" : {
"type" : "string",
"minLength" : 1,
"maxLength" : 4096,
"example" : "(from:TwitterDev OR from:TwitterAPI) has:media -is:retweet"
},
"style" : "form"
},
{
"name" : "start_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp (from most recent 7 days) from which the Tweets will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "end_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Tweets will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "since_id",
"in" : "query",
"description" : "Returns results with a Tweet ID greater than (that is, more recent than) the specified ID.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "form"
},
{
"name" : "until_id",
"in" : "query",
"description" : "Returns results with a Tweet ID less than (that is, older than) the specified ID.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "form"
},
{
"name" : "next_token",
"in" : "query",
"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.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken36"
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"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.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken36"
},
"style" : "form"
},
{
"name" : "granularity",
"in" : "query",
"description" : "The granularity for the search counts results.",
"required" : false,
"schema" : {
"type" : "string",
"enum" : [
"minute",
"hour",
"day"
],
"default" : "hour"
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/SearchCountFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2TweetsCountsRecentResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/tweets/firehose/stream" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Firehose stream",
"description" : "Streams 100% of public Tweets.",
"operationId" : "getTweetsFirehoseStream",
"parameters" : [
{
"name" : "backfill_minutes",
"in" : "query",
"description" : "The number of minutes of backfill requested.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 5,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "partition",
"in" : "query",
"description" : "The partition number.",
"required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 20,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "start_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Tweets will be provided.",
"required" : false,
"example" : "2021-02-14T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "end_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Tweets will be provided.",
"required" : false,
"example" : "2021-02-14T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/StreamingTweetResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
},
"x-twitter-streaming" : true
}
},
"/2/tweets/label/stream" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
}
],
"tags" : [
"Compliance"
],
"summary" : "Tweets Label stream",
"description" : "Streams 100% of labeling events applied to Tweets",
"operationId" : "getTweetsLabelStream",
"parameters" : [
{
"name" : "backfill_minutes",
"in" : "query",
"description" : "The number of minutes of backfill requested.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 5,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "start_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Tweet labels will be provided.",
"required" : false,
"example" : "2021-02-01T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "end_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Tweet labels will be provided.",
"required" : false,
"example" : "2021-02-01T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TweetLabelStreamResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
},
"x-twitter-streaming" : true
}
},
"/2/tweets/sample/stream" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Sample stream",
"description" : "Streams a deterministic 1% of public Tweets.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/volume-streams/api-reference/get-tweets-sample-stream"
},
"operationId" : "sampleStream",
"parameters" : [
{
"name" : "backfill_minutes",
"in" : "query",
"description" : "The number of minutes of backfill requested.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 5,
"format" : "int32"
},
"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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/StreamingTweetResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
},
"x-twitter-streaming" : true
}
},
"/2/tweets/sample10/stream" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Sample 10% stream",
"description" : "Streams a deterministic 10% of public Tweets.",
"operationId" : "getTweetsSample10Stream",
"parameters" : [
{
"name" : "backfill_minutes",
"in" : "query",
"description" : "The number of minutes of backfill requested.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 5,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "partition",
"in" : "query",
"description" : "The partition number.",
"required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 2,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "start_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Tweets will be provided.",
"required" : false,
"example" : "2021-02-14T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "end_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Tweets will be provided.",
"required" : false,
"example" : "2021-02-14T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2TweetsSample10StreamResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
},
"x-twitter-streaming" : true
}
},
"/2/tweets/search/all" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Full-archive search",
"description" : "Returns Tweets that match a search query.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-all"
},
"operationId" : "tweetsFullarchiveSearch",
"parameters" : [
{
"name" : "query",
"in" : "query",
"description" : "One query/rule/filter for matching Tweets. Refer to https://t.co/rulelength to identify the max query length.",
"required" : true,
"schema" : {
"type" : "string",
"minLength" : 1,
"maxLength" : 4096,
"example" : "(from:TwitterDev OR from:TwitterAPI) has:media -is:retweet"
},
"style" : "form"
},
{
"name" : "start_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp from which the Tweets will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "end_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Tweets will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "since_id",
"in" : "query",
"description" : "Returns results with a Tweet ID greater than (that is, more recent than) the specified ID.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "form"
},
{
"name" : "until_id",
"in" : "query",
"description" : "Returns results with a Tweet ID less than (that is, older than) the specified ID.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "form"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of search results to be returned by a request.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 10,
"maximum" : 500,
"format" : "int32",
"default" : 10
},
"style" : "form"
},
{
"name" : "next_token",
"in" : "query",
"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.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken36"
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"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.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken36"
},
"style" : "form"
},
{
"name" : "sort_order",
"in" : "query",
"description" : "This order in which to return results.",
"required" : false,
"schema" : {
"type" : "string",
"enum" : [
"recency",
"relevancy"
]
},
"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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2TweetsSearchAllResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/tweets/search/recent" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Recent search",
"description" : "Returns Tweets from the last 7 days that match a search query.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-recent"
},
"operationId" : "tweetsRecentSearch",
"parameters" : [
{
"name" : "query",
"in" : "query",
"description" : "One query/rule/filter for matching Tweets. Refer to https://t.co/rulelength to identify the max query length.",
"required" : true,
"schema" : {
"type" : "string",
"minLength" : 1,
"maxLength" : 4096,
"example" : "(from:TwitterDev OR from:TwitterAPI) has:media -is:retweet"
},
"style" : "form"
},
{
"name" : "start_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp from which the Tweets will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "end_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Tweets will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "since_id",
"in" : "query",
"description" : "Returns results with a Tweet ID greater than (that is, more recent than) the specified ID.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "form"
},
{
"name" : "until_id",
"in" : "query",
"description" : "Returns results with a Tweet ID less than (that is, older than) the specified ID.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "form"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of search results to be returned by a request.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 10,
"maximum" : 100,
"format" : "int32",
"default" : 10
},
"style" : "form"
},
{
"name" : "next_token",
"in" : "query",
"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.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken36"
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"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.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken36"
},
"style" : "form"
},
{
"name" : "sort_order",
"in" : "query",
"description" : "This order in which to return results.",
"required" : false,
"schema" : {
"type" : "string",
"enum" : [
"recency",
"relevancy"
]
},
"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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2TweetsSearchRecentResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/tweets/search/stream" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Filtered stream",
"description" : "Streams Tweets matching the stream's active rule set.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/get-tweets-search-stream"
},
"operationId" : "searchStream",
"parameters" : [
{
"name" : "backfill_minutes",
"in" : "query",
"description" : "The number of minutes of backfill requested.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 5,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "start_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Tweets will be provided.",
"required" : false,
"example" : "2021-02-01T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "end_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Tweets will be provided.",
"required" : false,
"example" : "2021-02-14T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FilteredStreamingTweetResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
},
"x-twitter-streaming" : true
}
},
"/2/tweets/search/stream/rules" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Rules lookup",
"description" : "Returns rules from a User's active rule set. Users can fetch all of their rules or a subset, specified by the provided rule ids.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/get-tweets-search-stream-rules"
},
"operationId" : "getRules",
"parameters" : [
{
"name" : "ids",
"in" : "query",
"description" : "A comma-separated list of Rule IDs.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RuleId"
}
},
"style" : "form"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 1000,
"format" : "int32",
"default" : 1000
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This value is populated by passing the 'next_token' returned in a request to paginate through results.",
"required" : false,
"schema" : {
"type" : "string",
"minLength" : 16,
"maxLength" : 16
},
"style" : "form"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RulesLookupResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
},
"post" : {
"security" : [
{
"BearerToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Add/Delete rules",
"description" : "Add or delete rules from a User's active rule set. Users can provide unique, optionally tagged rules to add. Users can delete their entire rule set or a subset specified by rule ids or values.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/post-tweets-search-stream-rules"
},
"operationId" : "addOrDeleteRules",
"parameters" : [
{
"name" : "dry_run",
"in" : "query",
"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.",
"required" : false,
"schema" : {
"type" : "boolean"
},
"style" : "form"
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddOrDeleteRulesRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddOrDeleteRulesResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/tweets/{id}" : {
"delete" : {
"security" : [
{
"OAuth2UserToken" : [
"tweet.read",
"tweet.write",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Tweet delete by Tweet ID",
"description" : "Delete specified Tweet (in the path) by ID.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/manage-tweets/api-reference/delete-tweets-id"
},
"operationId" : "deleteTweetById",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the Tweet to be deleted.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "simple"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TweetDeleteResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
},
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Tweet lookup by Tweet ID",
"description" : "Returns a variety of information about the Tweet specified by the requested ID.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/lookup/api-reference/get-tweets-id"
},
"operationId" : "findTweetById",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "A single Tweet 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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2TweetsIdResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/tweets/{id}/liking_users" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"like.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "Returns User objects that have liked the provided Tweet ID",
"description" : "Returns a list of Users that have liked the provided Tweet ID",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/get-tweets-id-liking_users"
},
"operationId" : "tweetsIdLikingUsers",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "A single Tweet ID.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32",
"default" : 100
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get the next 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken36"
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserExpansionsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2TweetsIdLikingUsersResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/tweets/{id}/quote_tweets" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Retrieve Tweets that quote a Tweet.",
"description" : "Returns a variety of information about each Tweet that quotes the Tweet specified by the requested ID.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/quote-tweets/api-reference/get-tweets-id-quote_tweets"
},
"operationId" : "findTweetsThatQuoteATweet",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "A single Tweet ID.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results to be returned.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 10,
"maximum" : 100,
"format" : "int32",
"default" : 10
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get a specified 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken36"
},
"style" : "form"
},
{
"name" : "exclude",
"in" : "query",
"description" : "The set of entities to exclude (e.g. 'replies' or 'retweets').",
"required" : false,
"schema" : {
"type" : "array",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"replies",
"retweets"
]
},
"example" : [
"replies",
"retweets"
]
},
"explode" : false,
"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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2TweetsIdQuoteTweetsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/tweets/{id}/retweeted_by" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "Returns User objects that have retweeted the provided Tweet ID",
"description" : "Returns a list of Users that have retweeted the provided Tweet ID",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/get-tweets-id-retweeted_by"
},
"operationId" : "tweetsIdRetweetingUsers",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "A single Tweet ID.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32",
"default" : 100
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get the next 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken36"
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserExpansionsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2TweetsIdRetweetedByResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/tweets/{tweet_id}/hidden" : {
"put" : {
"security" : [
{
"OAuth2UserToken" : [
"tweet.moderate.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Hide replies",
"description" : "Hides or unhides a reply to an owned conversation.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/hide-replies/api-reference/put-tweets-id-hidden"
},
"operationId" : "hideReplyById",
"parameters" : [
{
"name" : "tweet_id",
"in" : "path",
"description" : "The ID of the reply that you want to hide or unhide.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "simple"
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TweetHideRequest"
}
}
}
},
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TweetHideResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "User lookup by IDs",
"description" : "This endpoint returns information about Users. Specify Users by their ID.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users"
},
"operationId" : "findUsersById",
"parameters" : [
{
"name" : "ids",
"in" : "query",
"description" : "A list of User IDs, comma-separated. You can specify up to 100 IDs.",
"required" : true,
"example" : "2244994945,6253282,12",
"schema" : {
"type" : "array",
"minItems" : 1,
"maxItems" : 100,
"items" : {
"$ref" : "#/components/schemas/UserId"
}
},
"explode" : false,
"style" : "form"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserExpansionsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/by" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "User lookup by usernames",
"description" : "This endpoint returns information about Users. Specify Users by their username.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by"
},
"operationId" : "findUsersByUsername",
"parameters" : [
{
"name" : "usernames",
"in" : "query",
"description" : "A list of usernames, comma-separated.",
"required" : true,
"schema" : {
"type" : "array",
"minItems" : 1,
"maxItems" : 100,
"items" : {
"type" : "string",
"description" : "The Twitter handle (screen name) of this User.",
"pattern" : "^[A-Za-z0-9_]{1,15}$"
},
"example" : "TwitterDev,TwitterAPI"
},
"explode" : false,
"style" : "form"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserExpansionsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersByResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/by/username/{username}" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "User lookup by username",
"description" : "This endpoint returns information about a User. Specify User by username.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by-username-username"
},
"operationId" : "findUserByUsername",
"parameters" : [
{
"name" : "username",
"in" : "path",
"description" : "A username.",
"required" : true,
"example" : "TwitterDev",
"schema" : {
"type" : "string",
"pattern" : "^[A-Za-z0-9_]{1,15}$"
},
"style" : "simple"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserExpansionsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersByUsernameUsernameResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/compliance/stream" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
}
],
"tags" : [
"Compliance"
],
"summary" : "Users Compliance stream",
"description" : "Streams 100% of compliance data for Users",
"operationId" : "getUsersComplianceStream",
"parameters" : [
{
"name" : "backfill_minutes",
"in" : "query",
"description" : "The number of minutes of backfill requested.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 5,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "partition",
"in" : "query",
"description" : "The partition number.",
"required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 4,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "start_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the User Compliance events will be provided.",
"required" : false,
"example" : "2021-02-01T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "end_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the User Compliance events will be provided.",
"required" : false,
"example" : "2021-02-01T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserComplianceStreamResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
},
"x-twitter-streaming" : true
}
},
"/2/users/me" : {
"get" : {
"security" : [
{
"OAuth2UserToken" : [
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "User lookup me",
"description" : "This endpoint returns information about the requesting User.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-me"
},
"operationId" : "findMyUser",
"parameters" : [
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserExpansionsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersMeResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "User lookup by ID",
"description" : "This endpoint returns information about a User. Specify User by ID.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-id"
},
"operationId" : "findUserById",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the User to lookup.",
"required" : true,
"example" : "2244994945",
"schema" : {
"$ref" : "#/components/schemas/UserId"
},
"style" : "simple"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserExpansionsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersIdResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/blocking" : {
"get" : {
"security" : [
{
"OAuth2UserToken" : [
"block.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "Returns User objects that are blocked by provided User ID",
"description" : "Returns a list of Users that are blocked by the provided User ID",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/blocks/api-reference/get-users-blocking"
},
"operationId" : "usersIdBlocking",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User for whom to return results.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 1000,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get a specified 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken32"
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserExpansionsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersIdBlockingResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
},
"post" : {
"security" : [
{
"OAuth2UserToken" : [
"block.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "Block User by User ID",
"description" : "Causes the User (in the path) to block the target User. The User (in the path) must match the User context authorizing the request",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/blocks/api-reference/post-users-user_id-blocking"
},
"operationId" : "usersIdBlock",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User that is requesting to block the target User.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BlockUserRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BlockUserMutationResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/bookmarks" : {
"get" : {
"security" : [
{
"OAuth2UserToken" : [
"bookmark.read",
"tweet.read",
"users.read"
]
}
],
"tags" : [
"Bookmarks"
],
"summary" : "Bookmarks by User",
"description" : "Returns Tweet objects that have been bookmarked by the requesting User",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/bookmarks/api-reference/get-users-id-bookmarks"
},
"operationId" : "getUsersIdBookmarks",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User for whom to return results.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get the next 'page' of results.",
"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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersIdBookmarksResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
},
"post" : {
"security" : [
{
"OAuth2UserToken" : [
"bookmark.write",
"tweet.read",
"users.read"
]
}
],
"tags" : [
"Bookmarks"
],
"summary" : "Add Tweet to Bookmarks",
"description" : "Adds a Tweet (ID in the body) to the requesting User's (in the path) bookmarks",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/bookmarks/api-reference/post-users-id-bookmarks"
},
"operationId" : "postUsersIdBookmarks",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User for whom to add bookmarks.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BookmarkAddRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BookmarkMutationResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/bookmarks/{tweet_id}" : {
"delete" : {
"security" : [
{
"OAuth2UserToken" : [
"bookmark.write",
"tweet.read",
"users.read"
]
}
],
"tags" : [
"Bookmarks"
],
"summary" : "Remove a bookmarked Tweet",
"description" : "Removes a Tweet from the requesting User's bookmarked Tweets.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/bookmarks/api-reference/delete-users-id-bookmarks-tweet_id"
},
"operationId" : "usersIdBookmarksDelete",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User whose bookmark is to be removed.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
},
{
"name" : "tweet_id",
"in" : "path",
"description" : "The ID of the Tweet that the source User is removing from bookmarks.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "simple"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BookmarkMutationResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/followed_lists" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"list.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Lists"
],
"summary" : "Get User's Followed Lists",
"description" : "Returns a User's followed Lists.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/list-follows/api-reference/get-users-id-followed_lists"
},
"operationId" : "userFollowedLists",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the User to lookup.",
"required" : true,
"example" : "2244994945",
"schema" : {
"$ref" : "#/components/schemas/UserId"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32",
"default" : 100
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get a specified 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationTokenLong"
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/ListFieldsParameter"
},
{
"$ref" : "#/components/parameters/ListExpansionsParameter"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersIdFollowedListsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
},
"post" : {
"security" : [
{
"OAuth2UserToken" : [
"list.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Lists"
],
"summary" : "Follow a List",
"description" : "Causes a User to follow a List.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/list-follows/api-reference/post-users-id-followed-lists"
},
"operationId" : "listUserFollow",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User that will follow the List.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListFollowedRequest"
}
}
}
},
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListFollowedResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/followed_lists/{list_id}" : {
"delete" : {
"security" : [
{
"OAuth2UserToken" : [
"list.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Lists"
],
"summary" : "Unfollow a List",
"description" : "Causes a User to unfollow a List.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/list-follows/api-reference/delete-users-id-followed-lists-list_id"
},
"operationId" : "listUserUnfollow",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User that will unfollow the List.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
},
{
"name" : "list_id",
"in" : "path",
"description" : "The ID of the List to unfollow.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/ListId"
},
"style" : "simple"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListFollowedResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/followers" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"follows.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "Followers by User ID",
"description" : "Returns a list of Users who are followers of the specified User ID.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-followers"
},
"operationId" : "usersIdFollowers",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the User to lookup.",
"required" : true,
"example" : "2244994945",
"schema" : {
"$ref" : "#/components/schemas/UserId"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 1000,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get a specified 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken32"
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserExpansionsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersIdFollowersResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/following" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"follows.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "Following by User ID",
"description" : "Returns a list of Users that are being followed by the provided User ID",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-following"
},
"operationId" : "usersIdFollowing",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the User to lookup.",
"required" : true,
"example" : "2244994945",
"schema" : {
"$ref" : "#/components/schemas/UserId"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 1000,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get a specified 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken32"
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserExpansionsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersIdFollowingResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
},
"post" : {
"security" : [
{
"OAuth2UserToken" : [
"follows.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "Follow User",
"description" : "Causes the User(in the path) to follow, or “request to follow” for protected Users, the target User. The User(in the path) must match the User context authorizing the request",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/post-users-source_user_id-following"
},
"operationId" : "usersIdFollow",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User that is requesting to follow the target User.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UsersFollowingCreateRequest"
}
}
}
},
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UsersFollowingCreateResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/liked_tweets" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"like.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Returns Tweet objects liked by the provided User ID",
"description" : "Returns a list of Tweets liked by the provided User ID",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/get-users-id-liked_tweets"
},
"operationId" : "usersIdLikedTweets",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the User to lookup.",
"required" : true,
"example" : "2244994945",
"schema" : {
"$ref" : "#/components/schemas/UserId"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 5,
"maximum" : 100,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get the next 'page' of results.",
"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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersIdLikedTweetsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/likes" : {
"post" : {
"security" : [
{
"OAuth2UserToken" : [
"like.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Causes the User (in the path) to like the specified Tweet",
"description" : "Causes the User (in the path) to like the specified Tweet. The User in the path must match the User context authorizing the request.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/post-users-id-likes"
},
"operationId" : "usersIdLike",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User that is requesting to like the Tweet.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UsersLikesCreateRequest"
}
}
}
},
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UsersLikesCreateResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/likes/{tweet_id}" : {
"delete" : {
"security" : [
{
"OAuth2UserToken" : [
"like.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Causes the User (in the path) to unlike the specified Tweet",
"description" : "Causes the User (in the path) to unlike the specified Tweet. The User must match the User context authorizing the request",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/delete-users-id-likes-tweet_id"
},
"operationId" : "usersIdUnlike",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User that is requesting to unlike the Tweet.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
},
{
"name" : "tweet_id",
"in" : "path",
"description" : "The ID of the Tweet that the User is requesting to unlike.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "simple"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UsersLikesDeleteResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/list_memberships" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"list.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Lists"
],
"summary" : "Get a User's List Memberships",
"description" : "Get a User's List Memberships.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/get-users-id-list_memberships"
},
"operationId" : "getUserListMemberships",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the User to lookup.",
"required" : true,
"example" : "2244994945",
"schema" : {
"$ref" : "#/components/schemas/UserId"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32",
"default" : 100
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get a specified 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationTokenLong"
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/ListFieldsParameter"
},
{
"$ref" : "#/components/parameters/ListExpansionsParameter"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersIdListMembershipsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/mentions" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "User mention timeline by User ID",
"description" : "Returns Tweet objects that mention username associated to the provided User ID",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-mentions"
},
"operationId" : "usersIdMentions",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the User to lookup.",
"required" : true,
"example" : "2244994945",
"schema" : {
"$ref" : "#/components/schemas/UserId"
},
"style" : "simple"
},
{
"name" : "since_id",
"in" : "query",
"description" : "The minimum Tweet ID to be included in the result set. This parameter takes precedence over start_time if both are specified.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "form"
},
{
"name" : "until_id",
"in" : "query",
"description" : "The maximum Tweet ID to be included in the result set. This parameter takes precedence over end_time if both are specified.",
"required" : false,
"example" : "1346889436626259968",
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "form"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 5,
"maximum" : 100,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get the next 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken36"
},
"style" : "form"
},
{
"name" : "start_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Tweets will be provided. The since_id parameter takes precedence if it is also specified.",
"required" : false,
"example" : "2021-02-01T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "end_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Tweets will be provided. The until_id parameter takes precedence if it is also specified.",
"required" : false,
"example" : "2021-02-14T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersIdMentionsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/muting" : {
"get" : {
"security" : [
{
"OAuth2UserToken" : [
"mute.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "Returns User objects that are muted by the provided User ID",
"description" : "Returns a list of Users that are muted by the provided User ID",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/get-users-muting"
},
"operationId" : "usersIdMuting",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User for whom to return results.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 1000,
"format" : "int32",
"default" : 100
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get the next 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationTokenLong"
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
},
{
"$ref" : "#/components/parameters/UserExpansionsParameter"
},
{
"$ref" : "#/components/parameters/TweetFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersIdMutingResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
},
"post" : {
"security" : [
{
"OAuth2UserToken" : [
"mute.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "Mute User by User ID.",
"description" : "Causes the User (in the path) to mute the target User. The User (in the path) must match the User context authorizing the request.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/post-users-user_id-muting"
},
"operationId" : "usersIdMute",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User that is requesting to mute the target User.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MuteUserRequest"
}
}
}
},
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MuteUserMutationResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/owned_lists" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"list.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Lists"
],
"summary" : "Get a User's Owned Lists.",
"description" : "Get a User's Owned Lists.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/list-lookup/api-reference/get-users-id-owned_lists"
},
"operationId" : "listUserOwnedLists",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the User to lookup.",
"required" : true,
"example" : "2244994945",
"schema" : {
"$ref" : "#/components/schemas/UserId"
},
"style" : "simple"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32",
"default" : 100
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get a specified 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationTokenLong"
},
"style" : "form"
},
{
"$ref" : "#/components/parameters/ListFieldsParameter"
},
{
"$ref" : "#/components/parameters/ListExpansionsParameter"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersIdOwnedListsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/pinned_lists" : {
"get" : {
"security" : [
{
"OAuth2UserToken" : [
"list.read",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Lists"
],
"summary" : "Get a User's Pinned Lists",
"description" : "Get a User's Pinned Lists.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/pinned-lists/api-reference/get-users-id-pinned_lists"
},
"operationId" : "listUserPinnedLists",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User for whom to return results.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
},
{
"$ref" : "#/components/parameters/ListFieldsParameter"
},
{
"$ref" : "#/components/parameters/ListExpansionsParameter"
},
{
"$ref" : "#/components/parameters/UserFieldsParameter"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersIdPinnedListsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
},
"post" : {
"security" : [
{
"OAuth2UserToken" : [
"list.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Lists"
],
"summary" : "Pin a List",
"description" : "Causes a User to pin a List.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/pinned-lists/api-reference/post-users-id-pinned-lists"
},
"operationId" : "listUserPin",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User that will pin the List.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListPinnedRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListPinnedResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/pinned_lists/{list_id}" : {
"delete" : {
"security" : [
{
"OAuth2UserToken" : [
"list.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Lists"
],
"summary" : "Unpin a List",
"description" : "Causes a User to remove a pinned List.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists/pinned-lists/api-reference/delete-users-id-pinned-lists-list_id"
},
"operationId" : "listUserUnpin",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User for whom to return results.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
},
{
"name" : "list_id",
"in" : "path",
"description" : "The ID of the List to unpin.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/ListId"
},
"style" : "simple"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListUnpinResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/retweets" : {
"post" : {
"security" : [
{
"OAuth2UserToken" : [
"tweet.read",
"tweet.write",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Causes the User (in the path) to retweet the specified Tweet.",
"description" : "Causes the User (in the path) to retweet the specified Tweet. The User in the path must match the User context authorizing the request.",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/post-users-id-retweets"
},
"operationId" : "usersIdRetweets",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User that is requesting to retweet the Tweet.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UsersRetweetsCreateRequest"
}
}
}
},
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UsersRetweetsCreateResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/retweets/{source_tweet_id}" : {
"delete" : {
"security" : [
{
"OAuth2UserToken" : [
"tweet.read",
"tweet.write",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "Causes the User (in the path) to unretweet the specified Tweet",
"description" : "Causes the User (in the path) to unretweet the specified Tweet. The User must match the User context authorizing the request",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/delete-users-id-retweets-tweet_id"
},
"operationId" : "usersIdUnretweets",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User that is requesting to retweet the Tweet.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
},
{
"name" : "source_tweet_id",
"in" : "path",
"description" : "The ID of the Tweet that the User is requesting to unretweet.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "simple"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UsersRetweetsDeleteResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/timelines/reverse_chronological" : {
"get" : {
"security" : [
{
"OAuth2UserToken" : [
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "User home timeline by User ID",
"description" : "Returns Tweet objects that appears in the provided User ID's home timeline",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-reverse-chronological"
},
"operationId" : "usersIdTimeline",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the authenticated source User to list Reverse Chronological Timeline Tweets of.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
},
{
"name" : "since_id",
"in" : "query",
"description" : "The minimum Tweet ID to be included in the result set. This parameter takes precedence over start_time if both are specified.",
"required" : false,
"example" : "791775337160081409",
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "form"
},
{
"name" : "until_id",
"in" : "query",
"description" : "The maximum Tweet ID to be included in the result set. This parameter takes precedence over end_time if both are specified.",
"required" : false,
"example" : "1346889436626259968",
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "form"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get the next 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken36"
},
"style" : "form"
},
{
"name" : "exclude",
"in" : "query",
"description" : "The set of entities to exclude (e.g. 'replies' or 'retweets').",
"required" : false,
"schema" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"replies",
"retweets"
]
},
"example" : [
"replies",
"retweets"
]
},
"explode" : false,
"style" : "form"
},
{
"name" : "start_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Tweets will be provided. The since_id parameter takes precedence if it is also specified.",
"required" : false,
"example" : "2021-02-01T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "end_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Tweets will be provided. The until_id parameter takes precedence if it is also specified.",
"required" : false,
"example" : "2021-02-14T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersIdTimelinesReverseChronologicalResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{id}/tweets" : {
"get" : {
"security" : [
{
"BearerToken" : [ ]
},
{
"OAuth2UserToken" : [
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Tweets"
],
"summary" : "User Tweets timeline by User ID",
"description" : "Returns a list of Tweets authored by the provided User ID",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-tweets"
},
"operationId" : "usersIdTweets",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the User to lookup.",
"required" : true,
"example" : "2244994945",
"schema" : {
"$ref" : "#/components/schemas/UserId"
},
"style" : "simple"
},
{
"name" : "since_id",
"in" : "query",
"description" : "The minimum Tweet ID to be included in the result set. This parameter takes precedence over start_time if both are specified.",
"required" : false,
"example" : "791775337160081409",
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "form"
},
{
"name" : "until_id",
"in" : "query",
"description" : "The maximum Tweet ID to be included in the result set. This parameter takes precedence over end_time if both are specified.",
"required" : false,
"example" : "1346889436626259968",
"schema" : {
"$ref" : "#/components/schemas/TweetId"
},
"style" : "form"
},
{
"name" : "max_results",
"in" : "query",
"description" : "The maximum number of results.",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 5,
"maximum" : 100,
"format" : "int32"
},
"style" : "form"
},
{
"name" : "pagination_token",
"in" : "query",
"description" : "This parameter is used to get the next 'page' of results.",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/PaginationToken36"
},
"style" : "form"
},
{
"name" : "exclude",
"in" : "query",
"description" : "The set of entities to exclude (e.g. 'replies' or 'retweets').",
"required" : false,
"schema" : {
"type" : "array",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"replies",
"retweets"
]
},
"example" : [
"replies",
"retweets"
]
},
"explode" : false,
"style" : "form"
},
{
"name" : "start_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Tweets will be provided. The since_id parameter takes precedence if it is also specified.",
"required" : false,
"example" : "2021-02-01T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"style" : "form"
},
{
"name" : "end_time",
"in" : "query",
"description" : "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Tweets will be provided. The until_id parameter takes precedence if it is also specified.",
"required" : false,
"example" : "2021-02-14T18:40:40.000Z",
"schema" : {
"type" : "string",
"format" : "date-time"
},
"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" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Get2UsersIdTweetsResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{source_user_id}/blocking/{target_user_id}" : {
"delete" : {
"security" : [
{
"OAuth2UserToken" : [
"block.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "Unblock User by User ID",
"description" : "Causes the source User to unblock the target User. The source User must match the User context authorizing the request",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/blocks/api-reference/delete-users-user_id-blocking"
},
"operationId" : "usersIdUnblock",
"parameters" : [
{
"name" : "source_user_id",
"in" : "path",
"description" : "The ID of the authenticated source User that is requesting to unblock the target User.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
},
{
"name" : "target_user_id",
"in" : "path",
"description" : "The ID of the User that the source User is requesting to unblock.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserId"
},
"style" : "simple"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BlockUserMutationResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{source_user_id}/following/{target_user_id}" : {
"delete" : {
"security" : [
{
"OAuth2UserToken" : [
"follows.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "Unfollow User",
"description" : "Causes the source User to unfollow the target User. The source User must match the User context authorizing the request",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/delete-users-source_id-following"
},
"operationId" : "usersIdUnfollow",
"parameters" : [
{
"name" : "source_user_id",
"in" : "path",
"description" : "The ID of the authenticated source User that is requesting to unfollow the target User.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
},
{
"name" : "target_user_id",
"in" : "path",
"description" : "The ID of the User that the source User is requesting to unfollow.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserId"
},
"style" : "simple"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UsersFollowingDeleteResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/2/users/{source_user_id}/muting/{target_user_id}" : {
"delete" : {
"security" : [
{
"OAuth2UserToken" : [
"mute.write",
"tweet.read",
"users.read"
]
},
{
"UserToken" : [ ]
}
],
"tags" : [
"Users"
],
"summary" : "Unmute User by User ID",
"description" : "Causes the source User to unmute the target User. The source User must match the User context authorizing the request",
"externalDocs" : {
"url" : "https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/delete-users-user_id-muting"
},
"operationId" : "usersIdUnmute",
"parameters" : [
{
"name" : "source_user_id",
"in" : "path",
"description" : "The ID of the authenticated source User that is requesting to unmute the target User.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserIdMatchesAuthenticatedUser"
},
"style" : "simple"
},
{
"name" : "target_user_id",
"in" : "path",
"description" : "The ID of the User that the source User is requesting to unmute.",
"required" : true,
"schema" : {
"$ref" : "#/components/schemas/UserId"
},
"style" : "simple"
}
],
"responses" : {
"200" : {
"description" : "The request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MuteUserMutationResponse"
}
}
}
},
"default" : {
"description" : "The request has failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Error"
}
},
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
}
}
}
},
"servers" : [
{
"description" : "Twitter API",
"url" : "https://api.twitter.com"
}
],
"tags" : [
{
"name" : "Bookmarks",
"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" : "Compliance",
"description" : "Endpoints related to keeping Twitter data in your systems compliant",
"externalDocs" : {
"description" : "Find out more",
"url" : "https://developer.twitter.com/en/docs/twitter-api/compliance/batch-tweet/introduction"
}
},
{
"name" : "Direct Messages",
"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" : "General",
"description" : "Miscellaneous endpoints for general API functionality",
"externalDocs" : {
"description" : "Find out more",
"url" : "https://developer.twitter.com/en/docs/twitter-api"
}
},
{
"name" : "Lists",
"description" : "Endpoints related to retrieving, managing Lists",
"externalDocs" : {
"description" : "Find out more",
"url" : "https://developer.twitter.com/en/docs/twitter-api/lists"
}
},
{
"name" : "Spaces",
"description" : "Endpoints related to retrieving, managing Spaces",
"externalDocs" : {
"description" : "Find out more",
"url" : "https://developer.twitter.com/en/docs/twitter-api/spaces"
}
},
{
"name" : "Tweets",
"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" : "Users",
"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"
}
}
],
"components" : {
"securitySchemes" : {
"BearerToken" : {
"type" : "http",
"scheme" : "bearer"
},
"OAuth2UserToken" : {
"type" : "oauth2",
"flows" : {
"authorizationCode" : {
"authorizationUrl" : "https://api.twitter.com/2/oauth2/authorize",
"tokenUrl" : "https://api.twitter.com/2/oauth2/token",
"scopes" : {
"block.read" : "Accounts you’ve blocked.",
"block.write" : "Block and unblock accounts for you.",
"bookmark.read" : "Allows an app to read bookmarked Tweets",
"bookmark.write" : "Allows an app to create and delete bookmarks",
"dm.read" : "All your Direct Messages",
"dm.write" : "Send and manage Direct Messages for you",
"follows.read" : "People who follow you and people who you follow.",
"follows.write" : "Follow and unfollow people for you.",
"like.read" : "Tweets you’ve liked and likes you can view.",
"like.write" : "Like and un-like Tweets for you.",
"list.read" : "Lists, list members, and list followers of lists you’ve created or are a member of, including private lists.",
"list.write" : "Create and manage Lists for you.",
"mute.read" : "Accounts you’ve muted.",
"mute.write" : "Mute and unmute accounts for you.",
"offline.access" : "App can request refresh token.",
"space.read" : "Access all of the Spaces you can see.",
"tweet.moderate.write" : "Hide and unhide replies to your Tweets.",
"tweet.read" : "All the Tweets you can see, including Tweets from protected accounts.",
"tweet.write" : "Tweet and retweet for you.",
"users.read" : "Any account you can see, including protected accounts. Any account you can see, including protected accounts."
}
}
}
},
"UserToken" : {
"type" : "http",
"scheme" : "OAuth"
}
},
"schemas" : {
"AddOrDeleteRulesRequest" : {
"oneOf" : [
{
"$ref" : "#/components/schemas/AddRulesRequest"
},
{
"$ref" : "#/components/schemas/DeleteRulesRequest"
}
]
},
"AddOrDeleteRulesResponse" : {
"type" : "object",
"description" : "A response from modifying user-specified stream filtering rules.",
"required" : [
"meta"
],
"properties" : {
"data" : {
"type" : "array",
"description" : "All user-specified stream filtering rules that were created.",
"items" : {
"$ref" : "#/components/schemas/Rule"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"meta" : {
"$ref" : "#/components/schemas/RulesResponseMetadata"
}
}
},
"AddRulesRequest" : {
"type" : "object",
"description" : "A request to add a user-specified stream filtering rule.",
"required" : [
"add"
],
"properties" : {
"add" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RuleNoId"
}
}
}
},
"Aggregate" : {
"type" : "integer",
"description" : "The sum of results returned in this response.",
"format" : "int32"
},
"AnimatedGif" : {
"allOf" : [
{
"$ref" : "#/components/schemas/Media"
},
{
"type" : "object",
"properties" : {
"preview_image_url" : {
"type" : "string",
"format" : "uri"
},
"variants" : {
"$ref" : "#/components/schemas/Variants"
}
}
}
]
},
"BlockUserMutationResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"blocking" : {
"type" : "boolean"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"BlockUserRequest" : {
"type" : "object",
"required" : [
"target_user_id"
],
"properties" : {
"target_user_id" : {
"$ref" : "#/components/schemas/UserId"
}
}
},
"BookmarkAddRequest" : {
"type" : "object",
"required" : [
"tweet_id"
],
"properties" : {
"tweet_id" : {
"$ref" : "#/components/schemas/TweetId"
}
}
},
"BookmarkMutationResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"bookmarked" : {
"type" : "boolean"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"CashtagEntity" : {
"allOf" : [
{
"$ref" : "#/components/schemas/EntityIndicesInclusiveExclusive"
},
{
"$ref" : "#/components/schemas/CashtagFields"
}
]
},
"CashtagFields" : {
"type" : "object",
"description" : "Represent the portion of text recognized as a Cashtag, and its start and end position within the text.",
"required" : [
"tag"
],
"properties" : {
"tag" : {
"type" : "string",
"example" : "TWTR"
}
}
},
"ClientDisconnectedProblem" : {
"description" : "Your client has gone away.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
}
]
},
"ClientForbiddenProblem" : {
"description" : "A problem that indicates your client is forbidden from making this request.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
},
{
"type" : "object",
"properties" : {
"reason" : {
"type" : "string",
"enum" : [
"official-client-forbidden",
"client-not-enrolled"
]
},
"registration_url" : {
"type" : "string",
"format" : "uri"
}
}
}
]
},
"ComplianceJob" : {
"type" : "object",
"required" : [
"id",
"type",
"created_at",
"upload_url",
"download_url",
"upload_expires_at",
"download_expires_at",
"status"
],
"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"
}
}
},
"ComplianceJobName" : {
"type" : "string",
"description" : "User-provided name for a compliance job.",
"maxLength" : 64,
"example" : "my-job"
},
"ComplianceJobStatus" : {
"type" : "string",
"description" : "Status of a compliance job.",
"enum" : [
"created",
"in_progress",
"failed",
"complete",
"expired"
]
},
"ComplianceJobType" : {
"type" : "string",
"description" : "Type of compliance job to list.",
"enum" : [
"tweets",
"users"
]
},
"ConflictProblem" : {
"description" : "You cannot create a new job if one is already in progress.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
}
]
},
"ConnectionExceptionProblem" : {
"description" : "A problem that indicates something is wrong with the connection.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
},
{
"type" : "object",
"properties" : {
"connection_issue" : {
"type" : "string",
"enum" : [
"TooManyConnections",
"ProvisioningSubscription",
"RuleConfigurationIssue",
"RulesInvalidIssue"
]
}
}
}
]
},
"ContextAnnotation" : {
"type" : "object",
"description" : "Annotation inferred from the Tweet text.",
"required" : [
"domain",
"entity"
],
"properties" : {
"domain" : {
"$ref" : "#/components/schemas/ContextAnnotationDomainFields"
},
"entity" : {
"$ref" : "#/components/schemas/ContextAnnotationEntityFields"
}
}
},
"ContextAnnotationDomainFields" : {
"type" : "object",
"description" : "Represents the data for the context annotation domain.",
"required" : [
"id"
],
"properties" : {
"description" : {
"type" : "string",
"description" : "Description of the context annotation domain."
},
"id" : {
"type" : "string",
"description" : "The unique id for a context annotation domain.",
"pattern" : "^[0-9]{1,19}$"
},
"name" : {
"type" : "string",
"description" : "Name of the context annotation domain."
}
}
},
"ContextAnnotationEntityFields" : {
"type" : "object",
"description" : "Represents the data for the context annotation entity.",
"required" : [
"id"
],
"properties" : {
"description" : {
"type" : "string",
"description" : "Description of the context annotation entity."
},
"id" : {
"type" : "string",
"description" : "The unique id for a context annotation entity.",
"pattern" : "^[0-9]{1,19}$"
},
"name" : {
"type" : "string",
"description" : "Name of the context annotation entity."
}
}
},
"CountryCode" : {
"type" : "string",
"description" : "A two-letter ISO 3166-1 alpha-2 country code.",
"pattern" : "^[A-Z]{2}$",
"example" : "US"
},
"CreateAttachmentsMessageRequest" : {
"type" : "object",
"required" : [
"attachments"
],
"properties" : {
"attachments" : {
"$ref" : "#/components/schemas/DmAttachments"
},
"text" : {
"type" : "string",
"description" : "Text of the message.",
"minLength" : 1
}
}
},
"CreateComplianceJobRequest" : {
"type" : "object",
"description" : "A request to create a new batch compliance job.",
"required" : [
"type"
],
"properties" : {
"name" : {
"$ref" : "#/components/schemas/ComplianceJobName"
},
"resumable" : {
"type" : "boolean",
"description" : "If true, this endpoint will return a pre-signed URL with resumable uploads enabled."
},
"type" : {
"type" : "string",
"description" : "Type of compliance job to list.",
"enum" : [
"tweets",
"users"
]
}
}
},
"CreateComplianceJobResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/ComplianceJob"
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"CreateDmConversationRequest" : {
"type" : "object",
"required" : [
"conversation_type",
"participant_ids",
"message"
],
"properties" : {
"conversation_type" : {
"type" : "string",
"description" : "The conversation type that is being created.",
"enum" : [
"Group"
]
},
"message" : {
"$ref" : "#/components/schemas/CreateMessageRequest"
},
"participant_ids" : {
"$ref" : "#/components/schemas/DmParticipants"
}
},
"additionalProperties" : false
},
"CreateDmEventResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"required" : [
"dm_conversation_id",
"dm_event_id"
],
"properties" : {
"dm_conversation_id" : {
"$ref" : "#/components/schemas/DmConversationId"
},
"dm_event_id" : {
"$ref" : "#/components/schemas/DmEventId"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"CreateMessageRequest" : {
"anyOf" : [
{
"$ref" : "#/components/schemas/CreateTextMessageRequest"
},
{
"$ref" : "#/components/schemas/CreateAttachmentsMessageRequest"
}
]
},
"CreateTextMessageRequest" : {
"type" : "object",
"required" : [
"text"
],
"properties" : {
"attachments" : {
"$ref" : "#/components/schemas/DmAttachments"
},
"text" : {
"type" : "string",
"description" : "Text of the message.",
"minLength" : 1
}
}
},
"CreatedAt" : {
"type" : "string",
"description" : "Creation time of the compliance job.",
"format" : "date-time",
"example" : "2021-01-06T18:40:40.000Z"
},
"DeleteRulesRequest" : {
"type" : "object",
"description" : "A response from deleting user-specified stream filtering rules.",
"required" : [
"delete"
],
"properties" : {
"delete" : {
"type" : "object",
"description" : "IDs and values of all deleted user-specified stream filtering rules.",
"properties" : {
"ids" : {
"type" : "array",
"description" : "IDs of all deleted user-specified stream filtering rules.",
"items" : {
"$ref" : "#/components/schemas/RuleId"
}
},
"values" : {
"type" : "array",
"description" : "Values of all deleted user-specified stream filtering rules.",
"items" : {
"$ref" : "#/components/schemas/RuleValue"
}
}
}
}
}
},
"DisallowedResourceProblem" : {
"description" : "A problem that indicates that the resource requested violates the precepts of this API.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
},
{
"type" : "object",
"required" : [
"resource_id",
"resource_type",
"section"
],
"properties" : {
"resource_id" : {
"type" : "string"
},
"resource_type" : {
"type" : "string",
"enum" : [
"user",
"tweet",
"media",
"list",
"space"
]
},
"section" : {
"type" : "string",
"enum" : [
"data",
"includes"
]
}
}
}
]
},
"DmAttachments" : {
"type" : "array",
"description" : "Attachments to a DM Event.",
"items" : {
"$ref" : "#/components/schemas/DmMediaAttachment"
}
},
"DmConversationId" : {
"type" : "string",
"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.",
"pattern" : "^([0-9]{1,19}-[0-9]{1,19}|[0-9]{15,19})$",
"example" : "123123123-456456456"
},
"DmEvent" : {
"type" : "object",
"required" : [
"id",
"event_type"
],
"properties" : {
"attachments" : {
"type" : "object",
"description" : "Specifies the type of attachments (if any) present in this DM.",
"properties" : {
"card_ids" : {
"type" : "array",
"description" : "A list of card IDs (if cards are attached).",
"minItems" : 1,
"items" : {
"type" : "string"
}
},
"media_keys" : {
"type" : "array",
"description" : "A list of Media Keys for each one of the media attachments (if media are attached).",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/MediaKey"
}
}
}
},
"created_at" : {
"type" : "string",
"format" : "date-time"
},
"dm_conversation_id" : {
"$ref" : "#/components/schemas/DmConversationId"
},
"event_type" : {
"type" : "string",
"example" : "MessageCreate"
},
"id" : {
"$ref" : "#/components/schemas/DmEventId"
},
"participant_ids" : {
"type" : "array",
"description" : "A list of participants for a ParticipantsJoin or ParticipantsLeave event_type.",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/UserId"
}
},
"referenced_tweets" : {
"type" : "array",
"description" : "A list of Tweets this DM refers to.",
"minItems" : 1,
"items" : {
"type" : "object",
"required" : [
"id"
],
"properties" : {
"id" : {
"$ref" : "#/components/schemas/TweetId"
}
}
}
},
"sender_id" : {
"$ref" : "#/components/schemas/UserId"
},
"text" : {
"type" : "string"
}
}
},
"DmEventId" : {
"type" : "string",
"description" : "Unique identifier of a DM Event.",
"pattern" : "^[0-9]{1,19}$",
"example" : "1146654567674912769"
},
"DmMediaAttachment" : {
"type" : "object",
"required" : [
"media_id"
],
"properties" : {
"media_id" : {
"$ref" : "#/components/schemas/MediaId"
}
}
},
"DmParticipants" : {
"type" : "array",
"description" : "Participants for the DM Conversation.",
"minItems" : 2,
"maxItems" : 49,
"items" : {
"$ref" : "#/components/schemas/UserId"
}
},
"DownloadExpiration" : {
"type" : "string",
"description" : "Expiration time of the download URL.",
"format" : "date-time",
"example" : "2021-01-06T18:40:40.000Z"
},
"DownloadUrl" : {
"type" : "string",
"description" : "URL from which the user will retrieve their compliance results.",
"format" : "uri"
},
"DuplicateRuleProblem" : {
"description" : "The rule you have submitted is a duplicate.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
},
{
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
]
},
"End" : {
"type" : "string",
"description" : "The end time of the bucket.",
"format" : "date-time"
},
"EntityIndicesInclusiveExclusive" : {
"type" : "object",
"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.",
"required" : [
"start",
"end"
],
"properties" : {
"end" : {
"type" : "integer",
"description" : "Index (zero-based) at which position this entity ends. The index is exclusive.",
"minimum" : 0,
"example" : 61
},
"start" : {
"type" : "integer",
"description" : "Index (zero-based) at which position this entity starts. The index is inclusive.",
"minimum" : 0,
"example" : 50
}
}
},
"EntityIndicesInclusiveInclusive" : {
"type" : "object",
"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.",
"required" : [
"start",
"end"
],
"properties" : {
"end" : {
"type" : "integer",
"description" : "Index (zero-based) at which position this entity ends. The index is inclusive.",
"minimum" : 0,
"example" : 61
},
"start" : {
"type" : "integer",
"description" : "Index (zero-based) at which position this entity starts. The index is inclusive.",
"minimum" : 0,
"example" : 50
}
}
},
"Error" : {
"type" : "object",
"required" : [
"code",
"message"
],
"properties" : {
"code" : {
"type" : "integer",
"format" : "int32"
},
"message" : {
"type" : "string"
}
}
},
"Expansions" : {
"type" : "object",
"properties" : {
"media" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Media"
}
},
"places" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Place"
}
},
"polls" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Poll"
}
},
"topics" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Topic"
}
},
"tweets" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Tweet"
}
},
"users" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/User"
}
}
}
},
"FieldUnauthorizedProblem" : {
"description" : "A problem that indicates that you are not allowed to see a particular field on a Tweet, User, etc.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
},
{
"type" : "object",
"required" : [
"resource_type",
"field",
"section"
],
"properties" : {
"field" : {
"type" : "string"
},
"resource_type" : {
"type" : "string",
"enum" : [
"user",
"tweet",
"media",
"list",
"space"
]
},
"section" : {
"type" : "string",
"enum" : [
"data",
"includes"
]
}
}
}
]
},
"FilteredStreamingTweetResponse" : {
"type" : "object",
"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" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"matching_rules" : {
"type" : "array",
"description" : "The list of rules which matched the Tweet",
"items" : {
"type" : "object",
"required" : [
"id"
],
"properties" : {
"id" : {
"$ref" : "#/components/schemas/RuleId"
},
"tag" : {
"$ref" : "#/components/schemas/RuleTag"
}
}
}
}
}
},
"FullTextEntities" : {
"type" : "object",
"properties" : {
"annotations" : {
"type" : "array",
"minItems" : 1,
"items" : {
"description" : "Annotation for entities based on the Tweet text.",
"allOf" : [
{
"$ref" : "#/components/schemas/EntityIndicesInclusiveInclusive"
},
{
"type" : "object",
"description" : "Represents the data for the annotation.",
"properties" : {
"normalized_text" : {
"type" : "string",
"description" : "Text used to determine annotation.",
"example" : "Barack Obama"
},
"probability" : {
"type" : "number",
"description" : "Confidence factor for annotation type.",
"minimum" : 0,
"maximum" : 1,
"format" : "double"
},
"type" : {
"type" : "string",
"description" : "Annotation type.",
"example" : "Person"
}
}
}
]
}
},
"cashtags" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/CashtagEntity"
}
},
"hashtags" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/HashtagEntity"
}
},
"mentions" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/MentionEntity"
}
},
"urls" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/UrlEntity"
}
}
}
},
"GenericProblem" : {
"description" : "A generic problem with no additional information beyond that provided by the HTTP status code.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
}
]
},
"Geo" : {
"type" : "object",
"required" : [
"type",
"bbox",
"properties"
],
"properties" : {
"bbox" : {
"type" : "array",
"minItems" : 4,
"maxItems" : 4,
"items" : {
"type" : "number",
"minimum" : -180,
"maximum" : 180,
"format" : "double"
},
"example" : [
-105.193475,
39.60973,
-105.053164,
39.761974
]
},
"geometry" : {
"$ref" : "#/components/schemas/Point"
},
"properties" : {
"type" : "object"
},
"type" : {
"type" : "string",
"enum" : [
"Feature"
]
}
}
},
"Get2ComplianceJobsIdResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/ComplianceJob"
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"Get2ComplianceJobsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/ComplianceJob"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"meta" : {
"type" : "object",
"properties" : {
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2DmConversationsIdDmEventsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/DmEvent"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2DmConversationsWithParticipantIdDmEventsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/DmEvent"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2DmEventsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/DmEvent"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2ListsIdFollowersResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/User"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2ListsIdMembersResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/User"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2ListsIdResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/List"
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
}
}
},
"Get2ListsIdTweetsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Tweet"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2SpacesByCreatorIdsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Space"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2SpacesIdBuyersResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/User"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2SpacesIdResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/Space"
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
}
}
},
"Get2SpacesIdTweetsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Tweet"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2SpacesResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Space"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
}
}
},
"Get2SpacesSearchResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Space"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2TweetsCountsAllResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/SearchCount"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"meta" : {
"type" : "object",
"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"
}
}
}
}
},
"Get2TweetsCountsRecentResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/SearchCount"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"meta" : {
"type" : "object",
"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"
}
}
}
}
},
"Get2TweetsFirehoseStreamResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/Tweet"
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
}
}
},
"Get2TweetsIdLikingUsersResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/User"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2TweetsIdQuoteTweetsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Tweet"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2TweetsIdResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/Tweet"
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
}
}
},
"Get2TweetsIdRetweetedByResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/User"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2TweetsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Tweet"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
}
}
},
"Get2TweetsSample10StreamResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/Tweet"
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
}
}
},
"Get2TweetsSampleStreamResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/Tweet"
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
}
}
},
"Get2TweetsSearchAllResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Tweet"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"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"
}
}
}
}
},
"Get2TweetsSearchRecentResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Tweet"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"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"
}
}
}
}
},
"Get2TweetsSearchStreamResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/Tweet"
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
}
}
},
"Get2UsersByResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/User"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
}
}
},
"Get2UsersByUsernameUsernameResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/User"
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
}
}
},
"Get2UsersIdBlockingResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/User"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2UsersIdBookmarksResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Tweet"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2UsersIdFollowedListsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/List"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2UsersIdFollowersResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/User"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2UsersIdFollowingResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/User"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2UsersIdLikedTweetsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Tweet"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2UsersIdListMembershipsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/List"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2UsersIdMentionsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Tweet"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"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"
}
}
}
}
},
"Get2UsersIdMutingResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/User"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2UsersIdOwnedListsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/List"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"previous_token" : {
"$ref" : "#/components/schemas/PreviousToken"
},
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2UsersIdPinnedListsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/List"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"properties" : {
"result_count" : {
"$ref" : "#/components/schemas/ResultCount"
}
}
}
}
},
"Get2UsersIdResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/User"
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
}
}
},
"Get2UsersIdTimelinesReverseChronologicalResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Tweet"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"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"
}
}
}
}
},
"Get2UsersIdTweetsResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Tweet"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
},
"meta" : {
"type" : "object",
"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"
}
}
}
}
},
"Get2UsersMeResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/User"
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
}
}
},
"Get2UsersResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/User"
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
}
}
},
"HashtagEntity" : {
"allOf" : [
{
"$ref" : "#/components/schemas/EntityIndicesInclusiveExclusive"
},
{
"$ref" : "#/components/schemas/HashtagFields"
}
]
},
"HashtagFields" : {
"type" : "object",
"description" : "Represent the portion of text recognized as a Hashtag, and its start and end position within the text.",
"required" : [
"tag"
],
"properties" : {
"tag" : {
"type" : "string",
"description" : "The text of the Hashtag.",
"example" : "MondayMotivation"
}
}
},
"HttpStatusCode" : {
"type" : "integer",
"description" : "HTTP Status Code.",
"minimum" : 100,
"maximum" : 599
},
"InvalidRequestProblem" : {
"description" : "A problem that indicates this request is invalid.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
},
{
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
},
"parameters" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
}
}
}
}
]
},
"InvalidRuleProblem" : {
"description" : "The rule you have submitted is invalid.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
}
]
},
"JobId" : {
"type" : "string",
"description" : "Compliance Job ID.",
"pattern" : "^[0-9]{1,19}$",
"example" : "1372966999991541762"
},
"List" : {
"type" : "object",
"description" : "A Twitter List is a curated group of accounts.",
"required" : [
"id",
"name"
],
"properties" : {
"created_at" : {
"type" : "string",
"format" : "date-time"
},
"description" : {
"type" : "string"
},
"follower_count" : {
"type" : "integer"
},
"id" : {
"$ref" : "#/components/schemas/ListId"
},
"member_count" : {
"type" : "integer"
},
"name" : {
"type" : "string",
"description" : "The name of this List."
},
"owner_id" : {
"$ref" : "#/components/schemas/UserId"
},
"private" : {
"type" : "boolean"
}
}
},
"ListAddUserRequest" : {
"type" : "object",
"required" : [
"user_id"
],
"properties" : {
"user_id" : {
"$ref" : "#/components/schemas/UserId"
}
}
},
"ListCreateRequest" : {
"type" : "object",
"required" : [
"name"
],
"properties" : {
"description" : {
"type" : "string",
"minLength" : 0,
"maxLength" : 100
},
"name" : {
"type" : "string",
"minLength" : 1,
"maxLength" : 25
},
"private" : {
"type" : "boolean",
"default" : false
}
}
},
"ListCreateResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"description" : "A Twitter List is a curated group of accounts.",
"required" : [
"id",
"name"
],
"properties" : {
"id" : {
"$ref" : "#/components/schemas/ListId"
},
"name" : {
"type" : "string",
"description" : "The name of this List."
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"ListDeleteResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"deleted" : {
"type" : "boolean"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"ListFollowedRequest" : {
"type" : "object",
"required" : [
"list_id"
],
"properties" : {
"list_id" : {
"$ref" : "#/components/schemas/ListId"
}
}
},
"ListFollowedResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"following" : {
"type" : "boolean"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"ListId" : {
"type" : "string",
"description" : "The unique identifier of this List.",
"pattern" : "^[0-9]{1,19}$",
"example" : "1146654567674912769"
},
"ListMutateResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"is_member" : {
"type" : "boolean"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"ListPinnedRequest" : {
"type" : "object",
"required" : [
"list_id"
],
"properties" : {
"list_id" : {
"$ref" : "#/components/schemas/ListId"
}
}
},
"ListPinnedResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"pinned" : {
"type" : "boolean"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"ListUnpinResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"pinned" : {
"type" : "boolean"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"ListUpdateRequest" : {
"type" : "object",
"properties" : {
"description" : {
"type" : "string",
"minLength" : 0,
"maxLength" : 100
},
"name" : {
"type" : "string",
"minLength" : 1,
"maxLength" : 25
},
"private" : {
"type" : "boolean"
}
}
},
"ListUpdateResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"updated" : {
"type" : "boolean"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"Media" : {
"type" : "object",
"required" : [
"type"
],
"properties" : {
"height" : {
"$ref" : "#/components/schemas/MediaHeight"
},
"media_key" : {
"$ref" : "#/components/schemas/MediaKey"
},
"type" : {
"type" : "string"
},
"width" : {
"$ref" : "#/components/schemas/MediaWidth"
}
},
"discriminator" : {
"propertyName" : "type",
"mapping" : {
"animated_gif" : "#/components/schemas/AnimatedGif",
"photo" : "#/components/schemas/Photo",
"video" : "#/components/schemas/Video"
}
}
},
"MediaHeight" : {
"type" : "integer",
"description" : "The height of the media in pixels.",
"minimum" : 0
},
"MediaId" : {
"type" : "string",
"description" : "The unique identifier of this Media.",
"pattern" : "^[0-9]{1,19}$",
"example" : "1146654567674912769"
},
"MediaKey" : {
"type" : "string",
"description" : "The Media Key identifier for this attachment.",
"pattern" : "^([0-9]+)_([0-9]+)$"
},
"MediaWidth" : {
"type" : "integer",
"description" : "The width of the media in pixels.",
"minimum" : 0
},
"MentionEntity" : {
"allOf" : [
{
"$ref" : "#/components/schemas/EntityIndicesInclusiveExclusive"
},
{
"$ref" : "#/components/schemas/MentionFields"
}
]
},
"MentionFields" : {
"type" : "object",
"description" : "Represent the portion of text recognized as a User mention, and its start and end position within the text.",
"required" : [
"username"
],
"properties" : {
"id" : {
"$ref" : "#/components/schemas/UserId"
},
"username" : {
"$ref" : "#/components/schemas/UserName"
}
}
},
"MuteUserMutationResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"muting" : {
"type" : "boolean"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"MuteUserRequest" : {
"type" : "object",
"required" : [
"target_user_id"
],
"properties" : {
"target_user_id" : {
"$ref" : "#/components/schemas/UserId"
}
}
},
"NewestId" : {
"type" : "string",
"description" : "The newest id in this response."
},
"NextToken" : {
"type" : "string",
"description" : "The next token.",
"minLength" : 1
},
"NonCompliantRulesProblem" : {
"description" : "A problem that indicates the user's rule set is not compliant.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
}
]
},
"Oauth1PermissionsProblem" : {
"description" : "A problem that indicates your client application does not have the required OAuth1 permissions for the requested endpoint.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
}
]
},
"OldestId" : {
"type" : "string",
"description" : "The oldest id in this response."
},
"OperationalDisconnectProblem" : {
"description" : "You have been disconnected for operational reasons.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
},
{
"type" : "object",
"properties" : {
"disconnect_type" : {
"type" : "string",
"enum" : [
"OperationalDisconnect",
"UpstreamOperationalDisconnect",
"ForceDisconnect",
"UpstreamUncleanDisconnect",
"SlowReader",
"InternalError",
"ClientApplicationStateDegraded",
"InvalidRules"
]
}
}
}
]
},
"PaginationToken32" : {
"type" : "string",
"description" : "A base32 pagination token.",
"minLength" : 16
},
"PaginationToken36" : {
"type" : "string",
"description" : "A base36 pagination token.",
"minLength" : 1
},
"PaginationTokenLong" : {
"type" : "string",
"description" : "A 'long' pagination token.",
"minLength" : 1,
"maxLength" : 19
},
"Photo" : {
"allOf" : [
{
"$ref" : "#/components/schemas/Media"
},
{
"type" : "object",
"properties" : {
"alt_text" : {
"type" : "string"
},
"url" : {
"type" : "string",
"format" : "uri"
}
}
}
]
},
"Place" : {
"type" : "object",
"required" : [
"id",
"full_name"
],
"properties" : {
"contained_within" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/PlaceId"
}
},
"country" : {
"type" : "string",
"description" : "The full name of the county in which this place exists.",
"example" : "United States"
},
"country_code" : {
"$ref" : "#/components/schemas/CountryCode"
},
"full_name" : {
"type" : "string",
"description" : "The full name of this place.",
"example" : "Lakewood, CO"
},
"geo" : {
"$ref" : "#/components/schemas/Geo"
},
"id" : {
"$ref" : "#/components/schemas/PlaceId"
},
"name" : {
"type" : "string",
"description" : "The human readable name of this place.",
"example" : "Lakewood"
},
"place_type" : {
"$ref" : "#/components/schemas/PlaceType"
}
}
},
"PlaceId" : {
"type" : "string",
"description" : "The identifier for this place.",
"example" : "f7eb2fa2fea288b1"
},
"PlaceType" : {
"type" : "string",
"enum" : [
"poi",
"neighborhood",
"city",
"admin",
"country",
"unknown"
],
"example" : "city"
},
"Point" : {
"type" : "object",
"description" : "A [GeoJson Point](https://tools.ietf.org/html/rfc7946#section-3.1.2) geometry object.",
"required" : [
"type",
"coordinates"
],
"properties" : {
"coordinates" : {
"$ref" : "#/components/schemas/Position"
},
"type" : {
"type" : "string",
"enum" : [
"Point"
],
"example" : "Point"
}
}
},
"Poll" : {
"type" : "object",
"description" : "Represent a Poll attached to a Tweet.",
"required" : [
"id",
"options"
],
"properties" : {
"duration_minutes" : {
"type" : "integer",
"minimum" : 5,
"maximum" : 10080,
"format" : "int32"
},
"end_datetime" : {
"type" : "string",
"format" : "date-time"
},
"id" : {
"$ref" : "#/components/schemas/PollId"
},
"options" : {
"type" : "array",
"minItems" : 2,
"maxItems" : 4,
"items" : {
"$ref" : "#/components/schemas/PollOption"
}
},
"voting_status" : {
"type" : "string",
"enum" : [
"open",
"closed"
]
}
}
},
"PollId" : {
"type" : "string",
"description" : "Unique identifier of this poll.",
"pattern" : "^[0-9]{1,19}$",
"example" : "1365059861688410112"
},
"PollOption" : {
"type" : "object",
"description" : "Describes a choice in a Poll object.",
"required" : [
"position",
"label",
"votes"
],
"properties" : {
"label" : {
"$ref" : "#/components/schemas/PollOptionLabel"
},
"position" : {
"type" : "integer",
"description" : "Position of this choice in the poll."
},
"votes" : {
"type" : "integer",
"description" : "Number of users who voted for this choice."
}
}
},
"PollOptionLabel" : {
"type" : "string",
"description" : "The text of a poll choice.",
"minLength" : 1,
"maxLength" : 25
},
"Position" : {
"type" : "array",
"description" : "A [GeoJson Position](https://tools.ietf.org/html/rfc7946#section-3.1.1) in the format `[longitude,latitude]`.",
"minItems" : 2,
"maxItems" : 2,
"items" : {
"type" : "number"
},
"example" : [
-105.18816086351444,
40.247749999999996
]
},
"PreviousToken" : {
"type" : "string",
"description" : "The previous token.",
"minLength" : 1
},
"Problem" : {
"type" : "object",
"description" : "An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).",
"required" : [
"type",
"title"
],
"properties" : {
"detail" : {
"type" : "string"
},
"status" : {
"type" : "integer"
},
"title" : {
"type" : "string"
},
"type" : {
"type" : "string"
}
},
"discriminator" : {
"propertyName" : "type",
"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/oauth1-permissions" : "#/components/schemas/Oauth1PermissionsProblem",
"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"
}
}
},
"ReplySettings" : {
"type" : "string",
"description" : "Shows who can reply a Tweet. Fields returned are everyone, mentioned_users, and following.",
"pattern" : "^[A-Za-z]{1,12}$",
"enum" : [
"everyone",
"mentionedUsers",
"following",
"other"
]
},
"ResourceNotFoundProblem" : {
"description" : "A problem that indicates that a given Tweet, User, etc. does not exist.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
},
{
"type" : "object",
"required" : [
"parameter",
"value",
"resource_id",
"resource_type"
],
"properties" : {
"parameter" : {
"type" : "string",
"minLength" : 1
},
"resource_id" : {
"type" : "string"
},
"resource_type" : {
"type" : "string",
"enum" : [
"user",
"tweet",
"media",
"list",
"space"
]
},
"value" : {
"type" : "string",
"description" : "Value will match the schema of the field."
}
}
}
]
},
"ResourceUnauthorizedProblem" : {
"description" : "A problem that indicates you are not allowed to see a particular Tweet, User, etc.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
},
{
"type" : "object",
"required" : [
"value",
"resource_id",
"resource_type",
"section",
"parameter"
],
"properties" : {
"parameter" : {
"type" : "string"
},
"resource_id" : {
"type" : "string"
},
"resource_type" : {
"type" : "string",
"enum" : [
"user",
"tweet",
"media",
"list",
"space"
]
},
"section" : {
"type" : "string",
"enum" : [
"data",
"includes"
]
},
"value" : {
"type" : "string"
}
}
}
]
},
"ResourceUnavailableProblem" : {
"description" : "A problem that indicates a particular Tweet, User, etc. is not available to you.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
},
{
"type" : "object",
"required" : [
"parameter",
"resource_id",
"resource_type"
],
"properties" : {
"parameter" : {
"type" : "string",
"minLength" : 1
},
"resource_id" : {
"type" : "string"
},
"resource_type" : {
"type" : "string",
"enum" : [
"user",
"tweet",
"media",
"list",
"space"
]
}
}
}
]
},
"ResultCount" : {
"type" : "integer",
"description" : "The number of results returned in this response.",
"format" : "int32"
},
"Rule" : {
"type" : "object",
"description" : "A user-provided stream filtering rule.",
"required" : [
"value"
],
"properties" : {
"id" : {
"$ref" : "#/components/schemas/RuleId"
},
"tag" : {
"$ref" : "#/components/schemas/RuleTag"
},
"value" : {
"$ref" : "#/components/schemas/RuleValue"
}
}
},
"RuleId" : {
"type" : "string",
"description" : "Unique identifier of this rule.",
"pattern" : "^[0-9]{1,19}$",
"example" : "120897978112909812"
},
"RuleNoId" : {
"type" : "object",
"description" : "A user-provided stream filtering rule.",
"required" : [
"value"
],
"properties" : {
"tag" : {
"$ref" : "#/components/schemas/RuleTag"
},
"value" : {
"$ref" : "#/components/schemas/RuleValue"
}
}
},
"RuleTag" : {
"type" : "string",
"description" : "A tag meant for the labeling of user provided rules.",
"example" : "Non-retweeted coffee Tweets"
},
"RuleValue" : {
"type" : "string",
"description" : "The filterlang value of the rule.",
"example" : "coffee -is:retweet"
},
"RulesCapProblem" : {
"description" : "You have exceeded the maximum number of rules.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
}
]
},
"RulesLookupResponse" : {
"type" : "object",
"required" : [
"meta"
],
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Rule"
}
},
"meta" : {
"$ref" : "#/components/schemas/RulesResponseMetadata"
}
}
},
"RulesRequestSummary" : {
"oneOf" : [
{
"type" : "object",
"description" : "A summary of the results of the addition of user-specified stream filtering rules.",
"required" : [
"created",
"not_created",
"valid",
"invalid"
],
"properties" : {
"created" : {
"type" : "integer",
"description" : "Number of user-specified stream filtering rules that were created.",
"format" : "int32",
"example" : 1
},
"invalid" : {
"type" : "integer",
"description" : "Number of invalid user-specified stream filtering rules.",
"format" : "int32",
"example" : 1
},
"not_created" : {
"type" : "integer",
"description" : "Number of user-specified stream filtering rules that were not created.",
"format" : "int32",
"example" : 1
},
"valid" : {
"type" : "integer",
"description" : "Number of valid user-specified stream filtering rules.",
"format" : "int32",
"example" : 1
}
}
},
{
"type" : "object",
"required" : [
"deleted",
"not_deleted"
],
"properties" : {
"deleted" : {
"type" : "integer",
"description" : "Number of user-specified stream filtering rules that were deleted.",
"format" : "int32"
},
"not_deleted" : {
"type" : "integer",
"description" : "Number of user-specified stream filtering rules that were not deleted.",
"format" : "int32"
}
}
}
]
},
"RulesResponseMetadata" : {
"type" : "object",
"required" : [
"sent"
],
"properties" : {
"next_token" : {
"$ref" : "#/components/schemas/NextToken"
},
"result_count" : {
"type" : "integer",
"description" : "Number of Rules in result set.",
"format" : "int32"
},
"sent" : {
"type" : "string"
},
"summary" : {
"$ref" : "#/components/schemas/RulesRequestSummary"
}
}
},
"SearchCount" : {
"type" : "object",
"description" : "Represent a Search Count Result.",
"required" : [
"end",
"start",
"tweet_count"
],
"properties" : {
"end" : {
"$ref" : "#/components/schemas/End"
},
"start" : {
"$ref" : "#/components/schemas/Start"
},
"tweet_count" : {
"$ref" : "#/components/schemas/TweetCount"
}
}
},
"Space" : {
"type" : "object",
"description" : "",
"required" : [
"id",
"state"
],
"properties" : {
"created_at" : {
"type" : "string",
"description" : "Creation time of the Space.",
"format" : "date-time",
"example" : "2021-07-06T18:40:40.000Z"
},
"creator_id" : {
"$ref" : "#/components/schemas/UserId"
},
"ended_at" : {
"type" : "string",
"description" : "End time of the Space.",
"format" : "date-time",
"example" : "2021-07-06T18:40:40.000Z"
},
"host_ids" : {
"type" : "array",
"description" : "The user ids for the hosts of the Space.",
"items" : {
"$ref" : "#/components/schemas/UserId"
}
},
"id" : {
"$ref" : "#/components/schemas/SpaceId"
},
"invited_user_ids" : {
"type" : "array",
"description" : "An array of user ids for people who were invited to a Space.",
"items" : {
"$ref" : "#/components/schemas/UserId"
}
},
"is_ticketed" : {
"type" : "boolean",
"description" : "Denotes if the Space is a ticketed Space.",
"example" : "false"
},
"lang" : {
"type" : "string",
"description" : "The language of the Space.",
"example" : "en"
},
"participant_count" : {
"type" : "integer",
"description" : "The number of participants in a Space.",
"format" : "int32",
"example" : 10
},
"scheduled_start" : {
"type" : "string",
"description" : "A date time stamp for when a Space is scheduled to begin.",
"format" : "date-time",
"example" : "2021-07-06T18:40:40.000Z"
},
"speaker_ids" : {
"type" : "array",
"description" : "An array of user ids for people who were speakers in a Space.",
"items" : {
"$ref" : "#/components/schemas/UserId"
}
},
"started_at" : {
"type" : "string",
"description" : "When the Space was started as a date string.",
"format" : "date-time",
"example" : "2021-7-14T04:35:55Z"
},
"state" : {
"type" : "string",
"description" : "The current state of the Space.",
"enum" : [
"live",
"scheduled",
"ended"
],
"example" : "live"
},
"subscriber_count" : {
"type" : "integer",
"description" : "The number of people who have either purchased a ticket or set a reminder for this Space.",
"format" : "int32",
"example" : 10
},
"title" : {
"type" : "string",
"description" : "The title of the Space.",
"example" : "Spaces are Awesome"
},
"topics" : {
"type" : "array",
"description" : "The topics of a Space, as selected by its creator.",
"items" : {
"type" : "object",
"description" : "The Twitter Topic object.",
"required" : [
"id",
"name"
],
"properties" : {
"description" : {
"type" : "string",
"description" : "The description of the given topic."
},
"id" : {
"type" : "string",
"description" : "An ID suitable for use in the REST API."
},
"name" : {
"type" : "string",
"description" : "The name of the given topic."
}
},
"example" : {
"description" : "All about technology",
"id" : "848920371311001600",
"name" : "Technology"
}
}
},
"updated_at" : {
"type" : "string",
"description" : "When the Space was last updated.",
"format" : "date-time",
"example" : "2021-7-14T04:35:55Z"
}
}
},
"SpaceId" : {
"type" : "string",
"description" : "The unique identifier of this Space.",
"pattern" : "^[a-zA-Z0-9]{1,13}$",
"example" : "1SLjjRYNejbKM"
},
"Start" : {
"type" : "string",
"description" : "The start time of the bucket.",
"format" : "date-time"
},
"StreamingTweetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/Tweet"
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
},
"includes" : {
"$ref" : "#/components/schemas/Expansions"
}
}
},
"Topic" : {
"type" : "object",
"description" : "The topic of a Space, as selected by its creator.",
"required" : [
"id",
"name"
],
"properties" : {
"description" : {
"type" : "string",
"description" : "The description of the given topic.",
"example" : "All about technology"
},
"id" : {
"$ref" : "#/components/schemas/TopicId"
},
"name" : {
"type" : "string",
"description" : "The name of the given topic.",
"example" : "Technology"
}
}
},
"TopicId" : {
"type" : "string",
"description" : "Unique identifier of this Topic."
},
"Tweet" : {
"type" : "object",
"required" : [
"id",
"text",
"edit_history_tweet_ids"
],
"properties" : {
"attachments" : {
"type" : "object",
"description" : "Specifies the type of attachments (if any) present in this Tweet.",
"properties" : {
"media_keys" : {
"type" : "array",
"description" : "A list of Media Keys for each one of the media attachments (if media are attached).",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/MediaKey"
}
},
"poll_ids" : {
"type" : "array",
"description" : "A list of poll IDs (if polls are attached).",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/PollId"
}
}
}
},
"author_id" : {
"$ref" : "#/components/schemas/UserId"
},
"context_annotations" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/ContextAnnotation"
}
},
"conversation_id" : {
"$ref" : "#/components/schemas/TweetId"
},
"created_at" : {
"type" : "string",
"description" : "Creation time of the Tweet.",
"format" : "date-time",
"example" : "2021-01-06T18:40:40.000Z"
},
"edit_controls" : {
"type" : "object",
"required" : [
"is_edit_eligible",
"editable_until",
"edits_remaining"
],
"properties" : {
"editable_until" : {
"type" : "string",
"description" : "Time when Tweet is no longer editable.",
"format" : "date-time",
"example" : "2021-01-06T18:40:40.000Z"
},
"edits_remaining" : {
"type" : "integer",
"description" : "Number of times this Tweet can be edited."
},
"is_edit_eligible" : {
"type" : "boolean",
"description" : "Indicates if this Tweet is eligible to be edited.",
"example" : false
}
}
},
"edit_history_tweet_ids" : {
"type" : "array",
"description" : "A list of Tweet Ids in this Tweet chain.",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/TweetId"
}
},
"entities" : {
"$ref" : "#/components/schemas/FullTextEntities"
},
"geo" : {
"type" : "object",
"description" : "The location tagged on the Tweet, if the user provided one.",
"properties" : {
"coordinates" : {
"$ref" : "#/components/schemas/Point"
},
"place_id" : {
"$ref" : "#/components/schemas/PlaceId"
}
}
},
"id" : {
"$ref" : "#/components/schemas/TweetId"
},
"in_reply_to_user_id" : {
"$ref" : "#/components/schemas/UserId"
},
"lang" : {
"type" : "string",
"description" : "Language of the Tweet, if detected by Twitter. Returned as a BCP47 language tag.",
"example" : "en"
},
"non_public_metrics" : {
"type" : "object",
"description" : "Nonpublic engagement metrics for the Tweet at the time of the request.",
"properties" : {
"impression_count" : {
"type" : "integer",
"description" : "Number of times this Tweet has been viewed.",
"format" : "int32"
}
}
},
"organic_metrics" : {
"type" : "object",
"description" : "Organic nonpublic engagement metrics for the Tweet at the time of the request.",
"required" : [
"impression_count",
"retweet_count",
"reply_count",
"like_count"
],
"properties" : {
"impression_count" : {
"type" : "integer",
"description" : "Number of times this Tweet has been viewed."
},
"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."
}
}
},
"possibly_sensitive" : {
"type" : "boolean",
"description" : "Indicates if this Tweet contains URLs marked as sensitive, for example content suitable for mature audiences.",
"example" : false
},
"promoted_metrics" : {
"type" : "object",
"description" : "Promoted nonpublic engagement metrics for the Tweet at the time of the request.",
"properties" : {
"impression_count" : {
"type" : "integer",
"description" : "Number of times this Tweet has been viewed.",
"format" : "int32"
},
"like_count" : {
"type" : "integer",
"description" : "Number of times this Tweet has been liked.",
"format" : "int32"
},
"reply_count" : {
"type" : "integer",
"description" : "Number of times this Tweet has been replied to.",
"format" : "int32"
},
"retweet_count" : {
"type" : "integer",
"description" : "Number of times this Tweet has been Retweeted.",
"format" : "int32"
}
}
},
"public_metrics" : {
"type" : "object",
"description" : "Engagement metrics for the Tweet at the time of the request.",
"required" : [
"retweet_count",
"reply_count",
"like_count",
"impression_count"
],
"properties" : {
"impression_count" : {
"type" : "integer",
"description" : "Number of times this Tweet has been viewed.",
"format" : "int32"
},
"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."
}
}
},
"referenced_tweets" : {
"type" : "array",
"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.",
"minItems" : 1,
"items" : {
"type" : "object",
"required" : [
"type",
"id"
],
"properties" : {
"id" : {
"$ref" : "#/components/schemas/TweetId"
},
"type" : {
"type" : "string",
"enum" : [
"retweeted",
"quoted",
"replied_to"
]
}
}
}
},
"reply_settings" : {
"$ref" : "#/components/schemas/ReplySettings"
},
"source" : {
"type" : "string",
"description" : "This is deprecated."
},
"text" : {
"$ref" : "#/components/schemas/TweetText"
},
"withheld" : {
"$ref" : "#/components/schemas/TweetWithheld"
}
},
"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 Twitter API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i"
}
},
"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" : {
"type" : "object",
"required" : [
"tweet",
"event_at"
],
"properties" : {
"event_at" : {
"type" : "string",
"description" : "Event time.",
"format" : "date-time",
"example" : "2021-07-06T18:40:40.000Z"
},
"quote_tweet_id" : {
"$ref" : "#/components/schemas/TweetId"
},
"tweet" : {
"type" : "object",
"required" : [
"id",
"author_id"
],
"properties" : {
"author_id" : {
"$ref" : "#/components/schemas/UserId"
},
"id" : {
"$ref" : "#/components/schemas/TweetId"
}
}
}
}
},
"TweetComplianceStreamResponse" : {
"description" : "Tweet compliance stream events.",
"oneOf" : [
{
"type" : "object",
"description" : "Compliance event.",
"required" : [
"data"
],
"properties" : {
"data" : {
"$ref" : "#/components/schemas/TweetComplianceData"
}
}
},
{
"type" : "object",
"required" : [
"errors"
],
"properties" : {
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
]
},
"TweetCount" : {
"type" : "integer",
"description" : "The count for the bucket."
},
"TweetCreateRequest" : {
"type" : "object",
"properties" : {
"card_uri" : {
"type" : "string",
"description" : "Card Uri Parameter. This is mutually exclusive from Quote Tweet Id, Poll, Media, and Direct Message Deep Link."
},
"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",
"description" : "Exclusive Tweet for super followers.",
"default" : false
},
"geo" : {
"type" : "object",
"description" : "Place ID being attached to the Tweet for geo location.",
"properties" : {
"place_id" : {
"type" : "string"
}
},
"additionalProperties" : false
},
"media" : {
"type" : "object",
"description" : "Media information being attached to created Tweet. This is mutually exclusive from Quote Tweet Id, Poll, and Card URI.",
"required" : [
"media_ids"
],
"properties" : {
"media_ids" : {
"type" : "array",
"description" : "A list of Media Ids to be attached to a created Tweet.",
"minItems" : 1,
"maxItems" : 4,
"items" : {
"$ref" : "#/components/schemas/MediaId"
}
},
"tagged_user_ids" : {
"type" : "array",
"description" : "A list of User Ids to be tagged in the media for created Tweet.",
"minItems" : 0,
"maxItems" : 10,
"items" : {
"$ref" : "#/components/schemas/UserId"
}
}
},
"additionalProperties" : false
},
"nullcast" : {
"type" : "boolean",
"description" : "Nullcasted (promoted-only) Tweets do not appear in the public timeline and are not served to followers.",
"default" : false
},
"poll" : {
"type" : "object",
"description" : "Poll options for a Tweet with a poll. This is mutually exclusive from Media, Quote Tweet Id, and Card URI.",
"required" : [
"options",
"duration_minutes"
],
"properties" : {
"duration_minutes" : {
"type" : "integer",
"description" : "Duration of the poll in minutes.",
"minimum" : 5,
"maximum" : 10080,
"format" : "int32"
},
"options" : {
"type" : "array",
"minItems" : 2,
"maxItems" : 4,
"items" : {
"type" : "string",
"description" : "The text of a poll choice.",
"minLength" : 1,
"maxLength" : 25
}
},
"reply_settings" : {
"type" : "string",
"description" : "Settings to indicate who can reply to the Tweet.",
"enum" : [
"following",
"mentionedUsers"
]
}
},
"additionalProperties" : false
},
"quote_tweet_id" : {
"$ref" : "#/components/schemas/TweetId"
},
"reply" : {
"type" : "object",
"description" : "Tweet information of the Tweet being replied to.",
"required" : [
"in_reply_to_tweet_id"
],
"properties" : {
"exclude_reply_user_ids" : {
"type" : "array",
"description" : "A list of User Ids to be excluded from the reply Tweet.",
"items" : {
"$ref" : "#/components/schemas/UserId"
}
},
"in_reply_to_tweet_id" : {
"$ref" : "#/components/schemas/TweetId"
}
},
"additionalProperties" : false
},
"reply_settings" : {
"type" : "string",
"description" : "Settings to indicate who can reply to the Tweet.",
"enum" : [
"following",
"mentionedUsers"
]
},
"text" : {
"$ref" : "#/components/schemas/TweetText"
}
},
"additionalProperties" : false
},
"TweetCreateResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"required" : [
"id",
"text"
],
"properties" : {
"id" : {
"$ref" : "#/components/schemas/TweetId"
},
"text" : {
"$ref" : "#/components/schemas/TweetText"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"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",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"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" : {
"edit_tweet_ids" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/TweetId"
}
},
"event_at" : {
"type" : "string",
"description" : "Event time.",
"format" : "date-time",
"example" : "2021-07-06T18:40:40.000Z"
},
"initial_tweet_id" : {
"$ref" : "#/components/schemas/TweetId"
},
"tweet" : {
"type" : "object",
"required" : [
"id"
],
"properties" : {
"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",
"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.",
"pattern" : "^[0-9]{1,19}$",
"example" : "1346889436626259968"
},
"TweetLabelData" : {
"description" : "Tweet label data.",
"oneOf" : [
{
"$ref" : "#/components/schemas/TweetNoticeSchema"
},
{
"$ref" : "#/components/schemas/TweetUnviewableSchema"
}
]
},
"TweetLabelStreamResponse" : {
"description" : "Tweet label stream events.",
"oneOf" : [
{
"type" : "object",
"description" : "Tweet Label event.",
"required" : [
"data"
],
"properties" : {
"data" : {
"$ref" : "#/components/schemas/TweetLabelData"
}
}
},
{
"type" : "object",
"required" : [
"errors"
],
"properties" : {
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
]
},
"TweetNotice" : {
"type" : "object",
"required" : [
"tweet",
"event_type",
"event_at",
"application"
],
"properties" : {
"application" : {
"type" : "string",
"description" : "If the label is being applied or removed. Possible values are ‘apply’ or ‘remove’.",
"example" : "apply"
},
"details" : {
"type" : "string",
"description" : "Information shown on the Tweet label"
},
"event_at" : {
"type" : "string",
"description" : "Event time.",
"format" : "date-time",
"example" : "2021-07-06T18:40:40.000Z"
},
"event_type" : {
"type" : "string",
"description" : "The type of label on the Tweet",
"example" : "misleading"
},
"extended_details_url" : {
"type" : "string",
"description" : "Link to more information about this kind of label"
},
"label_title" : {
"type" : "string",
"description" : "Title/header of the Tweet label"
},
"tweet" : {
"type" : "object",
"required" : [
"id",
"author_id"
],
"properties" : {
"author_id" : {
"$ref" : "#/components/schemas/UserId"
},
"id" : {
"$ref" : "#/components/schemas/TweetId"
}
}
}
}
},
"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" : {
"event_at" : {
"type" : "string",
"description" : "Event time.",
"format" : "date-time",
"example" : "2021-07-06T18:40:40.000Z"
},
"quote_tweet_id" : {
"$ref" : "#/components/schemas/TweetId"
},
"tweet" : {
"type" : "object",
"required" : [
"id",
"author_id"
],
"properties" : {
"author_id" : {
"$ref" : "#/components/schemas/UserId"
},
"id" : {
"$ref" : "#/components/schemas/TweetId"
}
}
},
"withheld_in_countries" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/CountryCode"
}
}
}
},
"TweetText" : {
"type" : "string",
"description" : "The content of the Tweet.",
"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"
},
"TweetUndropComplianceSchema" : {
"type" : "object",
"required" : [
"undrop"
],
"properties" : {
"undrop" : {
"$ref" : "#/components/schemas/TweetComplianceSchema"
}
}
},
"TweetUnviewable" : {
"type" : "object",
"required" : [
"tweet",
"event_at",
"application"
],
"properties" : {
"application" : {
"type" : "string",
"description" : "If the label is being applied or removed. Possible values are ‘apply’ or ‘remove’.",
"example" : "apply"
},
"event_at" : {
"type" : "string",
"description" : "Event time.",
"format" : "date-time",
"example" : "2021-07-06T18:40:40.000Z"
},
"tweet" : {
"type" : "object",
"required" : [
"id",
"author_id"
],
"properties" : {
"author_id" : {
"$ref" : "#/components/schemas/UserId"
},
"id" : {
"$ref" : "#/components/schemas/TweetId"
}
}
}
}
},
"TweetUnviewableSchema" : {
"type" : "object",
"required" : [
"public_tweet_unviewable"
],
"properties" : {
"public_tweet_unviewable" : {
"$ref" : "#/components/schemas/TweetUnviewable"
}
}
},
"TweetWithheld" : {
"type" : "object",
"description" : "Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).",
"required" : [
"copyright",
"country_codes"
],
"properties" : {
"copyright" : {
"type" : "boolean",
"description" : "Indicates if the content is being withheld for on the basis of copyright infringement."
},
"country_codes" : {
"type" : "array",
"description" : "Provides a list of countries where this content is not available.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"$ref" : "#/components/schemas/CountryCode"
}
},
"scope" : {
"type" : "string",
"description" : "Indicates whether the content being withheld is the `tweet` or a `user`.",
"enum" : [
"tweet",
"user"
]
}
}
},
"TweetWithheldComplianceSchema" : {
"type" : "object",
"required" : [
"withheld"
],
"properties" : {
"withheld" : {
"$ref" : "#/components/schemas/TweetTakedownComplianceSchema"
}
}
},
"UnsupportedAuthenticationProblem" : {
"description" : "A problem that indicates that the authentication used is not supported.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
}
]
},
"UploadExpiration" : {
"type" : "string",
"description" : "Expiration time of the upload URL.",
"format" : "date-time",
"example" : "2021-01-06T18:40:40.000Z"
},
"UploadUrl" : {
"type" : "string",
"description" : "URL to which the user will upload their Tweet or user IDs.",
"format" : "uri"
},
"Url" : {
"type" : "string",
"description" : "A validly formatted URL.",
"format" : "uri",
"example" : "https://developer.twitter.com/en/docs/twitter-api"
},
"UrlEntity" : {
"description" : "Represent the portion of text recognized as a URL, and its start and end position within the text.",
"allOf" : [
{
"$ref" : "#/components/schemas/EntityIndicesInclusiveExclusive"
},
{
"$ref" : "#/components/schemas/UrlFields"
}
]
},
"UrlFields" : {
"type" : "object",
"description" : "Represent the portion of text recognized as a URL.",
"required" : [
"url"
],
"properties" : {
"description" : {
"type" : "string",
"description" : "Description of the URL landing page.",
"example" : "This is a description of the website."
},
"display_url" : {
"type" : "string",
"description" : "The URL as displayed in the Twitter client.",
"example" : "twittercommunity.com/t/introducing-…"
},
"expanded_url" : {
"$ref" : "#/components/schemas/Url"
},
"images" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/UrlImage"
}
},
"media_key" : {
"$ref" : "#/components/schemas/MediaKey"
},
"status" : {
"$ref" : "#/components/schemas/HttpStatusCode"
},
"title" : {
"type" : "string",
"description" : "Title of the page the URL points to.",
"example" : "Introducing the v2 follow lookup endpoints"
},
"unwound_url" : {
"type" : "string",
"description" : "Fully resolved url.",
"format" : "uri",
"example" : "https://twittercommunity.com/t/introducing-the-v2-follow-lookup-endpoints/147118"
},
"url" : {
"$ref" : "#/components/schemas/Url"
}
}
},
"UrlImage" : {
"type" : "object",
"description" : "Represent the information for the URL image.",
"properties" : {
"height" : {
"$ref" : "#/components/schemas/MediaHeight"
},
"url" : {
"$ref" : "#/components/schemas/Url"
},
"width" : {
"$ref" : "#/components/schemas/MediaWidth"
}
}
},
"UsageCapExceededProblem" : {
"description" : "A problem that indicates that a usage cap has been exceeded.",
"allOf" : [
{
"$ref" : "#/components/schemas/Problem"
},
{
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"enum" : [
"Daily",
"Monthly"
]
},
"scope" : {
"type" : "string",
"enum" : [
"Account",
"Product"
]
}
}
}
]
},
"User" : {
"type" : "object",
"description" : "The Twitter User object.",
"required" : [
"id",
"name",
"username"
],
"properties" : {
"created_at" : {
"type" : "string",
"description" : "Creation time of this User.",
"format" : "date-time"
},
"description" : {
"type" : "string",
"description" : "The text of this User's profile description (also known as bio), if the User provided one."
},
"entities" : {
"type" : "object",
"description" : "A list of metadata found in the User's profile description.",
"properties" : {
"description" : {
"$ref" : "#/components/schemas/FullTextEntities"
},
"url" : {
"type" : "object",
"description" : "Expanded details for the URL specified in the User's profile, with start and end indices.",
"properties" : {
"urls" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/UrlEntity"
}
}
}
}
}
},
"id" : {
"$ref" : "#/components/schemas/UserId"
},
"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."
},
"name" : {
"type" : "string",
"description" : "The friendly name of this User, as shown on their profile."
},
"pinned_tweet_id" : {
"$ref" : "#/components/schemas/TweetId"
},
"profile_image_url" : {
"type" : "string",
"description" : "The URL to the profile image for this User.",
"format" : "uri"
},
"protected" : {
"type" : "boolean",
"description" : "Indicates if this User has chosen to protect their Tweets (in other words, if this User's Tweets are private)."
},
"public_metrics" : {
"type" : "object",
"description" : "A list of metrics for this User.",
"required" : [
"followers_count",
"following_count",
"tweet_count",
"listed_count"
],
"properties" : {
"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."
},
"listed_count" : {
"type" : "integer",
"description" : "The number of lists that include this User."
},
"tweet_count" : {
"type" : "integer",
"description" : "The number of Tweets (including Retweets) posted by this User."
}
}
},
"url" : {
"type" : "string",
"description" : "The URL specified in the User's profile."
},
"username" : {
"$ref" : "#/components/schemas/UserName"
},
"verified" : {
"type" : "boolean",
"description" : "Indicate if this User is a verified Twitter User."
},
"verified_type" : {
"type" : "string",
"description" : "The Twitter Blue verified type of the user, eg: blue, government, business or none."
},
"withheld" : {
"$ref" : "#/components/schemas/UserWithheld"
}
},
"example" : {
"created_at" : "2013-12-14T04:35:55Z",
"id" : "2244994945",
"name" : "Twitter Dev",
"protected" : false,
"username" : "TwitterDev"
}
},
"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" : {
"type" : "object",
"required" : [
"user",
"event_at"
],
"properties" : {
"event_at" : {
"type" : "string",
"description" : "Event time.",
"format" : "date-time",
"example" : "2021-07-06T18:40:40.000Z"
},
"user" : {
"type" : "object",
"required" : [
"id"
],
"properties" : {
"id" : {
"$ref" : "#/components/schemas/UserId"
}
}
}
}
},
"UserComplianceStreamResponse" : {
"description" : "User compliance stream events.",
"oneOf" : [
{
"type" : "object",
"description" : "User compliance event.",
"required" : [
"data"
],
"properties" : {
"data" : {
"$ref" : "#/components/schemas/UserComplianceData"
}
}
},
{
"type" : "object",
"required" : [
"errors"
],
"properties" : {
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
]
},
"UserDeleteComplianceSchema" : {
"type" : "object",
"required" : [
"user_delete"
],
"properties" : {
"user_delete" : {
"$ref" : "#/components/schemas/UserComplianceSchema"
}
}
},
"UserId" : {
"type" : "string",
"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.",
"pattern" : "^[0-9]{1,19}$",
"example" : "2244994945"
},
"UserIdMatchesAuthenticatedUser" : {
"type" : "string",
"description" : "Unique identifier of this User. The value must be the same as the authenticated user.",
"example" : "2244994945"
},
"UserName" : {
"type" : "string",
"description" : "The Twitter handle (screen name) of this user.",
"pattern" : "^[A-Za-z0-9_]{1,15}$"
},
"UserProfileModificationComplianceSchema" : {
"type" : "object",
"required" : [
"user_profile_modification"
],
"properties" : {
"user_profile_modification" : {
"$ref" : "#/components/schemas/UserProfileModificationObjectSchema"
}
}
},
"UserProfileModificationObjectSchema" : {
"type" : "object",
"required" : [
"user",
"profile_field",
"new_value",
"event_at"
],
"properties" : {
"event_at" : {
"type" : "string",
"description" : "Event time.",
"format" : "date-time",
"example" : "2021-07-06T18:40:40.000Z"
},
"new_value" : {
"type" : "string"
},
"profile_field" : {
"type" : "string"
},
"user" : {
"type" : "object",
"required" : [
"id"
],
"properties" : {
"id" : {
"$ref" : "#/components/schemas/UserId"
}
}
}
}
},
"UserProtectComplianceSchema" : {
"type" : "object",
"required" : [
"user_protect"
],
"properties" : {
"user_protect" : {
"$ref" : "#/components/schemas/UserComplianceSchema"
}
}
},
"UserScrubGeoObjectSchema" : {
"type" : "object",
"required" : [
"user",
"up_to_tweet_id",
"event_at"
],
"properties" : {
"event_at" : {
"type" : "string",
"description" : "Event time.",
"format" : "date-time",
"example" : "2021-07-06T18:40:40.000Z"
},
"up_to_tweet_id" : {
"$ref" : "#/components/schemas/TweetId"
},
"user" : {
"type" : "object",
"required" : [
"id"
],
"properties" : {
"id" : {
"$ref" : "#/components/schemas/UserId"
}
}
}
}
},
"UserScrubGeoSchema" : {
"type" : "object",
"required" : [
"scrub_geo"
],
"properties" : {
"scrub_geo" : {
"$ref" : "#/components/schemas/UserScrubGeoObjectSchema"
}
}
},
"UserSuspendComplianceSchema" : {
"type" : "object",
"required" : [
"user_suspend"
],
"properties" : {
"user_suspend" : {
"$ref" : "#/components/schemas/UserComplianceSchema"
}
}
},
"UserTakedownComplianceSchema" : {
"type" : "object",
"required" : [
"user",
"withheld_in_countries",
"event_at"
],
"properties" : {
"event_at" : {
"type" : "string",
"description" : "Event time.",
"format" : "date-time",
"example" : "2021-07-06T18:40:40.000Z"
},
"user" : {
"type" : "object",
"required" : [
"id"
],
"properties" : {
"id" : {
"$ref" : "#/components/schemas/UserId"
}
}
},
"withheld_in_countries" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/CountryCode"
}
}
}
},
"UserUndeleteComplianceSchema" : {
"type" : "object",
"required" : [
"user_undelete"
],
"properties" : {
"user_undelete" : {
"$ref" : "#/components/schemas/UserComplianceSchema"
}
}
},
"UserUnprotectComplianceSchema" : {
"type" : "object",
"required" : [
"user_unprotect"
],
"properties" : {
"user_unprotect" : {
"$ref" : "#/components/schemas/UserComplianceSchema"
}
}
},
"UserUnsuspendComplianceSchema" : {
"type" : "object",
"required" : [
"user_unsuspend"
],
"properties" : {
"user_unsuspend" : {
"$ref" : "#/components/schemas/UserComplianceSchema"
}
}
},
"UserWithheld" : {
"type" : "object",
"description" : "Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).",
"required" : [
"country_codes"
],
"properties" : {
"country_codes" : {
"type" : "array",
"description" : "Provides a list of countries where this content is not available.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"$ref" : "#/components/schemas/CountryCode"
}
},
"scope" : {
"type" : "string",
"description" : "Indicates that the content being withheld is a `user`.",
"enum" : [
"user"
]
}
}
},
"UserWithheldComplianceSchema" : {
"type" : "object",
"required" : [
"user_withheld"
],
"properties" : {
"user_withheld" : {
"$ref" : "#/components/schemas/UserTakedownComplianceSchema"
}
}
},
"UsersFollowingCreateRequest" : {
"type" : "object",
"required" : [
"target_user_id"
],
"properties" : {
"target_user_id" : {
"$ref" : "#/components/schemas/UserId"
}
}
},
"UsersFollowingCreateResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"following" : {
"type" : "boolean"
},
"pending_follow" : {
"type" : "boolean"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"UsersFollowingDeleteResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"following" : {
"type" : "boolean"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"UsersLikesCreateRequest" : {
"type" : "object",
"required" : [
"tweet_id"
],
"properties" : {
"tweet_id" : {
"$ref" : "#/components/schemas/TweetId"
}
}
},
"UsersLikesCreateResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"liked" : {
"type" : "boolean"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"UsersLikesDeleteResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"liked" : {
"type" : "boolean"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"UsersRetweetsCreateRequest" : {
"type" : "object",
"required" : [
"tweet_id"
],
"properties" : {
"tweet_id" : {
"$ref" : "#/components/schemas/TweetId"
}
}
},
"UsersRetweetsCreateResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"retweeted" : {
"type" : "boolean"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"UsersRetweetsDeleteResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"retweeted" : {
"type" : "boolean"
}
}
},
"errors" : {
"type" : "array",
"minItems" : 1,
"items" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"Variant" : {
"type" : "object",
"properties" : {
"bit_rate" : {
"type" : "integer",
"description" : "The bit rate of the media."
},
"content_type" : {
"type" : "string",
"description" : "The content type of the media."
},
"url" : {
"type" : "string",
"description" : "The url to the media.",
"format" : "uri"
}
}
},
"Variants" : {
"type" : "array",
"description" : "An array of all available variants of the media.",
"items" : {
"$ref" : "#/components/schemas/Variant"
}
},
"Video" : {
"allOf" : [
{
"$ref" : "#/components/schemas/Media"
},
{
"type" : "object",
"properties" : {
"duration_ms" : {
"type" : "integer"
},
"non_public_metrics" : {
"type" : "object",
"description" : "Nonpublic engagement metrics for the Media at the time of the request.",
"properties" : {
"playback_0_count" : {
"type" : "integer",
"description" : "Number of users who made it through 0% of the video.",
"format" : "int32"
},
"playback_100_count" : {
"type" : "integer",
"description" : "Number of users who made it through 100% of the video.",
"format" : "int32"
},
"playback_25_count" : {
"type" : "integer",
"description" : "Number of users who made it through 25% of the video.",
"format" : "int32"
},
"playback_50_count" : {
"type" : "integer",
"description" : "Number of users who made it through 50% of the video.",
"format" : "int32"
},
"playback_75_count" : {
"type" : "integer",
"description" : "Number of users who made it through 75% of the video.",
"format" : "int32"
}
}
},
"organic_metrics" : {
"type" : "object",
"description" : "Organic nonpublic engagement metrics for the Media at the time of the request.",
"properties" : {
"playback_0_count" : {
"type" : "integer",
"description" : "Number of users who made it through 0% of the video.",
"format" : "int32"
},
"playback_100_count" : {
"type" : "integer",
"description" : "Number of users who made it through 100% of the video.",
"format" : "int32"
},
"playback_25_count" : {
"type" : "integer",
"description" : "Number of users who made it through 25% of the video.",
"format" : "int32"
},
"playback_50_count" : {
"type" : "integer",
"description" : "Number of users who made it through 50% of the video.",
"format" : "int32"
},
"playback_75_count" : {
"type" : "integer",
"description" : "Number of users who made it through 75% of the video.",
"format" : "int32"
},
"view_count" : {
"type" : "integer",
"description" : "Number of times this video has been viewed.",
"format" : "int32"
}
}
},
"preview_image_url" : {
"type" : "string",
"format" : "uri"
},
"promoted_metrics" : {
"type" : "object",
"description" : "Promoted nonpublic engagement metrics for the Media at the time of the request.",
"properties" : {
"playback_0_count" : {
"type" : "integer",
"description" : "Number of users who made it through 0% of the video.",
"format" : "int32"
},
"playback_100_count" : {
"type" : "integer",
"description" : "Number of users who made it through 100% of the video.",
"format" : "int32"
},
"playback_25_count" : {
"type" : "integer",
"description" : "Number of users who made it through 25% of the video.",
"format" : "int32"
},
"playback_50_count" : {
"type" : "integer",
"description" : "Number of users who made it through 50% of the video.",
"format" : "int32"
},
"playback_75_count" : {
"type" : "integer",
"description" : "Number of users who made it through 75% of the video.",
"format" : "int32"
},
"view_count" : {
"type" : "integer",
"description" : "Number of times this video has been viewed.",
"format" : "int32"
}
}
},
"public_metrics" : {
"type" : "object",
"description" : "Engagement metrics for the Media at the time of the request.",
"properties" : {
"view_count" : {
"type" : "integer",
"description" : "Number of times this video has been viewed.",
"format" : "int32"
}
}
},
"variants" : {
"$ref" : "#/components/schemas/Variants"
}
}
}
]
}
},
"parameters" : {
"ComplianceJobFieldsParameter" : {
"name" : "compliance_job.fields",
"in" : "query",
"description" : "A comma separated list of ComplianceJob fields to display.",
"required" : false,
"schema" : {
"type" : "array",
"description" : "The fields available for a ComplianceJob object.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"created_at",
"download_expires_at",
"download_url",
"id",
"name",
"resumable",
"status",
"type",
"upload_expires_at",
"upload_url"
]
},
"example" : [
"created_at",
"download_expires_at",
"download_url",
"id",
"name",
"resumable",
"status",
"type",
"upload_expires_at",
"upload_url"
]
},
"explode" : false,
"style" : "form"
},
"DmConversationFieldsParameter" : {
"name" : "dm_conversation.fields",
"in" : "query",
"description" : "A comma separated list of DmConversation fields to display.",
"required" : false,
"schema" : {
"type" : "array",
"description" : "The fields available for a DmConversation object.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"id"
]
},
"example" : [
"id"
]
},
"explode" : false,
"style" : "form"
},
"DmEventExpansionsParameter" : {
"name" : "expansions",
"in" : "query",
"description" : "A comma separated list of fields to expand.",
"schema" : {
"type" : "array",
"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.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"attachments.media_keys",
"participant_ids",
"referenced_tweets.id",
"sender_id"
]
},
"example" : [
"attachments.media_keys",
"participant_ids",
"referenced_tweets.id",
"sender_id"
]
},
"explode" : false,
"style" : "form"
},
"DmEventFieldsParameter" : {
"name" : "dm_event.fields",
"in" : "query",
"description" : "A comma separated list of DmEvent fields to display.",
"required" : false,
"schema" : {
"type" : "array",
"description" : "The fields available for a DmEvent object.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"attachments",
"created_at",
"dm_conversation_id",
"event_type",
"id",
"participant_ids",
"referenced_tweets",
"sender_id",
"text"
]
},
"example" : [
"attachments",
"created_at",
"dm_conversation_id",
"event_type",
"id",
"participant_ids",
"referenced_tweets",
"sender_id",
"text"
]
},
"explode" : false,
"style" : "form"
},
"ListExpansionsParameter" : {
"name" : "expansions",
"in" : "query",
"description" : "A comma separated list of fields to expand.",
"schema" : {
"type" : "array",
"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.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"owner_id"
]
},
"example" : [
"owner_id"
]
},
"explode" : false,
"style" : "form"
},
"ListFieldsParameter" : {
"name" : "list.fields",
"in" : "query",
"description" : "A comma separated list of List fields to display.",
"required" : false,
"schema" : {
"type" : "array",
"description" : "The fields available for a List object.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"created_at",
"description",
"follower_count",
"id",
"member_count",
"name",
"owner_id",
"private"
]
},
"example" : [
"created_at",
"description",
"follower_count",
"id",
"member_count",
"name",
"owner_id",
"private"
]
},
"explode" : false,
"style" : "form"
},
"MediaFieldsParameter" : {
"name" : "media.fields",
"in" : "query",
"description" : "A comma separated list of Media fields to display.",
"required" : false,
"schema" : {
"type" : "array",
"description" : "The fields available for a Media object.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"alt_text",
"duration_ms",
"height",
"media_key",
"non_public_metrics",
"organic_metrics",
"preview_image_url",
"promoted_metrics",
"public_metrics",
"type",
"url",
"variants",
"width"
]
},
"example" : [
"alt_text",
"duration_ms",
"height",
"media_key",
"non_public_metrics",
"organic_metrics",
"preview_image_url",
"promoted_metrics",
"public_metrics",
"type",
"url",
"variants",
"width"
]
},
"explode" : false,
"style" : "form"
},
"PlaceFieldsParameter" : {
"name" : "place.fields",
"in" : "query",
"description" : "A comma separated list of Place fields to display.",
"required" : false,
"schema" : {
"type" : "array",
"description" : "The fields available for a Place object.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"contained_within",
"country",
"country_code",
"full_name",
"geo",
"id",
"name",
"place_type"
]
},
"example" : [
"contained_within",
"country",
"country_code",
"full_name",
"geo",
"id",
"name",
"place_type"
]
},
"explode" : false,
"style" : "form"
},
"PollFieldsParameter" : {
"name" : "poll.fields",
"in" : "query",
"description" : "A comma separated list of Poll fields to display.",
"required" : false,
"schema" : {
"type" : "array",
"description" : "The fields available for a Poll object.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"duration_minutes",
"end_datetime",
"id",
"options",
"voting_status"
]
},
"example" : [
"duration_minutes",
"end_datetime",
"id",
"options",
"voting_status"
]
},
"explode" : false,
"style" : "form"
},
"SearchCountFieldsParameter" : {
"name" : "search_count.fields",
"in" : "query",
"description" : "A comma separated list of SearchCount fields to display.",
"required" : false,
"schema" : {
"type" : "array",
"description" : "The fields available for a SearchCount object.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"end",
"start",
"tweet_count"
]
},
"example" : [
"end",
"start",
"tweet_count"
]
},
"explode" : false,
"style" : "form"
},
"SpaceExpansionsParameter" : {
"name" : "expansions",
"in" : "query",
"description" : "A comma separated list of fields to expand.",
"schema" : {
"type" : "array",
"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.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"creator_id",
"host_ids",
"invited_user_ids",
"speaker_ids",
"topic_ids"
]
},
"example" : [
"creator_id",
"host_ids",
"invited_user_ids",
"speaker_ids",
"topic_ids"
]
},
"explode" : false,
"style" : "form"
},
"SpaceFieldsParameter" : {
"name" : "space.fields",
"in" : "query",
"description" : "A comma separated list of Space fields to display.",
"required" : false,
"schema" : {
"type" : "array",
"description" : "The fields available for a Space object.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"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"
]
},
"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"
]
},
"explode" : false,
"style" : "form"
},
"TopicFieldsParameter" : {
"name" : "topic.fields",
"in" : "query",
"description" : "A comma separated list of Topic fields to display.",
"required" : false,
"schema" : {
"type" : "array",
"description" : "The fields available for a Topic object.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"description",
"id",
"name"
]
},
"example" : [
"description",
"id",
"name"
]
},
"explode" : false,
"style" : "form"
},
"TweetExpansionsParameter" : {
"name" : "expansions",
"in" : "query",
"description" : "A comma separated list of fields to expand.",
"schema" : {
"type" : "array",
"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.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"attachments.media_keys",
"attachments.poll_ids",
"author_id",
"edit_history_tweet_ids",
"entities.mentions.username",
"geo.place_id",
"in_reply_to_user_id",
"referenced_tweets.id",
"referenced_tweets.id.author_id"
]
},
"example" : [
"attachments.media_keys",
"attachments.poll_ids",
"author_id",
"edit_history_tweet_ids",
"entities.mentions.username",
"geo.place_id",
"in_reply_to_user_id",
"referenced_tweets.id",
"referenced_tweets.id.author_id"
]
},
"explode" : false,
"style" : "form"
},
"TweetFieldsParameter" : {
"name" : "tweet.fields",
"in" : "query",
"description" : "A comma separated list of Tweet fields to display.",
"required" : false,
"schema" : {
"type" : "array",
"description" : "The fields available for a Tweet object.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"attachments",
"author_id",
"context_annotations",
"conversation_id",
"created_at",
"edit_controls",
"edit_history_tweet_ids",
"entities",
"geo",
"id",
"in_reply_to_user_id",
"lang",
"non_public_metrics",
"organic_metrics",
"possibly_sensitive",
"promoted_metrics",
"public_metrics",
"referenced_tweets",
"reply_settings",
"source",
"text",
"withheld"
]
},
"example" : [
"attachments",
"author_id",
"context_annotations",
"conversation_id",
"created_at",
"edit_controls",
"edit_history_tweet_ids",
"entities",
"geo",
"id",
"in_reply_to_user_id",
"lang",
"non_public_metrics",
"organic_metrics",
"possibly_sensitive",
"promoted_metrics",
"public_metrics",
"referenced_tweets",
"reply_settings",
"source",
"text",
"withheld"
]
},
"explode" : false,
"style" : "form"
},
"UserExpansionsParameter" : {
"name" : "expansions",
"in" : "query",
"description" : "A comma separated list of fields to expand.",
"schema" : {
"type" : "array",
"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.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"pinned_tweet_id"
]
},
"example" : [
"pinned_tweet_id"
]
},
"explode" : false,
"style" : "form"
},
"UserFieldsParameter" : {
"name" : "user.fields",
"in" : "query",
"description" : "A comma separated list of User fields to display.",
"required" : false,
"schema" : {
"type" : "array",
"description" : "The fields available for a User object.",
"minItems" : 1,
"uniqueItems" : true,
"items" : {
"type" : "string",
"enum" : [
"created_at",
"description",
"entities",
"id",
"location",
"name",
"pinned_tweet_id",
"profile_image_url",
"protected",
"public_metrics",
"url",
"username",
"verified",
"verified_type",
"withheld"
]
},
"example" : [
"created_at",
"description",
"entities",
"id",
"location",
"name",
"pinned_tweet_id",
"profile_image_url",
"protected",
"public_metrics",
"url",
"username",
"verified",
"verified_type",
"withheld"
]
},
"explode" : false,
"style" : "form"
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment