import { type types } from "https://deno.land/x/twi@1.2.1/mod.ts";
const { operations } = types;
Properties
listBatchComplianceJobs: { parameters: { query: { type: "tweets" | "users"; status?: ; compliance_job.fields?: components["parameters"]["ComplianceJobFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2ComplianceJobsResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
| "created"
| "in_progress"
| "failed"
| "complete"
Returns recent Compliance Jobs for a given job type and optional job status
createBatchComplianceJob: { parameters: { }; responses: { 200: { content: { application/json: components["schemas"]["CreateComplianceJobResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; requestBody: { content: { application/json: components["schemas"]["CreateComplianceJobRequest"]; }; }; }
Creates a compliance for the given job type
getBatchComplianceJob: { parameters: { path: { id: components["schemas"]["JobId"]; }; query: { compliance_job.fields?: components["parameters"]["ComplianceJobFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2ComplianceJobsIdResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a single Compliance Job by ID
listIdCreate: { parameters: { }; responses: { 200: { content: { application/json: components["schemas"]["ListCreateResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; requestBody: { content: { application/json: components["schemas"]["ListCreateRequest"]; }; }; }
Creates a new List.
listIdGet: { parameters: { path: { id: components["schemas"]["ListId"]; }; query: { list.fields?: components["parameters"]["ListFieldsParameter"]; expansions?: components["parameters"]["ListExpansionsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2ListsIdResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a List.
listIdUpdate: { parameters: { path: { id: components["schemas"]["ListId"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["ListUpdateResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; requestBody: { content: { application/json: components["schemas"]["ListUpdateRequest"]; }; }; }
Update a List that you own.
listIdDelete: { parameters: { path: { id: components["schemas"]["ListId"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["ListDeleteResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Delete a List that you own.
listGetFollowers: { parameters: { path: { id: components["schemas"]["ListId"]; }; query: { max_results?: number; pagination_token?: components["schemas"]["PaginationTokenLong"]; user.fields?: components["parameters"]["UserFieldsParameter"]; expansions?: components["parameters"]["UserExpansionsParameter"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2ListsIdFollowersResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a list of Users that follow a List by the provided List ID
listGetMembers: { parameters: { path: { id: components["schemas"]["ListId"]; }; query: { max_results?: number; pagination_token?: components["schemas"]["PaginationTokenLong"]; user.fields?: components["parameters"]["UserFieldsParameter"]; expansions?: components["parameters"]["UserExpansionsParameter"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2ListsIdMembersResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a list of Users that are members of a List by the provided List ID.
listAddMember: { parameters: { path: { id: components["schemas"]["ListId"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["ListMutateResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; requestBody: { content: { application/json: components["schemas"]["ListAddUserRequest"]; }; }; }
Causes a User to become a member of a List.
listRemoveMember: { parameters: { path: { id: components["schemas"]["ListId"]; user_id: components["schemas"]["UserId"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["ListMutateResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Causes a User to be removed from the members of a List.
listsIdTweets: { parameters: { path: { id: components["schemas"]["ListId"]; }; query: { max_results?: number; pagination_token?: components["schemas"]["PaginationToken36"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2ListsIdTweetsResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a list of Tweets associated with the provided List ID.
getOpenApiSpec: { parameters: { }; responses: { 200: { content: { application/json: { [key: string]: unknown; }; }; }; }; }
Full OpenAPI Specification in JSON format. (See https://github.com/OAI/OpenAPI-Specification/blob/master/README.md)
findSpacesByIds: { parameters: { query: { ids: string[]; space.fields?: components["parameters"]["SpaceFieldsParameter"]; expansions?: components["parameters"]["SpaceExpansionsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; topic.fields?: components["parameters"]["TopicFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2SpacesResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a variety of information about the Spaces specified by the requested IDs
findSpacesByCreatorIds: { parameters: { query: { user_ids: components["schemas"]["UserId"][]; space.fields?: components["parameters"]["SpaceFieldsParameter"]; expansions?: components["parameters"]["SpaceExpansionsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; topic.fields?: components["parameters"]["TopicFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2SpacesByCreatorIdsResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a variety of information about the Spaces created by the provided User IDs
searchSpaces: { parameters: { query: { query: string; state?: "live" | "scheduled" | "all"; max_results?: number; space.fields?: components["parameters"]["SpaceFieldsParameter"]; expansions?: components["parameters"]["SpaceExpansionsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; topic.fields?: components["parameters"]["TopicFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2SpacesSearchResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns Spaces that match the provided query.
findSpaceById: { parameters: { path: { id: string; }; query: { space.fields?: components["parameters"]["SpaceFieldsParameter"]; expansions?: components["parameters"]["SpaceExpansionsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; topic.fields?: components["parameters"]["TopicFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2SpacesIdResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a variety of information about the Space specified by the requested ID
spaceBuyers: { parameters: { path: { id: string; }; query: { pagination_token?: components["schemas"]["PaginationToken32"]; max_results?: number; user.fields?: components["parameters"]["UserFieldsParameter"]; expansions?: components["parameters"]["UserExpansionsParameter"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2SpacesIdBuyersResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Retrieves the list of Users who purchased a ticket to the given space
spaceTweets: { parameters: { path: { id: string; }; query: { max_results?: number; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2SpacesIdTweetsResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Retrieves Tweets shared in the specified Space.
findTweetsById: { parameters: { query: { ids: components["schemas"]["TweetId"][]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2TweetsResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a variety of information about the Tweet specified by the requested ID.
createTweet: { parameters: { }; responses: { 201: { content: { application/json: components["schemas"]["TweetCreateResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; requestBody: { content: { application/json: components["schemas"]["TweetCreateRequest"]; }; }; }
Causes the User to create a Tweet under the authorized account.
getTweetsComplianceStream: { parameters: { query: { backfill_minutes?: number; partition: number; start_time?: string; end_time?: string; }; }; responses: { 200: { content: { application/json: components["schemas"]["TweetComplianceStreamResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Streams 100% of compliance data for Tweets
tweetCountsFullArchiveSearch: { parameters: { query: { query: string; start_time?: string; end_time?: string; since_id?: components["schemas"]["TweetId"]; until_id?: components["schemas"]["TweetId"]; next_token?: components["schemas"]["PaginationToken36"]; pagination_token?: components["schemas"]["PaginationToken36"]; granularity?: "minute" | "hour" | "day"; search_count.fields?: components["parameters"]["SearchCountFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2TweetsCountsAllResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns Tweet Counts that match a search query.
tweetCountsRecentSearch: { parameters: { query: { query: string; start_time?: string; end_time?: string; since_id?: components["schemas"]["TweetId"]; until_id?: components["schemas"]["TweetId"]; next_token?: components["schemas"]["PaginationToken36"]; pagination_token?: components["schemas"]["PaginationToken36"]; granularity?: "minute" | "hour" | "day"; search_count.fields?: components["parameters"]["SearchCountFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2TweetsCountsRecentResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns Tweet Counts from the last 7 days that match a search query.
getTweetsFirehoseStream: { parameters: { query: { backfill_minutes?: number; partition: number; start_time?: string; end_time?: string; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["StreamingTweetResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Streams 100% of public Tweets.
getTweetsLabelStream: { parameters: { query: { backfill_minutes?: number; start_time?: string; end_time?: string; }; }; responses: { 200: { content: { application/json: components["schemas"]["TweetLabelStreamResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Streams 100% of labeling events applied to Tweets
sampleStream: { parameters: { query: { backfill_minutes?: number; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["StreamingTweetResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Streams a deterministic 1% of public Tweets.
getTweetsSample10Stream: { parameters: { query: { backfill_minutes?: number; partition: number; start_time?: string; end_time?: string; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2TweetsSample10StreamResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Streams a deterministic 10% of public Tweets.
tweetsFullarchiveSearch: { parameters: { query: { query: string; start_time?: string; end_time?: string; since_id?: components["schemas"]["TweetId"]; until_id?: components["schemas"]["TweetId"]; max_results?: number; next_token?: components["schemas"]["PaginationToken36"]; pagination_token?: components["schemas"]["PaginationToken36"]; sort_order?: "recency" | "relevancy"; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2TweetsSearchAllResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns Tweets that match a search query.
tweetsRecentSearch: { parameters: { query: { query: string; start_time?: string; end_time?: string; since_id?: components["schemas"]["TweetId"]; until_id?: components["schemas"]["TweetId"]; max_results?: number; next_token?: components["schemas"]["PaginationToken36"]; pagination_token?: components["schemas"]["PaginationToken36"]; sort_order?: "recency" | "relevancy"; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2TweetsSearchRecentResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns Tweets from the last 7 days that match a search query.
searchStream: { parameters: { query: { backfill_minutes?: number; start_time?: string; end_time?: string; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["FilteredStreamingTweetResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Streams Tweets matching the stream's active rule set.
getRules: { parameters: { query: { ids?: components["schemas"]["RuleId"][]; max_results?: number; pagination_token?: string; }; }; responses: { 200: { content: { application/json: components["schemas"]["RulesLookupResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
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.
addOrDeleteRules: { parameters: { query: { dry_run?: boolean; }; }; responses: { 200: { content: { application/json: components["schemas"]["AddOrDeleteRulesResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; requestBody: { content: { application/json: components["schemas"]["AddOrDeleteRulesRequest"]; }; }; }
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.
findTweetById: { parameters: { path: { id: components["schemas"]["TweetId"]; }; query: { tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2TweetsIdResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a variety of information about the Tweet specified by the requested ID.
deleteTweetById: { parameters: { path: { id: components["schemas"]["TweetId"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["TweetDeleteResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Delete specified Tweet (in the path) by ID.
tweetsIdLikingUsers: { parameters: { path: { id: components["schemas"]["TweetId"]; }; query: { max_results?: number; pagination_token?: components["schemas"]["PaginationToken36"]; user.fields?: components["parameters"]["UserFieldsParameter"]; expansions?: components["parameters"]["UserExpansionsParameter"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2TweetsIdLikingUsersResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a list of Users that have liked the provided Tweet ID
findTweetsThatQuoteATweet: { parameters: { path: { id: components["schemas"]["TweetId"]; }; query: { max_results?: number; pagination_token?: components["schemas"]["PaginationToken36"]; exclude?: ("replies" | "retweets")[]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2TweetsIdQuoteTweetsResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a variety of information about each Tweet that quotes the Tweet specified by the requested ID.
tweetsIdRetweetingUsers: { parameters: { path: { id: components["schemas"]["TweetId"]; }; query: { max_results?: number; pagination_token?: components["schemas"]["PaginationToken36"]; user.fields?: components["parameters"]["UserFieldsParameter"]; expansions?: components["parameters"]["UserExpansionsParameter"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2TweetsIdRetweetedByResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a list of Users that have retweeted the provided Tweet ID
hideReplyById: { parameters: { path: { tweet_id: components["schemas"]["TweetId"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["TweetHideResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; requestBody: { content: { application/json: components["schemas"]["TweetHideRequest"]; }; }; }
Hides or unhides a reply to an owned conversation.
findUsersById: { parameters: { query: { ids: components["schemas"]["UserId"][]; user.fields?: components["parameters"]["UserFieldsParameter"]; expansions?: components["parameters"]["UserExpansionsParameter"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
This endpoint returns information about Users. Specify Users by their ID.
findUsersByUsername: { parameters: { query: { usernames: string[]; user.fields?: components["parameters"]["UserFieldsParameter"]; expansions?: components["parameters"]["UserExpansionsParameter"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersByResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
This endpoint returns information about Users. Specify Users by their username.
findUserByUsername: { parameters: { path: { username: string; }; query: { user.fields?: components["parameters"]["UserFieldsParameter"]; expansions?: components["parameters"]["UserExpansionsParameter"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersByUsernameUsernameResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
This endpoint returns information about a User. Specify User by username.
getUsersComplianceStream: { parameters: { query: { backfill_minutes?: number; partition: number; start_time?: string; end_time?: string; }; }; responses: { 200: { content: { application/json: components["schemas"]["UserComplianceStreamResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Streams 100% of compliance data for Users
findMyUser: { parameters: { query: { user.fields?: components["parameters"]["UserFieldsParameter"]; expansions?: components["parameters"]["UserExpansionsParameter"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersMeResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
This endpoint returns information about the requesting User.
findUserById: { parameters: { path: { id: components["schemas"]["UserId"]; }; query: { user.fields?: components["parameters"]["UserFieldsParameter"]; expansions?: components["parameters"]["UserExpansionsParameter"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersIdResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
This endpoint returns information about a User. Specify User by ID.
usersIdBlocking: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; }; query: { max_results?: number; pagination_token?: components["schemas"]["PaginationToken32"]; user.fields?: components["parameters"]["UserFieldsParameter"]; expansions?: components["parameters"]["UserExpansionsParameter"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersIdBlockingResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a list of Users that are blocked by the provided User ID
usersIdBlock: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["BlockUserMutationResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; requestBody: { content: { application/json: components["schemas"]["BlockUserRequest"]; }; }; }
Causes the User (in the path) to block the target User. The User (in the path) must match the User context authorizing the request
getUsersIdBookmarks: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; }; query: { max_results?: number; pagination_token?: components["schemas"]["PaginationToken36"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersIdBookmarksResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns Tweet objects that have been bookmarked by the requesting User
postUsersIdBookmarks: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["BookmarkMutationResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; requestBody: { content: { application/json: components["schemas"]["BookmarkAddRequest"]; }; }; }
Adds a Tweet (ID in the body) to the requesting User's (in the path) bookmarks
usersIdBookmarksDelete: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; tweet_id: components["schemas"]["TweetId"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["BookmarkMutationResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Removes a Tweet from the requesting User's bookmarked Tweets.
userFollowedLists: { parameters: { path: { id: components["schemas"]["UserId"]; }; query: { max_results?: number; pagination_token?: components["schemas"]["PaginationTokenLong"]; list.fields?: components["parameters"]["ListFieldsParameter"]; expansions?: components["parameters"]["ListExpansionsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersIdFollowedListsResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a User's followed Lists.
listUserFollow: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["ListFollowedResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; requestBody: { content: { application/json: components["schemas"]["ListFollowedRequest"]; }; }; }
Causes a User to follow a List.
listUserUnfollow: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; list_id: components["schemas"]["ListId"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["ListFollowedResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Causes a User to unfollow a List.
usersIdFollowers: { parameters: { path: { id: components["schemas"]["UserId"]; }; query: { max_results?: number; pagination_token?: components["schemas"]["PaginationToken32"]; user.fields?: components["parameters"]["UserFieldsParameter"]; expansions?: components["parameters"]["UserExpansionsParameter"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersIdFollowersResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a list of Users who are followers of the specified User ID.
usersIdFollowing: { parameters: { path: { id: components["schemas"]["UserId"]; }; query: { max_results?: number; pagination_token?: components["schemas"]["PaginationToken32"]; user.fields?: components["parameters"]["UserFieldsParameter"]; expansions?: components["parameters"]["UserExpansionsParameter"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersIdFollowingResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a list of Users that are being followed by the provided User ID
usersIdFollow: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["UsersFollowingCreateResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; requestBody: { content: { application/json: components["schemas"]["UsersFollowingCreateRequest"]; }; }; }
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
usersIdLikedTweets: { parameters: { path: { id: components["schemas"]["UserId"]; }; query: { max_results?: number; pagination_token?: components["schemas"]["PaginationToken36"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersIdLikedTweetsResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a list of Tweets liked by the provided User ID
usersIdLike: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["UsersLikesCreateResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; requestBody: { content: { application/json: components["schemas"]["UsersLikesCreateRequest"]; }; }; }
Causes the User (in the path) to like the specified Tweet. The User in the path must match the User context authorizing the request.
usersIdUnlike: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; tweet_id: components["schemas"]["TweetId"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["UsersLikesDeleteResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Causes the User (in the path) to unlike the specified Tweet. The User must match the User context authorizing the request
getUserListMemberships: { parameters: { path: { id: components["schemas"]["UserId"]; }; query: { max_results?: number; pagination_token?: components["schemas"]["PaginationTokenLong"]; list.fields?: components["parameters"]["ListFieldsParameter"]; expansions?: components["parameters"]["ListExpansionsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersIdListMembershipsResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Get a User's List Memberships.
usersIdMentions: { parameters: { path: { id: components["schemas"]["UserId"]; }; query: { since_id?: components["schemas"]["TweetId"]; until_id?: components["schemas"]["TweetId"]; max_results?: number; pagination_token?: components["schemas"]["PaginationToken36"]; start_time?: string; end_time?: string; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersIdMentionsResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns Tweet objects that mention username associated to the provided User ID
usersIdMuting: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; }; query: { max_results?: number; pagination_token?: components["schemas"]["PaginationTokenLong"]; user.fields?: components["parameters"]["UserFieldsParameter"]; expansions?: components["parameters"]["UserExpansionsParameter"]; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersIdMutingResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a list of Users that are muted by the provided User ID
usersIdMute: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["MuteUserMutationResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; requestBody: { content: { application/json: components["schemas"]["MuteUserRequest"]; }; }; }
Causes the User (in the path) to mute the target User. The User (in the path) must match the User context authorizing the request.
listUserOwnedLists: { parameters: { path: { id: components["schemas"]["UserId"]; }; query: { max_results?: number; pagination_token?: components["schemas"]["PaginationTokenLong"]; list.fields?: components["parameters"]["ListFieldsParameter"]; expansions?: components["parameters"]["ListExpansionsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersIdOwnedListsResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Get a User's Owned Lists.
listUserPinnedLists: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; }; query: { list.fields?: components["parameters"]["ListFieldsParameter"]; expansions?: components["parameters"]["ListExpansionsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersIdPinnedListsResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Get a User's Pinned Lists.
listUserPin: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["ListPinnedResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; requestBody: { content: { application/json: components["schemas"]["ListPinnedRequest"]; }; }; }
Causes a User to pin a List.
listUserUnpin: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; list_id: components["schemas"]["ListId"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["ListUnpinResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Causes a User to remove a pinned List.
usersIdRetweets: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["UsersRetweetsCreateResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; requestBody: { content: { application/json: components["schemas"]["UsersRetweetsCreateRequest"]; }; }; }
Causes the User (in the path) to retweet the specified Tweet. The User in the path must match the User context authorizing the request.
usersIdUnretweets: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; source_tweet_id: components["schemas"]["TweetId"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["UsersRetweetsDeleteResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Causes the User (in the path) to unretweet the specified Tweet. The User must match the User context authorizing the request
usersIdTimeline: { parameters: { path: { id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; }; query: { since_id?: components["schemas"]["TweetId"]; until_id?: components["schemas"]["TweetId"]; max_results?: number; pagination_token?: components["schemas"]["PaginationToken36"]; exclude?: ("replies" | "retweets")[]; start_time?: string; end_time?: string; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersIdTimelinesReverseChronologicalResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns Tweet objects that appears in the provided User ID's home timeline
usersIdTweets: { parameters: { path: { id: components["schemas"]["UserId"]; }; query: { since_id?: components["schemas"]["TweetId"]; until_id?: components["schemas"]["TweetId"]; max_results?: number; pagination_token?: components["schemas"]["PaginationToken36"]; exclude?: ("replies" | "retweets")[]; start_time?: string; end_time?: string; tweet.fields?: components["parameters"]["TweetFieldsParameter"]; expansions?: components["parameters"]["TweetExpansionsParameter"]; media.fields?: components["parameters"]["MediaFieldsParameter"]; poll.fields?: components["parameters"]["PollFieldsParameter"]; user.fields?: components["parameters"]["UserFieldsParameter"]; place.fields?: components["parameters"]["PlaceFieldsParameter"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["Get2UsersIdTweetsResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Returns a list of Tweets authored by the provided User ID
usersIdUnblock: { parameters: { path: { source_user_id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; target_user_id: components["schemas"]["UserId"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["BlockUserMutationResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Causes the source User to unblock the target User. The source User must match the User context authorizing the request
usersIdUnfollow: { parameters: { path: { source_user_id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; target_user_id: components["schemas"]["UserId"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["UsersFollowingDeleteResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Causes the source User to unfollow the target User. The source User must match the User context authorizing the request
usersIdUnmute: { parameters: { path: { source_user_id: components["schemas"]["UserIdMatchesAuthenticatedUser"]; target_user_id: components["schemas"]["UserId"]; }; }; responses: { 200: { content: { application/json: components["schemas"]["MuteUserMutationResponse"]; }; }; default: { content: { application/json: components["schemas"]["Error"]; application/problem+json: components["schemas"]["Problem"]; }; }; }; }
Causes the source User to unmute the target User. The source User must match the User context authorizing the request