GMAPS

Members

gmaps.geocode({ address = "" })

“Get latitude and longitude from given address”

Parameters:address (str) – location’s address
Raises:ADDRESS_NOT_FOUND: address not found
Return type:gmaps.GmapsGeocodeEvent
class gmaps.GmapsGeocodeEvent
getPlaceId()
Returns:gmaps place Id
getAddress()
Returns:address
getLatitude()
Returns:place’s latitude
getLongitude()
Returns:place’s longitude
gmaps.reverseGeocode({ latitude =, longitude = })

“Return address of given coordinates”

Parameters:
  • latitude (double) – latitude of desired place
  • longitude (double) – longitude of desired place
Raises:

ADDRESS_NOT_FOUND: address not found
Return type:

gmaps.GmapsGeocodeEvent
gmaps.getDistance({ lat=, lon=, destLat=, destLon=, travelMode="", avoid="", arrivalTime=, departureTime=, transitMode="" })

“Return distance and travel time between two places”

Check gmaps doc for arguments values: https://developers.google.com/maps/documentation/distance-matrix/intro#DistanceMatrixRequests

Parameters:
  • lat (double) – latitude of starting place
  • lon (double) – longitude of starting place
  • destLat (double) – latitude of destination place
  • destLon (double) – longitude of destination place
  • travelMode (str) – travel mode. Defaults to DRIVING. OPTIONAL
  • avoid (str) – avoid certain roads (eg highways). No default value. OPTIONAL
  • arrivalTime (int) – desired arrival time in epoch. No default value. OPTIONAL
  • departureTime (int) – departure time in epoch. No default value. OPTIONAL
  • transitMode (str) – if travelMode == TRANSIT, specifies mean of transport. No default value. OPTIONAL
Return type:

gmaps.GmapsDistanceMatrixEvent
class gmaps.GmapsDistanceMatrixEvent
getDistance()
Returns:distance in meters
getDuration()
Returns:travel duration in seconds
getDurationHumanReadable()
Returns:travel duration human readable
getDurationInTraffic()
Returns:travel duration based on current and historical traffic
getDurationInTrafficHumanReadable()
Returns:travel duration based on current and historical traffic human readable
gmaps.searchNearBy({ latitude=, longitude=, radius=, name="", minPrice="", maxPrice="", openNow=, rankBy="", type"" })

“Get nearby places”

Check gmaps doc for arguments values: https://developers.google.com/places/web-service/search#PlaceSearchRequests

Parameters:
  • latitude (double) – latitude of desired place
  • longitude (double) – longitude of desired place
  • radius (double) – radius to search for places
  • name (str) – name to search for in nearBy places. No def value. OPTIONAL
  • minPrice (str) – minimum price for places to be included in results. Defaults to UNKNOWN. OPTIONAL
  • maxPrice (str) – maximum price for places to be included in results. Defaults to UNKNOWN. OPTIONAL
  • openNow (bool) – whether to only include open places in results. Defaults to false. OPTIONAL
  • rankBy (str) – sorting function for places. Defaults to prominence. OPTIONAL
  • type (str) – type of places to look for. No def value. OPTIONAL
Return type:

gmaps.GmapsSearchEvent
class gmaps.GmapsSearchEvent
getSize()
Returns:number of found places
getPlaces()
Returns:arraylist of places
getPlace(int index)
Returns:returns indexth place in arraylist of places
Return type:gmaps.GmapsPlace
class GmapsPlace
getName()
Returns:place’s name
getAddress()
Returns:place’s address
getLatitude()
Returns:place’s latitude
getLongitude()
Returns:place’s longitude
getPlaceId()
Returns:gmaps placeId
getVicinity()
Returns:feature name of a nearby location
getRating()
Returns:gmaps place’s rating
gmaps.placeDetails({ placeId="" })

“Retrieve place’s info”

Parameters:placeId (str) – gmaps desired place’s id
Return type:gmaps.GmapsDetailsEvent
class gmaps.GmapsDetailsEvent
getAddress()
Returns:place’s address
getPhoneNumber()
Returns:place’s phone number
getLatitude()
Returns:place’s latitude
getLongitude()
Returns:place’s longitude
getName()
Returns:place’s name
getPriceLevel()
Returns:place’s price level
getRating()
Returns:place’s rating
getVicinity()
Returns:feature name of a nearby location
getWebsite()
Returns:place’s website