npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

node-nominatim2

v0.1.0

Published

wrapper around nominatim API

Downloads

600

Readme

node-nominatim2

A simple wrapper for the awesome Nominatim API: http://wiki.openstreetmap.org/wiki/Nominatim

General

Node.js module for geocoding and reverse geocoding and lookup. Uses service OpenStreetMap geocoding API (Nominatim tool).

Geocoding is the process of matching address with geographic coordinates. Reverse Geocoding is the process of matching geographic coordinates with address.

Address geocoding. Provide an address or location and receive potential OSM geocodes.

Reverse geocoding. Provide latitude and longitude coordinates and receive the known address information for that location.

Address lookup. Lookup the address of one or multiple OSM objects like node, way or relation.

Usage Limits.

Installing

$ npm install node-nominatim2 [-S]

Usage

Require node-nominatim2

var Nominatim = require('node-nominatim2');

Instantiate an instance of Nominatim. You must provide a valid HTTP Referer or User-Agent identifying the application (stock User-Agents as set by http libraries will not do). You may also add a timeout option, which defaults to 2500 if not provided.

var options = {
  useragent: 'MyApp',
  referer: 'https://github.com/xbgmsharp/node-nominatim2',
  timeout: 1000
},
nominatim = new Nominatim(options);

Make a call to the API using the search method.

The search function calls to the http://nominatim.openstreetmap.org/search?<params>

nominatim.search({q: "135 pilkington, avenue birmingham"}, function (err, res, data) {
  if (err) throw err;
  log('res: ' + util.inspect(res));
  log('data: ' + util.inspect(data));
});

Make a call to the API using the reverse method.

The reverse function calls to the endpoint: http://nominatim.openstreetmap.org/reverse?<query>

var params = {
  lat: 52.5460941,
  lon: 13.35918
};
nominatim.reverse(params, function (err, res, data) {
  if (err) throw err;
  log('res: ' + util.inspect(res));
  log('data: ' + util.inspect(data));
});

Make a call to the API using the lookup method.

The lookup function calls to the endpoint: http://nominatim.openstreetmap.org/lookup?<query>

var params = {
  osm_ids: 'R146656,W104393803,N240109189'
};
nominatim.reverse(params, function (err, res, data) {
  if (err) throw err;
  log('res: ' + util.inspect(res));
  log('data: ' + util.inspect(data));
});

Additional parameters:

All methods accept optional parameters to accommodate the optional query string params available for the nominatim API calls. The following call is, for instance, possible and will return only the current property and its child properties:

var params = {
  q: '',
  addressdetails: 1,
  format: 'json',
  limit: 1,
  zoom: 18,
  'accept-language': 'en'
};
forecast.search(params, function (err, res, data) {
  if (err) throw err;
  log('res: ' + util.inspect(res));
  log('data: ' + util.inspect(data));
});

For more details check the documentation