Simple wrapper module for the OpenCage Geocoder API
Project description
OpenCage Data Geocoding Module for Python
A Python module that uses OpenCage Data's geocoder.
Usage
Install the module:
pip install opencage
Load the module:
from opencage.geocoder import OpenCageGeocode
Create an instance of the geocoder module, passing a valid OpenCage Data Geocoder API key as a parameter to the geocoder modules's constructor:
key = 'your-api-key-here'
geocoder = OpenCageGeocode(key)
Pass a string containing the query or address to be geocoded to the modules's geocode
method:
query = "82 Clerkenwell Road, London"
result = geocoder.geocode(query)
You can add additional parameters:
result = geocoder.geocode('London', no_annotations=1, language='es')
You can use the proximity parameter to provide the geocoder with a hint:
result = geocoder.geocode('London', proximity='42.828576, -81.406643')
print(result[0]['formatted'])
# u'London, ON N6A 3M8, Canada'
Reverse geocoding
Turn a lat/long into an address with the reverse_geocode
method:
results = geocoder.reverse_geocode(51.51024, -0.10303)
Exceptions
If anything goes wrong, then an exception will be raised:
InvalidInputError
for non-unicode query stringsUnknownError
if there's some problem with the API (bad results, 500 status code, etc)RateLimitExceededError
if you go past your rate limit
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
opencage-1.2.tar.gz
(4.7 kB
view hashes)
Built Distribution
opencage-1.2-py3-none-any.whl
(5.6 kB
view hashes)