Library for performing forward and reverse address geocoding for addresses or coordinates in the US and Canada.
You can install the package via npm or yarn (pick one):
$ npm install --save geocodio-library-node
$ yarn add geocodio-library-node
Don't have an API key yet? Sign up at https://dash.geocod.io to get an API key. The first 2,500 lookups per day are free.
const Geocodio = require('geocodio-library-node');
const geocoder = new Geocodio('YOUR_API_KEY');
// const geocoder = new Geocodio('YOUR_API_KEY', 'api-hipaa.geocod.io'); // optionally overwrite the API hostname
geocoder
.geocode('1109 N Highland St, Arlington, VA')
.then(response => {
console.log(response);
})
/*
response => {
"input": {
"address_components": {
"number": "1109",
"predirectional": "N",
"street": "Highland",
"suffix": "St",
"formatted_street": "N Highland St",
"city": "Arlington",
"state": "VA",
"country": "US"
},
"formatted_address": "1109 N Highland St, Arlington, VA"
},
"results": [
{
"address_components": {
"number": "1109",
"predirectional": "N",
"street": "Highland",
"suffix": "St",
"formatted_street": "N Highland St",
"city": "Arlington",
"county": "Arlington County",
"state": "VA",
"zip": "22201",
"country": "US"
},
"formatted_address": "1109 N Highland St, Arlington, VA 22201",
"location": {
"lat": 38.886672,
"lng": -77.094735
},
"accuracy": 1,
"accuracy_type": "rooftop",
"source": "Arlington"
},
{
"address_components": {
"number": "1109",
"predirectional": "N",
"street": "Highland",
"suffix": "St",
"formatted_street": "N Highland St",
"city": "Arlington",
"county": "Arlington County",
"state": "VA",
"zip": "22201",
"country": "US"
},
"formatted_address": "1109 N Highland St, Arlington, VA 22201",
"location": {
"lat": 38.886665,
"lng": -77.094733
},
"accuracy": 1,
"accuracy_type": "rooftop",
"source": "Virginia Geographic Information Network (VGIN)"
}
]
}
*/
.catch(error => {
console.error(error);
});
geocoder.reverse('38.9002898,-76.9990361')
.then(response => { ... })
.catch(err => { ... });
geocoder.reverse([38.9002898, -76.9990361])
.then(response => { ... })
.catch(err => { ... });
Note: You can read more about accuracy scores, accuracy types, input formats and more at https://www.geocod.io/docs/
To batch geocode, simply pass an array of addresses or coordinates instead of a single string
geocoder.geocode([
'1109 N Highland St, Arlington VA',
'525 University Ave, Toronto, ON, Canada',
'4410 S Highway 17 92, Casselberry FL',
'15000 NE 24th Street, Redmond WA',
'17015 Walnut Grove Drive, Morgan Hill CA'
])
.then(response => { ... })
.catch(err => { ... });
geocoder.reverse([
'35.9746000,-77.9658000',
'32.8793700,-96.6303900',
'33.8337100,-117.8362320',
'35.4171240,-80.6784760'
])
.then(response => { ... })
.catch(err => { ... });
// Optionally supply a custom key that will be returned along with results
geocoder.geocode({
'MyId1': '1109 N Highland St, Arlington VA',
'MyId2': '525 University Ave, Toronto, ON, Canada',
'MyId3': '4410 S Highway 17 92, Casselberry FL',
'MyId4': '15000 NE 24th Street, Redmond WA',
'MyId5': '17015 Walnut Grove Drive, Morgan Hill CA'
})
.then(response => { ... })
.catch(err => { ... });
Geocodio allows you to append additional data points such as congressional districts, census codes, timezone, ACS survey results and much much more.
To request additional fields, simply supply them as an array as the second parameter
geocoder.geocode(
[
'1109 N Highland St, Arlington VA',
'525 University Ave, Toronto, ON, Canada'
],
[ 'cd', 'timezone' ]
)
.then(response => { ... })
.catch(err => { ... });
geocoder.reverse('38.9002898,-76.9990361', ['census2010'])
.then(response => { ... })
.catch(err => { ... });
For forward geocoding requests it is possible to supply individual address components instead of a full address string. This works for both single and batch geocoding requests.
geocoder.geocode({
street: '1109 N Highland St',
city: 'Arlington',
state: 'VA',
postal_code: '22201'
})
.then(response => { ... })
.catch(err => { ... });
geocoder.geocode([
{
street: '1109 N Highland St',
city: 'Arlington',
state: 'VA'
},
{
street: '525 University Ave',
city: 'Toronto',
state: 'ON',
country: 'Canada',
},
])
.then(response => { ... })
.catch(err => { ... });
Optionally limit the number of maximum geocoding results by using the third parameter on geocode(...)
or reverse(...)
// Only get the frst result
geocoder.geocode('1109 N Highland St, Arlington, VA', [], 1)
.then(response => { ... })
.catch(err => { ... });
// Return up to 5 geocoding results
geocoder.reverse('38.9002898,-76.9990361', ['timezone'], 5)
.then(response => { ... })
.catch(err => { ... });
List methods are nested within .list
. To access list methods, be sure to to run geocoder.list
and then include the task method you would like to utilize.
To create and upload a new list using an existing .CSV file, run geocoder.list.create(...)
and pass in your filename/file path.
You may also need to pass in some additional parameters:
- Direction: Use the default string
"forward"
. - Format: Use the default string
"{{A}} {{B}} {{C}} {{D}}"
- Callback: A callback URL.
geocoder.list.create(
`${__dirname}/stubs/sample_list.csv`,
"forward",
"{{A}} {{B}} {{C}} {{D}}",
"https://example.com/my-callback"
)
To retrieve the current status of your list, pass your list's ID into geocoder.list.status(...)
.
geocoder.list.status(1234567)
.then(response => { ... })
.catch(err => { ... });
To retrieve all available lists, run geocoder.list.all()
. You do not need to pass anything into this function.
geocoder.list.all()
.then(response => { ... })
.catch(err => { ... });
To download a list, run geocoder.list.download(...)
and pass in the ID of the list you'd like to download, as well as a string that includes a filename. Be sure to include a .csv
file extension.
geocoder.list.download(1234567, "geocoded_file.csv")
.then(response => { ...})
.catch(err => { ... });
To delete a list, run geocoder.list.deleteList(...)
and pass in the ID of the list you'd like to delete.
geocoder.list.delete(1234567)
.then(response => { ... })
.catch(err => { ... });
$ npm test
Please see CHANGELOG for more information on what has changed recently.
If you discover any security related issues, please email security@geocod.io instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.