Wrapper module for the OpenCage Geocoder API
OpenCage Geocoding Module for Python
A Python module to access the OpenCage Geocoding API.
Build Status / Code Quality / etc
Supports Python 3.7 or newer. Use the older opencage 1.x releases if you need Python 2.7 support.
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'
query = '82 Clerkenwell Road, London' results = geocoder.geocode(query)
You can add additional parameters:
results = geocoder.geocode('London', no_annotations=1, language='es')
For example you can use the proximity parameter to provide the geocoder with a hint:
results = geocoder.geocode('London', proximity='42.828576, -81.406643') print(results['formatted']) # u'London, ON N6A 3M8, Canada'
Turn a lat/long into an address with the
result = geocoder.reverse_geocode(51.51024, -0.10303)
You can reuse your HTTP connection for multiple requests by
with block. This can help performance when making
a lot of requests:
queries = ['82 Clerkenwell Road, London', ...] with OpenCageGeocode(key) as geocoder: # Queries reuse the same HTTP connection results = [geocoder.geocode(query) for query in queries]
You can run requests in parallel with the
method which have the same parameters and response as their synronous counterparts.
You will need at least Python 3.7 and the
aiohttp packages installed.
async with OpenCageGeocode(key) as geocoder: results = await geocoder.geocode_async(address)
For a more complete example and links to futher tutorials on asyncronous IO see
batch.py in the
Non-SSL API use
If you have trouble accesing the OpenCage API with https, e.g. issues with OpenSSL libraries in your enviroment, then you can set the 'http' protocol instead. Please understand that the connection to the OpenCage API will no longer be encrypted.
geocoder = OpenCageGeocode('your-api-key', 'http')
Command-line batch geocoding
examples/batch.py for an example to geocode a CSV file.
If anything goes wrong, then an exception will be raised:
InvalidInputErrorfor non-unicode query strings
NotAuthorizedErrorif API key is missing, invalid syntax or disabled
ForbiddenErrorAPI key is blocked or suspended
RateLimitExceededErrorif you go past your rate limit
UnknownErrorif there's some problem with the API (bad results, 500 status code, etc)
Copyright & License
This software is copyright OpenCage GmbH.
Who is OpenCage GmbH?
We also run Geomob, a series of regular meetups for location based service creators, where we do our best to highlight geoinnovation. If you like geo stuff, you will probably enjoy the Geomob podcast.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.