# ngeohash

> geohash library for nodejs

Latest version **0.6.4** (published 2026-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install ngeohash
pnpm add ngeohash
yarn add ngeohash
bun add ngeohash
```

## Health

**Score 58/100 (C)** — status: active.

Positive: has types package; no vulnerabilities; recently updated; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.6.4 |
| Published | 2026-07-25 |
| First published | 2011-06-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/ngeohash) |
| Module format | CommonJS |
| Node | >=v0.2.0 |
| Dependencies | 0 |
| Unpacked size | 292.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 587 |
| Author | Ning Sun |
| Maintainers | sunng |
| Keywords | geohash, uint64, geohasher, geocode, geolocation |

## Links

- npm: https://www.npmjs.com/package/ngeohash
- Repository: https://github.com/sunng87/node-geohash
- Homepage: https://github.com/sunng87/node-geohash#readme
- Issues: https://github.com/sunng87/node-geohash/issues
- npm.io page: https://npm.io/package/ngeohash

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 0.6.4 (latest) — 2026-07-25
- 0.6.3 — 2018-12-17
- 0.6.2 — 2018-12-17
- 0.6.1 — 2018-12-15
- 0.6.0 — 2014-04-09
- 0.5.0 — 2014-04-03
- 0.4.1 — 2014-04-02
- 0.4.0 — 2014-03-31
- 0.3.2 — 2014-03-28
- 0.3.1 — 2014-03-03
- 0.3.0 — 2014-03-03
- 0.2.0 — 2011-06-23
- 0.1.0 — 2011-06-23

## README

node-geohash
============

Geohash library for nodejs.

[![Build Status](https://travis-ci.org/sunng87/node-geohash.svg)](https://travis-ci.org/sunng87/node-geohash)
[![NPM version](https://badge.fury.io/js/ngeohash.svg)](http://badge.fury.io/js/ngeohash)
![Dependencies](https://david-dm.org/sunng87/node-geohash.png)
[![Donate](https://img.shields.io/badge/donate-liberapay-yellow.svg)](https://liberapay.com/Sunng/donate)

## Install

```bash
npm install ngeohash
```


## Usage

```javascript
var geohash = require('ngeohash');
console.log(geohash.encode(37.8324, 112.5584));
// prints ww8p1r4t8
var latlon = geohash.decode('ww8p1r4t8');
console.log(latlon.latitude);
console.log(latlon.longitude);
```


## Basic Methods

### geohash.encode (latitude, longitude, precision=9)

Encode a pair of latitude and longitude values into a geohash. The third argument is optional, you can specify a length of this hash string, which also affects the precision of the geohash.


### geohash.decode (hashstring)

Decode a hash string into pair of latitude and longitude values. A javascript object is returned with `latitude` and `longitude` keys.


### geohash.decode_bbox (hashstring)

Decode hashstring into a bounding box that matches it. Data is returned as a four-element array: `[minlat, minlon, maxlat, maxlon]`.


### geohash.bboxes (minlat, minlon, maxlat, maxlon, precision=9)

Get all hashstringes between `[minlat, minlon]` and `[maxlat, maxlon]`. These keys can be used to find a poi stored in the cache with hashstring keys. eg. show all points in the visible range of map. `[minlat, minlon]` correspond to the southwest starting hash, whereas `[maxlat, maxlon]` correspond to the northeast starting hash.


### geohash.neighbor (hashstring, direction)

Find the neighbor of a geohash string in certain direction. Direction is a two-element array, i.e. `[1,0]` means north, `[-1,-1]` means southwest.


### geohash.neighbors (hashstring)

Find all 8 geohash neighbors `[n, ne, e, se, s, sw, w, nw]` of a geohash string. This method is more efficient than running the geohash.neighbor method multiple times for all directions. array: `[hashstr1, hashstr2, ... ]`




## Integer Methods

Note that integer precision is capped at 52bits in Javscript. These are just regular javascript floating point numbers, but the functionality should mimic other uint64 geohash functions in geohash libraries for other languages and are compatible with the geohash integers produced by them, however any geohash integer encoded in anything more than 52bits will be resolved to 52bits resolution.


### geohash.encode_int (latitude, longitude, bitDepth=52)

Encode a pair of latitude and longitude values into a geohash integer. The third argument is optional, you can specify the `bitDepth` of this number, which affects the precision of the geohash but also **must be used consistently when decoding**. Both even and odd bit depths are supported; note that an odd-length geohash string corresponds to an odd `bitDepth` (`5` bits per character).


### geohash.decode_int (hashinteger, bitDepth=52)

Decode a integer geohashed number into pair of latitude and longitude value approximations. A javascript object is returned with `latitude` and `longitude` keys. You should also provide the `bitDepth` at which to decode the number (ie. what bitDepth the number was originally produced with), but will default to 52.


### geohash.decode_bbox_int (hashinteger, bitDepth=52)

Decode an integer geohash into the bounding box that matches it. Data is returned as a four-element array: `[minlat, minlon, maxlat, maxlon]`.


### geohash.bboxes_int (minlat, minlon, maxlat, maxlon, bitDepth=52)

Get all geohash integers between `[minlat, minlon]` and `[maxlat, maxlon]`. These keys can be used to find a poi stored in the cache with geohash integer keys. eg. show all points in the visible range of map


### geohash.neighbor_int (hashinteger, direction, bitDepth=52)

Find the neighbor of a geohash integer in certain direction. Direction is a two-element array, i.e. `[1,0]` means north, `[-1,-1]` means southwest. The `bitDepth` should be specified, but defaults to 52 bits.


### geohash.neighbors_int (hashinteger, bitDepth=52)

Find all 8 neighbors `[n, ne, e, se, s, sw, w, nw]` of a geohash integer. This method is more efficient than running the geohash.neighbor method multiple times for all directions. The `bitDepth` should be specified, but defaults to 52 bits.

## Node-Geohash for browser

We recently added a [browserify](http://browserify.org/) script with `npm
run browserify`. `ngeohash.js` will be generated and
you can use this file in your javascript application for browser.

```html
<script src="./path/to/ngeohash.js"></script>
<script>
alert(ngeohash.encode(114.23, 38.23));
</script>
```

## About Geohash

Check [Wikipedia](http://en.wikipedia.org/wiki/Geohash "Wiki page for geohash") for more information.

## See Also

[Geohash.rs](https://github.com/sunng87/geohash.rs): node-geohash ported to [Rust](https://rust-lang.org): A rust library for geohash.

## License

node-geohash is open sourced under MIT License, of course.

## Donation

I'm now accepting donation on [liberapay](https://liberapay.com/Sunng/donate),
if you find my work helpful and want to keep it going.

---
_Source: https://npm.io/package/ngeohash · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._