Welcome to GeoPy’s documentation!

GeoPy logo
Documentation

https://geopy.readthedocs.io/

Source Code

https://github.com/geopy/geopy

Stack Overflow

https://stackoverflow.com/questions/tagged/geopy

GIS Stack Exchange

https://gis.stackexchange.com/questions/tagged/geopy

Discussions

https://github.com/geopy/geopy/discussions

Issue Tracker

https://github.com/geopy/geopy/issues

PyPI

https://pypi.org/project/geopy/

geopy is a Python client for several popular geocoding web services.

geopy makes it easy for Python developers to locate the coordinates of addresses, cities, countries, and landmarks across the globe using third-party geocoders and other data sources.

geopy is tested against CPython (versions 3.7, 3.8, 3.9, 3.10, 3.11, 3.12) and PyPy3. geopy 1.x line also supported CPython 2.7, 3.4 and PyPy2.

Contents

Installation

pip install geopy

Geocoders

Each geolocation service you might use, such as Google Maps, Bing Maps, or Nominatim, has its own class in geopy.geocoders abstracting the service’s API. Geocoders each define at least a geocode method, for resolving a location from a string, and may define a reverse method, which resolves a pair of coordinates to an address. Each Geocoder accepts any credentials or settings needed to interact with its service, e.g., an API key or locale, during its initialization.

To geolocate a query to an address and coordinates:

>>> from geopy.geocoders import Nominatim
>>> geolocator = Nominatim(user_agent="specify_your_app_name_here")
>>> location = geolocator.geocode("175 5th Avenue NYC")
>>> print(location.address)
Flatiron Building, 175, 5th Avenue, Flatiron, New York, NYC, New York, ...
>>> print((location.latitude, location.longitude))
(40.7410861, -73.9896297241625)
>>> print(location.raw)
{'place_id': '9167009604', 'type': 'attraction', ...}

To find the address corresponding to a set of coordinates:

>>> from geopy.geocoders import Nominatim
>>> geolocator = Nominatim(user_agent="specify_your_app_name_here")
>>> location = geolocator.reverse("52.509669, 13.376294")
>>> print(location.address)
Potsdamer Platz, Mitte, Berlin, 10117, Deutschland, European Union
>>> print((location.latitude, location.longitude))
(52.5094982, 13.3765983)
>>> print(location.raw)
{'place_id': '654513', 'osm_type': 'node', ...}

Locators’ geocode and reverse methods require the argument query, and also accept at least the argument exactly_one, which is True by default. Geocoders may have additional attributes, e.g., Bing accepts user_location, the effect of which is to bias results near that location. geocode and reverse methods may return three types of values:

  • When there are no results found, returns None.

  • When the method’s exactly_one argument is True and at least one result is found, returns a geopy.location.Location object, which can be iterated over as:

    (address<String>, (latitude<Float>, longitude<Float>))

    Or can be accessed as location.address, location.latitude, location.longitude, location.altitude, and location.raw. The last contains the full geocoder’s response for this result.

  • When exactly_one is False, and there is at least one result, returns a list of geopy.location.Location objects, as above:

    [location, [...]]

If a service is unavailable or otherwise returns a non-OK response, or doesn’t receive a response in the allotted timeout, you will receive one of the Exceptions detailed below.

Specifying Parameters Once

Geocoding methods accept a lot of different parameters, and you would probably want to specify some of them just once and not care about them later.

This is easy to achieve with Python’s functools.partial():

>>> from functools import partial
>>> from geopy.geocoders import Nominatim

>>> geolocator = Nominatim(user_agent="specify_your_app_name_here")

>>> geocode = partial(geolocator.geocode, language="es")
>>> print(geocode("london"))
Londres, Greater London, Inglaterra, SW1A 2DX, Gran Bretaña
>>> print(geocode("paris"))
París, Isla de Francia, Francia metropolitana, Francia
>>> print(geocode("paris", language="en"))
Paris, Ile-de-France, Metropolitan France, France

>>> reverse = partial(geolocator.reverse, language="es")
>>> print(reverse("52.509669, 13.376294"))
Steinecke, Potsdamer Platz, Tiergarten, Mitte, 10785, Alemania

If you need to modify the query, you can also use a one-liner with lambda. For example, if you only need to geocode locations in Cleveland, Ohio, you could do:

>>> geocode = lambda query: geolocator.geocode("%s, Cleveland OH" % query)
>>> print(geocode("11111 Euclid Ave"))
Thwing Center, Euclid Avenue, Magnolia-Wade Park Historic District,
University Circle, Cleveland, Cuyahoga County, Ohio, 44106, United States
of America

That lambda doesn’t accept kwargs. If you need them, you could do:

>>> _geocode = partial(geolocator.geocode, language="es")
>>> geocode = lambda query, **kw: _geocode("%s, Cleveland OH" % query, **kw)
>>> print(geocode("11111 Euclid Ave"))
Thwing Center, Euclid Avenue, Magnolia-Wade Park Historic District,
University Circle, Cleveland, Cuyahoga County, Ohio, 44106, Estados Unidos
>>> print(geocode("11111 Euclid Ave", language="en"))
Thwing Center, Euclid Avenue, Magnolia-Wade Park Historic District,
University Circle, Cleveland, Cuyahoga County, Ohio, 44106, United States
of America

Geopy Is Not a Service

Geocoding is provided by a number of different services, which are not affiliated with geopy in any way. These services provide APIs, which anyone could implement, and geopy is just a library which provides these implementations for many different services in a single package.

_images/geopy_and_geocoding_services.svg

Therefore:

  1. Different services have different Terms of Use, quotas, pricing, geodatabases and so on. For example, Nominatim is free, but provides low request limits. If you need to make more queries, consider using another (probably paid) service, such as OpenMapQuest or PickPoint (these two are commercial providers of Nominatim, so they should have the same data and APIs). Or, if you are ready to wait, you can try geopy.extra.rate_limiter.

  2. geopy cannot be responsible for the geocoding services’ databases. If you have issues with some queries which the service cannot fulfill, it should be directed to that service’s support team.

  3. geopy cannot be responsible for any networking issues between your computer and the geocoding service.

If you face any problem with your current geocoding service provider, you can always try a different one.

Async Mode

By default geopy geocoders are synchronous (i.e. they use an Adapter based on BaseSyncAdapter).

All geocoders can be used with asyncio by simply switching to an Adapter based on BaseAsyncAdapter (like AioHTTPAdapter).

Example:

from geopy.adapters import AioHTTPAdapter
from geopy.geocoders import Nominatim

async with Nominatim(
    user_agent="specify_your_app_name_here",
    adapter_factory=AioHTTPAdapter,
) as geolocator:
    location = await geolocator.geocode("175 5th Avenue NYC")
    print(location.address)

Basically the usage is the same as in synchronous mode, except that all geocoder calls should be used with await, and the geocoder instance should be created by async with. The context manager is optional, however, it is strongly advised to use it to avoid resources leaks.

Accessing Geocoders

The typical way of retrieving a geocoder class is to make an import from geopy.geocoders package:

from geopy.geocoders import Nominatim
geopy.geocoders.get_geocoder_for_service(service)

For the service provided, try to return a geocoder class.

>>> from geopy.geocoders import get_geocoder_for_service
>>> get_geocoder_for_service("nominatim")
geopy.geocoders.nominatim.Nominatim

If the string given is not recognized, a geopy.exc.GeocoderNotFound exception is raised.

Given that almost all of the geocoders provide the geocode method it could be used to make basic queries based entirely on user input:

from geopy.geocoders import get_geocoder_for_service

def geocode(geocoder, config, query):
    cls = get_geocoder_for_service(geocoder)
    geolocator = cls(**config)
    location = geolocator.geocode(query)
    return location.address

>>> geocode("nominatim", dict(user_agent="specify_your_app_name_here"), "london")
'London, Greater London, England, SW1A 2DX, United Kingdom'
>>> geocode("photon", dict(), "london")
'London, SW1A 2DX, London, England, United Kingdom'

Default Options Object

class geopy.geocoders.options

The options object contains default configuration values for geocoders, e.g. timeout and User-Agent. Instead of passing a custom value to each geocoder individually, you can override a default value in this object.

Please note that not all geocoders use all attributes of this object. For example, some geocoders don’t respect the default_scheme attribute. Refer to the specific geocoder’s initializer doc for a list of parameters which that geocoder accepts.

Example for overriding default timeout and user_agent:

>>> import geopy.geocoders
>>> from geopy.geocoders import Nominatim
>>> geopy.geocoders.options.default_user_agent = 'my_app/1'
>>> geopy.geocoders.options.default_timeout = 7
>>> geolocator = Nominatim()
>>> print(geolocator.headers)
{'User-Agent': 'my_app/1'}
>>> print(geolocator.timeout)
7
Attributes:
default_adapter_factory

A callable which returns a geopy.adapters.BaseAdapter instance. Adapters are different implementations of HTTP clients. See geopy.adapters for more info.

This callable accepts two keyword args: proxies and ssl_context. A class might be specified as this callable as well.

Example:

import geopy.geocoders
geopy.geocoders.options.default_adapter_factory = geopy.adapters.URLLibAdapter

geopy.geocoders.options.default_adapter_factory = (
    lambda proxies, ssl_context: MyAdapter(
        proxies=proxies, ssl_context=ssl_context, my_custom_arg=42
    )
)

If requests package is installed, the default adapter is geopy.adapters.RequestsAdapter. Otherwise it is geopy.adapters.URLLibAdapter.

New in version 2.0.

default_proxies

Tunnel requests through HTTP proxy.

By default the system proxies are respected (e.g. HTTP_PROXY and HTTPS_PROXY env vars or platform-specific proxy settings, such as macOS or Windows native preferences – see urllib.request.getproxies() for more details). The proxies value for using system proxies is None.

To disable system proxies and issue requests directly, explicitly pass an empty dict as a value for proxies: {}.

To use a custom HTTP proxy location, pass a string. Valid examples are:

  • "192.0.2.0:8080"

  • "john:passw0rd@192.0.2.0:8080"

  • "http://john:passw0rd@192.0.2.0:8080"

Please note:

  • Scheme part (http://) of the proxy is ignored.

  • Only http proxy is supported. Even if the proxy scheme is https, it will be ignored, and the connection between client and proxy would still be unencrypted. However, https requests via http proxy are still supported (via HTTP CONNECT method).

Raw urllib-style proxies dict might be provided instead of a string:

  • {"https": "192.0.2.0:8080"} – means that HTTP proxy would be used only for requests having https scheme. String proxies value is automatically used for both schemes, and is provided as a shorthand for the urllib-style proxies dict.

For more information, see documentation on urllib.request.getproxies().

default_scheme

Use 'https' or 'http' as the API URL’s scheme.

default_ssl_context

An ssl.SSLContext instance with custom TLS verification settings. Pass None to use the interpreter’s defaults (that is to use the system’s trusted CA certificates).

To use the CA bundle used by requests library:

import ssl
import certifi
import geopy.geocoders
ctx = ssl.create_default_context(cafile=certifi.where())
geopy.geocoders.options.default_ssl_context = ctx

To disable TLS certificate verification completely:

import ssl
import geopy.geocoders
ctx = ssl.create_default_context()
ctx.check_hostname = False
ctx.verify_mode = ssl.CERT_NONE
geopy.geocoders.options.default_ssl_context = ctx

See docs for the ssl.SSLContext class for more examples.

default_timeout

Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Pass None to disable timeout.

default_user_agent

User-Agent header to send with the requests to geocoder API.

default_adapter_factory

alias of geopy.adapters.RequestsAdapter

default_proxies = None
default_scheme = 'https'
default_ssl_context = None
default_timeout = 1
default_user_agent = 'geopy/2.4.1'

Usage with Pandas

It is possible to geocode a pandas DataFrame with geopy, however, rate-limiting must be taken into account.

A large number of DataFrame rows might produce a significant amount of geocoding requests to a Geocoding service, which might be throttled by the service (e.g. by returning Too Many Requests 429 HTTP error or timing out).

geopy.extra.rate_limiter classes provide a convenient wrapper, which can be used to automatically add delays between geocoding calls to reduce the load on the Geocoding service. Also it can retry failed requests and swallow errors for individual rows.

If you’re having the Too Many Requests error, you may try the following:

  • Use geopy.extra.rate_limiter with non-zero min_delay_seconds.

  • Try a different Geocoding service (please consult with their ToS first, as some services prohibit bulk geocoding).

  • Take a paid plan on the chosen Geocoding service, which provides higher quota.

  • Provision your own local copy of the Geocoding service (such as Nominatim).

Rate Limiter

RateLimiter and AsyncRateLimiter allow to perform bulk operations while gracefully handling error responses and adding delays when needed.

In the example below a delay of 1 second (min_delay_seconds=1) will be added between each pair of geolocator.geocode calls; all geopy.exc.GeocoderServiceError exceptions will be retried (up to max_retries times):

import pandas as pd
df = pd.DataFrame({'name': ['paris', 'berlin', 'london']})

from geopy.geocoders import Nominatim
geolocator = Nominatim(user_agent="specify_your_app_name_here")

from geopy.extra.rate_limiter import RateLimiter
geocode = RateLimiter(geolocator.geocode, min_delay_seconds=1)
df['location'] = df['name'].apply(geocode)

df['point'] = df['location'].apply(lambda loc: tuple(loc.point) if loc else None)

This would produce the following DataFrame:

>>> df
     name                                           location  \
0   paris  (Paris, Île-de-France, France métropolitaine, ...
1  berlin  (Berlin, 10117, Deutschland, (52.5170365, 13.3...
2  london  (London, Greater London, England, SW1A 2DU, UK...

                           point
0   (48.8566101, 2.3514992, 0.0)
1  (52.5170365, 13.3888599, 0.0)
2  (51.5073219, -0.1276474, 0.0)

To pass extra options to the geocode call:

from functools import partial
df['location'] = df['name'].apply(partial(geocode, language='de'))

To see a progress bar:

from tqdm import tqdm
tqdm.pandas()
df['location'] = df['name'].progress_apply(geocode)

Before using rate limiting classes, please consult with the Geocoding service ToS, which might explicitly consider bulk requests (even throttled) a violation.

class geopy.extra.rate_limiter.RateLimiter(func, *, min_delay_seconds=0.0, max_retries=2, error_wait_seconds=5.0, swallow_exceptions=True, return_value_on_exception=None)

This is a Rate Limiter implementation for synchronous functions (like geocoders with the default geopy.adapters.BaseSyncAdapter).

Examples:

from geopy.extra.rate_limiter import RateLimiter
from geopy.geocoders import Nominatim

geolocator = Nominatim(user_agent="specify_your_app_name_here")

search = ["moscow", "paris", "berlin", "tokyo", "beijing"]
geocode = RateLimiter(geolocator.geocode, min_delay_seconds=1)
locations = [geocode(s) for s in search]

search = [
    (55.47, 37.32), (48.85, 2.35), (52.51, 13.38),
    (34.69, 139.40), (39.90, 116.39)
]
reverse = RateLimiter(geolocator.reverse, min_delay_seconds=1)
locations = [reverse(s) for s in search]

RateLimiter class is thread-safe. If geocoding service’s responses are slower than min_delay_seconds, then you can benefit from parallelizing the work:

import concurrent.futures

geolocator = OpenMapQuest(api_key="...")
geocode = RateLimiter(geolocator.geocode, min_delay_seconds=1/20)

with concurrent.futures.ThreadPoolExecutor() as e:
    locations = list(e.map(geocode, search))

Changed in version 2.0: Added thread-safety support.

__init__(func, *, min_delay_seconds=0.0, max_retries=2, error_wait_seconds=5.0, swallow_exceptions=True, return_value_on_exception=None)
Parameters

  • func (callable) – A function which should be wrapped by the rate limiter.

  • min_delay_seconds (float) – Minimum delay in seconds between the wrapped func calls. To convert RPS rate to min_delay_seconds you need to divide 1 by RPS. For example, if you need to keep the rate at 20 RPS, you can use min_delay_seconds=1/20.

  • max_retries (int) – Number of retries on exceptions. Only geopy.exc.GeocoderServiceError exceptions are retried – others are always re-raised. max_retries + 1 requests would be performed at max per query. Set max_retries=0 to disable retries.

  • error_wait_seconds (float) – Time to wait between retries after errors. Must be greater or equal to min_delay_seconds.

  • swallow_exceptions (bool) – Should an exception be swallowed after retries? If not, it will be re-raised. If yes, the return_value_on_exception will be returned.

  • return_value_on_exception – Value to return on failure when swallow_exceptions=True.

class geopy.extra.rate_limiter.AsyncRateLimiter(func, *, min_delay_seconds=0.0, max_retries=2, error_wait_seconds=5.0, swallow_exceptions=True, return_value_on_exception=None)

This is a Rate Limiter implementation for asynchronous functions (like geocoders with geopy.adapters.BaseAsyncAdapter).

Examples:

from geopy.adapters import AioHTTPAdapter
from geopy.extra.rate_limiter import AsyncRateLimiter
from geopy.geocoders import Nominatim

async with Nominatim(
    user_agent="specify_your_app_name_here",
    adapter_factory=AioHTTPAdapter,
) as geolocator:

    search = ["moscow", "paris", "berlin", "tokyo", "beijing"]
    geocode = AsyncRateLimiter(geolocator.geocode, min_delay_seconds=1)
    locations = [await geocode(s) for s in search]

    search = [
        (55.47, 37.32), (48.85, 2.35), (52.51, 13.38),
        (34.69, 139.40), (39.90, 116.39)
    ]
    reverse = AsyncRateLimiter(geolocator.reverse, min_delay_seconds=1)
    locations = [await reverse(s) for s in search]

AsyncRateLimiter class is safe to use across multiple concurrent tasks. If geocoding service’s responses are slower than min_delay_seconds, then you can benefit from parallelizing the work:

import asyncio

async with OpenMapQuest(
    api_key="...", adapter_factory=AioHTTPAdapter
) as geolocator:

    geocode = AsyncRateLimiter(geolocator.geocode, min_delay_seconds=1/20)
    locations = await asyncio.gather(*(geocode(s) for s in search))

New in version 2.0.

__init__(func, *, min_delay_seconds=0.0, max_retries=2, error_wait_seconds=5.0, swallow_exceptions=True, return_value_on_exception=None)
Parameters

  • func (callable) – A function which should be wrapped by the rate limiter.

  • min_delay_seconds (float) – Minimum delay in seconds between the wrapped func calls. To convert RPS rate to min_delay_seconds you need to divide 1 by RPS. For example, if you need to keep the rate at 20 RPS, you can use min_delay_seconds=1/20.

  • max_retries (int) – Number of retries on exceptions. Only geopy.exc.GeocoderServiceError exceptions are retried – others are always re-raised. max_retries + 1 requests would be performed at max per query. Set max_retries=0 to disable retries.

  • error_wait_seconds (float) – Time to wait between retries after errors. Must be greater or equal to min_delay_seconds.

  • swallow_exceptions (bool) – Should an exception be swallowed after retries? If not, it will be re-raised. If yes, the return_value_on_exception will be returned.

  • return_value_on_exception – Value to return on failure when swallow_exceptions=True.

ArcGIS

class geopy.geocoders.ArcGIS(username=None, password=None, *, referer=None, token_lifetime=60, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, auth_domain='www.arcgis.com', domain='geocode.arcgis.com')

Geocoder using the ERSI ArcGIS API.

Documentation at:

https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm

__init__(username=None, password=None, *, referer=None, token_lifetime=60, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, auth_domain='www.arcgis.com', domain='geocode.arcgis.com')
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, out_fields=None)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • out_fields (str or iterable) – A list of output fields to be returned in the attributes field of the raw data. This can be either a python list/tuple of fields or a comma-separated string. See https://developers.arcgis.com/rest/geocode/api-reference/geocoding-service-output.htm for a list of supported output fields. If you want to return all supported output fields, set out_fields="*".

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, distance=None)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • distance (int) – Distance from the query location, in meters, within which to search. ArcGIS has a default of 100 meters, if not specified.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

AzureMaps

class geopy.geocoders.AzureMaps(subscription_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='atlas.microsoft.com')

Bases: geopy.geocoders.tomtom.TomTom

AzureMaps geocoder based on TomTom.

Documentation at:

https://docs.microsoft.com/en-us/azure/azure-maps/index

__init__(subscription_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='atlas.microsoft.com')
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, limit=None, typeahead=False, language=None)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • limit (int) – Maximum amount of results to return from the service. Unless exactly_one is set to False, limit will always be 1.

  • typeahead (bool) – If the “typeahead” flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.

  • language (str) – Language in which search results should be returned. When data in specified language is not available for a specific field, default language is used. List of supported languages (case-insensitive): https://developer.tomtom.com/online-search/online-search-documentation/supported-languages

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, language=None)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • language (str) – Language in which search results should be returned. When data in specified language is not available for a specific field, default language is used. List of supported languages (case-insensitive): https://developer.tomtom.com/online-search/online-search-documentation/supported-languages

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

Baidu

class geopy.geocoders.Baidu(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, security_key=None)

Geocoder using the Baidu Maps v2 API.

Documentation at:

http://lbsyun.baidu.com/index.php?title=webapi/guide/webservice-geocoding

Attention

Newly registered API keys will not work with v2 API, use BaiduV3 instead.

__init__(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, security_key=None)
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available. Baidu’s API will always return at most one result.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

BaiduV3

class geopy.geocoders.BaiduV3(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, security_key=None)

Bases: geopy.geocoders.baidu.Baidu

Geocoder using the Baidu Maps v3 API.

Documentation at:

http://lbsyun.baidu.com/index.php?title=webapi/guide/webservice-geocoding

__init__(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, security_key=None)
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available. Baidu’s API will always return at most one result.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

BANFrance

class geopy.geocoders.BANFrance(*, domain='api-adresse.data.gouv.fr', scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)

Geocoder using the Base Adresse Nationale France API.

Documentation at:

https://adresse.data.gouv.fr/api

__init__(*, domain='api-adresse.data.gouv.fr', scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)
Parameters
geocode(query, *, limit=None, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • limit (int) – Defines the maximum number of items in the response structure. If not provided and there are multiple results the BAN API will return 5 results by default. This will be reset to one if exactly_one is True.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

Bing

class geopy.geocoders.Bing(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='dev.virtualearth.net')

Geocoder using the Bing Maps Locations API.

Documentation at:

https://msdn.microsoft.com/en-us/library/ff701715.aspx

__init__(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='dev.virtualearth.net')
Parameters
geocode(query, *, exactly_one=True, user_location=None, timeout=DEFAULT_SENTINEL, culture=None, include_neighborhood=None, include_country_code=False)

Return a location point by address.

Parameters

  • query (str or dict) –

    The address or query you wish to geocode.

    For a structured query, provide a dictionary whose keys are one of: addressLine, locality (city), adminDistrict (state), countryRegion, or postalCode.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • user_location (geopy.point.Point) – Prioritize results closer to this location.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • culture (str) – Affects the language of the response, must be a two-letter country code.

  • include_neighborhood (bool) – Sets whether to include the neighborhood field in the response.

  • include_country_code (bool) – Sets whether to include the two-letter ISO code of the country in the response (field name ‘countryRegionIso2’).

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, culture=None, include_country_code=False)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • culture (str) – Affects the language of the response, must be a two-letter country code.

  • include_country_code (bool) – Sets whether to include the two-letter ISO code of the country in the response (field name ‘countryRegionIso2’).

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

DataBC

class geopy.geocoders.DataBC(*, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='geocoder.api.gov.bc.ca')

Geocoder using the Physical Address Geocoder from DataBC.

Documentation at:

https://github.com/bcgov/ols-geocoder/blob/gh-pages/geocoder-developer-guide.md

__init__(*, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='geocoder.api.gov.bc.ca')
Parameters
geocode(query, *, max_results=25, set_back=0, location_descriptor='any', exactly_one=True, timeout=DEFAULT_SENTINEL)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • max_results (int) – The maximum number of resutls to request.

  • set_back (float) – The distance to move the accessPoint away from the curb (in meters) and towards the interior of the parcel. location_descriptor must be set to accessPoint for set_back to take effect.

  • location_descriptor (str) – The type of point requested. It can be any, accessPoint, frontDoorPoint, parcelPoint, rooftopPoint and routingPoint.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

GeocodeEarth

class geopy.geocoders.GeocodeEarth(api_key, *, domain='api.geocode.earth', timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, scheme=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)

Bases: geopy.geocoders.pelias.Pelias

Geocode Earth, a Pelias-based service provided by the developers of Pelias itself.

Documentation at:

https://geocode.earth/docs

Pricing details:

https://geocode.earth/#pricing

__init__(api_key, *, domain='api.geocode.earth', timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, scheme=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, boundary_rect=None, countries=None, country_bias=None, language=None)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • boundary_rect (list or tuple of 2 items of geopy.point.Point or (latitude, longitude) or "%(latitude)s, %(longitude)s".) – Coordinates to restrict search within. Example: [Point(22, 180), Point(-22, -180)].

  • countries (list) –

    A list of country codes specified in ISO 3166-1 alpha-2 or alpha-3 format, e.g. ['USA', 'CAN']. This is a hard filter.

    New in version 2.3.

  • country_bias (str) –

    Bias results to this country (ISO alpha-3).

    Deprecated since version 2.3: Use countries instead. This option behaves the same way, i.e. it’s not a soft filter as the name suggests. This parameter is scheduled for removal in geopy 3.0.

  • language (str) – Preferred language in which to return results. Either uses standard RFC2616 accept-language string or a simple comma-separated list of language codes.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, language=None)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • language (str) –

    Preferred language in which to return results. Either uses standard RFC2616 accept-language string or a simple comma-separated list of language codes.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

GeocodeFarm

Changed in version 2.2: This class has been removed, because the service is too unreliable. See #445.

Geocodio

class geopy.geocoders.Geocodio(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain=None)

Geocoder using the Geocod.io API.

Documentation at:

https://www.geocod.io/docs/

Pricing details:

https://www.geocod.io/pricing/

New in version 2.2.

__init__(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain=None)
Parameters
geocode(query, *, limit=None, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return a location point by address.

Parameters

  • query (dict or str) –

    The address, query or a structured query you wish to geocode.

    For a structured query, provide a dictionary whose keys are one of: street, city, state, postal_code or country.

  • limit (int) – The maximum number of matches to return. This will be reset to 1 if exactly_one is True.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, limit=None)

Return an address by location point.

Parameters

  • query (str) – The coordinates for which you wish to obtain the closest human-readable addresses

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • limit (int) – The maximum number of matches to return. This will be reset to 1 if exactly_one is True.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

Geokeo

class geopy.geocoders.Geokeo(api_key, *, domain='geokeo.com', scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)

Geocoder using the geokeo API.

Documentation at:

https://geokeo.com/documentation.php

New in version 2.4.

__init__(api_key, *, domain='geokeo.com', scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)
Parameters
geocode(query, *, country=None, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • country (str) – Restricts the results to the specified country. The country code is a 2 character code as defined by the ISO 3166-1 Alpha 2 standard (e.g. us).

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

Geolake

class geopy.geocoders.Geolake(api_key, *, domain='api.geolake.com', scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)

Geocoder using the Geolake API.

Documentation at:

https://geolake.com/docs/api

Terms of Service at:

https://geolake.com/terms-of-use

__init__(api_key, *, domain='api.geolake.com', scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)
Parameters
geocode(query, *, country_codes=None, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return a location point by address.

Parameters

  • query (str or dict) –

    The address or query you wish to geocode.

    For a structured query, provide a dictionary whose keys are one of: country, state, city, zipcode, street, address, houseNumber or subNumber.

  • country_codes (str or list) – Provides the geocoder with a list of country codes that the query may reside in. This value will limit the geocoder to the supplied countries. The country code is a 2 character code as defined by the ISO-3166-1 alpha-2 standard (e.g. FR). Multiple countries can be specified with a Python list.

  • exactly_one (bool) – Return one result or a list of one result.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

GeoNames

class geopy.geocoders.GeoNames(username, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, scheme='http', domain='api.geonames.org')

GeoNames geocoder.

Documentation at:

http://www.geonames.org/export/geonames-search.html

Reverse geocoding documentation at:

http://www.geonames.org/export/web-services.html#findNearbyPlaceName

__init__(username, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, scheme='http', domain='api.geonames.org')
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, country=None, country_bias=None)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • country (str or list) – Limit records to the specified countries. Two letter country code ISO-3166 (e.g. FR). Might be a single string or a list of strings.

  • country_bias (str) – Records from the country_bias are listed first. Two letter country code ISO-3166.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, feature_code=None, lang=None, find_nearby_type='findNearbyPlaceName')

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • feature_code (str) – A GeoNames feature code

  • lang (str) – language of the returned name element (the pseudo language code ‘local’ will return it in local language) Full list of supported languages can be found here: https://www.geonames.org/countries/

  • find_nearby_type (str) – A flag to switch between different GeoNames API endpoints. The default value is findNearbyPlaceName which returns the closest populated place. Another currently implemented option is findNearby which returns the closest toponym for the lat/lng query.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse_timezone(query, *, timeout=DEFAULT_SENTINEL)

Find the timezone for a point in query.

GeoNames always returns a timezone: if the point being queried doesn’t have an assigned Olson timezone id, a pytz.FixedOffset timezone is used to produce the geopy.timezone.Timezone.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as “%(latitude)s, %(longitude)s”) – The coordinates for which you want a timezone.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

geopy.timezone.Timezone.

GoogleV3

class geopy.geocoders.GoogleV3(api_key=None, *, domain='maps.googleapis.com', scheme=None, client_id=None, secret_key=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, channel='')

Geocoder using the Google Maps v3 API.

Documentation at:

https://developers.google.com/maps/documentation/geocoding/

Pricing details:

https://developers.google.com/maps/documentation/geocoding/usage-and-billing

__init__(api_key=None, *, domain='maps.googleapis.com', scheme=None, client_id=None, secret_key=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, channel='')
Parameters
geocode(query=None, *, exactly_one=True, timeout=DEFAULT_SENTINEL, bounds=None, region=None, components=None, place_id=None, language=None, sensor=False)

Return a location point by address.

Parameters

  • query (str) –

    The address or query you wish to geocode. Optional, if components param is set:

    >>> g.geocode(components={"city": "Paris", "country": "FR"})
Location(France, (46.227638, 2.213749, 0.0))

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • bounds (list or tuple of 2 items of geopy.point.Point or (latitude, longitude) or "%(latitude)s, %(longitude)s".) – The bounding box of the viewport within which to bias geocode results more prominently. Example: [Point(22, 180), Point(-22, -180)].

  • region (str) – The region code, specified as a ccTLD (“top-level domain”) two-character value.

  • components (dict or list) –

    Restricts to an area. Can use any combination of: route, locality, administrative_area, postal_code, country.

    Pass a list of tuples if you want to specify multiple components of the same type, e.g.:

    >>> [('administrative_area', 'VA'), ('administrative_area', 'Arlington')]

  • place_id (str) –

    Retrieve a Location using a Place ID. Cannot be not used with query or bounds parameters.

    >>> g.geocode(place_id='ChIJOcfP0Iq2j4ARDrXUa7ZWs34')

  • language (str) – The language in which to return results.

  • sensor (bool) – Whether the geocoding request comes from a device with a location sensor.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, language=None, sensor=False)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • language (str) – The language in which to return results.

  • sensor (bool) – Whether the geocoding request comes from a device with a location sensor.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse_timezone(query, *, at_time=None, timeout=DEFAULT_SENTINEL)

Find the timezone a point in query was in for a specified at_time.

None will be returned for points without an assigned Olson timezone id (e.g. for Antarctica).

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as “%(latitude)s, %(longitude)s”) – The coordinates for which you want a timezone.

  • at_time (datetime.datetime or None) – The time at which you want the timezone of this location. This is optional, and defaults to the time that the function is called in UTC. Timezone-aware datetimes are correctly handled and naive datetimes are silently treated as UTC.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None or geopy.timezone.Timezone.

HERE

class geopy.geocoders.Here(*, app_id=None, app_code=None, apikey=None, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)

Geocoder using the HERE Geocoder API.

Documentation at:

https://developer.here.com/documentation/geocoder/

Attention

This class uses a v6 API which is in maintenance mode. Consider using the newer HereV7 class.

__init__(*, app_id=None, app_code=None, apikey=None, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)
Parameters
geocode(query, *, bbox=None, mapview=None, exactly_one=True, maxresults=None, pageinformation=None, language=None, additional_data=False, timeout=DEFAULT_SENTINEL)

Return a location point by address.

This implementation supports only a subset of all available parameters. A list of all parameters of the pure REST API is available here: https://developer.here.com/documentation/geocoder/topics/resource-geocode.html

Parameters

  • query (str or dict) –

    The address or query you wish to geocode.

    For a structured query, provide a dictionary whose keys are one of: city, county, district, country, state, street, housenumber, or postalcode.

  • bbox (list or tuple of 2 items of geopy.point.Point or (latitude, longitude) or "%(latitude)s, %(longitude)s".) – A type of spatial filter, limits the search for any other attributes in the request. Specified by two coordinate (lat/lon) pairs – corners of the box. The bbox search is currently similar to mapview but it is not extended (cited from the REST API docs). Relevant global results are also returned. Example: [Point(22, 180), Point(-22, -180)].

  • mapview (list or tuple of 2 items of geopy.point.Point or (latitude, longitude) or "%(latitude)s, %(longitude)s".) – The app’s viewport, given as two coordinate pairs, specified by two lat/lon pairs – corners of the bounding box, respectively. Matches from within the set map view plus an extended area are ranked highest. Relevant global results are also returned. Example: [Point(22, 180), Point(-22, -180)].

  • exactly_one (bool) – Return one result or a list of results, if available.

  • maxresults (int) – Defines the maximum number of items in the response structure. If not provided and there are multiple results the HERE API will return 10 results by default. This will be reset to one if exactly_one is True.

  • pageinformation (int) – A key which identifies the page to be returned when the response is separated into multiple pages. Only useful when maxresults is also provided.

  • language (str) – Affects the language of the response, must be a RFC 4647 language code, e.g. ‘en-US’.

  • additional_data (str) – A string with key-value pairs as described on https://developer.here.com/documentation/geocoder/topics/resource-params-additional.html. These will be added as one query parameter to the URL.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, radius=None, exactly_one=True, maxresults=None, pageinformation=None, language=None, mode='retrieveAddresses', timeout=DEFAULT_SENTINEL)

Return an address by location point.

This implementation supports only a subset of all available parameters. A list of all parameters of the pure REST API is available here: https://developer.here.com/documentation/geocoder/topics/resource-reverse-geocode.html

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • radius (float) – Proximity radius in meters.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • maxresults (int) – Defines the maximum number of items in the response structure. If not provided and there are multiple results the HERE API will return 10 results by default. This will be reset to one if exactly_one is True.

  • pageinformation (int) – A key which identifies the page to be returned when the response is separated into multiple pages. Only useful when maxresults is also provided.

  • language (str) – Affects the language of the response, must be a RFC 4647 language code, e.g. ‘en-US’.

  • mode (str) – Affects the type of returned response items, must be one of: ‘retrieveAddresses’ (default), ‘retrieveAreas’, ‘retrieveLandmarks’, ‘retrieveAll’, or ‘trackPosition’. See online documentation for more information.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

HEREv7

class geopy.geocoders.HereV7(apikey, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='search.hereapi.com')

Geocoder using the HERE Geocoding & Search v7 API.

Documentation at:

https://developer.here.com/documentation/geocoding-search-api/

Terms of Service at:

https://legal.here.com/en-gb/terms

New in version 2.2.

__init__(apikey, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='search.hereapi.com')
Parameters
geocode(query=None, *, components=None, at=None, countries=None, language=None, limit=None, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode. Optional, if components param is set.

  • components (dict) – A structured query. Can be used along with the free-text query. Should be a dictionary whose keys are one of: country, state, county, city, district, street, houseNumber, postalCode.

  • at (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The center of the search context.

  • countries (list) – A list of country codes specified in ISO 3166-1 alpha-3 format, e.g. ['USA', 'CAN']. This is a hard filter.

  • language (str) – Affects the language of the response, must be a BCP 47 compliant language code, e.g. en-US.

  • limit (int) – Defines the maximum number of items in the response structure. If not provided and there are multiple results the HERE API will return 20 results by default. This will be reset to one if exactly_one is True.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, language=None, limit=None, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • language (str) – Affects the language of the response, must be a BCP 47 compliant language code, e.g. en-US.

  • limit (int) – Maximum number of results to be returned. This will be reset to one if exactly_one is True.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

IGNFrance

class geopy.geocoders.IGNFrance(api_key=None, *, username=None, password=None, referer=None, domain='wxs.ign.fr', scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)

Geocoder using the IGN France GeoCoder OpenLS API.

Documentation at:

https://geoservices.ign.fr/services-web-essentiels

__init__(api_key=None, *, username=None, password=None, referer=None, domain='wxs.ign.fr', scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)
Parameters
geocode(query, *, query_type='StreetAddress', maximum_responses=25, is_freeform=False, filtering=None, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return a location point by address.

Parameters

  • query (str) – The query string to be geocoded.

  • query_type (str) – The type to provide for geocoding. It can be PositionOfInterest, StreetAddress or CadastralParcel. StreetAddress is the default choice if none provided.

  • maximum_responses (int) – The maximum number of responses to ask to the API in the query body.

  • is_freeform (str) – Set if return is structured with freeform structure or a more structured returned. By default, value is False.

  • filtering (str) – Provide string that help setting geocoder filter. It contains an XML string. See examples in documentation and ignfrance.py file in directory tests.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, reverse_geocode_preference=('StreetAddress',), maximum_responses=25, filtering='', exactly_one=True, timeout=DEFAULT_SENTINEL)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • reverse_geocode_preference (list) – Enable to set expected results type. It can be StreetAddress or PositionOfInterest. Default is set to StreetAddress.

  • maximum_responses (int) – The maximum number of responses to ask to the API in the query body.

  • filtering (str) – Provide string that help setting geocoder filter. It contains an XML string. See examples in documentation and ignfrance.py file in directory tests.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

MapBox

class geopy.geocoders.MapBox(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='api.mapbox.com', referer=None)

Geocoder using the Mapbox API.

Documentation at:

https://www.mapbox.com/api-documentation/

__init__(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='api.mapbox.com', referer=None)
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, proximity=None, country=None, language=None, bbox=None)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • proximity (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – A coordinate to bias local results based on a provided location.

  • country (str or list) – Country to filter result in form of ISO 3166-1 alpha-2 country code (e.g. FR). Might be a Python list of strings.

  • language (str) –

    This parameter controls the language of the text supplied in responses, and also affects result scoring, with results matching the user’s query in the requested language being preferred over results that match in another language. You can pass two letters country codes (ISO 639-1).

    New in version 2.3.

  • bbox (list or tuple of 2 items of geopy.point.Point or (latitude, longitude) or "%(latitude)s, %(longitude)s".) – The bounding box of the viewport within which to bias geocode results more prominently. Example: [Point(22, 180), Point(-22, -180)].

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

MapQuest

class geopy.geocoders.MapQuest(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='www.mapquestapi.com')

Geocoder using the MapQuest API based on Licensed data.

Documentation at:

https://developer.mapquest.com/documentation/geocoding-api/

MapQuest provides two Geocoding APIs:

__init__(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='www.mapquestapi.com')
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, limit=None, bounds=None)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • limit (int) – Limit the maximum number of items in the response. This will be reset to one if exactly_one is True.

  • bounds (list or tuple of 2 items of geopy.point.Point or (latitude, longitude) or "%(latitude)s, %(longitude)s".) – The bounding box of the viewport within which to bias geocode results more prominently. Example: [Point(22, 180), Point(-22, -180)].

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

MapTiler

class geopy.geocoders.MapTiler(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='api.maptiler.com')

Geocoder using the MapTiler API.

Documentation at:

https://cloud.maptiler.com/geocoding/ (requires sign-up)

__init__(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='api.maptiler.com')
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, proximity=None, language=None, bbox=None)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • proximity (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – A coordinate to bias local results based on a provided location.

  • language (str or list) – Prefer results in specific languages. Accepts a single string like "en" or a list like ["de", "en"].

  • bbox (list or tuple of 2 items of geopy.point.Point or (latitude, longitude) or "%(latitude)s, %(longitude)s".) – The bounding box of the viewport within which to bias geocode results more prominently. Example: [Point(22, 180), Point(-22, -180)].

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, language=None)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • language (str or list) – Prefer results in specific languages. Accepts a single string like "en" or a list like ["de", "en"].

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

OpenCage

class geopy.geocoders.OpenCage(api_key, *, domain='api.opencagedata.com', scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)

Geocoder using the OpenCageData API.

Documentation at:

https://opencagedata.com/api

Changed in version 2.2: Improved error handling by using the default errors map (e.g. to raise exc.GeocoderQuotaExceeded instead of exc.GeocoderQueryError for HTTP 402 error)

__init__(api_key, *, domain='api.opencagedata.com', scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)
Parameters
geocode(query, *, bounds=None, country=None, language=None, annotations=True, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • bounds (list or tuple of 2 items of geopy.point.Point or (latitude, longitude) or "%(latitude)s, %(longitude)s".) – Provides the geocoder with a hint to the region that the query resides in. This value will help the geocoder but will not restrict the possible results to the supplied region. The bounds parameter should be specified as 2 coordinate points – corners of a bounding box. Example: [Point(22, 180), Point(-22, -180)].

  • country (str or list) – Restricts the results to the specified country or countries. The country code is a 2 character code as defined by the ISO 3166-1 Alpha 2 standard (e.g. fr). Might be a Python list of strings.

  • language (str) – an IETF format language code (such as es for Spanish or pt-BR for Brazilian Portuguese); if this is omitted a code of en (English) will be assumed by the remote service.

  • annotations (bool) –

    Enable annotations data, which can be accessed via Location.raw. Set to False if you don’t need it to gain a little performance win.

    New in version 2.2.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, language=None, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • language (str) – The language in which to return results.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

OpenMapQuest

class geopy.geocoders.OpenMapQuest(api_key, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, domain='open.mapquestapi.com', scheme=None, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)

Bases: geopy.geocoders.nominatim.Nominatim

Geocoder using MapQuest Open Platform Web Services.

Documentation at:

https://developer.mapquest.com/documentation/open/

MapQuest provides two Geocoding APIs:

__init__(api_key, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, domain='open.mapquestapi.com', scheme=None, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, limit=None, addressdetails=False, language=False, geometry=None, extratags=False, country_codes=None, viewbox=None, bounded=False, featuretype=None, namedetails=False)

Return a location point by address.

Parameters

  • query (dict or str) –

    The address, query or a structured query you wish to geocode.

    For a structured query, provide a dictionary whose keys are one of: street, city, county, state, country, or postalcode. For more information, see Nominatim’s documentation for structured requests:

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • limit (int) – Maximum amount of results to return from Nominatim. Unless exactly_one is set to False, limit will always be 1.

  • addressdetails (bool) – If you want in Location.raw to include address details such as house_number, city_district, postcode, etc (in a structured form) set it to True

  • language (str) –

    Preferred language in which to return results. Either uses standard RFC2616 accept-language string or a simple comma-separated list of language codes.

  • geometry (str) – If present, specifies whether the geocoding service should return the result’s geometry in wkt, svg, kml, or geojson formats. This is available via the raw attribute on the returned geopy.location.Location object.

  • extratags (bool) – Include additional information in the result if available, e.g. wikipedia link, opening hours.

  • country_codes (str or list) – Limit search results to a specific country (or a list of countries). A country_code should be the ISO 3166-1alpha2 code, e.g. gb for the United Kingdom, de for Germany, etc.

  • viewbox (list or tuple of 2 items of geopy.point.Point or (latitude, longitude) or "%(latitude)s, %(longitude)s".) – Prefer this area to find search results. By default this is treated as a hint, if you want to restrict results to this area, specify bounded=True as well. Example: [Point(22, 180), Point(-22, -180)].

  • bounded (bool) – Restrict the results to only items contained within the bounding viewbox.

  • featuretype (str) – If present, restrict results to certain type of features. Allowed values: country, state, city, settlement.

  • namedetails (bool) – If you want in Location.raw to include namedetails, set it to True. This will be a list of alternative names, including language variants, etc.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, language=False, addressdetails=True, zoom=None, namedetails=False)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • language (str) –

    Preferred language in which to return results. Either uses standard RFC2616 accept-language string or a simple comma-separated list of language codes.

  • addressdetails (bool) – Whether or not to include address details, such as city, county, state, etc. in Location.raw

  • zoom (int) – Level of detail required for the address, an integer in range from 0 (country level) to 18 (building level), default is 18.

  • namedetails (bool) –

    If you want in Location.raw to include namedetails, set it to True. This will be a list of alternative names, including language variants, etc.

    New in version 2.3.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

Nominatim

class geopy.geocoders.Nominatim(*, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, domain='nominatim.openstreetmap.org', scheme=None, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)

Nominatim geocoder for OpenStreetMap data.

Documentation at:

https://nominatim.org/release-docs/develop/api/Overview/

Attention

Using Nominatim with the default user_agent is strongly discouraged, as it violates Nominatim’s Usage Policy https://operations.osmfoundation.org/policies/nominatim/ and may possibly cause 403 and 429 HTTP errors. Please make sure to specify a custom user_agent with Nominatim(user_agent="my-application") or by overriding the default user_agent: geopy.geocoders.options.default_user_agent = "my-application". An exception will be thrown if a custom user_agent is not specified.

__init__(*, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, domain='nominatim.openstreetmap.org', scheme=None, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, limit=None, addressdetails=False, language=False, geometry=None, extratags=False, country_codes=None, viewbox=None, bounded=False, featuretype=None, namedetails=False)

Return a location point by address.

Parameters

  • query (dict or str) –

    The address, query or a structured query you wish to geocode.

    For a structured query, provide a dictionary whose keys are one of: street, city, county, state, country, or postalcode. For more information, see Nominatim’s documentation for structured requests:

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • limit (int) – Maximum amount of results to return from Nominatim. Unless exactly_one is set to False, limit will always be 1.

  • addressdetails (bool) – If you want in Location.raw to include address details such as house_number, city_district, postcode, etc (in a structured form) set it to True

  • language (str) –

    Preferred language in which to return results. Either uses standard RFC2616 accept-language string or a simple comma-separated list of language codes.

  • geometry (str) – If present, specifies whether the geocoding service should return the result’s geometry in wkt, svg, kml, or geojson formats. This is available via the raw attribute on the returned geopy.location.Location object.

  • extratags (bool) – Include additional information in the result if available, e.g. wikipedia link, opening hours.

  • country_codes (str or list) – Limit search results to a specific country (or a list of countries). A country_code should be the ISO 3166-1alpha2 code, e.g. gb for the United Kingdom, de for Germany, etc.

  • viewbox (list or tuple of 2 items of geopy.point.Point or (latitude, longitude) or "%(latitude)s, %(longitude)s".) – Prefer this area to find search results. By default this is treated as a hint, if you want to restrict results to this area, specify bounded=True as well. Example: [Point(22, 180), Point(-22, -180)].

  • bounded (bool) – Restrict the results to only items contained within the bounding viewbox.

  • featuretype (str) – If present, restrict results to certain type of features. Allowed values: country, state, city, settlement.

  • namedetails (bool) – If you want in Location.raw to include namedetails, set it to True. This will be a list of alternative names, including language variants, etc.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, language=False, addressdetails=True, zoom=None, namedetails=False)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • language (str) –

    Preferred language in which to return results. Either uses standard RFC2616 accept-language string or a simple comma-separated list of language codes.

  • addressdetails (bool) – Whether or not to include address details, such as city, county, state, etc. in Location.raw

  • zoom (int) – Level of detail required for the address, an integer in range from 0 (country level) to 18 (building level), default is 18.

  • namedetails (bool) –

    If you want in Location.raw to include namedetails, set it to True. This will be a list of alternative names, including language variants, etc.

    New in version 2.3.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

Pelias

class geopy.geocoders.Pelias(domain, api_key=None, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, scheme=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)

Pelias geocoder.

Documentation at:

https://github.com/pelias/documentation

See also geopy.geocoders.GeocodeEarth which is a Pelias-based service provided by the developers of Pelias itself.

__init__(domain, api_key=None, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, scheme=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, boundary_rect=None, countries=None, country_bias=None, language=None)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • boundary_rect (list or tuple of 2 items of geopy.point.Point or (latitude, longitude) or "%(latitude)s, %(longitude)s".) – Coordinates to restrict search within. Example: [Point(22, 180), Point(-22, -180)].

  • countries (list) –

    A list of country codes specified in ISO 3166-1 alpha-2 or alpha-3 format, e.g. ['USA', 'CAN']. This is a hard filter.

    New in version 2.3.

  • country_bias (str) –

    Bias results to this country (ISO alpha-3).

    Deprecated since version 2.3: Use countries instead. This option behaves the same way, i.e. it’s not a soft filter as the name suggests. This parameter is scheduled for removal in geopy 3.0.

  • language (str) –

    Preferred language in which to return results. Either uses standard RFC2616 accept-language string or a simple comma-separated list of language codes.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, language=None)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • language (str) –

    Preferred language in which to return results. Either uses standard RFC2616 accept-language string or a simple comma-separated list of language codes.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

Photon

class geopy.geocoders.Photon(*, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, domain='photon.komoot.io', user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)

Geocoder using Photon geocoding service (data based on OpenStreetMap and service provided by Komoot on https://photon.komoot.io).

Documentation at:

https://github.com/komoot/photon

Photon/Komoot geocoder aims to let you search as you type with OpenStreetMap. No API Key is needed by this platform.

Changed in version 2.2: Changed default domain from photon.komoot.de to photon.komoot.io.

__init__(*, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, domain='photon.komoot.io', user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, location_bias=None, language=False, limit=None, osm_tag=None, bbox=None)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • location_bias (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates to use as location bias.

  • language (str) – Preferred language in which to return results.

  • limit (int) – Limit the number of returned results, defaults to no limit.

  • osm_tag (str or list or set) – The expression to filter (include/exclude) by key and/ or value, str as 'key:value' or list/set of str if multiple filters are required as ['key:!val', '!key', ':!value'].

  • bbox (list or tuple of 2 items of geopy.point.Point or (latitude, longitude) or "%(latitude)s, %(longitude)s".) –

    The bounding box of the viewport within which to bias geocode results more prominently. Example: [Point(22, 180), Point(-22, -180)].

    New in version 2.2.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, language=False, limit=None)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • language (str) – Preferred language in which to return results.

  • limit (int) – Limit the number of returned results, defaults to no limit.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

PickPoint

class geopy.geocoders.PickPoint(api_key, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, domain='api.pickpoint.io', scheme=None, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)

Bases: geopy.geocoders.nominatim.Nominatim

PickPoint geocoder is a commercial version of Nominatim.

Documentation at:

https://pickpoint.io/api-reference

__init__(api_key, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, domain='api.pickpoint.io', scheme=None, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, limit=None, addressdetails=False, language=False, geometry=None, extratags=False, country_codes=None, viewbox=None, bounded=False, featuretype=None, namedetails=False)

Return a location point by address.

Parameters

  • query (dict or str) –

    The address, query or a structured query you wish to geocode.

    For a structured query, provide a dictionary whose keys are one of: street, city, county, state, country, or postalcode. For more information, see Nominatim’s documentation for structured requests:

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • limit (int) – Maximum amount of results to return from Nominatim. Unless exactly_one is set to False, limit will always be 1.

  • addressdetails (bool) – If you want in Location.raw to include address details such as house_number, city_district, postcode, etc (in a structured form) set it to True

  • language (str) –

    Preferred language in which to return results. Either uses standard RFC2616 accept-language string or a simple comma-separated list of language codes.

  • geometry (str) – If present, specifies whether the geocoding service should return the result’s geometry in wkt, svg, kml, or geojson formats. This is available via the raw attribute on the returned geopy.location.Location object.

  • extratags (bool) – Include additional information in the result if available, e.g. wikipedia link, opening hours.

  • country_codes (str or list) – Limit search results to a specific country (or a list of countries). A country_code should be the ISO 3166-1alpha2 code, e.g. gb for the United Kingdom, de for Germany, etc.

  • viewbox (list or tuple of 2 items of geopy.point.Point or (latitude, longitude) or "%(latitude)s, %(longitude)s".) – Prefer this area to find search results. By default this is treated as a hint, if you want to restrict results to this area, specify bounded=True as well. Example: [Point(22, 180), Point(-22, -180)].

  • bounded (bool) – Restrict the results to only items contained within the bounding viewbox.

  • featuretype (str) – If present, restrict results to certain type of features. Allowed values: country, state, city, settlement.

  • namedetails (bool) – If you want in Location.raw to include namedetails, set it to True. This will be a list of alternative names, including language variants, etc.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, language=False, addressdetails=True, zoom=None, namedetails=False)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • language (str) –

    Preferred language in which to return results. Either uses standard RFC2616 accept-language string or a simple comma-separated list of language codes.

  • addressdetails (bool) – Whether or not to include address details, such as city, county, state, etc. in Location.raw

  • zoom (int) – Level of detail required for the address, an integer in range from 0 (country level) to 18 (building level), default is 18.

  • namedetails (bool) –

    If you want in Location.raw to include namedetails, set it to True. This will be a list of alternative names, including language variants, etc.

    New in version 2.3.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

LiveAddress

class geopy.geocoders.LiveAddress(auth_id, auth_token, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)

Geocoder using the LiveAddress API provided by SmartyStreets.

Documentation at:

https://smartystreets.com/docs/cloud/us-street-api

__init__(auth_id, auth_token, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, candidates=1)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • candidates (int) – An integer between 1 and 10 indicating the max number of candidate addresses to return if a valid address could be found.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

TomTom

class geopy.geocoders.TomTom(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='api.tomtom.com')

TomTom geocoder.

Documentation at:

https://developer.tomtom.com/search-api/search-api-documentation

__init__(api_key, *, scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='api.tomtom.com')
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, limit=None, typeahead=False, language=None)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • limit (int) – Maximum amount of results to return from the service. Unless exactly_one is set to False, limit will always be 1.

  • typeahead (bool) – If the “typeahead” flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.

  • language (str) – Language in which search results should be returned. When data in specified language is not available for a specific field, default language is used. List of supported languages (case-insensitive): https://developer.tomtom.com/online-search/online-search-documentation/supported-languages

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, language=None)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • language (str) – Language in which search results should be returned. When data in specified language is not available for a specific field, default language is used. List of supported languages (case-insensitive): https://developer.tomtom.com/online-search/online-search-documentation/supported-languages

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

What3Words

class geopy.geocoders.What3Words(api_key, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='api.what3words.com')

What3Words geocoder using the legacy V2 API.

Documentation at:

https://docs.what3words.com/api/v2/

Attention

Consider using What3WordsV3 instead.

__init__(api_key, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='api.what3words.com')
Parameters
geocode(query, *, lang='en', exactly_one=True, timeout=DEFAULT_SENTINEL)

Return a location point for a 3 words query. If the 3 words address doesn’t exist, a geopy.exc.GeocoderQueryError exception will be thrown.

Parameters

  • query (str) – The 3-word address you wish to geocode.

  • lang (str) – two character language code as supported by the API (https://docs.what3words.com/api/v2/#lang).

  • exactly_one (bool) – Return one result or a list of results, if available. Due to the address scheme there is always exactly one result for each 3 words address, so this parameter is rather useless for this geocoder.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, lang='en', exactly_one=True, timeout=DEFAULT_SENTINEL)

Return a 3 words address by location point. Each point on surface has a 3 words address, so there’s always a non-empty response.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the 3 word address.

  • lang (str) – two character language code as supported by the API (https://docs.what3words.com/api/v2/#lang).

  • exactly_one (bool) – Return one result or a list of results, if available. Due to the address scheme there is always exactly one result for each 3 words address, so this parameter is rather useless for this geocoder.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

geopy.location.Location or a list of them, if exactly_one=False.

What3WordsV3

class geopy.geocoders.What3WordsV3(api_key, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='api.what3words.com')

What3Words geocoder using the V3 API.

Documentation at:

https://developer.what3words.com/public-api/docs

New in version 2.2.

__init__(api_key, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='api.what3words.com')
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL)

Return a location point for a 3 words query. If the 3 words address doesn’t exist, a geopy.exc.GeocoderQueryError exception will be thrown.

Parameters

  • query (str) – The 3-word address you wish to geocode.

  • exactly_one (bool) – Return one result or a list of results, if available. Due to the address scheme there is always exactly one result for each 3 words address, so this parameter is rather useless for this geocoder.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, lang='en', exactly_one=True, timeout=DEFAULT_SENTINEL)

Return a 3 words address by location point. Each point on surface has a 3 words address, so there’s always a non-empty response.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the 3 word address.

  • lang (str) – two character language code as supported by the API (https://developer.what3words.com/public-api/docs#available-languages).

  • exactly_one (bool) – Return one result or a list of results, if available. Due to the address scheme there is always exactly one result for each 3 words address, so this parameter is rather useless for this geocoder.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

Return type

geopy.location.Location or a list of them, if exactly_one=False.

Woosmap

class geopy.geocoders.Woosmap(api_key, *, domain='api.woosmap.com', scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)

Geocoder using the Woosmap Address API.

Documentation at:

https://developers.woosmap.com/products/address-api/geocode/

New in version 2.4.

__init__(api_key, *, domain='api.woosmap.com', scheme=None, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None)
Parameters
geocode(query, *, limit=None, exactly_one=True, timeout=DEFAULT_SENTINEL, location=None, components=None, language=None, country_code_format=None)

Return a location point by address.

Parameters

  • query (str) – The address you wish to geocode.

  • limit (int) – Maximum number of results to be returned. This will be reset to one if exactly_one is True.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • location (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The center latlng to bias the search context.

  • components (dict or list) –

    Geographic places to which you would like to restrict your results. Currently, you can use components to filter over countries. Countries are identified by a two character, ISO 3166-1 Alpha-2 or a three character, ISO 3166-1 Alpha-3 compatible country code.

    Pass a list of tuples if you want to specify multiple components of the same type, e.g.:

    >>> [('country', 'FRA'), ('country', 'DE')]

  • language (str) – The language in which to return results. Must be a ISO 639-1 language code.

  • country_code_format (str) – Default country code format in responses is Alpha3. However, format in responses can be changed by specifying components in alpha2. Available formats: alpha2, alpha3.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, limit=None, exactly_one=True, timeout=DEFAULT_SENTINEL, language=None, country_code_format=None)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • limit (int) – Maximum number of results to be returned. This will be reset to one if exactly_one is True.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • language (str) – The language in which to return results.

  • country_code_format (str) – Default country code format in responses is Alpha3. However, format in responses can be changed by specifying components in alpha2. Available formats: alpha2, alpha3.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

Yandex

class geopy.geocoders.Yandex(api_key, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, scheme=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='geocode-maps.yandex.ru')

Yandex geocoder.

Documentation at:

https://tech.yandex.com/maps/doc/geocoder/desc/concepts/input_params-docpage/

__init__(api_key, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, scheme=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, domain='geocode-maps.yandex.ru')
Parameters
geocode(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, lang=None)

Return a location point by address.

Parameters

  • query (str) – The address or query you wish to geocode.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • lang (str) –

    Language of the response and regional settings of the map. List of supported values:

    • tr_TR – Turkish (only for maps of Turkey);

    • en_RU – response in English, Russian map features;

    • en_US – response in English, American map features;

    • ru_RU – Russian (default);

    • uk_UA – Ukrainian;

    • be_BY – Belarusian.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

reverse(query, *, exactly_one=True, timeout=DEFAULT_SENTINEL, kind=None, lang=None)

Return an address by location point.

Parameters

  • query (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – The coordinates for which you wish to obtain the closest human-readable addresses.

  • exactly_one (bool) – Return one result or a list of results, if available.

  • timeout (int) – Time, in seconds, to wait for the geocoding service to respond before raising a geopy.exc.GeocoderTimedOut exception. Set this only if you wish to override, on this call only, the value set during the geocoder’s initialization.

  • kind (str) – Type of toponym. Allowed values: house, street, metro, district, locality.

  • lang (str) –

    Language of the response and regional settings of the map. List of supported values:

    • tr_TR – Turkish (only for maps of Turkey);

    • en_RU – response in English, Russian map features;

    • en_US – response in English, American map features;

    • ru_RU – Russian (default);

    • uk_UA – Ukrainian;

    • be_BY – Belarusian.

Return type

None, geopy.location.Location or a list of them, if exactly_one=False.

Calculating Distance

Geopy can calculate geodesic distance between two points using the geodesic distance or the great-circle distance, with a default of the geodesic distance available as the function geopy.distance.distance.

Great-circle distance (great_circle) uses a spherical model of the earth, using the mean earth radius as defined by the International Union of Geodesy and Geophysics, (2a + b)/3 = 6371.0087714150598 kilometers approx 6371.009 km (for WGS-84), resulting in an error of up to about 0.5%. The radius value is stored in distance.EARTH_RADIUS, so it can be customized (it should always be in kilometers, however).

The geodesic distance is the shortest distance on the surface of an ellipsoidal model of the earth. The default algorithm uses the method is given by Karney (2013) (geodesic); this is accurate to round-off and always converges.

geopy.distance.distance currently uses geodesic.

There are multiple popular ellipsoidal models, and which one will be the most accurate depends on where your points are located on the earth. The default is the WGS-84 ellipsoid, which is the most globally accurate. geopy includes a few other models in the distance.ELLIPSOIDS dictionary:

              model             major (km)   minor (km)     flattening
ELLIPSOIDS = {'WGS-84':        (6378.137,    6356.7523142,  1 / 298.257223563),
              'GRS-80':        (6378.137,    6356.7523141,  1 / 298.257222101),
              'Airy (1830)':   (6377.563396, 6356.256909,   1 / 299.3249646),
              'Intl 1924':     (6378.388,    6356.911946,   1 / 297.0),
              'Clarke (1880)': (6378.249145, 6356.51486955, 1 / 293.465),
              'GRS-67':        (6378.1600,   6356.774719,   1 / 298.25),
              }

Here are examples of distance.distance usage, taking pair of (lat, lon) tuples:

>>> from geopy import distance
>>> newport_ri = (41.49008, -71.312796)
>>> cleveland_oh = (41.499498, -81.695391)
>>> print(distance.distance(newport_ri, cleveland_oh).miles)
538.39044536

>>> wellington = (-41.32, 174.81)
>>> salamanca = (40.96, -5.50)
>>> print(distance.distance(wellington, salamanca).km)
19959.6792674

Using great_circle distance:

>>> print(distance.great_circle(newport_ri, cleveland_oh).miles)
536.997990696

You can change the ellipsoid model used by the geodesic formulas like so:

>>> ne, cl = newport_ri, cleveland_oh
>>> print(distance.geodesic(ne, cl, ellipsoid='GRS-80').miles)

The above model name will automatically be retrieved from the distance.ELLIPSOIDS dictionary. Alternatively, you can specify the model values directly:

>>> distance.geodesic(ne, cl, ellipsoid=(6377., 6356., 1 / 297.)).miles

Distances support simple arithmetic, making it easy to do things like calculate the length of a path:

>>> from geopy import Nominatim
>>> d = distance.distance
>>> g = Nominatim(user_agent="specify_your_app_name_here")
>>> _, wa = g.geocode('Washington, DC')
>>> _, pa = g.geocode('Palo Alto, CA')
>>> print((d(ne, cl) + d(cl, wa) + d(wa, pa)).miles)
3277.30439191

Currently all algorithms assume that altitudes of the points are either zero (as in the examples above) or equal, and are relatively small. Thus altitudes never affect the resulting distances:

>>> from geopy import distance
>>> newport_ri = (41.49008, -71.312796)
>>> cleveland_oh = (41.499498, -81.695391)
>>> print(distance.distance(newport_ri, cleveland_oh).km)
866.4554329098687
>>> newport_ri = (41.49008, -71.312796, 100)
>>> cleveland_oh = (41.499498, -81.695391, 100)
>>> print(distance.distance(newport_ri, cleveland_oh).km)
866.4554329098687

If you need to calculate distances with elevation, then for short distances the Euclidean distance formula might give a suitable approximation:

>>> import math
>>> from geopy import distance
>>> p1 = (43.668613, 40.258916, 0.976)
>>> p2 = (43.658852, 40.250839, 1.475)
>>> flat_distance = distance.distance(p1[:2], p2[:2]).km
>>> print(flat_distance)
1.265133525952866
>>> euclidian_distance = math.sqrt(flat_distance**2 + (p2[2] - p1[2])**2)
>>> print(euclidian_distance)
1.359986705262199

An attempt to calculate distances between points with different altitudes would result in a ValueError exception.

geopy.distance.lonlat(x, y, z=0)

geopy.distance.distance accepts coordinates in (y, x)/(lat, lon) order, while some other libraries and systems might use (x, y)/(lon, lat).

This function provides a convenient way to convert coordinates of the (x, y)/(lon, lat) format to a geopy.point.Point instance.

Example:

>>> from geopy.distance import lonlat, distance
>>> newport_ri_xy = (-71.312796, 41.49008)
>>> cleveland_oh_xy = (-81.695391, 41.499498)
>>> print(distance(lonlat(*newport_ri_xy), lonlat(*cleveland_oh_xy)).miles)
538.3904453677203
Parameters

  • x – longitude

  • y – latitude

  • z – (optional) altitude

Returns

Point(latitude, longitude, altitude)

class geopy.distance.Distance(*args, **kwargs)

Base class for other distance algorithms. Represents a distance.

Can be used for units conversion:

>>> from geopy.distance import Distance
>>> Distance(miles=10).km
16.09344

Distance instances have all distance properties from geopy.units, e.g.: km, m, meters, miles and so on.

Distance instances are immutable.

They support comparison:

>>> from geopy.distance import Distance
>>> Distance(kilometers=2) == Distance(meters=2000)
True
>>> Distance(kilometers=2) > Distance(miles=1)
True

String representation:

>>> from geopy.distance import Distance
>>> repr(Distance(kilometers=2))
'Distance(2.0)'
>>> str(Distance(kilometers=2))
'2.0 km'
>>> repr(Distance(miles=2))
'Distance(3.218688)'
>>> str(Distance(miles=2))
'3.218688 km'

Arithmetics:

>>> from geopy.distance import Distance
>>> -Distance(miles=2)
Distance(-3.218688)
>>> Distance(miles=2) + Distance(kilometers=1)
Distance(4.218688)
>>> Distance(miles=2) - Distance(kilometers=1)
Distance(2.218688)
>>> Distance(kilometers=6) * 5
Distance(30.0)
>>> Distance(kilometers=6) / 5
Distance(1.2)
__init__(*args, **kwargs)

There are 3 ways to create a distance:

  • From kilometers:

    >>> from geopy.distance import Distance
>>> Distance(1.42)
Distance(1.42)

  • From units:

    >>> from geopy.distance import Distance
>>> Distance(kilometers=1.42)
Distance(1.42)
>>> Distance(miles=1)
Distance(1.609344)

  • From points (for non-abstract distances only), calculated as a sum of distances between all points:

    >>> from geopy.distance import geodesic
>>> geodesic((40, 160), (40.1, 160.1))
Distance(14.003702498106215)
>>> geodesic((40, 160), (40.1, 160.1), (40.2, 160.2))
Distance(27.999954644813478)
destination(point, bearing, distance=None)

Calculate destination point using a starting point, bearing and a distance. This method works for non-abstract distances only.

Example: a point 10 miles east from (34, 148):

>>> import geopy.distance
>>> geopy.distance.distance(miles=10).destination((34, 148), bearing=90)
Point(33.99987666492774, 148.17419994321995, 0.0)
Parameters

  • point (geopy.point.Point, list or tuple of (latitude, longitude), or string as "%(latitude)s, %(longitude)s".) – Starting point.

  • bearing (float) – Bearing in degrees: 0 – North, 90 – East, 180 – South, 270 or -90 – West.

  • distance (Distance) –

    Distance, can be used to override this instance:

    >>> from geopy.distance import distance, Distance
>>> distance(miles=10).destination((34, 148), bearing=90, distance=Distance(100))
Point(33.995238229104764, 149.08238904409637, 0.0)

Return type

geopy.point.Point

class geopy.distance.geodesic(*args, **kwargs)

Bases: geopy.distance.Distance

Calculate the geodesic distance between points.

Set which ellipsoidal model of the earth to use by specifying an ellipsoid keyword argument. The default is ‘WGS-84’, which is the most globally accurate model. If ellipsoid is a string, it is looked up in the ELLIPSOIDS dictionary to obtain the major and minor semiaxes and the flattening. Otherwise, it should be a tuple with those values. See the comments above the ELLIPSOIDS dictionary for more information.

Example:

>>> from geopy.distance import geodesic
>>> newport_ri = (41.49008, -71.312796)
>>> cleveland_oh = (41.499498, -81.695391)
>>> print(geodesic(newport_ri, cleveland_oh).miles)
538.390445368
class geopy.distance.great_circle(*args, **kwargs)

Bases: geopy.distance.Distance

Use spherical geometry to calculate the surface distance between points.

Set which radius of the earth to use by specifying a radius keyword argument. It must be in kilometers. The default is to use the module constant EARTH_RADIUS, which uses the average great-circle radius.

Example:

>>> from geopy.distance import great_circle
>>> newport_ri = (41.49008, -71.312796)
>>> cleveland_oh = (41.499498, -81.695391)
>>> print(great_circle(newport_ri, cleveland_oh).miles)
536.997990696

Data

class geopy.location.Location(address, point, raw)

Contains a parsed geocoder response. Can be iterated over as (location<String>, (latitude<float>, longitude<Float)). Or one can access the properties address, latitude, longitude, or raw. The last is a dictionary of the geocoder’s response for this item.

property address

Location as a formatted string returned by the geocoder or constructed by geopy, depending on the service.

Return type

str

property altitude

Location’s altitude.

Note

Geocoding services usually don’t consider altitude neither in requests nor in responses, so almost always the value of this property would be zero.

Return type

float

property latitude

Location’s latitude.

Return type

float

property longitude

Location’s longitude.

Return type

float

property point

geopy.point.Point instance representing the location’s latitude, longitude, and altitude.

Return type

geopy.point.Point

property raw

Location’s raw, unparsed geocoder response. For details on this, consult the service’s documentation.

Return type

dict

class geopy.point.Point(latitude=None, longitude=None, altitude=None)

A geodetic point with latitude, longitude, and altitude.

Latitude and longitude are floating point values in degrees. Altitude is a floating point value in kilometers. The reference level is never considered and is thus application dependent, so be consistent! The default for all values is 0.

Points can be created in a number of ways…

With latitude, longitude, and altitude:

>>> p1 = Point(41.5, -81, 0)
>>> p2 = Point(latitude=41.5, longitude=-81)

With a sequence of 2 to 3 values (latitude, longitude, altitude):

>>> p1 = Point([41.5, -81, 0])
>>> p2 = Point((41.5, -81))

Copy another Point instance:

>>> p2 = Point(p1)
>>> p2 == p1
True
>>> p2 is p1
False

Give a string containing at least latitude and longitude:

>>> p = Point('41.5,-81.0')
>>> p = Point('+41.5 -81.0')
>>> p = Point('41.5 N -81.0 W')
>>> p = Point('-41.5 S, 81.0 E, 2.5km')
>>> p = Point('23 26m 22s N 23 27m 30s E 21.0mi')
>>> p = Point('''3 26' 22" N 23 27' 30" E''')

Point values can be accessed by name or by index:

>>> p = Point(41.5, -81.0, 0)
>>> p.latitude == p[0]
True
>>> p.longitude == p[1]
True
>>> p.altitude == p[2]
True

When unpacking (or iterating), a (latitude, longitude, altitude) tuple is returned:

>>> latitude, longitude, altitude = p

Textual representations:

>>> p = Point(41.5, -81.0, 12.3)
>>> str(p)  # same as `p.format()`
'41 30m 0s N, 81 0m 0s W, 12.3km'
>>> p.format_unicode()
'41° 30′ 0″ N, 81° 0′ 0″ W, 12.3km'
>>> repr(p)
'Point(41.5, -81.0, 12.3)'
>>> repr(tuple(p))
'(41.5, -81.0, 12.3)'
static __new__(cls, latitude=None, longitude=None, altitude=None)
Parameters

  • latitude (float) – Latitude of point.

  • longitude (float) – Longitude of point.

  • altitude (float) – Altitude of point.

format(altitude=None, deg_char='', min_char='m', sec_char='s')

Format decimal degrees (DD) to degrees minutes seconds (DMS):

>>> p = Point(41.5, -81.0, 12.3)
>>> p.format()
'41 30m 0s N, 81 0m 0s W, 12.3km'
>>> p = Point(41.5, 0, 0)
>>> p.format()
'41 30m 0s N, 0 0m 0s E'

See also format_unicode().

Parameters

altitude (bool) – Whether to include altitude value. By default it is automatically included if it is non-zero.

format_altitude(unit='km')

Format altitude with unit:

>>> p = Point(41.5, -81.0, 12.3)
>>> p.format_altitude()
'12.3km'
>>> p = Point(41.5, -81.0, 0)
>>> p.format_altitude()
'0.0km'
Parameters

unit (str) – Resulting altitude unit. Supported units are listed in from_string() doc.

format_decimal(altitude=None)

Format decimal degrees with altitude:

>>> p = Point(41.5, -81.0, 12.3)
>>> p.format_decimal()
'41.5, -81.0, 12.3km'
>>> p = Point(41.5, 0, 0)
>>> p.format_decimal()
'41.5, 0.0'
Parameters

altitude (bool) – Whether to include altitude value. By default it is automatically included if it is non-zero.

format_unicode(altitude=None)

format() with pretty unicode chars for degrees, minutes and seconds:

>>> p = Point(41.5, -81.0, 12.3)
>>> p.format_unicode()
'41° 30′ 0″ N, 81° 0′ 0″ W, 12.3km'
Parameters

altitude (bool) – Whether to include altitude value. By default it is automatically included if it is non-zero.

classmethod from_point(point)

Create and return a new Point instance from another Point instance.

classmethod from_sequence(seq)

Create and return a new Point instance from any iterable with 2 to 3 elements. The elements, if present, must be latitude, longitude, and altitude, respectively.

classmethod from_string(string)

Create and return a Point instance from a string containing latitude and longitude, and optionally, altitude.

Latitude and longitude must be in degrees and may be in decimal form or indicate arcminutes and arcseconds (labeled with Unicode prime and double prime, ASCII quote and double quote or ‘m’ and ‘s’). The degree symbol is optional and may be included after the decimal places (in decimal form) and before the arcminutes and arcseconds otherwise. Coordinates given from south and west (indicated by S and W suffixes) will be converted to north and east by switching their signs. If no (or partial) cardinal directions are given, north and east are the assumed directions. Latitude and longitude must be separated by at least whitespace, a comma, or a semicolon (each with optional surrounding whitespace).

Altitude, if supplied, must be a decimal number with given units. The following unit abbrevations (case-insensitive) are supported:

  • km (kilometers)

  • m (meters)

  • mi (miles)

  • ft (feet)

  • nm, nmi (nautical miles)

Some example strings that will work include:

  • 41.5;-81.0

  • 41.5,-81.0

  • 41.5 -81.0

  • 41.5 N -81.0 W

  • -41.5 S;81.0 E

  • 23 26m 22s N 23 27m 30s E

  • 23 26' 22" N 23 27' 30" E

  • UT: N 39°20' 0'' / W 74°35' 0''

classmethod parse_altitude(distance, unit)

Parse altitude managing units conversion:

>>> Point.parse_altitude(712, 'm')
0.712
>>> Point.parse_altitude(712, 'km')
712.0
>>> Point.parse_altitude(712, 'mi')
1145.852928
Parameters

  • distance (float) – Numeric value of altitude.

  • unit (str) – distance unit. Supported units are listed in from_string() doc.

classmethod parse_degrees(degrees, arcminutes, arcseconds, direction=None)

Convert degrees, minutes, seconds and direction (N, S, E, W) to a single degrees number.

Return type

float

class geopy.timezone.Timezone(pytz_timezone, raw)

Contains a parsed response for a timezone request, which is implemented in few geocoders which provide such lookups.

property pytz_timezone

pytz timezone instance.

Return type

pytz.tzinfo.BaseTzInfo

property raw

Timezone’s raw, unparsed geocoder response. For details on this, consult the service’s documentation.

Return type

dict

Units Conversion

geopy.units module provides utility functions for performing angle and distance unit conversions.

Some shortly named aliases are provided for convenience (e.g. km() is an alias for kilometers()).

geopy.units.arcmin(degrees=0, radians=0, arcseconds=0)

Convert angle to arcminutes.

geopy.units.arcminutes(degrees=0, radians=0, arcseconds=0)

Convert angle to arcminutes.

geopy.units.arcsec(degrees=0, radians=0, arcminutes=0)

Convert angle to arcseconds.

geopy.units.arcseconds(degrees=0, radians=0, arcminutes=0)

Convert angle to arcseconds.

geopy.units.degrees(radians=0, arcminutes=0, arcseconds=0)

Convert angle to degrees.

geopy.units.feet(kilometers=0, meters=0, miles=0, nautical=0)

Convert distance to feet.

geopy.units.ft(kilometers=0, meters=0, miles=0, nautical=0)

Convert distance to feet.

geopy.units.kilometers(meters=0, miles=0, feet=0, nautical=0)

Convert distance to kilometers.

geopy.units.km(meters=0, miles=0, feet=0, nautical=0)

Convert distance to kilometers.

geopy.units.m(kilometers=0, miles=0, feet=0, nautical=0)

Convert distance to meters.

geopy.units.meters(kilometers=0, miles=0, feet=0, nautical=0)

Convert distance to meters.

geopy.units.mi(kilometers=0, meters=0, feet=0, nautical=0)

Convert distance to miles.

geopy.units.miles(kilometers=0, meters=0, feet=0, nautical=0)

Convert distance to miles.

geopy.units.nautical(kilometers=0, meters=0, miles=0, feet=0)

Convert distance to nautical miles.

geopy.units.nm(kilometers=0, meters=0, miles=0, feet=0)

Convert distance to nautical miles.

geopy.units.rad(degrees=0, arcminutes=0, arcseconds=0)

Convert angle to radians.

geopy.units.radians(degrees=0, arcminutes=0, arcseconds=0)

Convert angle to radians.

Exceptions

class geopy.exc.GeopyError

Bases: Exception

Geopy-specific exceptions are all inherited from GeopyError.

class geopy.exc.ConfigurationError

Bases: geopy.exc.GeopyError, ValueError

When instantiating a geocoder, the arguments given were invalid. See the documentation of each geocoder’s __init__ for more details.

class geopy.exc.GeocoderServiceError

Bases: geopy.exc.GeopyError

There was an exception caused when calling the remote geocoding service, and no more specific exception could be raised by geopy. When calling geocoders’ geocode or reverse methods, this is the most generic exception that can be raised, and any non-geopy exception will be caught and turned into this. The exception’s message will be that of the original exception.

class geopy.exc.GeocoderQueryError

Bases: geopy.exc.GeocoderServiceError, ValueError

Either geopy detected input that would cause a request to fail, or a request was made and the remote geocoding service responded that the request was bad.

class geopy.exc.GeocoderQuotaExceeded

Bases: geopy.exc.GeocoderServiceError

The remote geocoding service refused to fulfill the request because the client has used its quota.

class geopy.exc.GeocoderRateLimited(message, *, retry_after=None)

Bases: geopy.exc.GeocoderQuotaExceeded, OSError

The remote geocoding service has rate-limited the request. Retrying later might help.

Exception of this type has a retry_after attribute, which contains amount of time (in seconds) the service has asked to wait. Might be None if there were no such data in response.

New in version 2.2.

class geopy.exc.GeocoderAuthenticationFailure

Bases: geopy.exc.GeocoderServiceError

The remote geocoding service rejected the API key or account credentials this geocoder was instantiated with.

class geopy.exc.GeocoderInsufficientPrivileges

Bases: geopy.exc.GeocoderServiceError

The remote geocoding service refused to fulfill a request using the account credentials given.

class geopy.exc.GeocoderTimedOut

Bases: geopy.exc.GeocoderServiceError, TimeoutError

The call to the geocoding service was aborted because no response has been received within the timeout argument of either the geocoding class or, if specified, the method call. Some services are just consistently slow, and a higher timeout may be needed to use them.

class geopy.exc.GeocoderUnavailable

Bases: geopy.exc.GeocoderServiceError, OSError

Either it was not possible to establish a connection to the remote geocoding service, or the service responded with a code indicating it was unavailable.

class geopy.exc.GeocoderParseError

Bases: geopy.exc.GeocoderServiceError

Geopy could not parse the service’s response. This is probably due to a bug in geopy.

class geopy.exc.GeocoderNotFound

Bases: geopy.exc.GeopyError, ValueError

Caller requested the geocoder matching a string, e.g., "google" > GoogleV3, but no geocoder could be found.

Adapters

Adapters are HTTP client implementations used by geocoders.

Some adapters might support keep-alives, request retries, http2, persistence of Cookies, response compression and so on.

Adapters should be considered an implementation detail. Most of the time you wouldn’t need to know about their existence unless you want to tune HTTP client settings.

New in version 2.0: Adapters are currently provided on a provisional basis.

Supported Adapters

class geopy.adapters.RequestsAdapter(*, proxies, ssl_context, pool_connections=10, pool_maxsize=10, max_retries=2, pool_block=False)

Bases: geopy.adapters.BaseSyncAdapter

The adapter which uses requests library.

requests supports keep-alives, retries, persists Cookies, allows response compression and uses HTTP/1.1 [currently].

requests package must be installed in order to use this adapter.

The requests’ trust_env value is set to false, meaning that environment doesn’t affect the requests’ configuration. The ssl_context and proxies settings can be used for configuration.

Changed in version 2.4: This adapter used to use the certifi CA bundle by default, if an ssl_context wasn’t provided explicitly. This has been changed to use the system CA store by default.

class geopy.adapters.URLLibAdapter(*, proxies, ssl_context)

Bases: geopy.adapters.BaseSyncAdapter

The fallback adapter which uses urllib from the Python standard library, see urllib.request.urlopen().

urllib doesn’t support keep-alives, request retries, doesn’t persist Cookies and is HTTP/1.1 only.

urllib was the only available option for making requests in geopy 1.x, so this adapter behaves the same as geopy 1.x in terms of HTTP requests.

class geopy.adapters.AioHTTPAdapter(*, proxies, ssl_context)

Bases: geopy.adapters.BaseAsyncAdapter

The adapter which uses aiohttp library.

aiohttp supports keep-alives, persists Cookies, allows response compression and uses HTTP/1.1 [currently].

aiohttp package must be installed in order to use this adapter.

Base Classes

class geopy.adapters.AdapterHTTPError(message, *, status_code, headers, text)

Bases: OSError

An exception which must be raised by adapters when an HTTP response with a non-successful status code has been received.

Base Geocoder class translates this exception to an instance of geopy.exc.GeocoderServiceError.

__init__(message, *, status_code, headers, text)
Parameters

  • message (str) – Standard exception message.

  • status_code (int) – HTTP status code.

  • headers (dict) –

    HTTP response readers. A mapping object with lowercased or case-insensitive keys.

    New in version 2.2.

  • text (str) – HTTP body text.

class geopy.adapters.BaseAdapter(*, proxies, ssl_context)

Base class for an Adapter.

There are two types of adapters:

Concrete adapter implementations must extend one of the two base adapters above.

See geopy.geocoders.options.default_adapter_factory for details on how to specify an adapter to be used by geocoders.

__init__(*, proxies, ssl_context)

Initialize adapter.

Parameters
abstract get_json(url, *, timeout, headers)

Same as get_text except that the response is expected to be a valid JSON. The value returned is the parsed JSON.

geopy.exc.GeocoderParseError must be raised if the response cannot be parsed.

Parameters
abstract get_text(url, *, timeout, headers)

Make a GET request and return the response as string.

This method should not raise any exceptions other than these:

Parameters
class geopy.adapters.BaseSyncAdapter(*, proxies, ssl_context)

Bases: geopy.adapters.BaseAdapter

Base class for synchronous adapters.

class geopy.adapters.BaseAsyncAdapter(*, proxies, ssl_context)

Bases: geopy.adapters.BaseAdapter

Base class for asynchronous adapters.

See also: Async Mode.

Logging

geopy will log geocoding URLs with a logger name geopy at level DEBUG, and for some geocoders, these URLs will include authentication information.

HTTP bodies of responses with unsuccessful status codes are logged with INFO level.

Default logging level is NOTSET, which delegates the messages processing to the root logger. See docs for logging.Logger.setLevel() for more information.

Semver

geopy attempts to follow semantic versioning, however some breaking changes are still being made in minor releases, such as:

  • Backwards-incompatible changes of the undocumented API. This shouldn’t affect anyone, unless they extend geocoder classes or use undocumented features or monkey-patch anything. If you believe that something is missing in geopy, please consider opening an issue or providing a patch/PR instead of hacking around geopy.

  • Geocoding services sometimes introduce new APIs and deprecate the previous ones. We try to upgrade without breaking the geocoder’s API interface, but the geopy.location.Location.raw value might change in a backwards-incompatible way.

  • Behavior for invalid input and peculiar edge cases might be altered. For example, geopy.point.Point instances previously did coordinate values normalization, though it’s not documented, and it was completely wrong for the latitudes outside the [-90; 90] range. So instead of using an incorrectly normalized value for latitude, a ValueError exception is now thrown (#294).

Features and usages being phased out are covered with deprecation warnings when possible. Make sure to run your python with the -Wd switch to see if your code emits the warnings.

To make the upgrade less painful, please read the changelog before upgrading.

Changelog

Changelog for 2.x.x series.

Changelog for 1.x.x series.

Changelog for 0.9x series.