Locations¶
This class allows you to search for location information in various ways.
Name Lookup¶
Search for a location boundary by name. The search primarily uses the location names, but you can also filter the results by boundary type. See the documentation on name lookup for more information.
import urbanairship as ua
airship = ua.Airship(app_key, master_secret)
l = ua.LocationFinder(airship)
l.name_lookup('name', 'type')
Note
name is a required parameter, but type is optional
Coordinates Lookup¶
Search for a location by latitude and longitude coordinates. Type is an optional parameter. See the documentation on coordinates lookup for more information.
import urbanairship as ua
airship = ua.Airship(app_key, master_secret)
l = ua.LocationFinder(airship)
l.coordinates_lookup('lat', 'long', 'type')
Note
longitude and latitude are required parameters that must be numbers. Type is an optional parameter.
Bounding Box Lookup¶
Search for location using a bounding box. See the documentation on bounding box lookup for more information.
import urbanairship as ua
airship = ua.Airship(app_key, master_secret)
l = ua.LocationFinder(airship)
l.bounding_box_lookup('lat1', 'long1', 'lat2', 'long2', 'type')
Note
lat1, long1, lat2, and long2 and are required parameters that must be numbers. Type is an optional parameter.
Alias Lookup¶
Search for location by alias. See the documentation on alias lookup for more information.
import urbanairship as ua
airship = ua.Airship(app_key, master_secret)
l = ua.LocationFinder(airship)
l.alias_lookup('us_state=CA')
Note
from_alias can either be a single alias or a list of aliases.
Polygon Lookup¶
Search for location by polygon id. See the documentation on polygon lookup for more information.
import urbanairship as ua
airship = ua.Airship(app_key, master_secret)
l = ua.LocationFinder(airship)
l.polygon_lookup('id', 'zoom')
Note
polygon_id needs to be a string. Zoom is a number ranging 1-20.
Location Date Ranges¶
Get the possible date ranges that can be used with location endpoints. See the documentation on location date ranges for more information.
import urbanairship as ua
airship = ua.Airship(app_key, master_secret)
l = ua.LocationFinder(airship)
l.date_ranges()