Module: Twitter::API::Trends

### Home Classes Methods

### In Files

- lib/twitter/api/trends.rb

### Methods

- #local_trends
- #trend_locations
- #trends
- #trends_available
- #trends_closest
- #trends_place

### Included Modules

- Twitter::API::Utils

### Class/Module Index

Quicksearch

- Twitter
- Twitter::API
- Twitter::API::Arguments
- Twitter::API::DirectMessages
- Twitter::API::Favorites
- Twitter::API::FriendsAndFollowers
- Twitter::API::Help
- Twitter::API::Lists
- Twitter::API::PlacesAndGeo
- Twitter::API::SavedSearches
- Twitter::API::Search
- Twitter::API::SpamReporting
- Twitter::API::SuggestedUsers
- Twitter::API::Timelines
- Twitter::API::Trends
- Twitter::API::Tweets
- Twitter::API::Undocumented
- Twitter::API::Users
- Twitter::API::Utils
- Twitter::Action
- Twitter::Action::Favorite
- Twitter::Action::Follow
- Twitter::Action::ListMemberAdded
- Twitter::Action::Mention
- Twitter::Action::Reply
- Twitter::Action::Retweet
- Twitter::Action::Status
- Twitter::Action::Tweet
- Twitter::ActionFactory
- Twitter::Base
- Twitter::BasicUser
- Twitter::Client
- Twitter::Configurable
- Twitter::Configuration
- Twitter::Creatable
- Twitter::Cursor
- Twitter::Default
- Twitter::DirectMessage
- Twitter::Entity
- Twitter::Entity::Hashtag
- Twitter::Entity::Url
- Twitter::Entity::UserMention
- Twitter::Error
- Twitter::Error::AlreadyFavorited
- Twitter::Error::AlreadyRetweeted
- Twitter::Error::BadGateway
- Twitter::Error::BadRequest
- Twitter::Error::ClientError
- Twitter::Error::ConfigurationError
- Twitter::Error::DecodeError
- Twitter::Error::EnhanceYourCalm
- Twitter::Error::Forbidden
- Twitter::Error::GatewayTimeout
- Twitter::Error::IdentityMapKeyError
- Twitter::Error::InternalServerError
- Twitter::Error::NotAcceptable
- Twitter::Error::NotFound
- Twitter::Error::RateLimited
- Twitter::Error::ServerError
- Twitter::Error::ServiceUnavailable
- Twitter::Error::TooManyRequests
- Twitter::Error::Unauthorized
- Twitter::Error::UnprocessableEntity
- Twitter::Exceptable
- Twitter::Factory
- Twitter::Geo
- Twitter::Geo::Point
- Twitter::Geo::Polygon
- Twitter::GeoFactory
- Twitter::Identity
- Twitter::IdentityMap
- Twitter::Language
- Twitter::List
- Twitter::Media
- Twitter::Media::Photo
- Twitter::MediaFactory
- Twitter::Metadata
- Twitter::OEmbed
- Twitter::Place
- Twitter::ProfileBanner
- Twitter::RateLimit
- Twitter::Relationship
- Twitter::Request
- Twitter::Request::MultipartWithFile
- Twitter::Response
- Twitter::Response::ParseJson
- Twitter::Response::RaiseError
- Twitter::SavedSearch
- Twitter::SearchResults
- Twitter::Settings
- Twitter::Size
- Twitter::SourceUser
- Twitter::Status
- Twitter::Suggestion
- Twitter::TargetUser
- Twitter::Trend
- Twitter::Tweet
- Twitter::User
- Twitter::Version
- Enumerable
- Kernel

No matching classes.

# Twitter::API::Trends

### Public Instance Methods

local_trends(id=1, options={}) click to toggle source
Alias for: trends
trend_locations(options={}) click to toggle source
Alias for: trends_available
trends(id=1, options={}) click to toggle source

Returns the top 10 trending topics for a specific WOEID

@see dev.twitter.com/docs/api/1.1/get/trends/place @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @param id [Integer] The {developer.yahoo.com/geo/geoplanet Yahoo! Where On Earth ID} of the location to return trending information for. WOEIDs can be retrieved by calling {Twitter::API::Trends#trend_locations}. Global information is available by using 1 as the WOEID. @param options [Hash] A customizable set of options. @option options [String] :exclude Setting this equal to 'hashtags' will remove all hashtags from the trends list. @return [Array<Twitter::Trend>] @example Return the top 10 trending topics for San Francisco

    Twitter.trends(2487956)

    # File lib/twitter/api/trends.rb, line 22
    def trends(id=1, options={})
      options[:id] = id
      response = get("/1.1/trends/place.json", options)
      objects_from_array(Twitter::Trend, response[:body].first[:trends])
    end

Also aliased as: local_trends, trends_place
trends_available(options={}) click to toggle source

Returns the locations that Twitter has trending topic information for

@see dev.twitter.com/docs/api/1.1/get/trends/available @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @param options [Hash] A customizable set of options. @return [Array<Twitter::Place>] @example Return the locations that Twitter has trending topic information for

    Twitter.trends_available

    # File lib/twitter/api/trends.rb, line 40
    def trends_available(options={})
      objects_from_response(Twitter::Place, :get, "/1.1/trends/available.json", options)
    end

Also aliased as: trend_locations
trends_closest(options={}) click to toggle source

Returns the locations that Twitter has trending topic information for, closest to a specified location.

@see dev.twitter.com/docs/api/1.1/get/trends/closest @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @param options [Hash] A customizable set of options. @option options [Float] :lat If provided with a :long option the available trend locations will be sorted by distance, nearest to furthest, to the co-ordinate pair. The valid ranges for latitude are -90.0 to +90.0 (North is positive) inclusive. @option options [Float] :long If provided with a :lat option the available trend locations will be sorted by distance, nearest to furthest, to the co-ordinate pair. The valid ranges for longitude are -180.0 to +180.0 (East is positive) inclusive. @return [Array<Twitter::Place>] @example Return the locations that Twitter has trending topic information for

    Twitter.trends_closest

    # File lib/twitter/api/trends.rb, line 57
    def trends_closest(options={})
      objects_from_response(Twitter::Place, :get, "/1.1/trends/closest.json", options)
    end

trends_place(id=1, options={}) click to toggle source
Alias for: trends

[Validate]

Generated with the Darkfish Rdoc Generator 2.