city-grabber

City Grabber

This is a wrapper for the City Grabber API used to find the nearest city and country from latitude and longitude.

City grabber uses an algorithim that utalises spatial mapping and data analysis to give you a blazing fast and accurate response from over 10,000 cities across the glove.

This API requires an API key which can get obtained Here. It will come with 10 free requests.

Installation

npm i city-grabber --save

Usage

const cityGrabber = require( 'city-grabber' )

//Using Promises
cityGrabber.get( latitude, longitude, apiKey )
    .then( response => console.log( response.city, response.country ))
    .catch( e => console.log( e ))
    
//Async await
const response = await cityGrabber.get( latitude, longitude, apiKey )
console.log( response.city, response.country )

Demos

cityGrabber.get( 40.6721694, -73.9593683, apiKey )

//Response
{
    city: 'Brookyln'.
    country: 'US'
}

cityGrabber.get( 35.4526317, 139.4546863, apiKey )

//Response
{
    city: 'Yokohama'.
    country: 'JP'
}

Errors

Status	Error	Description
422	API KEY NOT FOUND	You need to pass your API key as a parameter. You can get one Here.
422	INVALID API KEY	Your key is invalid or badly formatted.
402	NO CREDITS REMAINING	You need to purchase more credits for your key. You can do that Here.
422	INVALID COORDINATES	Missing or invalid latitude/ longitude.

Documentation

Click Here to see the full documentation