resources/TwitterApiEndpoints.json
|
{
"application": { "GET application/rate_limit_status": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/developer-utilities/rate-limit-status/api-reference/get-application-rate_limit_status", "Uri": "https://api.twitter.com/1.1/application/rate_limit_status.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "Resources", "Description": "A comma-separated list of resource families you want to know the current rate limit disposition for. For best performance, only specify the resource families pertinent to your application. See API Rate Limiting for more information.", "Name": "resources", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "statuses,friends,trends,help" } ], "Function": "Get-TwitterRateLimitStatus", "Resource": "application/rate_limit_status", "Description": "Returns the current rate limits for methods belonging to the specified resource families." } }, "users": { "GET users/profile_banner": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-users-profile_banner", "Uri": "https://api.twitter.com/1.1/users/profile_banner.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "UserId", "Description": "The ID of the user for whom to return results. Helpful for disambiguating when a valid user ID is also a valid screen name.", "Name": "user_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": 123456 }, { "PSParameter": "ScreenName", "Description": "The screen name of the user for whom to return results. Helpful for disambiguating when a valid screen name is also a user ID.", "Name": "screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "noradio" } ], "Function": "Get-TwitterUserProfileBanner", "Resource": "users/profile_banner", "Description": "Returns a map of the available size variations of the specified user's profile banner. If the user has not uploaded a profile banner, a HTTP 404 will be served instead. This method can be used instead of string manipulation on the profile_banner_url returned in user objects as described in Profile Images and Banners.\nThe profile banner data available at each size variant's URL is in PNG format." }, "GET users/show": { "Iteration": "None", "ApiReference": "URL to API Reference", "Uri": "https://api.twitter.com/1.1/users/show.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "UserId", "Description": "The ID of the user for whom to return results. Either an id or screen_name is required for this method.", "Name": "user_id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": 12345 }, { "PSParameter": "ScreenName", "Description": "The screen name of the user for whom to return results. Either a id or screen_name is required for this method.", "Name": "screen_name", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": "noradio" }, { "PSParameter": "ExcludeEntities", "Description": "The entities node will not be included when set to false", "Name": "include_entities", "DefaultValue": true, "Required": "optional", "Implemented": true, "Example": false } ], "Function": "Get-TwitterUser", "Resource": "users/show", "Description": "Returns a variety of information about the user specified by the required user_id or screen_name parameter. The author's most recent Tweet will be returned inline when possible.\nGET users / lookup is used to retrieve a bulk collection of user objects.\nYou must be following a protected user to be able to see their most recent Tweet. If you don't follow a protected user, the user's Tweet will be removed. A Tweet will not always be returned in the current_status field." }, "GET users/lookup": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup", "Uri": "https://api.twitter.com/1.1/users/lookup.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "ScreenName", "Description": "A comma separated list of screen names, up to 100 are allowed in a single request. You are strongly encouraged to use a POST for larger (up to 100 screen names) requests.", "Name": "screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "twitterapi,twitter" }, { "PSParameter": "UserId", "Description": "A comma separated list of user IDs, up to 100 are allowed in a single request. You are strongly encouraged to use a POST for larger requests.", "Name": "user_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "783214,6253282" }, { "PSParameter": "ExcludeEntities", "Description": "The entities node that may appear within embedded statuses will not be included when set to false.", "Name": "include_entities", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "example of parameter 2" }, { "PSParameter": null, "Description": "Valid request values are compat and extended, which give compatibility mode and extended mode, respectively for Tweets that contain over 140 characters", "Name": "tweet_mode", "DefaultValue": "extended", "Required": "optional", "Implemented": false, "Example": "compat" } ], "Function": "Get-TwitterUserList", "Resource": "users/lookup", "Description": "Returns fully-hydrated user objects for up to 100 users per request, as specified by comma-separated values passed to the user_id and/or screen_name parameters.\nThis method is especially useful when used in conjunction with collections of user IDs returned from GET friends / ids and GET followers / ids.\nGET users / show is used to retrieve a single user object.\nThere are a few things to note when using this method.\nYou must be following a protected user to be able to see their most recent status update. If you don't follow a protected user their status will be removed.\nThe order of user IDs or screen names may not match the order of users in the returned array.\nIf a requested user is unknown, suspended, or deleted, then that user will not be returned in the results list.\nIf none of your lookup criteria can be satisfied by returning a user object, a HTTP 404 will be thrown.\nYou are strongly encouraged to use a POST for larger requests." } }, "oauth2": { "POST oauth2/token": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/authentication/api-reference/token", "Uri": "https://api.twitter.com/oauth2/token", "Method": "POST", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": null, "Description": "Specifies the type of grant being requested by the application. At this time, only client_credentials is allowed. See Application-Only Authentication for more information.", "Name": "grant_type", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": "client_credentials" } ], "Function": "Set-TwitterBearerToken", "Resource": "oauth2/token", "Description": "Allows a registered application to obtain an OAuth 2 Bearer Token, which can be used to make API requests on an application's own behalf, without a user context." } }, "favorites": { "GET favorites/list": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-favorites-list", "Uri": "https://api.twitter.com/1.1/favorites/list.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "UserId", "Description": "The ID of the user for whom to return results.", "Name": "user_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": 123456789 }, { "PSParameter": "ScreenName", "Description": "The screen name of the user for whom to return results.", "Name": "screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "twitterdev" }, { "Implemented": true, "Example": 5, "Name": "count", "MaxValue": 200, "Description": "Specifies the number of records to retrieve. Must be less than or equal to 200; defaults to 20. The value of count is best thought of as a limit to the number of Tweets to return because suspended or deleted content is removed after the count has been applied.", "Required": "optional", "DefaultValue": 20, "PSParameter": "Count", "MinValue": 1 }, { "PSParameter": "SinceId", "Description": "Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.", "Name": "since_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": 123456789 }, { "PSParameter": "MaxId", "Description": "Returns results with an ID less than (that is, older than) or equal to the specified ID.", "Name": "max_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": 654321 }, { "PSParameter": "ExcludeEntities", "Description": "The entities node will be omitted when set to false.", "Name": "include_entities", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "false" } ], "Function": "Get-TweetLikes", "Resource": "favorites/list", "Description": "Returns the 20 most recent Tweets liked by the authenticating or specified user.\nNote: favorites are now known as likes." }, "POST favorites/destroy": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-favorites-destroy", "Uri": "https://api.twitter.com/1.1/favorites/destroy.json", "Method": "POST", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "TweetId", "Description": "The numerical ID of the Tweet to like.", "Name": "id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": 123456 }, { "PSParameter": "ExcludeEntities", "Description": "The entities node will be omitted when set to false.", "Name": "include_entities", "DefaultValue": true, "Required": "optional", "Implemented": true, "Example": false } ], "Function": "Set-TweetLike", "Resource": "favorites/destroy", "Description": "Note: favorites are now known as likes.\nUnfavorites (un-likes) the Tweet specified in the ID parameter as the authenticating user. Returns the un-liked Tweet when successful.\nThe process invoked by this method is asynchronous. The immediately returned Tweet object may not indicate the resultant favorited status of the Tweet. A 200 OK response from this method will indicate whether the intended action was successful or not." }, "POST favorites/create": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-favorites-create", "Uri": "https://api.twitter.com/1.1/favorites/create.json", "Method": "POST", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "TweetId", "Description": "The numerical ID of the Tweet to like.", "Name": "id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": 123456 }, { "PSParameter": "ExcludeEntities", "Description": "The entities node will be omitted when set to false.", "Name": "include_entities", "DefaultValue": true, "Required": "optional", "Implemented": true, "Example": false } ], "Function": "Set-TweetLike", "Resource": "favorites/create", "Description": "Note: favorites are now known as likes.\nFavorites (likes) the Tweet specified in the ID parameter as the authenticating user. Returns the favorite Tweet when successful.\nThe process invoked by this method is asynchronous. The immediately returned Tweet object may not indicate the resultant favorited status of the Tweet. A 200 OK response from this method will indicate whether the intended action was successful or not." } }, "lists": { "GET lists/subscriptions": { "Iteration": "Cursor", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-subscriptions", "Uri": "https://api.twitter.com/1.1/lists/subscriptions.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "UserId", "Description": "The ID of the user for whom to return results. Helpful for disambiguating when a valid user ID is also a valid screen name.", "Name": "user_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null }, { "PSParameter": "ScreenName", "Description": "The screen name of the user for whom to return results. Helpful for disambiguating when a valid screen name is also a user ID.", "Name": "screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null }, { "Implemented": true, "Example": null, "Name": "count", "MaxValue": 1000, "Description": "The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.", "Required": "optional", "DefaultValue": 20, "PSParameter": "ResultsPerPage", "MinValue": 1 }, { "PSParameter": null, "Description": "Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list. It is recommended to always use cursors when the method supports them. See Cursoring for more information.", "Name": "cursor", "DefaultValue": -1, "Required": "optional", "Implemented": true, "Example": null } ], "Function": "Get-TwitterListSubscription", "Resource": "lists/subscriptions", "Description": "Obtain a collection of the lists the specified user is subscribed to, 20 lists per page by default. Does not include the user's own lists." }, "GET lists/list": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-list", "Uri": "https://api.twitter.com/1.1/lists/list.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "UserId", "Description": "The ID of the user for whom to return results. Helpful for disambiguating when a valid user ID is also a valid screen name. Note: Specifies the ID of the user to get lists from. Helpful for disambiguating when a valid user ID is also a valid screen name.", "Name": "user_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "12345" }, { "PSParameter": "ScreenName", "Description": "The screen name of the user for whom to return results. Helpful for disambiguating when a valid screen name is also a user ID.", "Name": "screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "noradio" }, { "PSParameter": "OwnedListFirst", "Description": "Set this to true if you would like owned lists to be returned first. See description above for information on how this parameter works.", "Name": "reverse", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "true" } ], "Function": "Get-TwitterList", "Resource": "lists/list", "Description": "Returns all lists the authenticating or specified user subscribes to, including their own. The user is specified using the user_id or screen_name parameters. If no user is given, the authenticating user is used.\nA maximum of 100 results will be returned by this call. Subscribed lists are returned first, followed by owned lists. This means that if a user subscribes to 90 lists and owns 20 lists, this method returns 90 subscriptions and 10 owned lists. The reverse method returns owned lists first, so with reverse=true, 20 owned lists and 80 subscriptions would be returned. If your goal is to obtain every list a user owns or subscribes to, use GET lists / ownerships and/or GET lists / subscriptions instead." }, "GET lists/ownerships": { "Iteration": "Cursor", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships", "Uri": "https://api.twitter.com/1.1/lists/ownerships.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "UserId", "Description": "The ID of the user for whom to return results. Helpful for disambiguating when a valid user ID is also a valid screen name.", "Name": "user_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null }, { "PSParameter": "ScreenName", "Description": "The screen name of the user for whom to return results. Helpful for disambiguating when a valid screen name is also a user ID.", "Name": "screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null }, { "Implemented": true, "Example": null, "Name": "count", "MaxValue": 1000, "Description": "The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.", "Required": "optional", "DefaultValue": 20, "PSParameter": "ResultsPerPage", "MinValue": 1 }, { "PSParameter": null, "Description": "Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list. It is recommended to always use cursors when the method supports them. See Cursoring for more information.", "Name": "cursor", "DefaultValue": -1, "Required": "optional", "Implemented": true, "Example": null } ], "Function": "Get-TwitterListByOwner", "Resource": "lists/ownerships", "Description": "Returns the lists owned by the specified Twitter user. Private lists will only be shown if the authenticated user is also the owner of the lists." }, "GET lists/statuses": { "Iteration": "Page?", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-statuses", "Uri": "https://api.twitter.com/1.1/lists/statuses.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "ListId", "Description": "The numerical id of the list.", "Name": "list_id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": null }, { "PSParameter": "Slug", "Description": "You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you'll also have to specify the list owner using the owner_id or owner_screen_name parameters.", "Name": "slug", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": null }, { "PSParameter": "OwnerScreenName", "Description": "The screen name of the user who owns the list being requested by a slug .", "Name": "owner_screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null }, { "PSParameter": "OwnerId", "Description": "The user ID of the user who owns the list being requested by a slug .", "Name": "owner_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null }, { "PSParameter": "SinceId", "Description": "Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.", "Name": "since_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null }, { "PSParameter": "MaxId", "Description": "Returns results with an ID less than (that is, older than) or equal to the specified ID.", "Name": "max_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null }, { "Implemented": true, "Example": null, "Name": "count", "MaxValue": 200, "Description": "Specifies the number of results to retrieve per page.", "Required": "optional", "DefaultValue": 20, "PSParameter": "Count", "MinValue": 1 }, { "PSParameter": "ExcludeEntities", "Description": "Entities are ON by default in API 1.1, each tweet includes a node called entities. This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. You can omit entities from the result by using include_entities=false", "Name": "include_entities", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null }, { "PSParameter": "ExcludeRetweets", "Description": "When set to either true , t or 1 , the list timeline will contain native retweets (if they exist) in addition to the standard stream of tweets. The output format of retweeted tweets is identical to the representation you see in home_timeline.", "Name": "include_rts", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null } ], "Function": "Get-TwitterListTweets", "Resource": "lists/statuses", "Description": "Returns a timeline of tweets authored by members of the specified list. Retweets are included by default. Use the include_rts=false parameter to omit retweets." }, "GET lists/members": { "Iteration": "Cursor", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-members", "Uri": "https://api.twitter.com/1.1/lists/members.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "ListId", "Description": "The numerical id of the list.", "Name": "list_id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": null }, { "PSParameter": "Slug", "Description": "You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you'll also have to specify the list owner using the owner_id or owner_screen_name parameters.", "Name": "slug", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": null }, { "PSParameter": "OwnerScreenName", "Description": "The screen name of the user who owns the list being requested by a slug.", "Name": "owner_screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null }, { "PSParameter": "OwnerId", "Description": "The user ID of the user who owns the list being requested by a slug.", "Name": "owner_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null }, { "Implemented": true, "Example": null, "Name": "count", "MaxValue": 5000, "Description": "Specifies the number of results to return per page (see cursor below). The default is 20, with a maximum of 5,000.", "Required": "optional", "DefaultValue": 20, "PSParameter": "ResultsPerPage", "MinValue": 1 }, { "PSParameter": null, "Description": "Causes the collection of list members to be broken into pages of consistent sizes (specified by the count parameter). If no cursor is provided, a value of -1 will be assumed, which is the first page.\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and forth. See Using cursors to navigate collections for more information.", "Name": "cursor", "DefaultValue": -1, "Required": "semi-optional", "Implemented": true, "Example": "12893764510938" }, { "PSParameter": "ExcludeEntities", "Description": "The entities node will not be included when set to false.", "Name": "include_entities", "DefaultValue": true, "Required": "optional", "Implemented": true, "Example": false }, { "PSParameter": "SkipStatus", "Description": "When set to either true, t or 1 statuses will not be included in the returned user objects.", "Name": "skip_status", "DefaultValue": false, "Required": "optional", "Implemented": true, "Example": null } ], "Function": "Get-TwitterListMember", "Resource": "lists/members", "Description": "Returns the members of the specified list. Private list members will only be shown if the authenticated user owns the specified list." }, "GET lists/show": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-show", "Uri": "https://api.twitter.com/1.1/lists/show.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "ListId", "Description": "The numerical id of the list.", "Name": "list_id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": null }, { "PSParameter": "Slug", "Description": "You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you'll also have to specify the list owner using the owner_id or owner_screen_name parameters.", "Name": "slug", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": null }, { "PSParameter": "OwnerScreenName", "Description": "The screen name of the user who owns the list being requested by a slug.", "Name": "owner_screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null }, { "PSParameter": "OwnerId", "Description": "The user ID of the user who owns the list being requested by a slug.", "Name": "owner_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null } ], "Function": "Get-TwitterList", "Resource": "lists/show", "Description": "Returns the specified list. Private lists will only be shown if the authenticated user owns the specified list." }, "GET lists/subscribers": { "Iteration": "Cursor", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-subscribers", "Uri": "https://api.twitter.com/1.1/lists/subscribers.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "ListId", "Description": "The numerical id of the list.", "Name": "list_id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": null }, { "PSParameter": "Slug", "Description": "You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you'll also have to specify the list owner using the owner_id or owner_screen_name parameters.", "Name": "slug", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": null }, { "PSParameter": "OwnerScreenName", "Description": "The screen name of the user who owns the list being requested by a slug.", "Name": "owner_screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null }, { "PSParameter": "OwnerId", "Description": "The user ID of the user who owns the list being requested by a slug.", "Name": "owner_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null }, { "Implemented": true, "Example": null, "Name": "count", "MaxValue": 5000, "Description": "Specifies the number of results to return per page (see cursor below). The default is 20, with a maximum of 5,000.", "Required": "optional", "DefaultValue": 20, "PSParameter": "ResultsPerPage", "MinValue": 1 }, { "PSParameter": null, "Description": "Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list. See Using cursors to navigate collections for more information.", "Name": "cursor", "DefaultValue": -1, "Required": "semi-optional", "Implemented": true, "Example": null }, { "PSParameter": "ExcludeEntities", "Description": "When set to either true , t or 1 , each tweet will include a node called entities. This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. While entities are opt-in on timelines at present, they will be made a default component of output in the future. See Tweet Entities for more details.", "Name": "include_entities", "DefaultValue": true, "Required": "optional", "Implemented": true, "Example": false }, { "PSParameter": "SkipStatus", "Description": "When set to either true, t or 1 statuses will not be included in the returned user objects.", "Name": "skip_status", "DefaultValue": false, "Required": "optional", "Implemented": true, "Example": null } ], "Function": "Get-TwitterListSubscriber", "Resource": "lists/subscribers", "Description": "Returns the subscribers of the specified list. Private list subscribers will only be shown if the authenticated user owns the specified list." } }, "search": { "GET search/tweets": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/tweets/search/api-reference/get-search-tweets", "Uri": "https://api.twitter.com/1.1/search/tweets.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "SearchString", "Description": "A UTF-8, URL-encoded search query of 500 characters maximum, including operators. Queries may additionally be limited by complexity.", "Name": "q", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": "@noradio" }, { "PSParameter": null, "Description": "Returns tweets by users located within a given radius of the given latitude/longitude. The location is preferentially taking from the Geotagging API, but will fall back to their Twitter profile. The parameter value is specified by latitude,longitude,radius , where radius units must be specified as either mi (miles) or km (kilometers). Note that you cannot use the near operator via the API to geocode arbitrary locations; however you can use this geocode parameter to search near geocodes directly. A maximum of 1,000 distinct sub-regions will be considered when using the radius modifier.", "Name": "geocode", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "37.781157 -122.398720 1mi" }, { "PSParameter": null, "Description": "Restricts tweets to the given language, given by an ISO 639-1 code. Language detection is best-effort.", "Name": "lang", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "eu" }, { "PSParameter": null, "Description": "Specify the language of the query you are sending (only ja is currently effective). This is intended for language-specific consumers and the default should work in the majority of cases.", "Name": "locale", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "ja" }, { "PSParameter": null, "Description": "Specifies what type of search results you would prefer to receive. The current default is mixed.\nValid values include:\n* mixed : Include both popular and real time results in the response.\n* recent : return only the most recent results in the response\n* popular : return only the most popular results in the response.", "Name": "result_type", "DefaultValue": "mixed", "Required": "optional", "Implemented": false, "Example": "mixed" }, { "Implemented": true, "Example": 100, "Name": "count", "MaxValue": 100, "Description": "The number of tweets to return per page, up to a maximum of 100. Defaults to 15. This was formerly the rpp parameter in the old Search API.", "Required": "optional", "DefaultValue": 15, "PSParameter": "Count", "MinValue": 1 }, { "PSParameter": null, "Description": "Returns tweets created before the given date. Date should be formatted as YYYY-MM-DD. Keep in mind that the search index has a 7-day limit. In other words, no tweets will be found for a date older than one week.", "Name": "until", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "2015-07-19" }, { "PSParameter": null, "Description": "Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.", "Name": "since_id", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": 123456 }, { "PSParameter": null, "Description": "Returns results with an ID less than (that is, older than) or equal to the specified ID.", "Name": "max_id", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": 654321 }, { "PSParameter": "ExcludeEntities", "Description": "The entities node will not be included when set to false.", "Name": "include_entities", "DefaultValue": true, "Required": "optional", "Implemented": true, "Example": false } ], "Function": "Search-Tweet", "Resource": "search/tweets", "Description": "Returns a collection of relevant Tweets matching a specified query.\nPlease note that Twitter's search service and, by extension, the Search API is not meant to be an exhaustive source of Tweets. Not all Tweets will be indexed or made available via the search interface.\nTo learn how to use Twitter Search effectively, please see the Standard search operators page for a list of available filter operators. Also, see the Working with Timelines page to learn best practices for navigating results by since_id and max_id." } }, "followers": { "GET followers/ids": { "Iteration": "Cursor", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids", "Uri": "https://api.twitter.com/1.1/followers/ids.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "UserId", "Description": "The ID of the user for whom to return results.", "Name": "user_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": 123456789 }, { "PSParameter": "ScreenName", "Description": "The screen name of the user for whom to return results.", "Name": "screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "twitterdev" }, { "PSParameter": null, "Description": "Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first page.\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and forth. See Using cursors to navigate collections for more information.", "Name": "cursor", "DefaultValue": -1, "Required": "semi-optional", "Implemented": true, "Example": 12893764510938 }, { "PSParameter": null, "Description": "Some programming environments will not consume Twitter IDs due to their size. Provide this option to have IDs returned as strings instead. More about Twitter IDs.", "Name": "stringify_ids", "DefaultValue": "false", "Required": "optional", "Implemented": false, "Example": "true" }, { "Implemented": true, "Example": 2048, "Name": "count", "MaxValue": 5000, "Description": "Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of count is best thought of as a limit to the number of results to return. When using the count parameter with this method, it is wise to use a consistent count value across all requests to the same user's collection. Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.", "Required": "optional", "DefaultValue": 20, "PSParameter": "Count", "MinValue": 1 } ], "Function": "Get-TwitterFollowers", "Resource": "followers/ids", "Description": "Returns a cursored collection of user IDs for every user following the specified user.\nAt this time, results are ordered with the most recent following first — however, this ordering is subject to unannounced change and eventual consistency issues. Results are given in groups of 5,000 user IDs and multiple pages of results can be navigated through using the next_cursor value in subsequent requests. See Using cursors to navigate collections for more information.\nThis method is especially powerful when used in conjunction with GET users / lookup, a method that allows you to convert user IDs into full user objects in bulk." }, "GET followers/list": { "Iteration": "Cursor", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-followers-list", "Uri": "https://api.twitter.com/1.1/followers/list.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "UserId", "Description": "The ID of the user for whom to return results.", "Name": "user_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": 123456789 }, { "PSParameter": "ScreenName", "Description": "The screen name of the user for whom to return results.", "Name": "screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "twitterdev" }, { "PSParameter": null, "Description": "Causes the results to be broken into pages. If no cursor is provided, a value of -1 will be assumed, which is the first page.\n The response from the API will include a previous_cursor and next_cursor to allow paging back and forth. See Using cursors to navigate collections for more information.", "Name": "cursor", "DefaultValue": -1, "Required": "semi-optional", "Implemented": true, "Example": 12893764510938 }, { "Implemented": true, "Example": 42, "Name": "count", "MaxValue": 200, "Description": "The number of users to return per page, up to a maximum of 200. Defaults to 20.", "Required": "optional", "DefaultValue": 20, "PSParameter": "Count", "MinValue": 1 }, { "PSParameter": "SkipStatus", "Description": "When set to either true, t or 1, statuses will not be included in the returned user objects. If set to any other value, statuses will be included.", "Name": "skip_status", "DefaultValue": "false", "Required": "optional", "Implemented": true, "Example": "false" }, { "PSParameter": "ExcludeEntities", "Description": "The user object entities node will not be included when set to false.", "Name": "include_entities", "DefaultValue": "true", "Required": "optional", "Implemented": true, "Example": "false" } ], "Function": "Get-TwitterFollowers", "Resource": "followers/list", "Description": "Returns a cursored collection of user objects for users following the specified user.\nAt this time, results are ordered with the most recent following first — however, this ordering is subject to unannounced change and eventual consistency issues. Results are given in groups of 20 users and multiple pages of results can be navigated through using the next_cursor value in subsequent requests. See Using cursors to navigate collections for more information." } }, "mutes": { "GET mutes/users/list": { "Iteration": "Cursor", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-mutes-users-list", "Uri": "https://api.twitter.com/1.1/mutes/users/list.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": null, "Description": "Causes the list of IDs to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out. If no cursor is provided, a value of -1 will be assumed, which is the first page.\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and forth. See Using cursors to navigate collections for more information.", "Name": "cursor", "DefaultValue": -1, "Required": "optional", "Implemented": true, "Example": 2 }, { "PSParameter": "ExcludeEntities", "Description": "The entities node will not be included when set to false.", "Name": "include_entities", "DefaultValue": true, "Required": "optional", "Implemented": true, "Example": false }, { "PSParameter": "SkipStatus", "Description": "When set to either true , t or 1 statuses will not be included in the returned user objects.", "Name": "skip_status", "DefaultValue": false, "Required": "optional", "Implemented": true, "Example": true } ], "Function": "Get-TwitterMutedUser", "Resource": "mutes/users/list", "Description": "Returns an array of user objects the authenticating user has muted." }, "GET mutes/users/ids": { "Iteration": "Cursor", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-mutes-users-ids", "Uri": "https://api.twitter.com/1.1/mutes/users/ids.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": null, "Description": "Many programming environments will not consume Twitter IDs due to their size. Provide this option to have IDs returned as strings instead. Read more about Twitter IDs.", "Name": "stringify_ids", "DefaultValue": false, "Required": "optional", "Implemented": false, "Example": true }, { "PSParameter": null, "Description": "Causes the list of IDs to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out. If no cursor is provided, a value of -1 will be assumed, which is the first page.\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and forth. See Using cursors to navigate collections for more information.", "Name": "cursor", "DefaultValue": -1, "Required": "optional", "Implemented": true, "Example": 2 } ], "Function": "Get-TwitterMutedUser", "Resource": "mutes/users/ids", "Description": "Returns an array of numeric user ids the authenticating user has muted." } }, "friends": { "GET friends/ids": { "Iteration": "Cursor", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids", "Uri": "https://api.twitter.com/1.1/friends/ids.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "UserId", "Description": "The ID of the user for whom to return results.", "Name": "user_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": 123456789 }, { "PSParameter": "ScreenName", "Description": "The screen name of the user for whom to return results.", "Name": "screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "twitterdev" }, { "PSParameter": null, "Description": "Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first page.\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and forth. See Using cursors to navigate collections for more information.", "Name": "cursor", "DefaultValue": -1, "Required": "semi-optional", "Implemented": true, "Example": 12893764510938 }, { "PSParameter": null, "Description": "Some programming environments will not consume Twitter IDs due to their size. Provide this option to have IDs returned as strings instead. More about Twitter IDs.", "Name": "stringify_ids", "DefaultValue": "false", "Required": "optional", "Implemented": false, "Example": "true" }, { "Implemented": true, "Example": 2048, "Name": "count", "MaxValue": 5000, "Description": "Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of count is best thought of as a limit to the number of results to return. When using the count parameter with this method, it is wise to use a consistent count value across all requests to the same user's collection. Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.", "Required": "optional", "DefaultValue": null, "PSParameter": "Count", "MinValue": 1 } ], "Function": "Get-TwitterFriends", "Resource": "friends/ids", "Description": "Returns a cursored collection of user IDs for every user the specified user is following (otherwise known as their friends).\nAt this time, results are ordered with the most recent following first — however, this ordering is subject to unannounced change and eventual consistency issues. Results are given in groups of 5,000 user IDs and multiple pages of results can be navigated through using the next_cursor value in subsequent requests. See Using cursors to navigate collections for more information.\nThis method is especially powerful when used in conjunction with GET users / lookup, a method that allows you to convert user IDs into full user objects in bulk." }, "GET friends/list": { "Iteration": "Cursor", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friends-list", "Uri": "https://api.twitter.com/1.1/friends/list.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "UserId", "Description": "The ID of the user for whom to return results.", "Name": "user_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": 123456789 }, { "PSParameter": "ScreenName", "Description": "The screen name of the user for whom to return results", "Name": "screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "twitterdev" }, { "PSParameter": null, "Description": "Causes the results to be broken into pages. If no cursor is provided, a value of -1 will be assumed, which is the first page.\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and forth. See Using cursors to navigate collections for more information.", "Name": "cursor", "DefaultValue": -1, "Required": "semi-optional", "Implemented": true, "Example": 12893764510938 }, { "Implemented": true, "Example": 42, "Name": "count", "MaxValue": 200, "Description": "The number of users to return per page, up to a maximum of 200.", "Required": "optional", "DefaultValue": 20, "PSParameter": "Count", "MinValue": 1 }, { "PSParameter": "SkipStatus", "Description": "When set to either true, t or 1 statuses will not be included in the returned user objects.", "Name": "skip_status", "DefaultValue": "false", "Required": "optional", "Implemented": true, "Example": "false" }, { "PSParameter": "ExcludeEntities", "Description": "The user object entities node will not be included when set to false.", "Name": "include_entities", "DefaultValue": "true", "Required": "optional", "Implemented": true, "Example": "false" } ], "Function": "Get-TwitterFriends", "Resource": "friends/list", "Description": "Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their friends).\nAt this time, results are ordered with the most recent following first — however, this ordering is subject to unannounced change and eventual consistency issues. Results are given in groups of 20 users and multiple pages of results can be navigated through using the next_cursor value in subsequent requests. See Using cursors to navigate collections for more information." } }, "saved_searches": { "POST saved_searches/create": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-create", "Uri": "https://api.twitter.com/1.1/saved_searches/create.json", "Method": "POST", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "SearchString", "Description": "The query of the search the user would like to save", "Name": "query", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": null } ], "Function": "Add-TwitterSavedSearch", "Resource": "saved_searches/create", "Description": "Create a new saved search for the authenticated user. A user may only have 25 saved searches." }, "GET saved_searches/list": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list", "Uri": "https://api.twitter.com/1.1/saved_searches/list.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": null, "Function": "Get-TwitterSavedSearch", "Resource": "saved_searches/list", "Description": "Returns the authenticated user's saved search queries." }, "GET saved_searches/show/:id": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list", "Uri": "https://api.twitter.com/1.1/saved_searches/show/:id.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "SearchId", "Description": "The ID of the saved search.", "Name": "id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": "313006" } ], "Function": "Get-TwitterSavedSearch", "Resource": "saved_searches/show/:id", "Description": "Retrieve the information for the saved search represented by the given id. The authenticating user must be the owner of saved search ID being requested." }, "POST saved_searches/destroy/:id": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-destroy-id", "Uri": "https://api.twitter.com/1.1/saved_searches/destroy/:id.json", "Method": "POST", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "SearchId", "Description": "The ID of the saved search.", "Name": "id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": 313006 } ], "Function": "Remove-TwitterSavedSearch", "Resource": "saved_searches/destroy/:id", "Description": "Destroys a saved search for the authenticating user. The authenticating user must be the owner of saved search id being destroyed." } }, "account": { "METHOD account/verify_credentials": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials", "Uri": "https://api.twitter.com/1.1/account/verify_credentials.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": null, "Description": "The entities node will not be included when set to false.", "Name": "include_entities", "DefaultValue": true, "Required": "optional", "Implemented": false, "Example": false }, { "PSParameter": null, "Description": "When set to either true , t or 1 statuses will not be included in the returned user objects.", "Name": "skip_status", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "false" }, { "PSParameter": null, "Description": "When set to true email will be returned in the user objects as a string. If the user does not have an email address on their account, or if the email address is not verified, null will be returned.", "Name": "include_email", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "false" } ], "Function": "Test-TwitterAuthentication", "Resource": "account/verify_credentials", "Description": "Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not. Use this method to test if supplied user credentials are valid." }, "GET account/settings": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-account-settings", "Uri": "https://api.twitter.com/1.1/account/settings.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": null, "Function": "Get-TwitterAccountSettings", "Resource": "account/settings", "Description": "Returns settings (including current trend, geo and sleep time information) for the authenticating user." } }, "statuses": { "GET statuses/home_timeline": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-home_timeline", "Uri": "https://api.twitter.com/1.1/statuses/home_timeline.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "Implemented": false, "Example": 5, "Name": "count", "MaxValue": 200, "Description": "Specifies the number of records to retrieve. Must be less than or equal to 200. Defaults to 20. The value of count is best thought of as a limit to the number of tweets to return because suspended or deleted content is removed after the count has been applied.", "Required": "optional", "DefaultValue": 20, "PSParameter": null, "MinValue": 1 }, { "PSParameter": null, "Description": "Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.", "Name": "since_id", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": 123456 }, { "PSParameter": null, "Description": "Returns results with an ID less than (that is, older than) or equal to the specified ID.", "Name": "max_id", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": 654321 }, { "PSParameter": null, "Description": "When set to either true , t or 1 , each Tweet returned in a timeline will include a user object including only the status authors numerical ID. Omit this parameter to receive the complete user object.", "Name": "trim_user", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": true }, { "PSParameter": "ExcludeRetweets", "Description": "This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count tweets — this is because the count parameter retrieves that many Tweets before filtering out retweets and replies.", "Name": "exclude_replies", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": true }, { "PSParameter": null, "Description": "The entities node will not be included when set to false.", "Name": "include_entities", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": false } ], "Function": "Get-TwitterTimeline", "Resource": "statuses/home_timeline", "Description": "Returns a collection of the most recent Tweets and Retweets posted by the authenticating user and the users they follow. The home timeline is central to how most users interact with the Twitter service.\nUp to 800 Tweets are obtainable on the home timeline. It is more volatile for users that follow many users or follow users who Tweet frequently." }, "GET statuses/show/:id": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-show-id", "Uri": "https://api.twitter.com/1.1/statuses/show.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "TweetId", "Description": "The numerical ID of the desired Tweet.", "Name": "id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": "123456789" }, { "PSParameter": null, "Description": "When set to either true , t or 1 , each Tweet returned in a timeline will include a user object including only the status authors numerical ID. Omit this parameter to receive the complete user object.", "Name": "trim_user", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "true" }, { "PSParameter": null, "Description": "When set to either true , t or 1 , any Tweets returned that have been retweeted by the authenticating user will include an additional current_user_retweet node, containing the ID of the source status for the retweet.", "Name": "include_my_retweet", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "true" }, { "PSParameter": null, "Description": "The entities node will not be included when set to false.", "Name": "include_entities", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "false" }, { "PSParameter": null, "Description": "If alt text has been added to any attached media entities, this parameter will return an ext_alt_text value in the top-level key for the media entity. If no value has been set, this will be returned as null.", "Name": "include_ext_alt_text", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "true" }, { "PSParameter": null, "Description": "When set to either true , t or 1 , the retrieved Tweet will include a card_uri attribute when there is an ads card attached to the Tweet and when that card was attached using the card_uri value.", "Name": "include_card_uri", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "true" } ], "Function": "Get-Tweet", "Resource": "statuses/show/:id", "Description": "Returns a single Tweet, specified by the id parameter. The Tweet's author will also be embedded within the Tweet.\nSee GET statuses / lookup for getting Tweets in bulk (up to 100 per call)." }, "GET statuses/user_timeline": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-user_timeline", "Uri": "https://api.twitter.com/1.1/statuses/user_timeline.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "UserId", "Description": "The ID of the user for whom to return results.", "Name": "user_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": 123456 }, { "PSParameter": "ScreenName", "Description": "The screen name of the user for whom to return results.", "Name": "screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "noradio" }, { "PSParameter": null, "Description": "Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occurred since the since_id, the since_id will be forced to the oldest ID available.", "Name": "since_id", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": 123456 }, { "Implemented": false, "Example": null, "Name": "count", "MaxValue": 200, "Description": "Specifies the number of Tweets to try and retrieve, up to a maximum of 200 per distinct request. The value of count is best thought of as a limit to the number of Tweets to return because suspended or deleted content is removed after the count has been applied. We include retweets in the count, even if include_rts is not supplied. It is recommended you always send include_rts=1 when using this API method.", "Required": "optional", "DefaultValue": 20, "PSParameter": null, "MinValue": 1 }, { "PSParameter": null, "Description": "Returns results with an ID less than (that is, older than) or equal to the specified ID.", "Name": "max_id", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": 654321 }, { "PSParameter": null, "Description": "When set to either true , t or 1 , each Tweet returned in a timeline will include a user object including only the status authors numerical ID. Omit this parameter to receive the complete user object.", "Name": "trim_user", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": true }, { "PSParameter": "ExcludeRetweets", "Description": "This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count tweets — this is because the count parameter retrieves that many Tweets before filtering out retweets and replies.", "Name": "exclude_replies", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": true }, { "PSParameter": null, "Description": "When set to false , the timeline will strip any native retweets (though they will still count toward both the maximal length of the timeline and the slice selected by the count parameter). Note: If you're using the trim_user parameter in conjunction with include_rts, the retweets will still contain a full user object.", "Name": "include_entities", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": false } ], "Function": "Get-TwitterTimeline", "Resource": "statuses/user_timeline", "Description": "Returns a collection of the most recent Tweets posted by the user indicated by the screen_name or user_id parameters.\nUser timelines belonging to protected users may only be requested when the authenticated user either owns the timeline or is an approved follower of the owner.\nThe timeline returned is the equivalent of the one seen as a user's profile on Twitter.\nThis method can only return up to 3,200 of a user's most recent Tweets. Native retweets of other statuses by the user is included in this total, regardless of whether include_rts is set to false when requesting this resource." }, "GET statuses/mentions_timeline": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-mentions_timeline", "Uri": "https://api.twitter.com/1.1/statuses/mentions_timeline.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "Implemented": false, "Example": null, "Name": "count", "MaxValue": 200, "Description": "Specifies the number of Tweets to try and retrieve, up to a maximum of 200. The value of count is best thought of as a limit to the number of tweets to return because suspended or deleted content is removed after the count has been applied. We include retweets in the count, even if include_rts is not supplied. It is recommended you always send include_rts=1 when using this API method.", "Required": "optional", "DefaultValue": 20, "PSParameter": null, "MinValue": 1 }, { "PSParameter": null, "Description": "Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occurred since the since_id, the since_id will be forced to the oldest ID available.", "Name": "since_id", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": 123456 }, { "PSParameter": null, "Description": "Returns results with an ID less than (that is, older than) or equal to the specified ID.", "Name": "max_id", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": 654321 }, { "PSParameter": null, "Description": "When set to either true , t or 1 , each tweet returned in a timeline will include a user object including only the status authors numerical ID. Omit this parameter to receive the complete user object.", "Name": "trim_user", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": true }, { "PSParameter": null, "Description": "The entities node will not be included when set to false.", "Name": "include_entities", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": false } ], "Function": "Get-TwitterTimeline", "Resource": "statuses/mentions_timeline", "Description": "Returns the 20 most recent mentions (Tweets containing a users's @screen_name) for the authenticating user.\nThe timeline returned is the equivalent of the one seen when you view your mentions on twitter.com.\nThis method can only return up to 800 tweets.\nSee Working with Timelines for instructions on traversing timelines." }, "POST statuses/retweet/:id": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-retweet-id", "Uri": "https://api.twitter.com/1.1/statuses/retweet/:id.json", "Method": "POST", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "Id", "Description": "The numerical ID of the desired status.", "Name": "id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": 123456 }, { "PSParameter": null, "Description": "When set to either true , t or 1 , each tweet returned in a timeline will include a user object including only the status authors numerical ID. Omit this parameter to receive the complete user object.", "Name": "trim_user", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": true } ], "Function": "Set-Retweet", "Resource": "statuses/retweet/:id", "Description": "Retweets a tweet. Returns the original Tweet with Retweet details embedded.\nUsage Notes:\nThis method is subject to update limits. A HTTP 403 will be returned if this limit as been hit.\nTwitter will ignore attempts to perform duplicate retweets.\nThe retweet_count will be current as of when the payload is generated and may not reflect the exact count. It is intended as an approximation." }, "POST statuses/update": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-update", "Uri": "https://api.twitter.com/1.1/statuses/update.json", "Method": "POST", "ApiVersion": "v1.1", "Parameters": [ { "Implemented": true, "Example": "Hello World!", "Name": "status", "MaxValue": "maximum value", "Description": "The text of the status update. URL encode as necessary. t.co link wrapping will affect character counts.", "Required": "required", "DefaultValue": null, "PSParameter": "TweetText", "MinValue": "minimum value" }, { "PSParameter": "ReplyToTweeet", "Description": "The ID of an existing status that the update is in reply to. Note: This parameter will be ignored unless the author of the Tweet this parameter references is mentioned within the status text. Therefore, you must include @username , where username is the author of the referenced Tweet, within the update.", "Name": "in_reply_to_status_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": 1234567890 }, { "PSParameter": null, "Description": "If set to true and used with in_reply_to_status_id, leading @mentions will be looked up from the original Tweet, and added to the new Tweet from there. This wil append @mentions into the metadata of an extended Tweet as a reply chain grows, until the limit on @mentions is reached. In cases where the original Tweet has been deleted, the reply will fail.", "Name": "auto_populate_reply_metadata", "DefaultValue": false, "Required": "optional", "Implemented": true, "Example": true }, { "PSParameter": null, "Description": "When used with auto_populate_reply_metadata, a comma-separated list of user ids which will be removed from the server-generated @mentions prefix on an extended Tweet. Note that the leading @mention cannot be removed as it would break the in-reply-to-status-id semantics. Attempting to remove it will be silently ignored.", "Name": "exclude_reply_user_ids", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "786491,54931584" }, { "PSParameter": null, "Description": "In order for a URL to not be counted in the status body of an extended Tweet, provide a URL as a Tweet attachment. This URL must be a Tweet permalink, or Direct Message deep link. Arbitrary, non-Twitter URLs must remain in the status text. URLs passed to the attachment_url parameter not matching either a Tweet permalink or Direct Message deep link will fail at Tweet creation and cause an exception.", "Name": "attachment_url", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "https://twitter.com/andypiper/status/903615884664725505" }, { "PSParameter": "MediaId", "Description": "A comma-delimited list of media_ids to associate with the Tweet. You may include up to 4 photos or 1 animated GIF or 1 video in a Tweet. See Uploading Media for further details on uploading media.", "Name": "media_ids", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "471592142565957632" }, { "PSParameter": "Sensitive", "Description": "If you upload Tweet media that might be considered sensitive content such as nudity, or medical procedures, you must set this value to true. See Media setting and best practices for more context.", "Name": "possibly_sensitive", "DefaultValue": false, "Required": "optional", "Implemented": false, "Example": true }, { "PSParameter": null, "Description": "The latitude of the location this Tweet refers to. This parameter will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there is no corresponding long parameter.", "Name": "lat", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "37.7821120598956" }, { "PSParameter": null, "Description": "The longitude of the location this Tweet refers to. The valid ranges for longitude are -180.0 to +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if geo_enabled is turned off, or if there no corresponding lat parameter.", "Name": "long", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "-122.400612831116" }, { "PSParameter": "Place", "Description": "A place in the world.", "Name": "place_id", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "df51dec6f4ee2b2c" }, { "PSParameter": null, "Description": "Whether or not to put a pin on the exact coordinates a Tweet has been sent from.", "Name": "display_coordinates", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": true }, { "PSParameter": null, "Description": "When set to either true , t or 1 , the response will include a user object including only the author's ID. Omit this parameter to receive the complete user object.", "Name": "trim_user", "DefaultValue": false, "Required": "optional", "Implemented": false, "Example": true }, { "PSParameter": null, "Description": "When set to true, enables shortcode commands for sending Direct Messages as part of the status text to send a Direct Message to a user. When set to false, it turns off this behavior and includes any leading characters in the status text that is posted.", "Name": "enable_dmcommands", "DefaultValue": false, "Required": "optional", "Implemented": false, "Example": true }, { "PSParameter": null, "Description": "When set to true, causes any status text that starts with shortcode commands to return an API error. When set to false, allows shortcode commands to be sent in the status text and acted on by the API.", "Name": "fail_dmcommands", "DefaultValue": true, "Required": "optional", "Implemented": false, "Example": false }, { "PSParameter": null, "Description": "Associate an ads card with the Tweet using the card_uri value from any ads card response.", "Name": "card_uri", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "card://853503245793641682" } ], "Function": "Publish-Tweet", "Resource": "statuses/update", "Description": "Updates the authenticating user's current status, also known as Tweeting.\nFor each update attempt, the update text is compared with the authenticating user's recent Tweets. Any attempt that would result in duplication will be blocked, resulting in a 403 error. A user cannot submit the same status twice in a row.\nWhile not rate limited by the API, a user is limited in the number of Tweets they can create at a time. If the number of updates posted by the user reaches the current allowed limit this method will return an HTTP 403 error." }, "POST statuses/unretweet/:id": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-unretweet-id", "Uri": "https://api.twitter.com/1.1/statuses/unretweet/:id.json", "Method": "POST", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "Id", "Description": "The numerical ID of the desired status.", "Name": "id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": 123456 }, { "PSParameter": null, "Description": "When set to either true , t or 1 , each tweet returned in a timeline will include a user object including only the status authors numerical ID. Omit this parameter to receive the complete user object.", "Name": "trim_user", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": true } ], "Function": "Set-Retweet", "Resource": "statuses/unretweet/:id", "Description": "Untweets a retweeted status. Returns the original Tweet with Retweet details embedded.\nUsage Notes:\nThis method is subject to update limits. A HTTP 429 will be returned if this limit has been hit.\nThe untweeted retweet status ID must be authored by the user backing the authentication token.\nAn application must have write privileges to POST. A HTTP 401 will be returned for read-only applications.\nWhen passing a source status ID instead of the retweet status ID a HTTP 200 response will be returned with the same Tweet object but no action." } }, "help": { "GET help/languages": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/developer-utilities/supported-languages/api-reference/get-help-languages", "Uri": "https://api.twitter.com/1.1/help/languages.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": null, "Function": "Get-TwitterLanguages", "Resource": "help/languages", "Description": "Returns the list of languages supported by Twitter along with the language code supported by Twitter.\n The language code may be formatted as ISO 639-1 alpha-2 (en), ISO 639-3 alpha-3 (msa), or ISO 639-1 alpha-2 combined with an ISO 3166-1 alpha-2 localization (zh-tw)" }, "GET help/configuration": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/developer-utilities/configuration/api-reference/get-help-configuration", "Uri": "https://api.twitter.com/1.1/help/configuration.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": null, "Function": "Get-TwitterConfiguration", "Resource": "help/configuration", "Description": "Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co shortened URL length.\nIt is recommended applications request this endpoint when they are loaded, but no more than once a day." } }, "media": { "POST media/upload (INIT)": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-init", "Uri": "https://upload.twitter.com/1.1/media/upload.json", "Method": "POST", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": null, "Description": "Must be set to INIT (case sensitive).", "Name": "command", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": "INIT" }, { "PSParameter": null, "Description": "The size of the media being uploaded in bytes.", "Name": "total_bytes", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": 987654 }, { "PSParameter": null, "Description": "The MIME type of the media being uploaded.", "Name": "media_type", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": "video/mp4" }, { "PSParameter": null, "Description": "A string enum value which identifies a media usecase. This identifier is used to enforce usecase specific constraints (e.g. file size, video duration) and enable advanced features.", "Name": "media_category", "DefaultValue": null, "Required": "sometimes", "Implemented": true, "Example": null }, { "PSParameter": null, "Description": "A comma-separated list of user IDs to set as additional owners allowed to use the returned media_id in Tweets or Cards. Up to 100 additional owners may be specified.", "Name": "additional_owners", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null } ], "Function": "Send-TwitterMedia", "Resource": "media/upload", "Description": "The INIT command request is used to initiate a file upload session. It returns a media_id which should be used to execute all subsequent requests. The next step after a successful return from INIT command is the APPEND command." }, "POST media/metadata/create": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-metadata-create", "Uri": "https://upload.twitter.com/1.1/media/metadata/create.json", "Method": "POST", "ApiVersion": "v1.1", "Parameters": null, "Function": "Set-TwitterMediaAltImageText", "Resource": "media/metadata/create", "Description": "This endpoint can be used to provide additional information about the uploaded media_id. This feature is currently only supported for images and GIFs." }, "POST media/upload (APPEND)": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-append", "Uri": "https://upload.twitter.com/1.1/media/upload.json", "Method": "POST", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": null, "Description": "Must be set to APPEND (case sensitive).", "Name": "command", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": "APPEND" }, { "PSParameter": null, "Description": "The media_id returned from the INIT command.", "Name": "media_id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": 123456789 }, { "PSParameter": null, "Description": "The raw binary file content being uploaded. It must be <= 5 MB, and cannot be used with media_data.", "Name": "media", "DefaultValue": null, "Required": "required", "Implemented": false, "Example": null }, { "PSParameter": null, "Description": "The base64-encoded chunk of media file. It must be <= 5 MB and cannot be used with media. Use raw binary (media parameter) when possible.", "Name": "media_data", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": null }, { "PSParameter": null, "Description": "An ordered index of file chunk. It must be between 0-999 inclusive. The first segment has index 0, second segment has index 1, and so on.", "Name": "segment_index", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null } ], "Function": "Send-TwitterMedia", "Resource": "media/upload", "Description": "The APPEND command is used to upload a chunk (consecutive byte range) of the media file. For example, a 3 MB file could be split into 3 chunks of size 1 MB, and uploaded using 3 APPEND command requests. After the entire file is uploaded, the next step is to call the FINALIZE command.\nThere are a number of advantages of uploading a media file in small chunks:\nImproved reliability and success rates under low bandwidth network conditions\nUploads can be paused and resumed\nFile chunks can be retried individually\nAbility to tune chunk sizes to match changing network conditions e.g on cellular clients" }, "POST media/upload (FINALIZE)": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-finalize", "Uri": "https://upload.twitter.com/1.1/media/upload.json", "Method": "POST", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": null, "Description": "Must be set to FINALIZE (case sensitive).", "Name": "command", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": "FINALIZE" }, { "PSParameter": null, "Description": "The media_id returned from the INIT command.", "Name": "media_id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": 123456789 } ], "Function": "Send-TwitterMedia", "Resource": "media/upload", "Description": "The FINALIZE command should be called after the entire media file is uploaded using APPEND commands. If and (only if) the response of the FINALIZE command contains a processing_info field, it may also be necessary to use a STATUS command and wait for it to return success before proceeding to Tweet creation." } }, "direct_messages": { "DELETE direct_messages/events/destroy": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/delete-message-event", "Uri": "https://api.twitter.com/1.1/direct_messages/events/destroy.json", "Method": "DELETE", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "DirectMessageId", "Description": "The id of the Direct Message event that should be deleted.", "Name": "id ", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": null } ], "Function": "Unpublish-TwitterDM", "Resource": "direct_messages/events/destroy", "Description": "Deletes the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message. Direct Messages are only removed from the interface of the user context provided. Other members of the conversation can still access the Direct Messages. A successful delete will return a 204 http response code with no body content.\nImportant: This method requires an access token with RWD (read, write & direct message) permissions." }, "GET direct_messages/events/list": { "Iteration": "Cursor", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/list-events", "Uri": "https://api.twitter.com/1.1/direct_messages/events/list.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "Implemented": true, "Example": 5, "Name": "count", "MaxValue": 50, "Description": "Max number of events to be returned. 20 default. 50 max.", "Required": "optional", "DefaultValue": 20, "PSParameter": "Count", "MinValue": 1 }, { "PSParameter": null, "Description": "For paging through result sets greater than 1 page, use the “next_cursor” property from the previous request.", "Name": "cursor", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": null } ], "Function": "Get-TwitterDM", "Resource": "direct_messages/events/list", "Description": "Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order." }, "GET direct_messages/events/show": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/get-event", "Uri": "https://api.twitter.com/1.1/direct_messages/events/show.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "DirectMessageId", "Description": "The id of the Direct Message event that should be returned.", "Name": "id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": 110 } ], "Function": "Get-TwitterDM", "Resource": "direct_messages/events/show", "Description": "Returns a single Direct Message event by the given id." }, "POST direct_messages/events/new": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/new-event", "Uri": "https://api.twitter.com/1.1/direct_messages/events/new.json", "Method": "POST", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": null, "Description": "The type of event you are posting. For Direct Messages, use message_create.", "Name": "type", "DefaultValue": "message_create", "Required": "required", "Implemented": true, "Example": "message_create" }, { "PSParameter": "UserId", "Description": "The ID of the user who should receive the direct message.", "Name": "message_create.target.recipient_id", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": 123456789654 }, { "PSParameter": "", "Description": "The Message Data Object defining the content to deliver to the recipient.", "Name": "message_create.message_data", "DefaultValue": null, "Required": "required or optional", "Implemented": true, "Example": "[message data object]" }, { "PSParameter": "Message", "Description": "The text of your Direct Message. URL encode as necessary. Max length of 10,000 characters. Max length of 9,990 characters if used as a Welcome Message.", "Name": "text", "DefaultValue": null, "Required": "required", "Implemented": true, "Example": "Sending a direct message." }, { "PSParameter": null, "Description": "The Quick Reply type to present to the user (example requests below):\noptions - Array of Options objects (20 max).\ntext_input - Text Input object.\nlocation - Location object.", "Name": "quick_reply.type", "DefaultValue": "default value of parameter 2", "Required": "optional", "Implemented": false, "Example": "example of parameter 2" }, { "PSParameter": null, "Description": "The attachment type. Can be media or location.", "Name": "attachment.type", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": null }, { "PSParameter": "MediaId", "Description": "A media id to associate with the message. A Direct Message may only reference a single media_id. See Uploading Media for further details on uploading media.", "Name": "attachment.media.id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": 654987321 } ], "Function": "Publish-TwitterDM", "Resource": "direct_messages/events/new", "Description": "Publishes a new message_create event resulting in a Direct Message sent to a specified user from the authenticating user. Returns an event if successful. Supports publishing Direct Messages with optional Quick Reply and media attachment. Replaces behavior currently provided by POST direct_messages/new.\nRequires a JSON POST body and Content-Type header to be set to application/json. Setting Content-Length may also be required if it is not automatically." } }, "blocks": { "GET blocks/list": { "Iteration": "Cursor", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list", "Uri": "https://api.twitter.com/1.1/blocks/list.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "ExcludeEntities", "Description": "The entities node will not be included when set to false.", "Name": "include_entities", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "false" }, { "PSParameter": "SkipStatus", "Description": "When set to either true , t or 1 statuses will not be included in the returned user objects.", "Name": "skip_status", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "false" }, { "PSParameter": null, "Description": "Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first page.\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and forth. See Using cursors to navigate collections for more information.", "Name": "cursor", "DefaultValue": null, "Required": "semi-optional", "Implemented": true, "Example": 12893764510938 } ], "Function": "Get-TwitterBlocks", "Resource": "blocks/list", "Description": "Returns a collection of user objects that the authenticating user is blocking.\nImportant This method is cursored, meaning your app must make multiple requests in order to receive all blocks correctly. See Using cursors to navigate collections for more details on how cursoring works." }, "GET blocks/ids": { "Iteration": "Cursor", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-blocks-ids", "Uri": "https://api.twitter.com/1.1/blocks/ids.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": null, "Description": "Many programming environments will not consume Twitter IDs due to their size. Provide this option to have IDs returned as strings instead. Read more about Twitter IDs.", "Name": "stringify_ids", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "true" }, { "PSParameter": null, "Description": "Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first page.\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and forth. See Using cursors to navigate collections for more information.", "Name": "cursor", "DefaultValue": -1, "Required": "semi-optional", "Implemented": true, "Example": 12893764510938 } ], "Function": "Get-TwitterBlocks", "Resource": "GET blocks/ids", "Description": "Returns an array of numeric user ids the authenticating user is blocking.\nImportant This method is cursored, meaning your app must make multiple requests in order to receive all blocks correctly. See Using cursors to navigate collections for more details on how cursoring works." } }, "friendships": { "GET friendships/outgoing": { "Iteration": "Cursor", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-outgoing", "Uri": "https://api.twitter.com/1.1/friendships/outgoing.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": null, "Description": "Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first page.\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and forth. See Using cursors to navigate collections for more information.", "Name": "cursor", "DefaultValue": -1, "Required": "semi-optional", "Implemented": true, "Example": "12893764510938" }, { "PSParameter": null, "Description": "Some programming environments will not consume Twitter IDs due to their size. Provide this option to have IDs returned as strings instead. More about Twitter IDs.", "Name": "stringify_ids", "DefaultValue": false, "Required": "optional", "Implemented": false, "Example": "true" } ], "Function": "Get-TwitterFriendship", "Resource": "friendships/outgoing", "Description": "Returns a collection of numeric IDs for every protected user for whom the authenticating user has a pending follow request." }, "GET friendships/show": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-show", "Uri": "https://api.twitter.com/1.1/friendships/show.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "SourceScreenName", "Description": "The user_id of the subject user.", "Name": "source_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "783214" }, { "PSParameter": "SourceUserId", "Description": "The screen_name of the subject user.", "Name": "source_screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "Twitter" }, { "PSParameter": "TargetUserId", "Description": "The user_id of the target user.", "Name": "target_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "2244994945" }, { "PSParameter": "TargetScreenName", "Description": "The screen_name of the target user.", "Name": "target_screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "example of parameter 2" } ], "Function": "Get-TwitterFriendship", "Resource": "friendships/show", "Description": "Returns detailed information about the relationship between two arbitrary users." }, "GET friendships/no_retweets/ids": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-no_retweets-ids", "Uri": "https://api.twitter.com/1.1/friendships/no_retweets/ids.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": null, "Description": "Some programming environments will not consume Twitter IDs due to their size. Provide this option to have IDs returned as strings instead. Read more about Twitter IDs. This parameter is important to use in Javascript environments.", "Name": "stringify_ids", "DefaultValue": false, "Required": "optional", "Implemented": false, "Example": "true" } ], "Function": "Get-TwitterFriendship", "Resource": "friendships/no_retweets/ids", "Description": "Returns a collection of user_ids that the currently authenticated user does not want to receive retweets from.\nUse POST friendships / update to set the 'no retweets' status for a given user account on behalf of the current user." }, "GET friendships/incoming": { "Iteration": "Cursor", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming", "Uri": "https://api.twitter.com/1.1/friendships/incoming.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": null, "Description": "Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first page.\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and forth.", "Name": "cursor", "DefaultValue": -1, "Required": "semi-optional", "Implemented": true, "Example": "12893764510938" }, { "PSParameter": null, "Description": "Many programming environments will not consume our Tweet ids due to their size. Provide this option to have ids returned as strings instead.", "Name": "stringify_ids", "DefaultValue": null, "Required": "optional", "Implemented": false, "Example": "true" } ], "Function": "Get-TwitterFriendship", "Resource": "friendships/incoming", "Description": "Returns a collection of numeric IDs for every user who has a pending request to follow the authenticating user." }, "GET friendships/lookup": { "Iteration": "None", "ApiReference": "https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-lookup", "Uri": "https://api.twitter.com/1.1/friendships/lookup.json", "Method": "GET", "ApiVersion": "v1.1", "Parameters": [ { "PSParameter": "ScreenName", "Description": "A comma separated list of screen names, up to 100 are allowed in a single request.", "Name": "screen_name", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "twitterapi,twitter" }, { "PSParameter": "UserId", "Description": "A comma separated list of user IDs, up to 100 are allowed in a single request.", "Name": "user_id", "DefaultValue": null, "Required": "optional", "Implemented": true, "Example": "783214,6253282" } ], "Function": "Get-TwitterFriendship", "Resource": "friendships/lookup", "Description": "Returns the relationships of the authenticating user to the comma-separated list of up to 100 screen_names or user_ids provided. Values for connections can be: following, following_requested, followed_by, none, blocking, muting." } } } |