Module: Twitter::REST::PlacesAndGeo

Includes:
Utils
Included in:
API
Defined in:
lib/twitter/rest/places_and_geo.rb

Constant Summary

Constants included from Utils

Utils::DEFAULT_CURSOR

Instance Method Summary collapse

Methods included from Utils

flat_pmap, pmap

Instance Method Details

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

Search for places that can be attached to a Tweets#update

Parameters:

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

    A customizable set of options.

Options Hash (options):

  • :lat (Float) —

    The latitude to search around. This option will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn't a corresponding :long option.

  • :long (Float) —

    The longitude to search around. The valid range for longitude is -180.0 to +180.0 (East is positive) inclusive. This option will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding :lat option.

  • :query (String) —

    Free-form text to match against while executing a geo-based query, best suited for finding nearby locations by name.

  • :ip (String) —

    An IP address. Used when attempting to fix geolocation based off of the user's IP address.

  • :granularity (String) — default: 'neighborhood' —

    This is the minimal granularity of place types to return and must be one of: 'poi', 'neighborhood', 'city', 'admin' or 'country'.

  • :accuracy (String) — default: '0m' —

    A hint on the "region" in which to search. If a number, then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet. If coming from a device, in practice, this value is whatever accuracy the device has measuring its location (whether it be coming from a GPS, WiFi triangulation, etc.).

  • :max_results (Integer) —

    A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many "nearby" results to return. Ideally, only pass in the number of places you intend to display to the user here.

  • :contained_within (String) —

    This is the place_id which you would like to restrict the search results to. Setting this value means only places within the given place_id will be found.

  • :"attribute:street_address" (String) —

    This option searches for places which have this given street address. There are other well-known and application-specific attributes available. Custom attributes are also permitted.

Returns:

Raises:

See Also:

Rate Limited?:

  • Yes

Authentication:

  • Requires user context



58
59
60
 
# File 'lib/twitter/rest/places_and_geo.rb', line 58

def geo_search(options = {})
  perform_get_with_object('/1.1/geo/search.json', options, Twitter::GeoResults)
end

#place(place_id, options = {}) ⇒ Twitter::Place

Returns all the information about a known place

Parameters:

  • place_id (String) —

    A place in the world. These IDs can be retrieved from #reverse_geocode.

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

    A customizable set of options.

Returns:

Raises:

See Also:

Rate Limited?:

  • Yes

Authentication:

  • Requires user context



19
20
21
 
# File 'lib/twitter/rest/places_and_geo.rb', line 19

def place(place_id, options = {})
  perform_get_with_object("/1.1/geo/id/#{place_id}.json", options, Twitter::Place)
end

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

Note:

This request is an informative call and will deliver generalized results about geography.

Searches for up to 20 places that can be used as a place_id

Parameters:

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

    A customizable set of options.

Options Hash (options):

  • :lat (Float) —

    The latitude to search around. This option will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn't a corresponding :long option.

  • :long (Float) —

    The longitude to search around. The valid range for longitude is -180.0 to +180.0 (East is positive) inclusive. This option will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding :lat option.

  • :accuracy (String) — default: '0m' —

    A hint on the "region" in which to search. If a number, then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet. If coming from a device, in practice, this value is whatever accuracy the device has measuring its location (whether it be coming from a GPS, WiFi triangulation, etc.).

  • :granularity (String) — default: 'neighborhood' —

    This is the minimal granularity of place types to return and must be one of: 'poi', 'neighborhood', 'city', 'admin' or 'country'.

  • :max_results (Integer) —

    A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many "nearby" results to return. Ideally, only pass in the number of places you intend to display to the user here.

Returns:

Raises:

See Also:

Rate Limited?:

  • Yes

Authentication:

  • Requires user context



37
38
39
 
# File 'lib/twitter/rest/places_and_geo.rb', line 37

def reverse_geocode(options = {})
  perform_get_with_object('/1.1/geo/reverse_geocode.json', options, Twitter::GeoResults)
end

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

Note:

Conceptually, you would use this method to get a list of known places to choose from first. Then, if the desired place doesn't exist, make a request to #place to create a new one. The token contained in the response is the token necessary to create a new place.

Locates places near the given coordinates which are similar in name

Parameters:

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

    A customizable set of options.

Options Hash (options):

  • :lat (Float) —

    The latitude to search around. This option will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn't a corresponding :long option.

  • :long (Float) —

    The longitude to search around. The valid range for longitude is -180.0 to +180.0 (East is positive) inclusive. This option will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding :lat option.

  • :name (String) —

    The name a place is known as.

  • :contained_within (String) —

    This is the place_id which you would like to restrict the search results to. Setting this value means only places within the given place_id will be found.

  • :"attribute:street_address" (String) —

    This option searches for places which have this given street address. There are other well-known and application-specific attributes available. Custom attributes are also permitted.

Returns:

Raises:

See Also:

Rate Limited?:

  • Yes

Authentication:

  • Requires user context



77
78
79
 
# File 'lib/twitter/rest/places_and_geo.rb', line 77

def similar_places(options = {})
  perform_get_with_object('/1.1/geo/similar_places.json', options, Twitter::GeoResults)
end