Module: Twitter::REST::Trends

Includes:

Utils

Included in:

API

Defined in:

lib/twitter/rest/trends.rb

Constant Summary

Constants included from Utils

Utils::DEFAULT_CURSOR

Instance Method Summary

• #trends(id = 1, options = {}) ⇒ Array<Twitter::Trend> (also: #local_trends, #trends_place)

  Returns the top 50 trending topics for a specific WOEID.

• #trends_available(options = {}) ⇒ Array<Twitter::Place> (also: #trend_locations)

  Returns the locations that Twitter has trending topic information for.

• #trends_closest(options = {}) ⇒ Array<Twitter::Place>

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

Methods included from Utils

flat_pmap, pmap

Instance Method Details

#trends(id = 1, options = {}) ⇒ Array<Twitter::Trend> Also known as: local_trends, trends_place

Returns the top 50 trending topics for a specific WOEID

Parameters:

• id (Integer) (defaults to: 1) —

  The Yahoo! Where On Earth ID of the location to return trending information for. WOEIDs can be retrieved by calling #trends_available. Global information is available by using 1 as the WOEID.

• options (Hash) (defaults to: {}) —

  A customizable set of options.

Options Hash (options):

• :exclude (String) —

  Setting this equal to 'hashtags' will remove all hashtags from the trends list.

Returns:

• (Array<Twitter::Trend>)

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/get/trends/place

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/twitter/rest/trends.rb', line 21

def trends(id = 1, options = {})
  options = options.dup
  options[:id] = id
  response = perform_get("/1.1/trends/place.json", options).first
  Twitter::TrendResults.new(response)
end

#trends_available(options = {}) ⇒ Array<Twitter::Place> Also known as: trend_locations

Returns the locations that Twitter has trending topic information for

Parameters:

• options (Hash) (defaults to: {}) —

  A customizable set of options.

Returns:

• (Array<Twitter::Place>)

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/get/trends/available

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/twitter/rest/trends.rb', line 38

def trends_available(options = {})
  perform_get_with_objects("/1.1/trends/available.json", options, Twitter::Place)
end

#trends_closest(options = {}) ⇒ Array<Twitter::Place>

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

Parameters:

• options (Hash) (defaults to: {}) —

  A customizable set of options.

Options Hash (options):

• :lat (Float) —

  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.

• :long (Float) —

  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.

Returns:

• (Array<Twitter::Place>)

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/get/trends/closest

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/twitter/rest/trends.rb', line 53

def trends_closest(options = {})
  perform_get_with_objects("/1.1/trends/closest.json", options, Twitter::Place)
end