openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 108 kB
JSON
{"openapi":"3.0.0","info":{"contact":{"email":"support@twitter.com","name":"Twitter support","url":"https://dev.twitter.com","x-twitter":"twitter"},"title":"Twitter API","version":"1.1","x-apisguru-categories":["social"],"x-logo":{"url":"https://twitter.com/twitter/profile_image?size=original"},"x-origin":[{"converter":{"url":"https://github.com/mermade/oas-kit","version":"2.6.0"},"format":"wadl","url":"http://api.apigee.com/v1/consoles/twitter/apidescription?format=wadl"},{"format":"swagger","url":"https://raw.githubusercontent.com/APIs-guru/unofficial_openapi_specs/master/twitter.com/1.1/twitter.json","version":"2.0"}],"x-providerName":"twitter.com","x-serviceName":"legacy","x-tags":["pii"],"x-unofficialSpec":true},"paths":{"/account/settings.json":{"get":{"description":"Returns settings (including\ncurrent trend, geo and sleep time information) for the authenticating user.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/account/settings"},"operationId":"account.settings.get","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"The Yahoo! Where On Earth ID to use as the user's default trend location. Global information is\navailable by using 1 as the WOEID. The woeid must be one of the locations returned by GET\ntrends/available.\n\nExample Values: 1","in":"query","name":"trend_location_woeid","required":false,"schema":{"type":"string"}},{"description":"When set to true, t or 1, will enable sleep time for the user. Sleep time is the time when push or\nSMS notifications should not be sent to the user.\n\nExample Values: true","in":"query","name":"sleep_time_enabled","required":false,"schema":{"type":"string"}},{"description":"The hour that sleep time should begin if it is enabled. The value for this parameter should be\nprovided in ISO8601 format (i.e. 00-23). The time is considered to be in the same timezone as the\nuser's time_zone setting.\n\nExample Values: 13","in":"query","name":"start_sleep_time","required":false,"schema":{"type":"string"}},{"description":"The hour that sleep time should end if it is enabled. The value for this parameter should be\nprovided in ISO8601 format (i.e. 00-23). The time is considered to be in the same timezone as the\nuser's time_zone setting.\n\nExample Values: 13","in":"query","name":"end_sleep_time","required":false,"schema":{"type":"string"}},{"description":"The timezone dates and times should be displayed in for the user. The timezone must be one of the\nRails TimeZone names.\n\nExample Values: Europe/Copenhagen, Pacific/Tongatapu","in":"query","name":"time_zone","required":false,"schema":{"type":"string"}},{"description":"The language which Twitter should render in for this user. The language must be specified by the\nappropriate two letter ISO 639-1 representation. Currently supported languages are provided by GET\nhelp/languages.\n\nExample Values: it, en, es","in":"query","name":"lang","required":false,"schema":{"type":"string"}}],"post":{"description":"Updates the\nauthenticating user's settings.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/account/settings"},"operationId":"account.settings.post","responses":{"200":{"description":"Successful Response"}}}},"/account/update_delivery_device.json":{"parameters":[{"description":"Must be one of: sms, none.\n\nExample Values: sms","in":"query","name":"device","required":true,"schema":{"type":"string"}},{"description":"When set to either true, t or 1, each tweet will include a node called \"entities,\". This node\noffers a variety of metadata about the tweet in a discreet structure, including: user_mentions,\nurls, and hashtags. While entities are opt-in on timelines at present, they will be made a default\ncomponent of output in the future. See Tweet Entities for more detail on entities.\n\nExample Values: true","in":"query","name":"include_entities","required":false,"schema":{"type":"string"}}],"post":{"description":"Sets which\ndevice Twitter delivers updates to for the authenticating user. Sending none as the device parameter\nwill disable SMS updates.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/account/update_delivery_device"},"operationId":"account.update_delivery_device","responses":{"200":{"description":"Successful Response"}}}},"/account/update_profile.json":{"parameters":[{"description":"Full name associated with the profile. Maximum of 20 characters.\n\nExample Values: Marcel Molina","in":"query","name":"name","required":false,"schema":{"type":"string"}},{"description":"URL associated with the profile. Will be prepended with \"http://\" if not present. Maximum of 100\ncharacters.\n\nExample Values: http://project.ioni.st","in":"query","name":"url","required":false,"schema":{"type":"string"}},{"description":"The city or country describing where the user of the account is located. The contents are not\nnormalized or geocoded in any way. Maximum of 30 characters.\n\nExample Values: San Francisco, CA","in":"query","name":"location","required":false,"schema":{"type":"string"}},{"description":"A description of the user owning the account. Maximum of 160 characters.\n\nExample Values: Flipped my wig at age 22 and it never grew back. Also: I work at Twitter.","in":"query","name":"description","required":false,"schema":{"type":"string"}},{"description":"The entities node will not be included when set to false.\n\nExample Values: false","in":"query","name":"include_entities","required":false,"schema":{"type":"string"}},{"description":"When set to either true, t or 1 statuses will not be included in the returned user objects.","in":"query","name":"skip_status","required":false,"schema":{"type":"string"}}],"post":{"description":"Sets values that\nusers are able to set under the Account tab of their settings page. Only the parameters specified\nwill be updated.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/account/update_profile"},"operationId":"account.update_profile","responses":{"200":{"description":"Successful Response"}}}},"/account/update_profile_background_image.json":{"parameters":[{"description":"Content type header","in":"header","name":"Content-Type","required":true,"schema":{"type":"string","default":"multipart/form-data"}},{"description":"Whether or not to tile the background image. If set to true, t or 1 the background image will\nbe displayed tiled. The image will not be tiled otherwise.","in":"query","name":"tile","required":false,"schema":{"type":"string"}},{"description":"Determines whether to display the profile background image or not. When set to true, t or 1 the\nbackground image will be displayed if an image is being uploaded with the request, or has been\nuploaded previously. An error will be returned if you try to use a background image when one is\nnot being uploaded or does not exist. If this parameter is defined but set to anything other\nthan true, t or 1, the background image will stop being used.","in":"query","name":"use","required":false,"schema":{"type":"string"}},{"description":"The entities node will not be included when set to false.\n\nExample Values: false","in":"query","name":"include_entities","required":false,"schema":{"type":"string"}},{"description":"When set to either true, t or 1 statuses will not be included in the returned user objects.","in":"query","name":"skip_status","required":false,"schema":{"type":"string"}}],"post":{"description":"Updates the authenticating user's profile background image. This method can also be used to enable\nor disable the profile background image. Although each parameter is marked as optional, at least one\nof image, tile or use must be provided when making this request.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/account/update_profile_background_image"},"operationId":"accounts.update_profile_background_image","responses":{"200":{"description":"Successful Response"}}}},"/account/update_profile_colors.json":{"parameters":[{"description":"Profile background color. Example Values: 3D3D3D","in":"query","name":"profile_background_color","required":false,"schema":{"type":"string"}},{"description":"Profile link color.Example Values: 0000FF","in":"query","name":"profile_link_color","required":false,"schema":{"type":"string"}},{"description":"Profile sidebar's border color. Example Values: 0F0F0F","in":"query","name":"profile_sidebar_border_color","required":false,"schema":{"type":"string"}},{"description":"Profile sidebar's background color. Example Values: 00FF00","in":"query","name":"profile_sidebar_fill_color","required":false,"schema":{"type":"string"}},{"description":"Profile text color. Example Values: 000000","in":"query","name":"profile_text_color","required":false,"schema":{"type":"string"}},{"description":"The entities node will not be included when set to false. Example Values: false","in":"query","name":"include_entities","required":false,"schema":{"type":"string"}},{"description":"When set to either true, t or 1 statuses will not be included in the returned user objects.","in":"query","name":"skip_status","required":false,"schema":{"type":"string"}}],"post":{"description":"Sets one or\nmore hex values that control the color scheme of the authenticating user's profile page on\ntwitter.com.\nEach parameter's value must be a valid hexidecimal value, and may be either three or six characters\n(ex: #fff or #ffffff).","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/account/update_profile_colors"},"operationId":"accounts.update_profile_colors","responses":{"200":{"description":"Successful Response"}}}},"/account/update_profile_image.json":{"parameters":[{"description":"Content type header","in":"header","name":"Content-Type","required":true,"schema":{"type":"string","default":"multipart/form-data"}},{"description":"When set to either true, t or 1 statuses will not be included in the returned user objects.","in":"query","name":"skip_status","required":false,"schema":{"type":"string"}}],"post":{"description":"Updates the\nauthenticating user's profile image. Note that this method expects raw multipart data, not a URL to\nan image. This method asynchronously processes the uploaded file before updating the user's profile\nimage URL. You can either update your local cache the next time you request the user's information,\nor, at least 5 seconds after uploading the image, ask for the updated URL using GET\nusers/profile_image/:screen_name\n(https://dev.twitter.com/docs/api/1/get/users/profile_image/:screen_name).","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/account/update_profile_image"},"operationId":"accounts.update_profile_image","responses":{"200":{"description":"Successful Response"}}}},"/application/rate_limit_status.json":{"get":{"description":"Returns the\ncurrent rate limits for\nmethods belonging to the specified resource families.\n\nEach 1.1 API resource belongs to a \"resource family\" which is indicated in its method documentation.\nYou can typically determine a method's resource family from the first component of the path after\nthe resource version.\n\nThis method responds with a map of methods belonging to the families specified by the resources\nparameter, the current remaining uses for each of those resources within the current rate limiting\nwindow, and its expiration time in epoch time. It also includes a rate_limit_context field that\nindicates the current access token context.\n\nYou may also issue requests to this method without any parameters to receive a map of all rate\nlimited GET methods. If your application only uses a few of methods, please explicitly provide a\nresources parameter with the specified resource families you work with.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/application/rate_limit_status"},"operationId":"application.rate_limit_status","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"A comma-separated list of resource families you want to know the current rate limit disposition\nfor. For best performance, only specify the resource families pertinent to your application.Example\nValues: statuses,friends,trends,help","in":"query","name":"resources","required":false,"schema":{"type":"string"}}]},"/blocks/create.json":{"parameters":[{"description":"The entities node will not be included when set to false.\n\nExample Values: false","in":"query","name":"include_entities","required":false,"schema":{"type":"string"}},{"description":"When set to either true, t or 1 statuses will not be included in the returned user objects.","in":"query","name":"skip_status","required":false,"schema":{"type":"string"}}],"post":{"description":"Blocks the specified user from\nfollowing the authenticating user. In addition the blocked user will not show in the authenticating\nusers mentions or timeline (unless retweeted by another user). If a follow or friend relationship\nexists it is destroyed.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/blocks/create"},"operationId":"blocks.create","responses":{"200":{"description":"Successful Response"}}}},"/blocks/destroy.json":{"parameters":[{"description":"The entities node will not be included when set to false.\n\nExample Values: false","in":"query","name":"include_entities","required":false,"schema":{"type":"string"}},{"description":"When set to either true, t or 1 statuses will not be included in the returned user objects.","in":"query","name":"skip_status","required":false,"schema":{"type":"string"}}],"post":{"description":"Un-blocks the user specified\nin the ID parameter for the authenticating user. Returns the un-blocked user in the requested format\nwhen successful. If relationships existed before the block was instated, they will not be restored.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/blocks/destroy"},"operationId":"blocks.destroy","responses":{"200":{"description":"Successful Response"}}}},"/blocks/ids.json":{"get":{"description":"Returns an array of numeric user\nids the authenticating user is blocking.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/blocks/ids"},"operationId":"blocks.ids","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"Many programming environments will not consume our ids due to their size. Provide this option to\nhave ids returned as strings instead. Read more about Twitter IDs, JSON and Snowflake.\n\nExample Values: true","in":"query","name":"stringify_ids","required":false,"schema":{"type":"string"}},{"description":"Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The\nnumber of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after\nconnections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first\n\"page.\"\n\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and\nforth. See Using cursors to navigate collections for more information.\n\nExample Values: 12893764510938","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}]},"/blocks/list.json":{"get":{"description":"Allows one to enable or\ndisable retweets and device notifications from the specified user.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/blocks/list"},"operationId":"blocks.list","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"The entities node will not be included when set to false. Example Values: false","in":"query","name":"include_entities","required":false,"schema":{"type":"string"}},{"description":"When set to either true, t or 1 statuses will not be included in the returned user objects.","in":"query","name":"skip_status","required":false,"schema":{"type":"string"}},{"description":"Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The\nnumber of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after\nconnections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first\n\"page.\"\n\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and\nforth. See Using cursors to navigate collections for more information.\n\nExample Values: 12893764510938","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}]},"/direct_messages.json":{"get":{"description":"Returns the 20 most recent\ndirect messages sent to the authenticating user. Includes detailed information about the sender and\nrecipient user. You can request up to 200 direct messages per call, up to a maximum of 800 incoming\nDMs.\n\nImportant: This method requires an access token with RWD (read, write and direct message)\npermissions.\nConsult The Application Permission Model for more information.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/direct_messages"},"operationId":"direct_messages","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"Specifies the number of direct messages to try and retrieve, up to a maximum of 200. The value of\ncount is best thought of as a limit to the number of Tweets to return because suspended or deleted\ncontent is removed after the count has been applied.\n\nExample Values: 5","in":"query","name":"count","required":false,"schema":{"type":"string"}},{"description":"Returns results with an ID greater than (that is, more recent than) the specified ID. There are\nlimits to the number of Tweets which can be accessed through the API. If the limit of Tweets has\noccured since the since_id, the since_id will be forced to the oldest ID available.\nExample Values: 12345","in":"query","name":"since_id","required":false,"schema":{"type":"string"}},{"description":"Returns results with an ID less than (that is, older than) or equal to the specified ID.\n\nExample Values: 54321","in":"query","name":"max_id","required":false,"schema":{"type":"string"}},{"description":"The entities node will not be included when set to false.\n\nExample Values: false","in":"query","name":"include_entities","required":false,"schema":{"type":"string"}},{"description":"Specifies the page of results to retrieve.\n\nExample Values: 3","in":"query","name":"page","required":false,"schema":{"type":"string"}},{"description":"When set to either true, t or 1 statuses will not be included in the returned user objects.","in":"query","name":"skip_status","required":false,"schema":{"type":"string"}}]},"/direct_messages/destroy.json":{"parameters":[{"description":"The ID of the direct message to delete.\n\nExample Values: 1270516771","in":"query","name":"id","required":true,"schema":{"type":"string"}},{"description":"The entities node will not be included when set to false.\n\nExample Values: false","in":"query","name":"include_entities","required":false,"schema":{"type":"string"}}],"post":{"description":"Destroys the direct\nmessage specified in the required ID parameter. The authenticating user must be the recipient of the\nspecified direct message.\n\nImportant: This method requires an access token with RWD (read, write and direct message)\npermissions.\nConsult The Application Permission Model for more information.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/direct_messages/destroy"},"operationId":"direct_messages.destroy","responses":{"200":{"description":"Successful Response"}}}},"/direct_messages/new.json":{"parameters":[{"description":"The text of your direct message. Be sure to URL encode as necessary, and keep the message under 140\ncharacters.\n\nExample Values: Meet me behind the cafeteria after school","in":"query","name":"text","required":true,"schema":{"type":"string"}}],"post":{"description":"Sends a new direct\nmessage to the specified user from the authenticating user. Requires both the user and text\nparameters and must be a POST. Returns the sent message in the requested format if successful.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/direct_messages/new"},"operationId":"direct_messages.new","responses":{"200":{"description":"Successful Response"}}}},"/direct_messages/sent.json":{"get":{"description":"Returns the 20 most\nrecent direct messages sent by the authenticating user. Includes detailed information about the\nsender and recipient user. You can request up to 200 direct messages per call, up to a maximum of\n800 outgoing DMs.\n\nImportant: This method requires an access token with RWD (read, write and direct message)\npermissions. Consult The Application Permission Model for more information.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/direct_messages/sent"},"operationId":"direct_messages.sent","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"Specifies the number of direct messages to try and retrieve, up to a maximum of 200. The value of\ncount is best thought of as a limit to the number of Tweets to return because suspended or deleted\ncontent is removed after the count has been applied.\n\nExample Values: 5","in":"query","name":"count","required":false,"schema":{"type":"string"}},{"description":"Returns results with an ID greater than (that is, more recent than) the specified ID. There are\nlimits to the number of Tweets which can be accessed through the API. If the limit of Tweets has\noccured since the since_id, the since_id will be forced to the oldest ID available.\n\nExample Values: 12345","in":"query","name":"since_id","required":false,"schema":{"type":"string"}},{"description":"Returns results with an ID less than (that is, older than) or equal to the specified ID.\n\nExample Values: 54321","in":"query","name":"max_id","required":false,"schema":{"type":"string"}},{"description":"The entities node will not be included when set to false.\n\nExample Values: false","in":"query","name":"include_entities","required":false,"schema":{"type":"string"}},{"description":"Specifies the page of results to retrieve.\n\nExample Values: 3","in":"query","name":"page","required":false,"schema":{"type":"string"}}]},"/direct_messages/show.json":{"get":{"description":"Returns a single direct\nmessage, specified by an id parameter. Like the /1.1/direct_messages.format request, this method\nwill include the user objects of the sender and recipient.\n\nImportant: This method requires an access token with RWD (read, write and direct message)\npermissions.\nConsult The Application Permission Model for more information.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/direct_messages/show"},"operationId":"direct_messages.show","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"The ID of the direct message.\n\nExample Values: 587424932","in":"query","name":"id","required":true,"schema":{"type":"string"}}]},"/favorites/create.json":{"parameters":[{"description":"The numerical ID of the desired status.\n\nExample Values: 123","in":"query","name":"id","required":true,"schema":{"type":"string"}},{"description":"The entities node will be omitted when set to false.\n\nExample Values: false","in":"query","name":"include_entities","required":false,"schema":{"type":"string"}}],"post":{"description":"Favorites the status\nspecified in the ID parameter as the authenticating user. Returns the favorite status when\nsuccessful.\n\nThis process invoked by this method is asynchronous. The immediately returned status may not\nindicate the resultant favorited status of the tweet. A 200 OK response from this method will\nindicate whether the intended action was successful or not.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/favorites/create"},"operationId":"favorites.create","responses":{"200":{"description":"Successful Response"}}}},"/favorites/destroy.json":{"parameters":[{"description":"The numerical ID of the desired status.\n\nExample Values: 123","in":"query","name":"id","required":true,"schema":{"type":"string"}},{"description":"The entities node will be omitted when set to false.\n\nExample Values: false","in":"query","name":"include_entities","required":false,"schema":{"type":"string"}}],"post":{"description":"Un-favorites the status\nspecified in the ID parameter as the authenticating user. Returns the un-favorited status in the\nrequested format when successful.\n\nThis process invoked by this method is asynchronous. The immediately returned status may not\nindicate the resultant favorited status of the tweet. A 200 OK response from this method will\nindicate whether the intended action was successful or not.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/favorites/destroy"},"operationId":"favorites.destroy","responses":{"200":{"description":"Successful Response"}}}},"/favorites/list.json":{"get":{"description":"Returns the 20 most recent\nTweets favorited by the authenticating or specified user.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/favorites/list"},"operationId":"favorites.list","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"Specifies the number of records to retrieve. Must be less than or equal to 200. Defaults to 20.\n\nExample Values: 5","in":"query","name":"count","required":false,"schema":{"type":"string"}},{"description":"Returns results with an ID greater than (that is, more recent than) the specified ID. There are\nlimits to the number of Tweets which can be accessed through the API. If the limit of Tweets has\noccured since the since_id, the since_id will be forced to the oldest ID available.\n\nExample Values: 12345","in":"query","name":"since_id","required":false,"schema":{"type":"string"}},{"description":"Returns results with an ID less than (that is, older than) or equal to the specified ID.\n\nExample Values: 54321","in":"query","name":"max_id","required":false,"schema":{"type":"string"}},{"description":"The entities node will be omitted when set to false.\n\nExample Values: false","in":"query","name":"include_entities","required":false,"schema":{"type":"string"}}]},"/followers/ids.json":{"get":{"description":"Returns a cursored collection\nof user IDs for every user following the specified user.\n\nAt this time, results are ordered with the most recent following first — however, this ordering is\nsubject to unannounced change and eventual consistency issues. Results are given in groups of 5,000\nuser IDs and multiple \"pages\" of results can be navigated through using the next_cursor value in\nsubsequent requests. See Using cursors to navigate collections for more information.\n\nThis method is especially powerful when used in conjunction with GET users/lookup, a method that\nallows you to convert user IDs into full user objects in bulk.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/followers/ids"},"operationId":"followers.ids","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"Many programming environments will not consume our Tweet ids due to their size. Provide this option\nto have ids returned as strings instead. Example Values: true","in":"query","name":"stringify_ids","required":false,"schema":{"type":"string"}},{"description":"Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The\nnumber of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after\nconnections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first\n\"page.\"\n\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and\nforth.Example Values: 12893764510938","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}]},"/friends/ids.json":{"get":{"description":"Returns a cursored collection of\nuser IDs for every user the specified user is following (otherwise known as their \"friends\").\n\nAt this time, results are ordered with the most recent following first — however, this ordering is\nsubject to unannounced change and eventual consistency issues. Results are given in groups of 5,000\nuser IDs and multiple \"pages\" of results can be navigated through using the next_cursor value in\nsubsequent requests. See Using cursors to navigate collections for more information.\n\nThis method is especially powerful when used in conjunction with GET users/lookup, a method that\nallows you to convert user IDs into full user objects in bulk.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/friends/ids"},"operationId":"friends.ids","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"Many programming environments will not consume our Tweet ids due to their size. Provide this option\nto have ids returned as strings instead. Example Values: true","in":"query","name":"stringify_ids","required":false,"schema":{"type":"string"}},{"description":"Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The\nnumber of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after\nconnections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first\n\"page.\"\n\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and\nforth.Example Values: 12893764510938","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}]},"/friendships/create.json":{"parameters":[{"description":"Enable notifications for the target user. Example Values: true","in":"query","name":"follow","required":false,"schema":{"type":"string"}}],"post":{"description":"Allows the authenticating\nusers to follow the user specified in the ID parameter.\n\nReturns the befriended user in the requested format when successful. Returns a string describing the\nfailure condition when unsuccessful. If you are already friends with the user a HTTP 403 may be\nreturned, though for performance reasons you may get a 200 OK message even if the friendship already\nexists.\n\nActions taken in this method are asynchronous and changes will be eventually consistent.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/friendships/create"},"operationId":"friendships.create","responses":{"200":{"description":"Successful Response"}}}},"/friendships/destroy.json":{"parameters":[],"post":{"description":"Allows the\nauthenticating\nuser to unfollow the user specified in the ID parameter.\n\nReturns the unfollowed user in the requested format when successful. Returns a string describing the\nfailure condition when unsuccessful.\n\nActions taken in this method are asynchronous and changes will be eventually consistent.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/friendships/destroy"},"operationId":"friendships.destroy","responses":{"200":{"description":"Successful Response"}}}},"/friendships/incoming.json":{"get":{"description":"Returns the\nrelationships\nof the authenticating user to the comma-separated list of up to 100 screen_names or user_ids\nprovided. Values for connections can be: following, following_requested, followed_by, none.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/friendships/incoming"},"operationId":"friendships.incoming","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"Many programming environments will not consume our Tweet ids due to their size. Provide this option\nto have ids returned as strings instead. Example Values: true","in":"query","name":"stringify_ids","required":false,"schema":{"type":"string"}},{"description":"Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The\nnumber of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after\nconnections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first\n\"page.\"\n\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and\nforth.Example Values: 12893764510938","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}]},"/friendships/lookup.json":{"get":{"description":"Returns the relationships\nof the authenticating user to the comma-separated list of up to 100 screen_names or user_ids\nprovided. Values for connections can be: following, following_requested, followed_by, none.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/friendships/lookup"},"operationId":"friendships.lookup","responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/friendships/outgoing.json":{"get":{"description":"Returns a collection of\nnumeric IDs for every protected user for whom the authenticating user has a pending follow request.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/friendships/outgoing"},"operationId":"friendships.outgoing","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"Many programming environments will not consume our Tweet ids due to their size. Provide this option\nto have ids returned as strings instead. Example Values: true","in":"query","name":"stringify_ids","required":false,"schema":{"type":"string"}},{"description":"Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The\nnumber of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after\nconnections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first\n\"page.\"\n\nThe response from the API will include a previous_cursor and next_cursor to allow paging back and\nforth.Example Values: 12893764510938","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}]},"/friendships/show.json":{"get":{"description":"Returns detailed information\nabout the relationship between two arbitrary users.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/friendships/show"},"operationId":"friendships.show","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"The user_id of the subject user.\n\nExample Values: 3191321","in":"query","name":"source_id","required":false,"schema":{"type":"string"}},{"description":"The screen_name of the subject user.\n\nExample Values: raffi","in":"query","name":"source_screen_name","required":false,"schema":{"type":"string"}},{"description":"The user_id of the target user.\n\nExample Values: 20","in":"query","name":"target_id","required":true,"schema":{"type":"string"}},{"description":"The screen_name of the target user.\n\nExample Values: noradio","in":"query","name":"target_screen_name","required":true,"schema":{"type":"string"}}]},"/friendships/update.json":{"parameters":[{"description":"Enable/disable device notifications from the target user. Example Values: true, false","in":"query","name":"device","required":true,"schema":{"type":"string"}},{"description":"Enable/disable retweets from the target user. Example Values: true, false","in":"query","name":"retweets","required":true,"schema":{"type":"string"}}],"post":{"description":"Allows one to enable or\ndisable retweets and device notifications from the specified user.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/friendships/update"},"operationId":"friendships.update","responses":{"200":{"description":"Successful Response"}}}},"/geo/id/{place_id}.json":{"get":{"description":"Returns all the\ninformation about a known place.Example Values: df51dec6f4ee2b2c","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/geo/id/%3Aplace_id"},"operationId":"geo.place_id","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"A place in the world. These IDs can be retrieved from geo/reverse_geocode.\n\nExample Values: df51dec6f4ee2b2c","in":"path","name":"place_id","required":true,"schema":{"type":"string"}}]},"/geo/places.json":{"parameters":[{"description":"This parameter searches for places which have this given street address. There are other\nwell-known, and application specific attributes available. Custom attributes are also permitted.\nLearn more about Place Attributes.\n\nExample Values: 795%20Folsom%20St","in":"query","name":"attribute:street_address","required":false,"schema":{"type":"string"}},{"description":"If supplied, the response will use the JSONP format with a callback of the given name.","in":"query","name":"callback","required":false,"schema":{"type":"string"}}],"post":{"description":"Creates a new place object at the\ngiven latitude and longitude.\n\nBefore creating a place you need to query GET geo/similar_places with the latitude, longitude and\nname of the place you wish to create. The query will return an array of places which are similar to\nthe one you wish to create, and a token. If the place you wish to create isn't in the returned array\nyou can use the token with this method to create a new one.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/geo/place"},"operationId":"geo.places","responses":{"200":{"description":"Successful Response"}}}},"/geo/reverse_geocode.json":{"get":{"description":"Given a latitude and a\nlongitude, searches for up to 20 places that can be used as a place_id when updating a status.\n\nThis request is an informative call and will deliver generalized results about geography","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/geo/reverse_geocode"},"operationId":"geo.reverse_geocode","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"The latitude to search around. This parameter will be ignored unless it is inside the range -90.0\nto +90.0 (North is positive) inclusive. It will also be ignored if there isn't a corresponding long\nparameter.\n\nExample Values: 37.7821120598956","in":"query","name":"lat","required":true,"schema":{"type":"string"}},{"description":"The longitude to search around. The valid ranges for longitude is -180.0 to +180.0 (East is\npositive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if\ngeo_enabled is disabled, or if there not a corresponding lat parameter.\n\nExample Values: -122.400612831116","in":"query","name":"long","required":true,"schema":{"type":"string"}},{"description":"A hint on the \"region\" in which to search. If a number, then this is a radius in meters, but it can\nalso take a string that is suffixed with ft to specify feet. If this is not passed in, then it is\nassumed to be 0m. If coming from a device, in practice, this value is whatever accuracy the device\nhas measuring its location (whether it be coming from a GPS, WiFi triangulation, etc.).\n\nExample Values: 5ft","in":"query","name":"accuracy","required":false,"schema":{"type":"string"}},{"description":"This is the minimal granularity of place types to return and must be one of: poi, neighborhood,\ncity, admin or country. If no granularity is provided for the request neighborhood is assumed.\nSetting this to city, for example, will find places which have a type of city, admin or country.\n\nExample Values: city","in":"query","name":"granularity","required":false,"schema":{"type":"string"}},{"description":"A hint as to the number of results to return. This does not guarantee that the number of results\nreturned will equal max_results, but instead informs how many \"nearby\" results to return. Ideally,\nonly pass in the number of places you intend to display to the user here.\n\nExample Values: 3","in":"query","name":"max_results","required":false,"schema":{"type":"string"}},{"description":"If supplied, the response will use the JSONP format with a callback of the given name.","in":"query","name":"callback","required":false,"schema":{"type":"string"}}]},"/geo/search.json":{"get":{"description":"Search for places that can be\nattached to a statuses/update. Given a latitude and a longitude pair, an IP address, or a name, this\nrequest will return a list of all the valid places that can be used as the place_id when updating a\nstatus.\n\nConceptually, a query can be made from the user's location, retrieve a list of places, have the user\nvalidate the location he or she is at, and then send the ID of this location with a call to POST\nstatuses/update.\n\nThis is the recommended method to use find places that can be attached to statuses/update. Unlike\nGET geo/reverse_geocode which provides raw data access, this endpoint can potentially re-order\nplaces with regards to the user who is authenticated. This approach is also preferred for\ninteractive place matching with the user.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/geo/search"},"operationId":"geo.search","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"A hint on the \"region\" in which to search. If a number, then this is a radius in meters, but it can\nalso take a string that is suffixed with ft to specify feet. If this is not passed in, then it is\nassumed to be 0m. If coming from a device, in practice, this value is whatever accuracy the device\nhas measuring its location (whether it be coming from a GPS, WiFi triangulation, etc.).\n\nExample Values: 5ft","in":"query","name":"accuracy","required":false,"schema":{"type":"string"}},{"description":"This is the minimal granularity of place types to return and must be one of: poi, neighborhood,\ncity, admin or country. If no granularity is provided for the request neighborhood is assumed.\nSetting this to city, for example, will find places which have a type of city, admin or country.\n\nExample Values: city","in":"query","name":"granularity","required":false,"schema":{"type":"string"}},{"description":"This is the place_id which you would like to restrict the search results to. Setting this value\nmeans only places within the given place_id will be found.\n\nSpecify a place_id. For example, to scope all results to places within \"San Francisco, CA USA\", you\nwould specify a place_id of \"5a110d312052166f\"\n\nExample Values: 247f43d441defc03","in":"query","name":"contained_within","required":false,"schema":{"type":"string"}},{"description":"This parameter searches for places which have this given street address. There are other\nwell-known, and application specific attributes available. Custom attributes are also permitted.\nLearn more about Place Attributes.\n\nExample Values: 795%20Folsom%20St","in":"query","name":"attribute:street_address","required":false,"schema":{"type":"string"}},{"description":"If supplied, the response will use the JSONP format with a callback of the given name.","in":"query","name":"callback","required":false,"schema":{"type":"string"}}]},"/geo/similar_places.json":{"get":{"description":"Locates places near the\ngiven coordinates which are similar in name.\n\nConceptually you would use this method to get a list of known places to choose from first. Then, if\nthe desired place doesn't exist, make a request to POST geo/place to create a new one.\n\nThe token contained in the response is the token needed to be able to create a new place.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/geo/similar_places"},"operationId":"geo.similar_places","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"This is the place_id which you would like to restrict the search results to. Setting this value\nmeans only places within the given place_id will be found.\n\nSpecify a place_id. For example, to scope all results to places within \"San Francisco, CA USA\", you\nwould specify a place_id of \"5a110d312052166f\"\n\nExample Values: 247f43d441defc03","in":"query","name":"contained_within","required":false,"schema":{"type":"string"}},{"description":"This parameter searches for places which have this given street address. There are other\nwell-known, and application specific attributes available. Custom attributes are also permitted.\nLearn more about Place Attributes.\n\nExample Values: 795%20Folsom%20St","in":"query","name":"attribute:street_address","required":false,"schema":{"type":"string"}},{"description":"If supplied, the response will use the JSONP format with a callback of the given name.","in":"query","name":"callback","required":false,"schema":{"type":"string"}}]},"/help/configuration.json":{"get":{"description":"Returns the current\nconfiguration used by Twitter including twitter.com slugs which are not usernames, maximum photo\nresolutions, and t.co URL lengths.\n\nIt is recommended applications request this endpoint when they are loaded, but no more than once a\nday.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/help/configuration"},"operationId":"help.configurations","responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/help/languages.json":{"get":{"description":"Returns the list of languages\nsupported by Twitter along with their ISO 639-1 code. The ISO 639-1 code is the two letter value to\nuse if you include lang with any of your requests.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/help/languages"},"operationId":"help.languages","responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/help/privacy.json":{"get":{"description":"Returns Twitter's Privacy Policy","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/help/privacy"},"operationId":"help.privacy","responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/help/tos.json":{"get":{"description":"Returns the Twitter Terms of Service\nin the requested format. These are not the same as the Developer Rules of the Road.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/help/tos"},"operationId":"help.tos","responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/lists/create.json":{"parameters":[{"description":"The name for the list.A list's name must start with a letter and can consist only of 25 or fewer\nletters, numbers, \"-\", or \"_\" characters.","in":"query","name":"name","required":true,"schema":{"type":"string"}},{"description":"Whether your list is public or private. Values can be public or private. If no mode is specified\nthe list will be public.","in":"query","name":"mode","required":false,"schema":{"type":"string"}},{"description":"The description to give the list.","in":"query","name":"description","required":false,"schema":{"type":"string"}}],"post":{"description":"Creates a new list for the\nauthenticated user. Note that you can't create more than 20 lists per account.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/lists/create"},"operationId":"lists.create","responses":{"200":{"description":"Successful Response"}}}},"/lists/destroy.json":{"parameters":[{"description":"The screen name of the user who owns the list being requested by a slug.","in":"query","name":"owner_screen_name","required":false,"schema":{"type":"string"}},{"description":"The user ID of the user who owns the list being requested by a slug.","in":"query","name":"owner_id","required":false,"schema":{"type":"string"}}],"post":{"description":"Deletes the specified list.\nThe authenticated user must own the list to be able to destroy it.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/post/lists/destroy"},"operationId":"lists.destroy","responses":{"200":{"description":"Successful Response"}}}},"/lists/list.json":{"get":{"description":"Returns all lists the\nauthenticating or specified user subscribes to, including their own. The user is specified using the\nuser_id or screen_name parameters. If no user is given, the authenticating user is used.\n\nThis method used to be GET lists in version 1.0 of the API and has been renamed for consistency with\nother call.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/lists/list"},"operationId":"lists.list","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"The screen name of the user for whom to return results for. Helpful for disambiguating when a valid\nscreen name is also a user ID.\n\nExample Values: noradio","in":"query","name":"screen_name","required":true,"schema":{"type":"string"}},{"description":"The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID\nis also a valid screen name.\n\nExample Values: 12345\n\nNote:: Specifies the ID of the user to get lists from. Helpful for disambiguating when a valid user\nID is also a valid screen name.","in":"query","name":"user_id","required":true,"schema":{"type":"string"}}]},"/lists/members.json":{"get":{"description":"Returns the members of the\nspecified list. Private list members will only be shown if the authenticated user owns the specified\nlist.","externalDocs":{"url":"https://dev.twitter.com/docs/api/1.1/get/lists/members"},"operationId":"lists.members","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"The screen name of the user who owns the list being requested by a slug.","in":"query","name":"owner_screen_name","required":false,"schema":{"type":"string"}},{"description":"The user ID of the user who owns the list being requested by a slug.","in":"query","name":"owner_id","required":false,"schema":{"type":"string"}},{"description":"The entities node will be disincluded when set to false.\n\nExample Values: false","in":"query","name":"include_entities","required":false,"schema":{"type":"string"}},{"description":"When set to either true, t or 1 statuses will not be included in the returned user objects.","in":"query","name":"skip_status","required":false,"schema":{"type":"string"}},{"description":"Causes the collection of list members to be broken into \"pages\" of somewhat consistent size. If no\ncursor is provided, a value of -1 will be assumed, which