# google-geolocation

> Google Maps Geolocation API for Node.js (unofficial)

Latest version **2.1.4** (published 2024-03-29) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install google-geolocation
pnpm add google-geolocation
yarn add google-geolocation
bun add google-geolocation
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.1.4 |
| Published | 2024-03-29 |
| First published | 2016-09-30 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=18 |
| Dependencies | 0 |
| Unpacked size | 6.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Franklin |
| Maintainers | franklin |
| Keywords | accesspoints, api, bssid, carrier, cellular, geolocation, google, location, lookup, mcc, mnc, mobile, network, unlicense, wifi, wlan |

## Links

- npm: https://www.npmjs.com/package/google-geolocation
- Repository: https://github.com/fvdm/nodejs-geolocation
- Homepage: https://github.com/fvdm/nodejs-geolocation#readme
- Issues: https://github.com/fvdm/nodejs-geolocation/issues
- npm.io page: https://npm.io/package/google-geolocation

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 2.1.4 (latest) — 2024-03-29
- 2.1.3 — 2024-03-29
- 2.0.0 — 2021-09-22
- 1.0.2 — 2017-12-12
- 1.0.1 — 2016-09-30
- 1.0.0 — 2016-09-30

## README

# google-geolocation

Google Maps Geolocation API for Node.js (unofficial)

You need a Google API key with access to the Google Maps Geolocation API.

[![npm](https://img.shields.io/npm/v/google-geolocation.svg?maxAge=3600)](https://www.npmjs.com/package/google-geolocation)
[![Build Status](https://github.com/fvdm/nodejs-geolocation/actions/workflows/node.js.yml/badge.svg?branch=master)](https://github.com/fvdm/nodejs-geolocation/actions/workflows/node.js.yml)
[![Coverage Status](https://coveralls.io/repos/github/fvdm/nodejs-geolocation/badge.svg?branch=master)](https://coveralls.io/github/fvdm/nodejs-geolocation?branch=master)

* [API documentation](https://developers.google.com/maps/documentation/geolocation/intro)
* [Release notes](https://github.com/fvdm/nodejs-geolocation/releases)


## Example

```js
const geo = require( 'google-geolocation' );

function out( obj ) {
  console.dir( obj, {
    depth: null,
    colors: true,
  } );
}

// Get data
geo( {
  key: 'abc123',
  wifiAccessPoints: [{
    macAddress: '01:23:45:67:89:AB',
    signalStrength: -65,
    signalToNoiseRatio: 40,
  }],
} )
  .then( out )
  .catch( out )
;
```


## Installation

`npm i google-geolocation`


## Configuration

param     | type   | default | description
:---------|:-------|:--------|:-----------
key       | string |         | Google API key
[timeout] | number | `5000`  | Request timeout in ms
...       | mixed  |         | API parameters


#### Example

```js
const geo = require( 'google-geolocation' );

geo( {
  key: 'abc123',
  timeout: 2000,
} );
```


## Unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <https://unlicense.org>


## Author

[Franklin](https://fvdm.com)
| [Buy me a coffee](https://fvdm.com/donating)

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