Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/VikramTiwari/reverse-geocode
get reverse-geocoded :earth_americas: data from latitude and longitude values :globe_with_meridians:
https://github.com/VikramTiwari/reverse-geocode
geo geocode latitude longitude reverse-geocoding
Last synced: 16 days ago
JSON representation
get reverse-geocoded :earth_americas: data from latitude and longitude values :globe_with_meridians:
- Host: GitHub
- URL: https://github.com/VikramTiwari/reverse-geocode
- Owner: VikramTiwari
- License: mit
- Created: 2016-05-24T01:22:26.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T01:38:54.000Z (over 1 year ago)
- Last Synced: 2024-05-28T02:53:38.322Z (about 1 month ago)
- Topics: geo, geocode, latitude, longitude, reverse-geocoding
- Language: JavaScript
- Homepage:
- Size: 2.01 MB
- Stars: 18
- Watchers: 4
- Forks: 3
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists
- my-awesome-stars - VikramTiwari/reverse-geocode - get reverse-geocoded :earth_americas: data from latitude and longitude values :globe_with_meridians: (JavaScript)
README
# reverse-geocode
get reverse-geocoded data for latitude and longitude values
 [](https://www.npmjs.com/package/reverse-geocode) [](https://www.npmjs.com/package/reverse-geocode)
## Features
- Zero dependencies
- Quick city level lookups
- Only US, Canada and Australia dataset as of now, more coming soon.
## How to use
- Include package in your project
```bash
npm install --save reverse-geocode
or
yarn add reverse-geocode
```
- Use package to get geo data from lat-long values. Specify a country code, which should match `/locations/{countryCode}.json`. USA, Australia, and Canada are provided.
```javascript
const reverse = require('reverse-geocode')
console.log(reverse.lookup(37.8072792, -122.4780652, 'us'))
/*
{ zipcode: '94129',
state_abbr: 'CA',
latitude: '37.799840',
longitude: '-122.46167',
city: 'San Francisco',
state: 'California',
distance: 1.6610566475026183 }
*/
```
```javascript
const reverse = require('reverse-geocode')
console.log(reverse.lookup(50.447444, -104.418513, 'ca'))
/*
{ country: 'CA',
zipcode: 'S4Z',
region: 'Regina Northeast',
state: 'Saskatchewan',
state_abbr: 'SK',
city: 'Regina',
latitude: 50.4497,
longitude: -104.5323,
distance: 8.06066680024397 }
*/
```
More sample outputs are in [test snapshots](__tests__/__snapshots__/reverse-geocode.test.js.snap).
### Data Format
The contents of a location data file is a simple JSON array, of location data:
```javascript
;[
{
zipcode: '59221',
state_abbr: 'MT',
latitude: '47.900376',
longitude: '-104.13403',
city: 'Fairview',
state: 'Montana',
},
]
```
Find country postalcode data from a provider of your choice, format as above, and save into `/locations/` as `{countryCode}.JSON`. Then, specify the same country code.
For a good time, save all data to `all.json` and specify `'all'` to the `reverse.lookup` method.
### Credits
- Haversine originally by Nick Justice (niix) at
- Inspired from cities by Steven Lu (sjlu) at