Skip to main content

OpenCage Geocoding Module for Python

A Python module to access the OpenCage Geocoder.

Build Status

Build Status Kritika Analysis Status PyPI version

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 strings
  • UnknownError if there's some problem with the API (bad results, 500 status code, etc)
  • RateLimitExceededError if you go past your rate limit

This software is copyright OpenCage GmbH. Please see LICENSE.txt

Who is OpenCage GmbH?

We run the OpenCage Geocoder. Learn more about us.

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.

Metadata

Release files for opencage 1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for opencage 1.2.1
File Size Uploaded
opencage-1.2.1.tar.gz 5.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for opencage 1.2.1
File Interpreter ABI Platform
opencage-1.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 11.3 kB

Release files / opencage-1.2.1.tar.gz

Download URL opencage-1.2.1.tar.gz
Size 5.2 kB
Tags Source
SHA-256 checksum
How to use checksums
fcf903a49603003a9a412376bf82ef88edbc104f7ae6b554ddbf15742b214822
BLAKE2b-256 checksum
How to use checksums
d38e65baa6cf2431a38620b17c15c3dccbe3ba82ca57d686ef4bc156b9a6328a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

Release files / opencage-1.2.1-py3-none-any.whl

Download URL opencage-1.2.1-py3-none-any.whl
Size 6.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f6837b868ba94d4c8fbbefbe90ef3f977eb31da23bda0cacdd2afb10fc45f4ae
BLAKE2b-256 checksum
How to use checksums
006b05922eb2ea69713f3c9e355649d8c905a7a0880e9511b7b10d6dedeb859e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

Release history Release notifications | RSS feed

3.4.0

2 release files

3.3.2

2 release files

3.3.1

2 release files

3.3.0

2 release files

3.2.0

2 release files

3.1.0

2 release files

3.0.4

2 release files

3.0.3

2 release files

3.0.2

2 release files

3.0.1

2 release files

3.0.0

2 release files

2.4.0

2 release files

2.3.1

2 release files

2.3.0

2 release files

2.2.0

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.2.2

2 release files

This release

1.2.1 This release

2 release files

1.2

2 release files

1.1.6

2 release files

1.1.4

1 release file

1.1.3

1 release file

1.1.2

1.1.1

1 release file

1.1.0

1 release file

1.0.1

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page