Skip to main content

Geocoder is a simple and consistent geocoding library.

Project description

https://img.shields.io/pypi/v/geocoder.svg https://img.shields.io/pypi/dm/geocoder.svg https://travis-ci.org/DenisCarriere/geocoder.svg?branch=master https://coveralls.io/repos/DenisCarriere/geocoder/badge.svg?branch=master&service=github

Simple and consistent geocoding library written in Python.

Many online providers such as Google & Bing have geocoding services, these providers do not include Python libraries and have different JSON responses between each other.

It can be very difficult sometimes to parse a particular geocoding provider since each one of them have their own JSON schema.

Here is a typical example of retrieving a Lat & Lng from Google using Python, things shouldn’t be this hard.

>>> import requests
>>> url = 'https://maps.googleapis.com/maps/api/geocode/json'
>>> params = {'sensor': 'false', 'address': 'Mountain View, CA'}
>>> r = requests.get(url, params=params)
>>> results = r.json()['results']
>>> location = results[0]['geometry']['location']
>>> location['lat'], location['lng']
(37.3860517, -122.0838511)

Now lets use Geocoder to do the same task.

>>> import geocoder
>>> g = geocoder.google('Mountain View, CA')
>>> g.latlng
(37.3860517, -122.0838511)

API Overview

Many properties are available once the geocoder object is created.

Forward

>>> import geocoder
>>> g = geocoder.google('Mountain View, CA')
>>> g.geojson
>>> g.json
>>> g.wkt
>>> g.osm
...

Reverse

>>> g = geocoder.google([45.15, -75.14], method='reverse')
>>> g.city
>>> g.state
>>> g.state_long
>>> g.country
>>> g.country_long
...

House Addresses

>>> g = geocoder.google("453 Booth Street, Ottawa ON")
>>> g.housenumber
>>> g.postal
>>> g.street
>>> g.street_long
...

IP Addresses

>>> import geocoder
>>> g = geocoder.ip('199.7.157.0')
>>> g = geocoder.ip('me')
>>> g.latlng
>>> g.city

Command Line Interface

$ geocode "Ottawa, ON"  >> ottawa.geojson
$ geocode "Ottawa, ON" \
    --provide google \
    --out geojson \
    --method geocode

Providers

Provider

Optimal

Access

ArcGIS

World

Baidu

China

API key

Bing

World

API key

CanadaPost

Canada

API key

FreeGeoIP

World

Geocoder.ca

North America

Rate Limit

GeoNames

World

Username

GeoOttawa

Ottawa

Google

World

Rate Limit

HERE

World

API key

IPInfo

World

Mapbox

World

API key

MapQuest

World

API key

MaxMind

World

OpenCage

World

API key

OpenStreetMap

World

TomTom

World

API key

What3Words

World

API key

Yahoo

World

Yandex

Russia

Installation

PyPi Install

To install Geocoder, simply:

$ pip install geocoder

GitHub Install

Installing the latest version from Github:

$ git clone https://github.com/DenisCarriere/geocoder
$ cd geocoder
$ python setup.py install

Documentation

https://geocoder.readthedocs.org/

Twitter

Speak up on Twitter DenisCarriere and tell me how you use this Python Geocoder. New updates will be pushed to Twitter Hashtags python.

Topic not available?

If you cannot find a topic you are looking for, please feel free to ask me DenisCarriere or post them on the Github Issues Page.

Feedback

Please feel free to give any feedback on this module. If you find any bugs or any enhancements to recommend please send some of your comments/suggestions to the Github Issues Page.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

geocoder-1.8.2.tar.gz (33.8 kB view hashes)

Uploaded Source

Built Distribution

geocoder-1.8.2-py2.py3-none-any.whl (154.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page