Open Location Code is a library to generate short codes that can be used like street addresses, for places where street addresses don't exist.
JavaScript Java C++ Python Go HTML Other
Clone or download
zongweil Merge pull request #181 from viettaml/patch-1
Remove use of std::begin() and std::end()
Latest commit 930df41 Jul 20, 2018
Permalink
Failed to load latest commit information.
android_demo Minor fix (proposal) Nov 15, 2017
cpp Remove use of std::begin() and std::end() Jul 20, 2018
csharp Add link to C# .NET Standard implementation Feb 22, 2018
dart Fix floating point bug in encodeGrid Nov 15, 2017
docs Add RTL language details to OLC definition Jun 29, 2018
garmin/PlusCodeDatafield Add link to Garmin app store Feb 1, 2017
go Fix floating point bug in encodeGrid Nov 15, 2017
java Add config for including library in MavenCentral. Jun 18, 2018
js Use fine-grained closure_js_library deps Jul 9, 2018
python spelling: maximum Mar 14, 2018
ruby spelling: maximum Mar 14, 2018
rust spelling: separator Mar 14, 2018
swift Add link to Swift 3.x implementation. Jul 28, 2017
test_data Add test for grid floating point errors Nov 15, 2017
typescript Add typescript implementation link Jun 7, 2018
visualbasic spelling: maximum Mar 14, 2018
.bazelrc display all test output Jun 12, 2018
.gitignore Add Closure JS implementation May 17, 2017
.travis.yml update all tests to bazel 14.0 Jun 12, 2018
API.txt Update API.txt Apr 1, 2016
CHANGELOG.md Change format of OLC codes from +xxxx.xxxxxx to xxxxxx+xx. Jan 30, 2015
CONTRIBUTING.md Add Closure JS implementation May 17, 2017
FAQ.txt first commit Oct 27, 2014
LICENSE first commit Oct 27, 2014
README.md Some minor updates Nov 3, 2016
TESTING.md Fix typos in build documentation Jan 18, 2018
WORKSPACE Update Bazel Closure version Jun 8, 2018
package.json Create package.json Jun 17, 2016

README.md

Open Location Code

Build Status CDNJS

Open Location Code is a technology that gives a way of encoding location into a form that is easier to use than latitude and longitude. The codes generated are called plus codes, as their distinguishing attribute is that they include a "+" character.

The technology is designed to produce codes that can be used as a replacement for street addresses, especially in places where buildings aren't numbered or streets aren't named.

Plus codes represent an area, not a point. As digits are added to a code, the area shrinks, so a long code is more precise than a short code.

Codes that are similar are located closer together than codes that are different.

A location can be converted into a code, and a code can be converted back to a location completely offline.

There are no data tables to lookup or online services required. The algorithm is publicly available and can be used without restriction.

Links

Description

Codes are made up of a sequence of digits chosen from a set of 20. The digits in the code alternate between latitude and longitude. The first four digits describe a one degree latitude by one degree longitude area, aligned on degrees. Adding two further digits to the code, reduces the area to 1/20th of a degree by 1/20th of a degree within the previous area. And so on - each pair of digits reduces the area to 1/400th of the previous area.

As an example, the Parliament Buildings in Nairobi, Kenya are located at 6GCRPR6C+24. 6GCR is the area from 2S 36E to 1S 37E. PR6C+24 is a 14 meter wide by 14 meter high area within 6GCR.

A "+" character is used after eight digits, to break the code up into two parts and to distinguish codes from postal codes.

There will be locations where a 10 digit code is not sufficiently precise, but refining it by a factor of 20 is i) unnecessarily precise and ii) requires extending the code by two digits. Instead, after 10 digits, the area is divided into a 4x5 grid and a single digit used to identify the grid square. A single grid refinement step reduces the area to approximately 3.5x2.8 meters.

Codes can be shortened relative to a location. This reduces the number of digits that must be remembered, by using a location to identify an approximate area, and then generating the nearest matching code. Shortening a code, if possible, will drop four or more digits from the start of the code. The degree to which a code can be shortened depends on the proximity of the reference location.

If the reference location is derived from a town or city name, it is dependent on the accuracy of the geocoding service. Although one service may place "Zurich" close to the Google office, another may move it by a hundred meters or more, and this could be enough to prevent the original code being recovered. Rather than a large city size feature to generate the reference location, it is better to use smaller, neighbourhood features, that will not have as much variation in their geocode results.

Guidelines for shortening codes are in the wiki.

Recovering shortened codes works by providing the short code and a reference location. This does not need to be the same as the location used to shorten the code, but it does need to be nearby. Shortened codes always include the "+" character so it is simple to compute the missing component.

  • 8F+GG is missing six leading characters
  • 6C8F+GG is missing four leading characters

Example Code

The subdirectories contain sample implementations and tests for different languages. Each implementation provides the following functions:

  • Test a code to see if it is a valid sequence
  • Test a code to see if it is a valid full code Not all valid sequences are valid full codes
  • Encode a latitude and longitude to a standard accuracy (14 meter by 14 meter) code
  • Encode a latitude and longitude to a code of any length
  • Decode a code to its coordinates: low, high and center
  • Shorten a full code relative to a location
  • Extend a short code relative to a location