Use Python? Want to geocode something? Looking for directions? This client library brings the following Google Maps Platform Web Services APIs to your server-side Python applications:
- Maps Static API
- Directions API
- Distance Matrix API
- Elevation API
- Geocoding API
- Places API
- Roads API
- Time Zone API TODO ? Geolocation API TODO ? Address Validation API
- Sign up with Google Maps Platform
- A Google Maps Platform project with the desired API(s) from the above list enabled
- An API key associated with the project above
- Python 3.5+
This client library is designed for use in server-side applications.
In either case, it is important to add API key restrictions to improve its security. Additional security measures, such as hiding your key from version control, should also be put in place to further improve the security of your API key.
Check out the API Security Best Practices guide to learn more.
$ pip install -U googlemaps
Note that you will need requests 2.4.0 or higher if you want to specify connect/read timeouts.
This example uses the Geocoding API and the Directions API with an API key:
import googlemaps
from datetime import datetime
gmaps = googlemaps.Client(key='YOUR_API_KEY')
# Geocoding an address
geocode_result = gmaps.geocode('1600 Amphitheatre Parkway, Mountain View, CA')
# Look up an address with reverse geocoding
reverse_geocode_result = gmaps.reverse_geocode((40.714224, -73.961452))
# Request directions via public transit
now = datetime.now()
directions_result = gmaps.directions("Sydney Town Hall",
"Parramatta, NSW",
mode="transit",
departure_time=now)
# Validate an address with address validation
addressvalidation_result = gmaps.addressvalidation(['1600 Amphitheatre Pk'],
regionCode='US',
locality='Mountain View',
enableUspsCass=True)
# Get an Address Descriptor of a location in the reverse geocoding response
address_descriptor_result = gmaps.reverse_geocode((40.714224, -73.961452), enable_address_descriptor=True)For more usage examples, check out the tests.
Automatically retry when intermittent failures occur. That is, when any of the retriable 5xx errors are returned from the API.
# Installing nox
$ pip install nox
# Running tests
$ nox
# Generating documentation
$ nox -e docs
# Copy docs to gh-pages
$ nox -e docs && mv docs/_build/html generated_docs && git clean -Xdi && git checkout gh-pages
For more information, see the reference documentation.
Contributions are welcome and encouraged! If you'd like to contribute, send us a pull request and refer to our code of conduct and contributing guide.
This library uses Google Maps Platform services. Use of Google Maps Platform services through this library is subject to the Google Maps Platform Terms of Service.
This library is not a Google Maps Platform Core Service. Therefore, the Google Maps Platform Terms of Service, e.g., Technical Support Services Guidelines, Service Level Agreement "SLA", and Deprecation Policy, do not apply to the code in this library.
This library is offered via an open source license. It is not governed by the Google Maps Platform Support Technical Support Services Guidelines, the SLA, or the Deprecation Policy. However, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service.
This library adheres to semantic versioning to indicate when backwards-incompatible changes are introduced. Accordingly, while the library is in version 0.x, backwards-incompatible changes may be introduced at any time.
If you find a bug, or have a feature request, please file an issue on GitHub. If you would like to get answers to technical questions from other Google Maps Platform developers, ask through one of our developer community channels. If you'd like to contribute, please check the contributing guide.
You can also discuss this library on our Discord server.