{ "content": [ { "type": "text", "text": "# Net::Twitter (perldoc)\n\n## SYNOPSIS\n\nuse Net::Twitter;\nuse Scalar::Util 'blessed';\n# When no authentication is required:\nmy $nt = Net::Twitter->new(legacy => 0);\n# As of 13-Aug-2010, Twitter requires OAuth for authenticated requests\nmy $nt = Net::Twitter->new(\ntraits => [qw/API::RESTv11/],\nconsumerkey => $consumerkey,\nconsumersecret => $consumersecret,\naccesstoken => $token,\naccesstokensecret => $tokensecret,\n);\nmy $result = $nt->update('Hello, world!');\neval {\nmy $statuses = $nt->friendstimeline({ sinceid => $highwater, count => 100 });\nfor my $status ( @$statuses ) {\nprint \"$status->{createdat} <$status->{user}{screenname}> $status->{text}\\n\";\n}\n};\nif ( my $err = $@ ) {\ndie $@ unless blessed $err && $err->isa('Net::Twitter::Error');\nwarn \"HTTP Response Code: \", $err->code, \"\\n\",\n\"HTTP Message......: \", $err->message, \"\\n\",\n\"Twitter error.....: \", $err->error, \"\\n\";\n}\nTWITTER API V1.1 SUPPORT\nThis version of Net::Twitter provides Twitter API v1.1 support. Enable it by including the\n\"API::RESTv11\" trait instead of \"API::REST\". Using Twitter API v1.1 may require changes to you\ncode! It is not completely backwards compatible with v1.\nFor help migrating your application to Twitter API v1.1, see\nNet::Twitter::Manual::MigratingToV11.\n\n## DESCRIPTION\n\nThis module has been superseded by Twitter::API. Please update as soon as you possibly can to\nuse new features and the new API versions. This module will no longer be supported.\n\n## Sections\n\n- **VERSION**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **RETURN VALUES**\n- **METHODS AND ARGUMENTS** (1 subsections)\n- **AUTHENTICATION**\n- **API METHODS AND ARGUMENTS** (59 subsections)\n- **Search API Methods** (1 subsections)\n- **Lists API Methods**\n- **TwitterVision API Methods** (2 subsections)\n- **LEGACY COMPATIBILITY**\n- **ERROR HANDLING** (2 subsections)\n- **FAQ**\n- **SEE ALSO**\n- **SUPPORT**\n- **ACKNOWLEDGEMENTS**\n- **AUTHOR**\n- **CONTRIBUTORS**\n- **LICENSE**\n- **DISCLAIMER OF WARRANTY**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "Net::Twitter", "section": "", "mode": "perldoc", "summary": null, "synopsis": "use Net::Twitter;\nuse Scalar::Util 'blessed';\n# When no authentication is required:\nmy $nt = Net::Twitter->new(legacy => 0);\n# As of 13-Aug-2010, Twitter requires OAuth for authenticated requests\nmy $nt = Net::Twitter->new(\ntraits => [qw/API::RESTv11/],\nconsumerkey => $consumerkey,\nconsumersecret => $consumersecret,\naccesstoken => $token,\naccesstokensecret => $tokensecret,\n);\nmy $result = $nt->update('Hello, world!');\neval {\nmy $statuses = $nt->friendstimeline({ sinceid => $highwater, count => 100 });\nfor my $status ( @$statuses ) {\nprint \"$status->{createdat} <$status->{user}{screenname}> $status->{text}\\n\";\n}\n};\nif ( my $err = $@ ) {\ndie $@ unless blessed $err && $err->isa('Net::Twitter::Error');\nwarn \"HTTP Response Code: \", $err->code, \"\\n\",\n\"HTTP Message......: \", $err->message, \"\\n\",\n\"Twitter error.....: \", $err->error, \"\\n\";\n}\nTWITTER API V1.1 SUPPORT\nThis version of Net::Twitter provides Twitter API v1.1 support. Enable it by including the\n\"API::RESTv11\" trait instead of \"API::REST\". Using Twitter API v1.1 may require changes to you\ncode! It is not completely backwards compatible with v1.\nFor help migrating your application to Twitter API v1.1, see\nNet::Twitter::Manual::MigratingToV11.", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [], "section_outline": [ { "name": "VERSION", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 39, "subsections": [] }, { "name": "DESCRIPTION", "lines": 30, "subsections": [] }, { "name": "RETURN VALUES", "lines": 19, "subsections": [] }, { "name": "METHODS AND ARGUMENTS", "lines": 212, "subsections": [ { "name": "credentials", "lines": 6 } ] }, { "name": "AUTHENTICATION", "lines": 20, "subsections": [] }, { "name": "API METHODS AND ARGUMENTS", "lines": 47, "subsections": [ { "name": "Cursors and Paging", "lines": 44 }, { "name": "Synthetic Arguments", "lines": 3 }, { "name": "-authenticate", "lines": 6 }, { "name": "-since", "lines": 6 }, { "name": "-legacy_lists_api", "lines": 9 }, { "name": "Common Parameters", "lines": 27 }, { "name": "Methods", "lines": 36 }, { "name": "add_place", "lines": 16 }, { "name": "block_exists", "lines": 53 }, { "name": "create_block", "lines": 13 }, { "name": "create_favorite", "lines": 29 }, { "name": "create_list", "lines": 12 }, { "name": "create_media_metadata", "lines": 16 }, { "name": "create_mute", "lines": 13 }, { "name": "create_saved_search", "lines": 38 }, { "name": "destroy_block", "lines": 12 }, { "name": "destroy_direct_message", "lines": 15 }, { "name": "destroy_favorite", "lines": 12 }, { "name": "destroy_friend", "lines": 16 }, { "name": "destroy_mute", "lines": 12 }, { "name": "destroy_saved_search", "lines": 14 }, { "name": "destroy_status", "lines": 28 }, { "name": "disable_notifications", "lines": 9 }, { "name": "enable_notifications", "lines": 114 }, { "name": "friendship_exists", "lines": 57 }, { "name": "geo_id", "lines": 237 }, { "name": "lookup_statuses", "lines": 92 }, { "name": "mutes", "lines": 27 }, { "name": "new_direct_message", "lines": 64 }, { "name": "rate_limit_status", "lines": 16 }, { "name": "related_results", "lines": 22 }, { "name": "report_spam", "lines": 11 }, { "name": "retweet", "lines": 11 }, { "name": "retweeted_by", "lines": 8 }, { "name": "retweeted_by_ids", "lines": 17 }, { "name": "retweeted_by_user", "lines": 20 }, { "name": "retweeted_to_user", "lines": 11 }, { "name": "retweeters_ids", "lines": 15 }, { "name": "retweets", "lines": 25 }, { "name": "reverse_geocode", "lines": 54 }, { "name": "search", "lines": 36 }, { "name": "show_direct_message", "lines": 58 }, { "name": "show_saved_search", "lines": 11 }, { "name": "show_status", "lines": 27 }, { "name": "similar_places", "lines": 89 }, { "name": "trends_current", "lines": 19 }, { "name": "trends_place", "lines": 39 }, { "name": "update", "lines": 57 }, { "name": "update_delivery_device", "lines": 38 }, { "name": "update_location", "lines": 39 }, { "name": "update_profile_banner", "lines": 39 }, { "name": "update_profile_image", "lines": 25 }, { "name": "update_with_media", "lines": 31 }, { "name": "upload", "lines": 14 }, { "name": "upload_status", "lines": 11 }, { "name": "user_suggestions", "lines": 15 }, { "name": "user_suggestions_for", "lines": 27 }, { "name": "users_search", "lines": 31 }, { "name": "update_with_media", "lines": 30 } ] }, { "name": "Search API Methods", "lines": 3, "subsections": [ { "name": "search", "lines": 17 } ] }, { "name": "Lists API Methods", "lines": 10, "subsections": [] }, { "name": "TwitterVision API Methods", "lines": 4, "subsections": [ { "name": "current_status", "lines": 8 }, { "name": "update_twittervision", "lines": 7 } ] }, { "name": "LEGACY COMPATIBILITY", "lines": 17, "subsections": [] }, { "name": "ERROR HANDLING", "lines": 3, "subsections": [ { "name": "Wrapping Errors", "lines": 19 }, { "name": "Exception Handling", "lines": 32 } ] }, { "name": "FAQ", "lines": 30, "subsections": [] }, { "name": "SEE ALSO", "lines": 16, "subsections": [] }, { "name": "SUPPORT", "lines": 9, "subsections": [] }, { "name": "ACKNOWLEDGEMENTS", "lines": 6, "subsections": [] }, { "name": "AUTHOR", "lines": 2, "subsections": [] }, { "name": "CONTRIBUTORS", "lines": 20, "subsections": [] }, { "name": "LICENSE", "lines": 9, "subsections": [] }, { "name": "DISCLAIMER OF WARRANTY", "lines": 16, "subsections": [] } ], "sections": { "VERSION": { "content": "version 4.01043\n", "subsections": [] }, "SYNOPSIS": { "content": "use Net::Twitter;\nuse Scalar::Util 'blessed';\n\n# When no authentication is required:\nmy $nt = Net::Twitter->new(legacy => 0);\n\n# As of 13-Aug-2010, Twitter requires OAuth for authenticated requests\nmy $nt = Net::Twitter->new(\ntraits => [qw/API::RESTv11/],\nconsumerkey => $consumerkey,\nconsumersecret => $consumersecret,\naccesstoken => $token,\naccesstokensecret => $tokensecret,\n);\n\nmy $result = $nt->update('Hello, world!');\n\neval {\nmy $statuses = $nt->friendstimeline({ sinceid => $highwater, count => 100 });\nfor my $status ( @$statuses ) {\nprint \"$status->{createdat} <$status->{user}{screenname}> $status->{text}\\n\";\n}\n};\nif ( my $err = $@ ) {\ndie $@ unless blessed $err && $err->isa('Net::Twitter::Error');\n\nwarn \"HTTP Response Code: \", $err->code, \"\\n\",\n\"HTTP Message......: \", $err->message, \"\\n\",\n\"Twitter error.....: \", $err->error, \"\\n\";\n}\n\nTWITTER API V1.1 SUPPORT\nThis version of Net::Twitter provides Twitter API v1.1 support. Enable it by including the\n\"API::RESTv11\" trait instead of \"API::REST\". Using Twitter API v1.1 may require changes to you\ncode! It is not completely backwards compatible with v1.\n\nFor help migrating your application to Twitter API v1.1, see\nNet::Twitter::Manual::MigratingToV11.\n", "subsections": [] }, "DESCRIPTION": { "content": "This module has been superseded by Twitter::API. Please update as soon as you possibly can to\nuse new features and the new API versions. This module will no longer be supported.\n\nThis module provides a perl interface to the Twitter APIs. See for\na full description of the Twitter APIs.\n\nTWITTER API VERSION 1.1\nTwitter will (perhaps has by the time you read this) deprecated version 1 of the API.\nDocumentation, here, assumes version 1.1 of the API. For version 1 documentation, see\nNet::Twitter::Role::API::REST.\n\nTo use Twitter API version 1.1, simply replace \"API::REST\" in the \"traits\" argument to \"new\"\nwith \"API::RESTv11\". The \"Net::Twitter\" API is backwards compatible to the extent possible. If\nTwitter does not provide a 1.1 endpoint for a version 1 call, \"Net::Twitter\" cannot support it,\nof course.\n\nTwitter API version 1.1 requires OAuth authentication for all calls. There is no longer an IP\naddress limit and a per-user limit. Each API call has it's own rate limit. Most are 15 calls\nreset every 15 minutes. Others are 180 calls, reset every 15 minutes. These limits may change.\nFor current rate limits, see .\n\nOMG! THE MOOSE!\nNet::Twitter is Moose based. Moose provides some advantages, including the ability for the\nmaintainer of this module to respond quickly to Twitter API changes.\n\nSee Net::Twitter::Lite if you need an alternative without Moose and its dependencies.\n\nNet::Twitter::Lite's API method definitions and documentation are generated from Net::Twitter.\nIt is a related module, but does not depend on Net::Twitter or Moose for installation.\n", "subsections": [] }, "RETURN VALUES": { "content": "Net::Twitter decodes the data structures returned by the Twitter API into native perl data\nstructures (HASH references and ARRAY references). The full layout of those data structures are\nnot documented, here. They change often, usually with the addition of new elements, and\ndocumenting all of those changes would be a significant challenge.\n\nInstead, rely on the online Twitter API documentation and inspection of the returned data.\n\nThe Twitter API online documentation is located at .\n\nTo inspect the data, use Data::Dumper or similar module of your choice. Here's a simple example\nusing Data::Dumper:\n\nuse Data::Dumper;\n\nmy $r = $nt->search($searchterm);\nprint Dumper $r;\n\nFor more information on perl data structures, see perlreftut, perldsc, and perllol.\n", "subsections": [] }, "METHODS AND ARGUMENTS": { "content": "new This constructs a \"Net::Twitter\" object. It takes several named parameters, all of them\noptional:\n\ntraits\nAn ARRAY ref of traits used to control which APIs the constructed \"Net::Twitter\" object\nwill support and how it handles errors. Possible values are:\n\nAPI::RESTv11\nProvides support for the Twitter REST API version 1.1 methods.\n\nAPI::Search\nDeprecated. Use \"search\" in API::RESTv11 instead.\n\nAppAuth\nProvides Application-Only Authentication\n with methods,\n\"requestaccesstoken\" and \"invalidatetoken\". See Net::Twitter::Role::AppAuth.\n\nExample:\n\nmy $nt = Net::Twitter->new(\ntraits => [ qw/AppAuth API::RESTv11/ ],\nconsumerkey => 'my-consumer-key',\nconsumersecret => 'my-consumer-secret',\n);\n\n$nt->requestaccesstoken;\nsay 'token: ', $nt->accesstoken;\nmy $r = $nt->followersids({\nscreenname => 'timtoady',\ncursor => -1,\n});\n\n# good until invalidated, with ...\n$nt->invalidatetoken\n\nAutoCursor\n\"AutoCursor\" is a parameterized trait that provides an automatic loop for cursored\ncalls, returning an ARRAY reference to the combined results. By default, it handles\n\"friendsids\" and \"followersids\". See Net::Twitter::Role::AutoCursor for details.\n\nInflateObjects\nWhen this optional trait is included, Net::Twitter inflates HASH refs returned by\nTwitter into objects with read accessors for each element. In addition, it inflates\ndates to DateTime objects and URLs to URI objects. Objects that include a\n\"createdat\" attribute also have a \"relativecreatedat\" method.\n\nFor example, with \"InflateObjects\" applied, the method returns an\narray of status objects:\n\n$r = $nt->friendstimeline;\nfor my $status ( @$r ) {\n$r->user->screenname; # same as $r->{user}{screenname}\n\n# $createdat is a DateTime; $age is a DateTime::Duration\nmy $age = DateTime->now - $r->createdat;\n\n# print an age in a similar style to the Twitter web site, e.g.:\n# less than a minute ago\n# about a minute ago\n# 6 minutes ago\n# 1 day ago\n# etc.\nprint $r->relativecreatedat;\n\nLegacy\nThis trait provides backwards compatibility to \"Net::Twitter\" versions prior to\n3.00. It implies the traits \"API::REST\", \"API::Search\", \"API::TwitterVision\", and\n\"API::WrapError\". It also provides additional functionality to ensure consistent\nbehavior for applications written for use with legacy versions of \"Net::Twitter\".\n\nIn the current version, this trait is automatically included if the \"traits\" option\nis not specified. This ensures backwards compatibility for existing applications\nusing \"Net::Twitter\" versions prior to 3.00. See section \"LEGACY COMPATIBILITY\" for\nmore details.\n\nOAuth\nThe \"OAuth\" trait provides OAuth authentication rather than the default Basic\nAuthentication for Twitter API method calls. See the \"Authentication\" section and\nNet::Twitter::Role::OAuth for full documentation.\n\nRateLimit\nThe \"RateLimit\" trait adds utility methods that return information about the current\nrate limit status. See Net::Twitter::Role::RateLimit for details.\n\nRetryOnError\nThe \"RetryOnError\" trait automatically retries Twitter API calls with temporary\nfailures. See Net::Twitter::Role::RetryOnError for details.\n\nWrapError\n\"Net::Twitter\" normally throws exceptions on error. When this trait is included,\n\"Net::Twitter\" returns undef when a method fails and makes the error available\nthrough method \"geterror\". This is the way all errors were handled in Net::Twitter\nversions prior to version 3.00.\n\nSome examples of using the \"traits\" parameter in \"new\":\n\n# provide support for *only* the REST API; throw exceptions on error\n$nt = Net::Twitter->new(traits => ['API::RESTv11']);\n\n# provide support for both the REST and Search APIs; wrap errors\n$nt = Net::Twitter->new(traits => [qw/API::RESTv11 API::Search WrapError/]);\n\n# Provide legacy support for applications written with Net::Twitter\n# prior to version 3.0.\n$nt = Net::Twitter->new(traits => ['Legacy']);\n\nlegacy\nA boolean. If set to 0, \"new\" constructs a \"Net::Twitter\" object implementing the REST\nAPI and throws exceptions on API method errors.\n\nNet::Twitter->new(legacy => 0);\n\nis a shortcut for:\n\nNet::Twitter->new(traits => ['API::RESTv11']);\n\nIf set to 1, \"new\" constructs a \"Net::Twitter\" object with the \"Legacy\" trait.\n\nNet::Twitter->new(legacy => 1);\n\nis a shortcut for:\n\nNet::Twitter->new(traits => ['Legacy']);\n\nusername\nThis is the username for Basic Authentication. NOTE: as of 31-Aug-2010, Twitter no\nlonger supports Basic Authentication. Use OAuth instead. Other Twitter compatible\nservices may, however, accept Basic Authentication, so support for it remains in\n\"Net::Twitter\".\n\npassword\nThis is the password used for Basic Authentication.\n\nclientname\nThe value for the \"X-Twitter-Client-Name\" HTTP header. It defaults to \"Perl\nNet::Twitter\". Note: This option has nothing to do with the \"via\" application byline.\n\nclientver\nThe value for the \"X-Twitter-Client-Version\" HTTP header. It defaults to current version\nof the \"Net::Twitter\" module.\n\nclienturl\nThe value for the \"X-Twitter-Client-URL\" HTTP header. It defaults to the search.cpan.org\npage for the \"Net::Twitter\" distribution.\n\nuseragentclass\nThe \"LWP::UserAgent\" compatible class used internally by \"Net::Twitter\". It defaults to\n\"LWP::UserAgent\". For POE based applications, consider using \"LWP::UserAgent::POE\".\n\nuseragentargs\nAn HASH ref of arguments to pass to constructor of the class specified with\n\"useragentclass\", above. It defaults to {} (an empty HASH ref).\n\nuseragent\nThe value for \"User-Agent\" HTTP header. It defaults to \"Net::Twitter/4.01043 (Perl)\".\n\nsource\nTwitter on longer uses the \"source\" parameter. Support for it remains in \"Net::Twitter\"\nfor any compatible services that may use it. It was originally used by Twitter to\nprovide an \"via\" application byline.\n\napiurl\nThe URL for the Twitter API. This defaults to \"http://api.twitter.com/1\". This option is\navailable when the \"API::RESTv11\" trait is included.\n\napihost\nDEPRECATED - Setting the \"apiurl\" is sufficient.\n\napirealm\nA string containing the Twitter API realm used for Basic Authentication. It defaults to\n\"Twitter API\". This option is available when the \"API::RESTv11\" trait is included.\n\nidentica\nIf set to 1, \"Net::Twitter\" overrides the defaults for \"apiurl\", \"apihost\", and\n\"apirealm\" to \"http://identi.ca/api\", \"identi.ca:80\", and \"Laconica API\" respectively.\nIt defaults to 0. This option is available when the \"API::RESTv11\" trait is included.\n\nconsumerkey\nA string containing the OAuth consumer key provided by Twitter when an application is\nregistered. This option is available when the \"OAuth\" trait is included.\n\nconsumersecret\nA string containing the OAuth consumer secret. This option is available when the \"OAuth\"\ntrait is included.\n\nssl If set to 1, an SSL connection will be used for all API calls. Defaults to 1.\n\nnetrc\n(Optional) Sets the *machine* key to look up in \".netrc\" to obtain credentials. If set\nto 1, Net::Twitter will use the value of the \"netrcmachine\" option (below).\n\n# in .netrc\nmachine api.twitter.com\nlogin YOURTWITTERUSERNAME\npassword YOURTWITTERPASSWORD\nmachine semifor.twitter.com\nlogin semifor\npassword SUPERSECRET\n\n# in your perl program\n$nt = Net::Twitter->new(netrc => 1);\n$nt = Net::Twitter->new(netrc => 'semifor.twitter.com');\n\nnetrcmachine\n(Optional) Sets the \"machine\" entry to look up in \".netrc\" when \"> is used.\nDefaults to \"api.twitter.com\".\n\ndecodehtmlentities\nTwitter encodes HTML entities in the \"text\" field of statuses. Set this option to 1 to\nhave them automatically decoded. Default 0.\n", "subsections": [ { "name": "credentials", "content": "Set the credentials for Basic Authentication. This is helpful for managing multiple\naccounts.\n\nua Provides access to the constructed user agent object used internally by \"Net::Twitter\". Use\nit with caution.\n" } ] }, "AUTHENTICATION": { "content": "With REST API version 1.1, all API calls require OAuth. Since 31-Aug-2010, version 1 required\nOAuth requests requiring authentication. Other Twitter compatible services, like Identi.ca,\naccept Basic Authentication. So, \"Net::Twitter\" provides support for both.\n\nTo set up OAuth, include the \"consumerkey\" and \"consumersecret\" options to \"new\". When they\nare provided, the \"OAuth\" trait will be automatically included. See Net::Twitter::Role::OAuth\nfor more information on using OAuth, including examples.\n\nTo set up Basic Authentication in \"Net::Twitter\", provide the \"username\" and \"password\" options\nto \"new\" or call the \"credentials\" method.\n\nIn addition to the arguments specified for each API method described below, an additional\n\"-authenticate\" parameter can be passed. To request an \"Authorization\" header, pass\n\"-authenticate => 1\"; to suppress an authentication header, pass \"-authenticate => 0\". Even if\nrequested, an Authorization header will not be added if there are no user credentials (username\nand password for Basic Authentication; access tokens for OAuth).\n\nThis is probably only useful for non-Twitter sites that use the Twitter API and support\nunauthenticated calls.\n", "subsections": [] }, "API METHODS AND ARGUMENTS": { "content": "Most Twitter API methods take parameters. All Net::Twitter API methods will accept a HASH ref of\nnamed parameters as specified in the Twitter API documentation. For convenience, many\nNet::Twitter methods accept simple positional arguments. The positional parameter passing style\nis optional; you can always use the named parameters in a HASH reference if you prefer.\n\nYou may pass any number of required parameters as positional parameters. You must pass them in\nthe order specified in the documentation for each method. Optional parameters must be passed as\nnamed parameters in a HASH reference. The HASH reference containing the named parameters must be\nthe final parameter to the method call. Any required parameters not passed as positional\nparameters, must be included in the named parameter HASH reference.\n\nFor example, the REST API method \"update\" has one required parameter, \"status\". You can call\n\"update\" with a HASH ref argument:\n\n$nt->update({ status => 'Hello world!' });\n\nOr, you can use the convenient, positional parameter form:\n\n$nt->update('Hello world!');\n\nThe \"update\" method also has an optional parameter, \"inreplytostatusid\". To use it, you must\nuse the HASH ref form:\n\n$nt->update({ status => 'Hello world!', inreplytostatusid => $replyto });\n\nYou may use the convenient positional form for the required \"status\" parameter with the optional\nparameters specified in the named parameter HASH reference:\n\n$nt->update('Hello world!', { inreplytostatusid => $replyto });\n\nConvenience form is provided for the required parameters of all API methods. So, these two calls\nare equivalent:\n\n$nt->friendshipexists({ usera => $fred, userb => $barney });\n$nt->friendshipexists($fred, $barney);\n\nMany API methods have aliases. You can use the API method name, or any of its aliases, as you\nprefer. For example, these calls are all equivalent:\n\n$nt->friendshipexists($fred, $barney);\n$nt->relationshipexists($fred, $barney);\n$nt->follows($fred, $barney);\n\nAliases support both the HASH ref and convenient forms:\n\n$nt->follows({ usera => $fred, userb => $barney });\n", "subsections": [ { "name": "Cursors and Paging", "content": "Some methods return partial results a page at a time. Originally, methods that returned partial\nresults used a \"page\" parameter. A more recent addition to the Twitter API for retrieving\nmultiple pages uses the \"cursor\" parameter. Usually, a method uses either the \"page\" parameter\nor the \"cursor\" parameter, but not both. There have been exceptions to this rule when Twitter\ndeprecates the use of \"page\" for a method in favor of \"cursor\". In that case, both methods may\nwork during a transition period. So, if a method supports both, you should always use the\n\"cursor\" parameter.\n\nPaging\nFor methods that support paging, the first page is returned by passing \"page => 1\", the second\npage by passing \"page => 2\", etc. If no \"page\" parameter is passed, the first page is returned.\n\nHere's an example that demonstrates how to obtain all favorites in a loop:\n\nmy @favs;\nfor ( my $page = 1; ; ++$page ) {\nmy $r = $nt->favorites({ page => $page });\nlast unless @$r;\n\npush @favs, @$r;\n}\n\nCursors\nCursoring employs a different strategy. To obtain the first page of results, pass \"cursor =>\n-1\". Twitter returns a reference to a hash that includes entries \"nextcursor\",\n\"previouscursor\", and an entry with a reference to an array containing a page of the requested\nitems. The key for the array reference will be named \"users\", \"ids\", or something similar\ndepending upon the type of returned items. For example, when \"cursor\" parameter is used with the\n\"followersids\" method, the returned in hash entry \"ids\".\n\nThe \"nextcursor\" value can be used in a subsequent call to obtain the next page of results.\nWhen you have obtained the last page of results, \"nextcursor\" will be 0. Likewise, you can use\nthe value for \"previouscursor\" to obtain the previous page of results. When you have obtained\nthe first page, \"previouscursor\" will be 0.\n\nHere's an example that demonstrates how to obtain all follower IDs in a loop using the \"cursor\"\nparameter:\n\nmy @ids;\nfor ( my $cursor = -1, my $r; $cursor; $cursor = $r->{nextcursor} ) {\n$r = $nt->followersids({ cursor => $cursor });\npush @ids, @{ $r->{ids} };\n}\n" }, { "name": "Synthetic Arguments", "content": "In addition to the arguments described in the Twitter API Documentation for each API method,\nNet::Twitter supports additional *synthetic* arguments.\n" }, { "name": "-authenticate", "content": "When set to 1, Net::Twitter will provide an Authorization header for the API call; when set\nto 0, it will suppress the Authentication header. This argument overrides the defined\nauthentication behavior for the API method. It is probably only useful for the\n\"ratelimitstatus\" method which returns different values for authenticated and\nunauthenticated calls. See \"AUTHENTICATION\" for more details.\n" }, { "name": "-since", "content": "API methods that accept the \"sinceid\" argument will also accept the synthetic \"-since\"\nargument, instead. \"-since\" may be a \"Date::Time\" object, an epoch time (the number of\nseconds since the system epoch), or a string in the same format returned by Twitter for the\n\"createdat\" attribute. Only statuses with a \"createdat\" time greater than \"-since\" will be\nreturned by the API call.\n" }, { "name": "-legacy_lists_api", "content": "This option is only effective when the legacy \"API::Lists\" trait is applied. Passing\n\"-legacylistsapi\" set to 0 for lists methods will use the new lists endpoints and\nsemantics. This will facilitate upgrading an application to use the new lists api methods.\nWhen the \"API::Lists\" trait is not applied, this option is ignored.\n\nREST API Methods\nThese methods are provided when trait \"API::RESTv11\" is included in the \"traits\" option to\n\"new\".\n" }, { "name": "Common Parameters", "content": "id Several of these methods accept a user ID as the \"id\" parameter. The user ID can be either a\nscreen name, or the users numeric ID. To disambiguate, use the \"screenname\" or \"userid\"\nparameters, instead.\n\nFor example, These calls are equivalent:\n\n$nt->createfriend('perlapi'); # screen name\n$nt->createfriend(1564061); # numeric ID\n$nt->createfriend({ id => 'perlapi' });\n$nt->createfriend({ screenname => 'perlapi' });\n$nt->createfriend({ userid => 1564061 });\n\nHowever userid 911 and screenname 911 are separate Twitter accounts. These calls are NOT\nequivalent:\n\n$nt->createfriend(911); # interpreted as screen name\n$nt->createfriend({ userid => 911 }); # screen name: richellis\n\nWhenever the \"id\" parameter is required and \"userid\" and \"screenname\" are also parameters,\nusing any one of them satisfies the requirement.\n\nskipuser\nThe timeline methods all accept an optional \"skipuser\" parameter. When set to a true value,\nthe statuses returned in a timeline will not contain an entire embedded user HASH. Instead,\nthe user node will contain only an \"id\" element to indicate the numerical ID of the Twitter\nuser that sent the status.\n" }, { "name": "Methods", "content": "accountsettings\n\nParameters: *none*\nRequired: *none*\n\nReturns the current trend, geo and sleep time information for the authenticating user.\n\nReturns: HashRef\n\nTwitter API documentation: GET account/settings\n\n\naccounttotals DEPRECATED\n\nParameters: *none*\nRequired: *none*\n\nReturns the current count of friends, followers, updates (statuses) and favorites of the\nauthenticating user.\n\nReturns: HashRef\n\naddlistmember\n\nParameters: listid, slug, userid, screenname, ownerscreenname, ownerid\nRequired: *none*\n\nAdd a member to a list. The authenticated user must own the list to be able to add members\nto it. Note that lists can't have more than 500 members.\n\nReturns: User\n\nTwitter API documentation: POST lists/members/create\n\n\naddplace" }, { "name": "add_place", "content": "Parameters: name, containedwithin, token, lat, long, attribute:streetaddress, callback\nRequired: name, containedwithin, token, lat, long\n\nCreates a new place object at the given latitude and longitude.\n\nBefore creating a place you need to query \"similarplaces\" with the latitude, longitude and\nname of the place you wish to create. The query will return an array of places which are\nsimilar to the one you wish to create, and a token. If the place you wish to create isn't in\nthe returned array you can use the token with this method to create a new one.\n\nReturns: Place\n\nTwitter API documentation: POST geo/place\n\n\nblockexists DEPRECATED" }, { "name": "block_exists", "content": "Parameters: id, userid, screenname, includeentities\nRequired: id\n\nReturns if the authenticating user is blocking a target user. Will return the blocked user's\nobject if a block exists, and error with HTTP 404 response code otherwise.\n\nReturns: BasicUser\n\nblocking\nalias: blockslist\n\nParameters: cursor, includeentities, skipstatus\nRequired: *none*\n\nReturns an array of user objects that the authenticating user is blocking.\n\nReturns: ArrayRef[BasicUser]\n\nTwitter API documentation: GET blocks/list\n\n\nblockingids\nalias: blocksids\n\nParameters: cursor, stringifyids\nRequired: *none*\n\nReturns an array of numeric user ids the authenticating user is blocking.\n\nReturns: ArrayRef[Int]\n\nTwitter API documentation: GET blocks/ids\n\n\ncontributees DEPRECATED\n\nParameters: userid, screenname, includeentities, skipsatus\nRequired: *none*\n\nReturns an array of users that the specified user can contribute to.\n\nReturns: ArrayRef[User]\n\ncontributors DEPRECATED\n\nParameters: userid, screenname, includeentities, skipsatus\nRequired: *none*\n\nReturns an array of users who can contribute to the specified account.\n\nReturns: ArrayRef[User]\n\ncreateblock" }, { "name": "create_block", "content": "Parameters: userid, screenname, includeentities, skipstatus\nRequired: id\n\nBlocks the user specified in the \"userid\" or \"screenname\" parameter as the authenticating\nuser. Returns the blocked user when successful. You can find out more about blocking in the\nTwitter Support Knowledge Base.\n\nReturns: BasicUser\n\nTwitter API documentation: POST blocks/create\n\n\ncreatefavorite" }, { "name": "create_favorite", "content": "Parameters: id, includeentities\nRequired: id\n\nFavorites the status specified in the ID parameter as the authenticating user. Returns the\nfavorite status when successful.\n\nReturns: Status\n\nTwitter API documentation: POST favorites/create\n\n\ncreatefriend\nalias: follow\nalias: follownew\nalias: createfriendship\n\nParameters: userid, screenname, follow\nRequired: *none*\n\nFollows the user specified in the \"userid\" or \"screenname\" parameter as the authenticating\nuser. Returns the befriended user when successful. Returns a string describing the failure\ncondition when unsuccessful.\n\nReturns: BasicUser\n\nTwitter API documentation: POST friendships/create\n\n\ncreatelist" }, { "name": "create_list", "content": "Parameters: listid, slug, name, mode, description, ownerscreenname, ownerid\nRequired: name\n\nCreates a new list for the authenticated user. Note that you can't create more than 20 lists\nper account.\n\nReturns: List\n\nTwitter API documentation: POST lists/create\n\n\ncreatemediametadata" }, { "name": "create_media_metadata", "content": "Parameters: mediaid, alttext\nRequired: mediaid\n\nAdds metadata -- alt text, in particular -- to a previously uploaded media object, specified\nby its ID. (One knows this ID via the return value of the preceding \"upload\" call.)\n\nThe \"alttext\" parameter must have as its value a hashref containing a single key-value\npair. The key must be \"text\", and the value is the alt text to assign to the media object.\nThe text must be 400 characters or fewer in length.\n\nReturns: HashRef\n\nTwitter API documentation: POST media/metadata/create\n\n\ncreatemute" }, { "name": "create_mute", "content": "Parameters: userid, screenname\nRequired: id\n\nMutes the user specified in the \"userid\" or \"screenname\" parameter as the authenticating\nuser. Returns the muted user when successful. You can find out more about muting in the\nTwitter Support Knowledge Base.\n\nReturns: BasicUser\n\nTwitter API documentation: POST mutes/users/create\n\n\ncreatesavedsearch" }, { "name": "create_saved_search", "content": "Parameters: query\nRequired: query\n\nCreates a saved search for the authenticated user.\n\nReturns: SavedSearch\n\nTwitter API documentation: POST savedsearches/create\n\n\ndeletelist\n\nParameters: ownerscreenname, ownerid, listid, slug\nRequired: *none*\n\nDeletes the specified list. The authenticated user must own the list to be able to destroy\nit.\n\nReturns: List\n\nTwitter API documentation: POST lists/destroy\n\n\ndeletelistmember\nalias: removelistmember\n\nParameters: listid, slug, userid, screenname, ownerscreenname, ownerid\nRequired: *none*\n\nRemoves the specified member from the list. The authenticated user must be the list's owner\nto remove members from the list.\n\nReturns: User\n\nTwitter API documentation: POST lists/members/destroy\n\n\ndestroyblock" }, { "name": "destroy_block", "content": "Parameters: userid, screenname, includeentities, skipstatus\nRequired: id\n\nUn-blocks the user specified in the \"userid\" or \"screenname\" parameter as the\nauthenticating user. Returns the un-blocked user when successful.\n\nReturns: BasicUser\n\nTwitter API documentation: POST blocks/destroy\n\n\ndestroydirectmessage" }, { "name": "destroy_direct_message", "content": "Parameters: id, includeentities\nRequired: id\n\nDestroys the direct message specified in the required ID parameter. The authenticating user\nmust be the recipient of the specified direct message.\n\nImportant: this method requires an access token with RWD (read, write, and direct message)\npermissions.\n\nReturns: DirectMessage\n\nTwitter API documentation: POST directmessages/destroy\n\n\ndestroyfavorite" }, { "name": "destroy_favorite", "content": "Parameters: id, includeentities\nRequired: id\n\nUn-favorites the status specified in the ID parameter as the authenticating user. Returns\nthe un-favorited status.\n\nReturns: Status\n\nTwitter API documentation: POST favorites/destroy\n\n\ndestroyfriend" }, { "name": "destroy_friend", "content": "alias: unfollow\nalias: destroyfriendship\n\nParameters: userid, screenname\nRequired: id\n\nDiscontinues friendship with the user specified in the \"userid\" or \"screenname\" parameter\nas the authenticating user. Returns the un-friended user when successful. Returns a string\ndescribing the failure condition when unsuccessful.\n\nReturns: BasicUser\n\nTwitter API documentation: POST friendships/destroy\n\n\ndestroymute" }, { "name": "destroy_mute", "content": "Parameters: userid, screenname\nRequired: id\n\nUn-mutes the user specified in the \"userid\" or \"screenname\" parameter as the\nauthenticating user. Returns the un-muted user when successful.\n\nReturns: BasicUser\n\nTwitter API documentation: POST mutes/users/destroy\n\n\ndestroysavedsearch" }, { "name": "destroy_saved_search", "content": "alias: deletesavedsearch\n\nParameters: id\nRequired: id\n\nDestroys a saved search. The search, specified by \"id\", must be owned by the authenticating\nuser.\n\nReturns: SavedSearch\n\nTwitter API documentation: POST savedsearches/destroy/:id\n\n\ndestroystatus" }, { "name": "destroy_status", "content": "Parameters: id, trimuser\nRequired: id\n\nDestroys the status specified by the required ID parameter. The authenticating user must be\nthe author of the specified status.\n\nReturns: Status\n\nTwitter API documentation: POST statuses/destroy/:id\n\n\ndirectmessages\n\nParameters: sinceid, maxid, count, page, includeentities, skipstatus\nRequired: *none*\n\nReturns a list of the 20 most recent direct messages sent to the authenticating user\nincluding detailed information about the sending and recipient users.\n\nImportant: this method requires an access token with RWD (read, write, and direct message)\npermissions.\n\nReturns: ArrayRef[DirectMessage]\n\nTwitter API documentation: GET directmessages\n\n\ndisablenotifications DEPRECATED" }, { "name": "disable_notifications", "content": "Parameters: id, screenname, includeentities\nRequired: id\n\nDisables notifications for updates from the specified user to the authenticating user.\nReturns the specified user when successful.\n\nReturns: BasicUser\n\nenablenotifications DEPRECATED" }, { "name": "enable_notifications", "content": "Parameters: id, screenname, includeentities\nRequired: id\n\nEnables notifications for updates from the specified user to the authenticating user.\nReturns the specified user when successful.\n\nReturns: BasicUser\n\nendsession DEPRECATED\n\nParameters: *none*\nRequired: *none*\n\nEnds the session of the authenticating user, returning a null cookie. Use this method to\nsign users out of client-facing applications like widgets.\n\nReturns: Error\n\nfavorites\n\nParameters: userid, screenname, count, sinceid, maxid, includeentities\nRequired: *none*\n\nReturns the 20 most recent favorite statuses for the authenticating user or user specified\nby the ID parameter.\n\nReturns: ArrayRef[Status]\n\nTwitter API documentation: GET favorites/list\n\n\nfollowers\nalias: followerslist\n\nParameters: userid, screenname, cursor\nRequired: *none*\n\nReturns a cursored collection of user objects for users following the specified user.\n\nReturns: HashRef\n\nTwitter API documentation: GET followers/list\n\n\nfollowersids\n\nParameters: userid, screenname, cursor, stringifyids\nRequired: *none*\n\nReturns a reference to an array of numeric IDs for every user following the specified user.\nThe order of the IDs may change from call to call. To obtain the screen names, pass the\narrayref to \"lookupusers\".\n\nUse the optional \"cursor\" parameter to retrieve IDs in pages of 5000. When the \"cursor\"\nparameter is used, the return value is a reference to a hash with keys \"previouscursor\",\n\"nextcursor\", and \"ids\". The value of \"ids\" is a reference to an array of IDS of the user's\nfollowers. Set the optional \"cursor\" parameter to -1 to get the first page of IDs. Set it to\nthe prior return's value of \"previouscursor\" or \"nextcursor\" to page forward or backwards.\nWhen there are no prior pages, the value of \"previouscursor\" will be 0. When there are no\nsubsequent pages, the value of \"nextcursor\" will be 0.\n\nReturns: HashRef|ArrayRef[Int]\n\nTwitter API documentation: GET followers/ids\n\n\nfriends\nalias: friendslist\n\nParameters: userid, screenname, cursor\nRequired: *none*\n\nReturns a cursored collection of user objects for users followed by the specified user.\n\nReturns: HashRef\n\nTwitter API documentation: GET friends/list\n\n\nfriendsids\nalias: followingids\n\nParameters: userid, screenname, cursor, stringifyids\nRequired: *none*\n\nReturns a reference to an array of numeric IDs for every user followed by the specified\nuser. The order of the IDs is reverse chronological.\n\nUse the optional \"cursor\" parameter to retrieve IDs in pages of 5000. When the \"cursor\"\nparameter is used, the return value is a reference to a hash with keys \"previouscursor\",\n\"nextcursor\", and \"ids\". The value of \"ids\" is a reference to an array of IDS of the user's\nfriends. Set the optional \"cursor\" parameter to -1 to get the first page of IDs. Set it to\nthe prior return's value of \"previouscursor\" or \"nextcursor\" to page forward or backwards.\nWhen there are no prior pages, the value of \"previouscursor\" will be 0. When there are no\nsubsequent pages, the value of \"nextcursor\" will be 0.\n\nReturns: HashRef|ArrayRef[Int]\n\nTwitter API documentation: GET friends/ids\n\n\nfriendstimeline DEPRECATED\nalias: followingtimeline\n\nParameters: sinceid, maxid, count, excludereplies, contributordetails, includeentities,\ntrimuser\nRequired: *none*\n\nReturns the 20 most recent statuses, including retweets, posted by the authenticating user\nand that user's friends.\n\nReturns: ArrayRef[Status]\n\nfriendshipexists DEPRECATED" }, { "name": "friendship_exists", "content": "alias: relationshipexists\nalias: follows\n\nParameters: userida, useridb, screennamea, screennameb, usera, userb\nRequired: usera, userb\n\nThis method is provided for backwards compatibility with Twitter API V1.0. Twitter API V1.1\ndoes not provide an endpoint for this call. Instead, \"showfriendship\" is called, the result\nis inspected, and an appropriate value is returned which can be evaluated in a boolean\ncontext.\n\nTests for the existence of friendship between two users. Will return true if usera follows\nuserb, otherwise will return false.\n\nUse of \"usera\" and \"userb\" is deprecated. It has been preserved for backwards\ncompatibility, and is used for the two-argument positional form:\n\n$nt->friendshipexists($usera, $userb);\n\nInstead, you should use one of the named argument forms:\n\n$nt->friendshipexists({ userida => $id1, useridb => $id2 });\n$nt->friendshipexists({ screennamea => $name1, screennameb => $name2 });\n\nConsider using \"showfriendship\" instead.\n\nReturns: Bool\n\nfriendshipsincoming\nalias: incomingfriendships\n\nParameters: cursor, stringifyids\nRequired: *none*\n\nReturns an HASH ref with an array of numeric IDs in the \"ids\" element for every user who has\na pending request to follow the authenticating user.\n\nReturns: HashRef\n\nTwitter API documentation: GET friendships/incoming\n\n\nfriendshipsoutgoing\nalias: outgoingfriendships\n\nParameters: cursor, stringifyids\nRequired: *none*\n\nReturns an HASH ref with an array of numeric IDs in the \"ids\" element for every protected\nuser for whom the authenticating user has a pending follow request.\n\nReturns: HashRef\n\nTwitter API documentation: GET friendships/outgoing\n\n\ngeoid" }, { "name": "geo_id", "content": "Parameters: placeid\nRequired: placeid\n\nReturns details of a place returned from the \"reversegeocode\" method.\n\nReturns: HashRef\n\nTwitter API documentation: GET geo/id/:placeid\n\n\ngeosearch\n\nParameters: lat, long, query, ip, granularity, accuracy, maxresults, containedwithin,\nattribute:streetaddress, callback\nRequired: *none*\n\nSearch for places that can be attached to a statuses/update. Given a latitude and a\nlongitude pair, an IP address, or a name, this request will return a list of all the valid\nplaces that can be used as the placeid when updating a status.\n\nConceptually, a query can be made from the user's location, retrieve a list of places, have\nthe user validate the location he or she is at, and then send the ID of this location with a\ncall to statuses/update.\n\nThis is the recommended method to use find places that can be attached to statuses/update.\nUnlike geo/reversegeocode which provides raw data access, this endpoint can potentially\nre-order places with regards to the user who is authenticated. This approach is also\npreferred for interactive place matching with the user.\n\nReturns: HashRef\n\nTwitter API documentation: GET geo/search\n\n\ngetconfiguration\n\nParameters: *none*\nRequired: *none*\n\nReturns the current configuration used by Twitter including twitter.com slugs which are not\nusernames, maximum photo resolutions, and t.co URL lengths.\n\nIt is recommended applications request this endpoint when they are loaded, but no more than\nonce a day.\n\nReturns: HashRef\n\nTwitter API documentation: GET help/configuration\n\n\ngetlanguages\n\nParameters: *none*\nRequired: *none*\n\nReturns the list of languages supported by Twitter along with their ISO 639-1 code. The ISO\n639-1 code is the two letter value to use if you include lang with any of your requests.\n\nReturns: ArrayRef[Lanugage]\n\nTwitter API documentation: GET help/languages\n\n\ngetlist\nalias: showlist\n\nParameters: listid, slug, ownerscreenname, ownerid\nRequired: *none*\n\nReturns the specified list. Private lists will only be shown if the authenticated user owns\nthe specified list.\n\nReturns: List\n\nTwitter API documentation: GET lists/show\n\n\ngetlists\nalias: listlists\nalias: allsubscriptions\n\nParameters: userid, screenname, reverse\nRequired: *none*\n\nReturns all lists the authenticating or specified user subscribes to, including their own.\nThe user is specified using the userid or screenname parameters. If no user is given, the\nauthenticating user is used.\n\nA maximum of 100 results will be returned by this call. Subscribed lists are returned first,\nfollowed by owned lists. This means that if a user subscribes to 90 lists and owns 20 lists,\nthis method returns 90 subscriptions and 10 owned lists. The reverse method returns owned\nlists first, so with \"reverse =\" 1>, 20 owned lists and 80 subscriptions would be returned.\nIf your goal is to obtain every list a user owns or subscribes to, use \nand/or \"listsubscriptions\" instead.\n\nReturns: Hashref\n\nTwitter API documentation: GET lists/list\n\n\ngetprivacypolicy\n\nParameters: *none*\nRequired: *none*\n\nReturns Twitter's privacy policy.\n\nReturns: HashRef\n\nTwitter API documentation: GET help/privacy\n\n\ngettos\n\nParameters: *none*\nRequired: *none*\n\nReturns the Twitter Terms of Service. These are not the same as the Developer Rules of the\nRoad.\n\nReturns: HashRef\n\nTwitter API documentation: GET help/tos\n\n\nhometimeline\n\nParameters: sinceid, maxid, count, excludereplies, contributordetails, includeentities,\ntrimuser\nRequired: *none*\n\nReturns the 20 most recent statuses, including retweets, posted by the authenticating user\nand that user's friends.\n\nReturns: ArrayRef[Status]\n\nTwitter API documentation: GET statuses/hometimeline\n\n\nlistmembers\n\nParameters: listid, slug, ownerscreenname, ownerid, cursor, includeentities,\nskipstatus\nRequired: *none*\n\nReturns the members of the specified list. Private list members will only be shown if the\nauthenticated user owns the specified list.\n\nReturns: Hashref\n\nTwitter API documentation: GET lists/members\n\n\nlistmemberships\n\nParameters: userid, screenname, cursor, filtertoownedlists\nRequired: *none*\n\nReturns the lists the specified user has been added to. If userid or screenname are not\nprovided the memberships for the authenticating user are returned.\n\nReturns: Hashref\n\nTwitter API documentation: GET lists/memberships\n\n\nlistownerships\n\nParameters: userid, screenname, count, cursor\nRequired: *none*\n\nObtain a collection of the lists owned by the specified Twitter user. Private lists will\nonly be shown if the authenticated user is also the owner of the lists.\n\nReturns: ArrayRef[List]\n\nTwitter API documentation: GET lists/ownerships\n\n\nliststatuses\n\nParameters: listid, slug, ownerscreenname, ownerid, sinceid, maxid, count,\nincludeentities, includerts\nRequired: *none*\n\nReturns tweet timeline for members of the specified list. Historically, retweets were not\navailable in list timeline responses but you can now use the includerts=true parameter to\nadditionally receive retweet objects.\n\nReturns: ArrayRef[Status]\n\nTwitter API documentation: GET lists/statuses\n\n\nlistsubscribers\n\nParameters: listid, slug, ownerscreenname, ownerid, cursor, includeentities,\nskipstatus\nRequired: *none*\n\nReturns the subscribers of the specified list. Private list subscribers will only be shown\nif the authenticated user owns the specified list.\n\nReturns: Hashref\n\nTwitter API documentation: GET lists/subscribers\n\n\nlistsubscriptions\nalias: subscriptions\n\nParameters: userid, screenname, count, cursor\nRequired: *none*\n\nObtain a collection of the lists the specified user is subscribed to, 20 lists per page by\ndefault. Does not include the user's own lists.\n\nReturns: ArrayRef[List]\n\nTwitter API documentation: GET lists/subscriptions\n\n\nlookupfriendships\n\nParameters: userid, screenname\nRequired: *none*\n\nReturns the relationship of the authenticating user to the comma separated list or ARRAY ref\nof up to 100 screennames or userids provided. Values for connections can be: following,\nfollowingrequested, followedby, none. Requires authentication.\n\nReturns: ArrayRef\n\nTwitter API documentation: GET friendships/lookup\n\n\nlookupstatuses" }, { "name": "lookup_statuses", "content": "Parameters: id, includeentities, trimuser, map\nRequired: id\n\nReturns a hash reference of tweets from an arbitrary set of ids.\n\nReturns: HashRef\n\nTwitter API documentation: GET statuses/lookup\n\n\nlookupusers\n\nParameters: userid, screenname, includeentities\nRequired: *none*\n\nReturn up to 100 users worth of extended information, specified by either ID, screen name,\nor combination of the two. The author's most recent status (if the authenticating user has\npermission) will be returned inline. This method is rate limited to 1000 calls per hour.\n\nThis method will accept user IDs or screen names as either a comma delimited string, or as\nan ARRAY ref. It will also accept arguments in the normal HASHREF form or as a simple list\nof named arguments. I.e., any of the following forms are acceptable:\n\n$nt->lookupusers({ userid => '1234,6543,3333' });\n$nt->lookupusers(userid => '1234,6543,3333');\n$nt->lookupusers({ userid => [ 1234, 6543, 3333 ] });\n$nt->lookupusers({ screenname => 'fred,barney,wilma' });\n$nt->lookupusers(screenname => ['fred', 'barney', 'wilma']);\n\n$nt->lookupusers(\nscreenname => ['fred', 'barney' ],\nuserid => '4321,6789',\n);\n\nReturns: ArrayRef[User]\n\nTwitter API documentation: GET users/lookup\n\n\nmemberscreateall\nalias: addlistmembers\n\nParameters: listid, slug, ownerscreenname, ownerid\nRequired: *none*\n\nAdds multiple members to a list, by specifying a reference to an array or a comma-separated\nlist of member ids or screen names. The authenticated user must own the list to be able to\nadd members to it. Note that lists can't have more than 500 members, and you are limited to\nadding up to 100 members to a list at a time with this method.\n\nReturns: List\n\nTwitter API documentation: POST lists/members/createall\n\n\nmembersdestroyall\nalias: removelistmembers\n\nParameters: listid, slug, userid, screenname, ownerscreenname, ownerid\nRequired: *none*\n\nRemoves multiple members from a list, by specifying a reference to an array of member ids or\nscreen names, or a string of comma separated user ids or screen names. The authenticated\nuser must own the list to be able to remove members from it. Note that lists can't have more\nthan 500 members, and you are limited to removing up to 100 members to a list at a time with\nthis method.\n\nPlease note that there can be issues with lists that rapidly remove and add memberships.\nTake care when using these methods such that you are not too rapidly switching between\nremovals and adds on the same list.\n\nReturns: List\n\nTwitter API documentation: POST lists/members/destroyall\n\n\nmentions\nalias: replies\nalias: mentionstimeline\n\nParameters: sinceid, maxid, count, trimuser, includeentities, contributordetails\nRequired: *none*\n\nReturns the 20 most recent mentions (statuses containing @username) for the authenticating\nuser.\n\nReturns: ArrayRef[Status]\n\nTwitter API documentation: GET statuses/mentionstimeline\n\n\nmutes" }, { "name": "mutes", "content": "alias: mutingids\nalias: mutedids\n\nParameters: cursor\nRequired: *none*\n\nReturns an array of numeric user ids the authenticating user has muted.\n\nReturns: ArrayRef[Int]\n\nTwitter API documentation: GET mutes/users/ids\n\n\nmuting\nalias: muteslist\n\nParameters: cursor, includeentities, skipstatus\nRequired: *none*\n\nReturns an array of user objects that the authenticating user is muting.\n\nReturns: ArrayRef[BasicUser]\n\nTwitter API documentation: GET mutes/users/list\n\n\nnewdirectmessage" }, { "name": "new_direct_message", "content": "Parameters: userid, screenname, text\nRequired: text\n\nSends a new direct message to the specified user from the authenticating user. Requires both\nthe user and text parameters. Returns the sent message when successful. In order to support\nnumeric screen names, the \"screenname\" or \"userid\" parameters may be used instead of\n\"user\".\n\nImportant: this method requires an access token with RWD (read, write, and direct message)\npermissions.\n\nReturns: DirectMessage\n\nTwitter API documentation: POST directmessages/new\n\n\nnoretweetids\nalias: noretweetsids\n\nParameters: *none*\nRequired: *none*\n\nReturns an ARRAY ref of user IDs for which the authenticating user does not want to receive\nretweets.\n\nReturns: ArrayRef[UserIDs]\n\nTwitter API documentation: GET friendships/noretweets/ids\n\n\noembed\n\nParameters: id, url, maxwidth, hidemedia, hidethread, omitscript, align, related, lang\nRequired: *none*\n\nReturns information allowing the creation of an embedded representation of a Tweet on third\nparty sites. See the oEmbed specification for information about the\nresponse format.\n\nWhile this endpoint allows a bit of customization for the final appearance of the embedded\nTweet, be aware that the appearance of the rendered Tweet may change over time to be\nconsistent with Twitter's Display Requirements\n. Do not rely on any class or id\nparameters to stay constant in the returned markup.\n\nReturns: Status\n\nTwitter API documentation: GET statuses/oembed\n\n\nprofilebanner\n\nParameters: userid, screenname\nRequired: *none*\n\nReturns a hash reference mapping available size variations to URLs that can be used to\nretrieve each variation of the banner.\n\nReturns: HashRef\n\nTwitter API documentation: GET users/profilebanner\n\n\nratelimitstatus" }, { "name": "rate_limit_status", "content": "Parameters: resources\nRequired: *none*\n\nReturns the remaining number of API requests available to the authenticated user before the\nAPI limit is reached for the current hour.\n\nUse \"->ratelimitstatus({ authenticate => 0 })\" to force an unauthenticated call, which\nwill return the status for the IP address rather than the authenticated user. (Note: for a\nweb application, this is the server's IP address.)\n\nReturns: RateLimitStatus\n\nTwitter API documentation: GET application/ratelimitstatus\n\n\nrelatedresults DEPRECATED" }, { "name": "related_results", "content": "Parameters: id\nRequired: id\n\nIf available, returns an array of replies and mentions related to the specified status.\nThere is no guarantee there will be any replies or mentions in the response. This method is\nonly available to users who have access to #newtwitter. Requires authentication.\n\nReturns: ArrayRef[Status]\n\nremoveprofilebanner\n\nParameters: *none*\nRequired: *none*\n\nRemoves the uploaded profile banner for the authenticating user.\n\nReturns: Nothing\n\nTwitter API documentation: POST account/removeprofilebanner\n\n\nreportspam" }, { "name": "report_spam", "content": "Parameters: userid, screenname\nRequired: id\n\nThe user specified in the id is blocked by the authenticated user and reported as a spammer.\n\nReturns: User\n\nTwitter API documentation: POST users/reportspam\n\n\nretweet" }, { "name": "retweet", "content": "Parameters: idtrimuser\nRequired: id\n\nRetweets a tweet.\n\nReturns: Status\n\nTwitter API documentation: POST statuses/retweet/:id\n\n\nretweetedby DEPRECATED" }, { "name": "retweeted_by", "content": "Parameters: id, count, page, trimuser, includeentities\nRequired: id\n\nReturns up to 100 users who retweeted the status identified by \"id\".\n\nReturns: ArrayRef[User]\n\nretweetedbyids DEPRECATED" }, { "name": "retweeted_by_ids", "content": "Parameters: id, count, page, trimuser, includeentities\nRequired: id\n\nReturns the IDs of up to 100 users who retweeted the status identified by \"id\".\n\nReturns: ArrayRef[User]\n\nretweetedbyme DEPRECATED\n\nParameters: sinceid, maxid, count, page, trimuser, includeentities\nRequired: *none*\n\nReturns the 20 most recent retweets posted by the authenticating user.\n\nReturns: ArrayRef[Status]\n\nretweetedbyuser DEPRECATED" }, { "name": "retweeted_by_user", "content": "Parameters: id, userid, screenname\nRequired: id\n\nReturns the 20 most recent retweets posted by the specified user. The user is specified\nusing the userid or screenname parameters. This method is identical to \"retweetedbyme\"\nexcept you can choose the user to view. Does not require authentication, unless the user is\nprotected.\n\nReturns: ArrayRef\n\nretweetedtome DEPRECATED\n\nParameters: sinceid, maxid, count, page\nRequired: *none*\n\nReturns the 20 most recent retweets posted by the authenticating user's friends.\n\nReturns: ArrayRef[Status]\n\nretweetedtouser DEPRECATED" }, { "name": "retweeted_to_user", "content": "Parameters: id, userid, screenname\nRequired: id\n\nReturns the 20 most recent retweets posted by users the specified user follows. The user is\nspecified using the userid or screenname parameters. This method is identical to\n\"retweetedtome\" except you can choose the user to view. Does not require authentication,\nunless the user is protected.\n\nReturns: ArrayRef\n\nretweetersids" }, { "name": "retweeters_ids", "content": "Parameters: id, cursor, stringifyids\nRequired: id\n\nReturns a collection of up to 100 user IDs belonging to users who have retweeted the tweet\nspecified by the id parameter.\n\nThis method offers similar data to \"retweets\" and replaces API v1's \"retweetedbyids\"\nmethod.\n\nReturns: HashRef\n\nTwitter API documentation: GET statuses/retweeters/ids\n\n\nretweets" }, { "name": "retweets", "content": "Parameters: id, count, trimuser\nRequired: id\n\nReturns up to 100 of the first retweets of a given tweet.\n\nReturns: Arrayref[Status]\n\nTwitter API documentation: GET statuses/retweets/:id\n\n\nretweetsofme\nalias: retweetedofme\n\nParameters: sinceid, maxid, count, trimuser, includeentities, includeuserentities\nRequired: *none*\n\nReturns the 20 most recent tweets of the authenticated user that have been retweeted by\nothers.\n\nReturns: ArrayRef[Status]\n\nTwitter API documentation: GET statuses/retweetsofme\n\n\nreversegeocode" }, { "name": "reverse_geocode", "content": "Parameters: lat, long, accuracy, granularity, maxresults, callback\nRequired: lat, long\n\nSearch for places (cities and neighborhoods) that can be attached to a statuses/update.\nGiven a latitude and a longitude, return a list of all the valid places that can be used as\na placeid when updating a status. Conceptually, a query can be made from the user's\nlocation, retrieve a list of places, have the user validate the location he or she is at,\nand then send the ID of this location up with a call to statuses/update.\n\nThere are multiple granularities of places that can be returned -- \"neighborhoods\",\n\"cities\", etc. At this time, only United States data is available through this method.\n\nlat Required. The latitude to query about. Valid ranges are -90.0 to +90.0 (North is\npositive) inclusive.\n\nlong\nRequired. The longitude to query about. Valid ranges are -180.0 to +180.0 (East is\npositive) inclusive.\n\naccuracy\nOptional. A hint on the \"region\" in which to search. If a number, then this is a radius\nin meters, but it can also take a string that is suffixed with ft to specify feet. If\nthis is not passed in, then it is assumed to be 0m. If coming from a device, in\npractice, this value is whatever accuracy the device has measuring its location (whether\nit be coming from a GPS, WiFi triangulation, etc.).\n\ngranularity\nOptional. The minimal granularity of data to return. If this is not passed in, then\n\"neighborhood\" is assumed. \"city\" can also be passed.\n\nmaxresults\nOptional. A hint as to the number of results to return. This does not guarantee that the\nnumber of results returned will equal maxresults, but instead informs how many \"nearby\"\nresults to return. Ideally, only pass in the number of places you intend to display to\nthe user here.\n\nReturns: HashRef\n\nTwitter API documentation: GET geo/reversegeocode\n\n\nsavedsearches\n\nParameters: *none*\nRequired: *none*\n\nReturns the authenticated user's saved search queries.\n\nReturns: ArrayRef[SavedSearch]\n\nTwitter API documentation: GET savedsearches/list\n\n\nsearch" }, { "name": "search", "content": "Parameters: q, count, callback, lang, locale, rpp, sinceid, maxid, until, geocode,\nresulttype, includeentities\nRequired: q\n\nReturns a HASH reference with some meta-data about the query including the \"nextpage\",\n\"refreshurl\", and \"maxid\". The statuses are returned in \"results\". To iterate over the\nresults, use something similar to:\n\nmy $r = $nt->search($searchterm);\nfor my $status ( @{$r->{statuses}} ) {\nprint \"$status->{text}\\n\";\n}\n\nReturns: HashRef\n\nTwitter API documentation: GET search/tweets\n\n\nsentdirectmessages\nalias: directmessagessent\n\nParameters: sinceid, maxid, page, count, includeentities\nRequired: *none*\n\nReturns a list of the 20 most recent direct messages sent by the authenticating user\nincluding detailed information about the sending and recipient users.\n\nImportant: this method requires an access token with RWD (read, write, and direct message)\npermissions.\n\nReturns: ArrayRef[DirectMessage]\n\nTwitter API documentation: GET directmessages/sent\n\n\nshowdirectmessage" }, { "name": "show_direct_message", "content": "Parameters: id\nRequired: id\n\nReturns a single direct message, specified by an id parameter. Like the \"directmessages\"\nrequest, this method will include the user objects of the sender and recipient. Requires\nauthentication.\n\nImportant: this method requires an access token with RWD (read, write, and direct message)\npermissions.\n\nReturns: HashRef\n\nTwitter API documentation: GET directmessages/show\n\n\nshowfriendship\nalias: showrelationship\n\nParameters: sourceid, sourcescreenname, targetid, targetscreenname\nRequired: *none*\n\nReturns detailed information about the relationship between two users.\n\nReturns: Relationship\n\nTwitter API documentation: GET friendships/show\n\n\nshowlistmember\nalias: islistmember\n\nParameters: ownerscreenname, ownerid, listid, slug, userid, screenname,\nincludeentities, skipstatus\nRequired: *none*\n\nCheck if the specified user is a member of the specified list. Returns the user or undef.\n\nReturns: Maybe[User]\n\nTwitter API documentation: GET lists/members/show\n\n\nshowlistsubscriber\nalias: islistsubscriber\nalias: issubscriberlists\n\nParameters: ownerscreenname, ownerid, listid, slug, userid, screenname,\nincludeentities, skipstatus\nRequired: *none*\n\nReturns the user if they are a subscriber.\n\nReturns: User\n\nTwitter API documentation: GET lists/subscribers/show\n\n\nshowsavedsearch" }, { "name": "show_saved_search", "content": "Parameters: id\nRequired: id\n\nRetrieve the data for a saved search, by \"id\", owned by the authenticating user.\n\nReturns: SavedSearch\n\nTwitter API documentation: GET savedsearches/show/:id\n\n\nshowstatus" }, { "name": "show_status", "content": "Parameters: id, trimuser, includeentities, includemyretweet\nRequired: id\n\nReturns a single status, specified by the id parameter. The status's author will be returned\ninline.\n\nReturns: Status\n\nTwitter API documentation: GET statuses/show/:id\n\n\nshowuser\n\nParameters: userid, screenname, includeentities\nRequired: *none*\n\nReturns extended information of a given user, specified by ID or screen name as per the\nrequired id parameter. This information includes design settings, so third party developers\ncan theme their widgets according to a given user's preferences. You must be properly\nauthenticated to request the page of a protected user.\n\nReturns: ExtendedUser\n\nTwitter API documentation: GET users/show\n\n\nsimilarplaces" }, { "name": "similar_places", "content": "Parameters: lat, long, name, containedwithin, attribute:streetaddress, callback\nRequired: lat, long, name\n\nLocates places near the given coordinates which are similar in name.\n\nConceptually you would use this method to get a list of known places to choose from first.\nThen, if the desired place doesn't exist, make a request to \"addplace\" to create a new one.\n\nThe token contained in the response is the token needed to be able to create a new place.\n\nReturns: HashRef\n\nTwitter API documentation: GET geo/similarplaces\n\n\nsubscribelist\n\nParameters: ownerscreenname, ownerid, listid, slug\nRequired: *none*\n\nSubscribes the authenticated user to the specified list.\n\nReturns: List\n\nTwitter API documentation: POST lists/subscribers/create\n\n\nsuggestioncategories\n\nParameters: *none*\nRequired: *none*\n\nReturns the list of suggested user categories. The category slug can be used in the\n\"usersuggestions\" API method get the users in that category . Does not require\nauthentication.\n\nReturns: ArrayRef\n\nTwitter API documentation: GET users/suggestions\n\n\ntest DEPRECATED\n\nParameters: *none*\nRequired: *none*\n\nReturns the string \"ok\" status code.\n\nReturns: Hash\n\ntrendsavailable\n\nParameters: *none*\nRequired: *none*\n\nReturns the locations with trending topic information. The response is an array of\n\"locations\" that encode the location's WOEID (a Yahoo! Where On Earth ID\n) and some other human-readable information such\nas a the location's canonical name and country.\n\nFor backwards compatibility, this method accepts optional \"lat\" and \"long\" parameters. You\nshould call \"trendsclosest\" directly, instead.\n\nUse the WOEID returned in the location object to query trends for a specific location.\n\nReturns: ArrayRef[Location]\n\nTwitter API documentation: GET trends/available\n\n\ntrendsclosest\n\nParameters: lat, long\nRequired: *none*\n\nReturns the locations with trending topic information. The response is an array of\n\"locations\" that encode the location's WOEID (a Yahoo! Where On Earth ID\n) and some other human-readable information such\nas a the location's canonical name and country. The results are sorted by distance from that\nlocation, nearest to farthest.\n\nUse the WOEID returned in the location object to query trends for a specific location.\n\nReturns: ArrayRef[Location]\n\nTwitter API documentation: GET trends/closest\n\n\ntrendscurrent DEPRECATED" }, { "name": "trends_current", "content": "Parameters: exclude\nRequired: *none*\n\nReturns the current top ten trending topics on Twitter. The response includes the time of\nthe request, the name of each trending topic, and query used on Twitter Search results page\nfor that topic.\n\nReturns: HashRef\n\ntrendsdaily DEPRECATED\n\nParameters: date, exclude\nRequired: *none*\n\nReturns the top 20 trending topics for each hour in a given day.\n\nReturns: HashRef\n\ntrendsplace" }, { "name": "trends_place", "content": "alias: trendslocation\n\nParameters: id, exclude\nRequired: id\n\nReturns the top 10 trending topics for a specific WOEID. The response is an array of \"trend\"\nobjects that encode the name of the trending topic, the query parameter that can be used to\nsearch for the topic on Search, and the direct URL that can be issued against Search. This\ninformation is cached for five minutes, and therefore users are discouraged from querying\nthese endpoints faster than once every five minutes. Global trends information is also\navailable from this API by using a WOEID of 1.\n\nReturns: ArrayRef[Trend]\n\nTwitter API documentation: GET trends/place\n\n\ntrendsweekly DEPRECATED\n\nParameters: date, exclude\nRequired: *none*\n\nReturns the top 30 trending topics for each day in a given week.\n\nReturns: HashRef\n\nunsubscribelist\n\nParameters: listid, slug, ownerscreenname, ownerid\nRequired: *none*\n\nUnsubscribes the authenticated user from the specified list.\n\nReturns: List\n\nTwitter API documentation: POST lists/subscribers/destroy\n\n\nupdate" }, { "name": "update", "content": "Parameters: attachmenturl, displaycoordinates, inreplytostatusid, lat, long,\nmediaids, placeid, status, trimuser\nRequired: status\n\nUpdates the authenticating user's status. Requires the status parameter specified. A status\nupdate with text identical to the authenticating user's current status will be ignored.\n\nstatus\nRequired. The text of your status update. URL encode as necessary. Statuses over 140\ncharacters will cause a 403 error to be returned from the API.\n\ninreplytostatusid\nOptional. The ID of an existing status that the update is in reply to. o Note: This\nparameter will be ignored unless the author of the tweet this parameter references is\nmentioned within the status text. Therefore, you must include @username, where username\nis the author of the referenced tweet, within the update.\n\nlat Optional. The location's latitude that this tweet refers to. The valid ranges for\nlatitude is -90.0 to +90.0 (North is positive) inclusive. This parameter will be ignored\nif outside that range, if it is not a number, if geoenabled is disabled, or if there\nnot a corresponding long parameter with this tweet.\n\nlong\nOptional. The location's longitude that this tweet refers to. The valid ranges for\nlongitude is -180.0 to +180.0 (East is positive) inclusive. This parameter will be\nignored if outside that range, if it is not a number, if geoenabled is disabled, or if\nthere not a corresponding lat parameter with this tweet.\n\nplaceid\nOptional. The place to attach to this status update. Valid placeids can be found by\nquerying \"reversegeocode\".\n\ndisplaycoordinates\nOptional. By default, geo-tweets will have their coordinates exposed in the status\nobject (to remain backwards compatible with existing API applications). To turn off the\ndisplay of the precise latitude and longitude (but keep the contextual location\ninformation), pass \"displaycoordinates =\" 0> on the status update.\n\nReturns: Status\n\nTwitter API documentation: POST statuses/update\n\n\nupdateaccountsettings\n\nParameters: trendlocationwoid, sleeptimeenabled, startsleeptime, endsleeptime,\ntimezone, lang\nRequired: *none*\n\nUpdates the authenticating user's settings.\n\nReturns: HashRef\n\nTwitter API documentation: POST account/settings\n\n\nupdatedeliverydevice" }, { "name": "update_delivery_device", "content": "Parameters: device, includeentities\nRequired: device\n\nSets which device Twitter delivers updates to for the authenticating user. Sending none as\nthe device parameter will disable SMS updates.\n\nReturns: BasicUser\n\nTwitter API documentation: POST account/updatedeliverydevice\n\n\nupdatefriendship\n\nParameters: userid, screenname, device, retweets\nRequired: *none*\n\nAllows you enable or disable retweets and device notifications from the specified user. All\nother values are assumed to be false. Requires authentication.\n\nReturns: HashRef\n\nTwitter API documentation: POST friendships/update\n\n\nupdatelist\n\nParameters: listid, slug, name, mode, description, ownerscreenname, ownerid\nRequired: *none*\n\nUpdates the specified list. The authenticated user must own the list to be able to update\nit.\n\nReturns: List\n\nTwitter API documentation: POST lists/update\n\n\nupdatelocation DEPRECATED" }, { "name": "update_location", "content": "Parameters: location\nRequired: location\n\nThis method has been deprecated in favor of the updateprofile method. Its URL will continue\nto work, but please consider migrating to the newer and more comprehensive method of\nupdating profile attributes.\n\nReturns: BasicUser\n\nupdateprofile\n\nParameters: name, url, location, description, includeentities, skipstatus\nRequired: *none*\n\nSets values that users are able to set under the \"Account\" tab of their settings page. Only\nthe parameters specified will be updated; to only update the \"name\" attribute, for example,\nonly include that parameter in your request.\n\nReturns: ExtendedUser\n\nTwitter API documentation: POST account/updateprofile\n\n\nupdateprofilebackgroundimage\n\nParameters: image, tile, includeentities, skipstatus, use\nRequired: *none*\n\nUpdates the authenticating user's profile background image. The \"image\" parameter must be an\narrayref with the same interpretation as the \"image\" parameter in the \"updateprofileimage\"\nmethod. See that method's documentation for details. The \"use\" parameter allows you to\nspecify whether to use the uploaded profile background or not.\n\nReturns: ExtendedUser\n\nTwitter API documentation: POST account/updateprofilebackgroundimage\n\n\nupdateprofilebanner" }, { "name": "update_profile_banner", "content": "Parameters: banner, width, height, offsetleft, offsettop\nRequired: banner\n\nUploads a profile banner on behalf of the authenticating user. The \"image\" parameter is an\narrayref with the following interpretation:\n\n[ $file ]\n[ $file, $filename ]\n[ $file, $filename, ContentType => $mimetype ]\n[ undef, $filename, ContentType => $mimetype, Content => $rawimagedata ]\n\nThe first value of the array ($file) is the name of a file to open. The second value\n($filename) is the name given to Twitter for the file. If $filename is not provided, the\nbasename portion of $file is used. If $mimetype is not provided, it will be provided\nautomatically using LWP::MediaTypes::guessmediatype().\n\n$rawimagedata can be provided, rather than opening a file, by passing \"undef\" as the first\narray value.\n\nReturns: Nothing\n\nTwitter API documentation: POST account/updateprofilebanner\n\n\nupdateprofilecolors\n\nParameters: profilebackgroundcolor, profiletextcolor, profilelinkcolor,\nprofilesidebarfillcolor, profilesidebarbordercolor, includeentities, skipstatus\nRequired: *none*\n\nSets one or more hex values that control the color scheme of the authenticating user's\nprofile page on twitter.com. These values are also returned in the /users/show API method.\n\nReturns: ExtendedUser\n\nTwitter API documentation: POST account/updateprofilecolors\n\n\nupdateprofileimage" }, { "name": "update_profile_image", "content": "Parameters: image, includeentities, skipstatus\nRequired: image\n\nUpdates the authenticating user's profile image. The \"image\" parameter is an arrayref with\nthe following interpretation:\n\n[ $file ]\n[ $file, $filename ]\n[ $file, $filename, ContentType => $mimetype ]\n[ undef, $filename, ContentType => $mimetype, Content => $rawimagedata ]\n\nThe first value of the array ($file) is the name of a file to open. The second value\n($filename) is the name given to Twitter for the file. If $filename is not provided, the\nbasename portion of $file is used. If $mimetype is not provided, it will be provided\nautomatically using LWP::MediaTypes::guessmediatype().\n\n$rawimagedata can be provided, rather than opening a file, by passing \"undef\" as the first\narray value.\n\nReturns: ExtendedUser\n\nTwitter API documentation: POST account/updateprofileimage\n\n\nupdatewithmedia DEPRECATED" }, { "name": "update_with_media", "content": "Parameters: status, media[], possiblysensitive, inreplytostatusid, lat, long, placeid,\ndisplaycoordinates\nRequired: status, media[]\n\nUpdates the authenticating user's status and attaches media for upload.\n\nNote that Twitter has marked this endpoint as deprecated, and recommends instead calling\n\"upload\", then (optionally) \"createmediametadata\", then \"update\".\n\nThe \"media[]\" parameter is an arrayref with the following interpretation:\n\n[ $file ]\n[ $file, $filename ]\n[ $file, $filename, ContentType => $mimetype ]\n[ undef, $filename, ContentType => $mimetype, Content => $rawimagedata ]\n\nThe first value of the array ($file) is the name of a file to open. The second value\n($filename) is the name given to Twitter for the file. If $filename is not provided, the\nbasename portion of $file is used. If $mimetype is not provided, it will be provided\nautomatically using LWP::MediaTypes::guessmediatype().\n\n$rawimagedata can be provided, rather than opening a file, by passing \"undef\" as the first\narray value.\n\nThe Tweet text will be rewritten to include the media URL(s), which will reduce the number\nof characters allowed in the Tweet text. If the URL(s) cannot be appended without text\ntruncation, the tweet will be rejected and this method will return an HTTP 403 error.\n\nReturns: Status\n\nupload" }, { "name": "upload", "content": "Parameters: media\nRequired: media\n\nUploads an image to twitter without immediately posting it to the authenticating user's\ntimeline. Its return-value hashref notably contains a \"mediaid\" value that's useful as a\nparameter value in various other endpoint calls, such as \"update\" and\n\"createmediametadata\".\n\nReturns: HashRef\n\nTwitter API documentation: POST media/upload\n\n\nuploadstatus" }, { "name": "upload_status", "content": "Parameters: mediaid, command\nRequired: mediaid, command\n\nCheck the status for async video uploads.\n\nReturns: status\n\nTwitter API documentation: GET media/upload\n\n\nusersuggestions" }, { "name": "user_suggestions", "content": "alias: followsuggestions\n\nParameters: slug, lang\nRequired: slug\n\nAccess the users in a given slug (category) of the Twitter suggested user list and return\ntheir most recent status if they are not a protected user. Currently supported values for\noptional parameter \"lang\" are \"en\", \"fr\", \"de\", \"es\", \"it\". Does not require authentication.\n\nReturns: ArrayRef\n\nTwitter API documentation: GET users/suggestions/:slug/members\n\n\nusersuggestionsfor" }, { "name": "user_suggestions_for", "content": "alias: followsuggestionsfor\n\nParameters: slug, lang\nRequired: slug\n\nAccess the users in a given slug (category) of the Twitter suggested user list.\n\nReturns: ArrayRef\n\nTwitter API documentation: GET users/suggestions/:slug\n\n\nusertimeline\n\nParameters: userid, screenname, sinceid, maxid, count, trimuser, excludereplies,\nincluderts, contributordetails\nRequired: *none*\n\nReturns the 20 most recent statuses posted by the authenticating user, or the user specified\nby \"screenname\" or \"userid\".\n\nReturns: ArrayRef[Status]\n\nTwitter API documentation: GET statuses/usertimeline\n\n\nuserssearch" }, { "name": "users_search", "content": "alias: findpeople\nalias: searchusers\n\nParameters: q, perpage, page, count, includeentities\nRequired: q\n\nRun a search for users similar to Find People button on Twitter.com; the same results\nreturned by people search on Twitter.com will be returned by using this API (about being\nlisted in the People Search). It is only possible to retrieve the first 1000 matches from\nthis API.\n\nReturns: ArrayRef[Users]\n\nTwitter API documentation: GET users/search\n\n\nverifycredentials\n\nParameters: includeentities, skipstatus, includeemail\nRequired: *none*\n\nReturns an HTTP 200 OK response code and a representation of the requesting user if\nauthentication was successful; returns a 401 status code and an error message if not. Use\nthis method to test if supplied user credentials are valid.\n\nReturns: ExtendedUser\n\nTwitter API documentation: GET account/verifycredentials\n\n\nupdatewithmedia" }, { "name": "update_with_media", "content": "Parameters: status, media[], possiblysensitive, inreplytostatusid, lat, long, placeid,\ndisplaycoordinates\nRequired: status, media\n\nUpdates the authenticating user's status and attaches media for upload.\n\nThe \"media[]\" parameter is an arrayref with the following interpretation:\n\n[ $file ]\n[ $file, $filename ]\n[ $file, $filename, ContentType => $mimetype ]\n[ undef, $filename, ContentType => $mimetype, Content => $rawimagedata ]\n\nThe first value of the array ($file) is the name of a file to open. The second value\n($filename) is the name given to Twitter for the file. If $filename is not provided, the\nbasename portion of $file is used. If $mimetype is not provided, it will be provided\nautomatically using LWP::MediaTypes::guessmediatype().\n\n$rawimagedata can be provided, rather than opening a file, by passing \"undef\" as the first\narray value.\n\nThe Tweet text will be rewritten to include the media URL(s), which will reduce the number\nof characters allowed in the Tweet text. If the URL(s) cannot be appended without text\ntruncation, the tweet will be rejected and this method will return an HTTP 403 error.\n\nReturns: Status\n\nTwitter API documentation: POST statuses/updatewithmedia\n\n" } ] }, "Search API Methods": { "content": "These methods are provided when trait \"API::Search\" is included in the \"traits\" option to \"new\".\n\nsearch", "subsections": [ { "name": "search", "content": "Parameters: q, geocode, lang, locale, resulttype, count, until, sinceid, maxid,\nincludeentities, callback\nRequired: q\n\nReturns a HASH reference with some meta-data about the query including the \"nextpage\",\n\"refreshurl\", and \"maxid\". The statuses are returned in \"results\". To iterate over the\nresults, use something similar to:\n\nmy $r = $nt->search($searchterm);\nmy $r = $nt->search({ q => $searchterm, count => 10 })\n\nfor my $status ( @{$r->{results}} ) {\nprint \"$status->{text}\\n\";\n}\n\nReturns: HashRef\n" } ] }, "Lists API Methods": { "content": "The original Lists API methods have been deprecated. Net::Twitter::Role::API::Lists provides\nbackwards compatibility for code written using those deprecated methods. If you're not already\nusing the \"API::Lists\" trait, don't! Use the lists methods described above.\n\nIf you are using the \"API::Lists\" trait, you should remove it from your code and change the\narguments in your list API method calls to match those described above.\n\nAlso, if using the \"API::Lists\" trait, you can pass synthetic argument \"-legacylistsapi\" set\nto 0 for individual calls to use the new endpoints semantics.\n", "subsections": [] }, "TwitterVision API Methods": { "content": "These methods are provided when trait \"API::TwitterVision\" is included in the \"traits\" option to\n\"new\".\n\ncurrentstatus", "subsections": [ { "name": "current_status", "content": "Parameters: id, callback\nRequired: id\n\nGet the current location and status of a user.\n\nReturns: HashRef\n\nupdatetwittervision" }, { "name": "update_twittervision", "content": "Parameters: location\nRequired: location\n\nUpdates the location for the authenticated user.\n\nReturns: HashRef\n" } ] }, "LEGACY COMPATIBILITY": { "content": "This version of \"Net::Twitter\" automatically includes the \"Legacy\" trait if no \"traits\" option\nis provided to \"new\". Therefore, these 2 calls are currently equivalent:\n\n$nt = Net::Twitter->new(username => $user, password => $passwd);\n$nt = Net::Twitter->new(\nusername => $user,\npassword => $passwd,\ntraits => ['Legacy'],\n);\n\nThus, existing applications written for a prior version of \"Net::Twitter\" should continue to\nrun, without modification, with this version.\n\nIn a future release, the default traits may change. Prior to that change, however, a nearer\nfuture version will add a warning if no \"traits\" option is provided to \"new\". To avoid this\nwarning, add an appropriate \"traits\" option to your existing application code.\n", "subsections": [] }, "ERROR HANDLING": { "content": "There are currently two strategies for handling errors: throwing exceptions and wrapping errors.\nException handling is the newer, recommended strategy.\n", "subsections": [ { "name": "Wrapping Errors", "content": "When trait \"WrapError\" is specified (or \"Legacy\", which includes trait \"WrapError\"),\n\"Net::Twitter\" returns undef on error. To retrieve information about the error, use methods\n\"httpcode\", \"httpmessage\", and \"geterror\". These methods are described in the\nNet::Twitter::Role::WrapError.\n\nif ( my $followers = $nt->followers ) {\nfor my $follower ( @$followers ) {\n#...\n}\n}\nelse {\nwarn \"HTTP message: \", $nt->httpmessage, \"\\n\";\n}\n\nSince an error is stored in the object instance, this error handling strategy is problematic\nwhen using a user agent like \"LWP::UserAgent::POE\" that provides concurrent requests. The error\nfor one request can be overwritten by a concurrent request before you have an opportunity to\naccess it.\n" }, { "name": "Exception Handling", "content": "When \"Net::Twitter\" encounters a Twitter API error or a network error, it throws a\n\"Net::Twitter::Error\" object. You can catch and process these exceptions by using \"eval\" blocks\nand testing $@:\n\neval {\nmy $statuses = $nt->friendstimeline(); # this might die!\n\nfor my $status ( @$statuses ) {\n#...\n}\n};\nif ( $@ ) {\n# friendstimeline encountered an error\n\nif ( blessed $@ && $@->isa('Net::Twitter::Error') ) {\n#... use the thrown error obj\nwarn $@->error;\n}\nelse {\n# something bad happened!\ndie $@;\n}\n}\n\n\"Net::Twitter::Error\" stringifies to something reasonable, so if you don't need detailed error\ninformation, you can simply treat $@ as a string:\n\neval { $nt->update($status) };\nif ( $@ ) {\nwarn \"update failed because: $@\\n\";\n}\n" } ] }, "FAQ": { "content": "Why does \"->followers({ screenname => $friend })\" return *my* followers instead of $friends's?\nFirst, check carefully to make sure you've spelled \"screenname\" correctly. Twitter\nsometimes discards parameters it doesn't recognize. In this case, the result is a list of\nyour own followers---the same thing that would happen if you called \"followers\" without the\n\"screenname\" parameter.\n\nHow do I use the \"geocode\" parameter in the Search API?\nThe \"geocode\" parameter value includes a latitude, longitude, and radius separated with\ncommas.\n\n$r = $nt->search({ geocode => \"45.511795,-122.675629,25mi\" });\n\nHow do I get Twitter to display something other than \"from Perl Net::Twitter\"?\nIf you set the source parameter to \"api\", twitter will display \"from API\", and if you set it\nto the empty string, twitter will display, \"from web\".\n\n$nt = Net::Twitter->new(netrc => 1,legacy => 0,ssl => 1,source => 'api');\n$nt->update('A post with the source parameter overridden.');\n# result: http://twitter.com/semifortest/status/6541105458\n\n$nt = Net::Twitter->new(netrc => 1,legacy => 0,ssl => 1,source => '');\n$nt->update('A post with the source parameter overridden.');\n# result: http://twitter.com/semifortest/status/6541257224\n\nIf you want something other than \"Net::Twitter\", \"API\", or \"web\", you need to register an\napplication and use OAuth authentication. If you do that, you can have any name you choose\nfor the application printed as the source. Since rolling out OAuth, Twitter has stopped\nissuing new registered source parameters, only existing register source parameters are\nvalid.\n", "subsections": [] }, "SEE ALSO": { "content": "Net::Twitter::Error\nThe \"Net::Twitter\" exception object.\n\n\nThis is the official Twitter API documentation. It describes the methods and their\nparameters in more detail and may be more current than the documentation provided with this\nmodule.\n\nLWP::UserAgent::POE\nThis LWP::UserAgent compatible class can be used in POE based application along with\nNet::Twitter to provide concurrent, non-blocking requests.\n\nCatalyst::Authentication::Credential::Twitter\nThis module, by Jesse Stay, provides Twitter OAuth authentication support for the popular\nCatalyst web application framework.\n", "subsections": [] }, "SUPPORT": { "content": "Please report bugs to \"bug-net-twitter@rt.cpan.org\", or through the web interface at\n.\n\nJoin the Net::Twitter IRC channel at .\n\nFollow perlapi: .\n\nTrack Net::Twitter development at .\n", "subsections": [] }, "ACKNOWLEDGEMENTS": { "content": "Many thanks to Chris Thompson , the original author of \"Net::Twitter\" and\nall versions prior to 3.00.\n\nAlso, thanks to Chris Prather (perigrin) for answering many design and implementation questions,\nespecially with regards to Moose.\n", "subsections": [] }, "AUTHOR": { "content": "Marc Mims (@semifor on Twitter)\n", "subsections": [] }, "CONTRIBUTORS": { "content": "Roberto Etcheverry (@retcheverry on Twitter)\n\nKATOU Akira\n\nFrancisco Pecorella\n\nDoug Bell \n\nJustin Hunter \n\nAllen Haim \n\nJoe Papperello (@antipasta on Github and Twitter)\n\nSamuel Kaufman (ediblenergy on Github)\n\nAnnMary Mathew (ammathew on Github)\n\nOlaf Alders (oalders on Github)\n", "subsections": [] }, "LICENSE": { "content": "Copyright (c) 2009-2016 Marc Mims\n\nThe Twitter API itself, and the description text used in this module is:\n\nCopyright (c) 2016 Twitter\n\nThis library is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself.\n", "subsections": [] }, "DISCLAIMER OF WARRANTY": { "content": "BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE\nEXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER\nEXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY\nAND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE\nSOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY\nSERVICING, REPAIR, OR CORRECTION.\n\nIN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER,\nOR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE\nLICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR\nCONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT\nLIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR\nOTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.\n", "subsections": [] } } } }