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

@simple-nominatim/core

v0.1.5

Published

A lightweight library to make requests to the Nominatim API from Node programs

Downloads

270

Readme

This is a library designed to facilitate requests to the Nominatim API.

It is part of the Simple Nominatim monorepo. You can also search for the @simple-nominatim/core package on npm.

Disclaimers

The utilization of this project is governed by the Nominatim Usage Policy (aka Geocoding Policy). Please adhere to fair usage practices as outlined by the OSMF Operations Working Group.

The owner and contributors of the Simple Nominatim project, including its libraries, assume no responsibility for any misuse.

Installation

Simple Nominatim currently only supports the Search, Reverse and Status endpoints.

npm install -g @simple-nominatim/core

Usage

Reverse Endpoint

Geocode

Use the geocodeReverse method directly in your code:

import { geocodeReverse } from '@simple-nominatim/core'

const results = await geocodeReverse({ latitude: '37.4219999', longitude: '-122.0840575' }, { format: 'jsonv2' })
Parameters
  • latitude: Specify the latitude of the coordinate.
    • This is a required option.
  • longitude: Specify the longitude of the coordinate.
    • This is a required option.
Options
  • email: Specify an appropriate email address when making large numbers of identified request.
  • format: Define the output format.
    • This is a required option.
    • Values include xml, json, jsonv2, geojson, and geocodejson.

Search Endpoint

Free-form query

Use the freeFormSearch method directly in your code:

import { freeFormSearch } from '@simple-nominatim/core'

const results = await freeFormSearch({ query: '1600 Amphitheatre Parkway, Mountain View, CA, USA' }, { format: 'jsonv2' })
Parameters
  • query: A free-form query string to search.
    • This is a required option.
Options
  • email: Specify an appropriate email address when making large numbers of identified request.
  • format: Define the output format.
    • This is a required option.
    • Values include xml, json, jsonv2, geojson, and geocodejson.
  • limit: Specify the maximum number of returned results. Cannot be more than 40.

Structured query

Use the structuredSearch method directly in your code:

import { structuredSearch } from '@simple-nominatim/core'

const results = await structuredSearch({ country: 'USA' }, { format: 'jsonv2' })
Parameters
  • amenity: Specify the name or type of point of interest (POI).
  • city: Specify the city name.
  • country: Specify the country name.
    • This is a required option.
  • county: Specify the county name.
  • postalcode: Specify the postal code.
  • state: Specify the state name.
  • street: Specify the house number and street name.
Options
  • email: Specify an appropriate email address when making large numbers of identified request.
  • format: Define the output format.
    • This is a required option.
    • Values include xml, json, jsonv2, geojson, and geocodejson.
  • limit: Specify the maximum number of returned results. Cannot be more than 40.

Status Endpoint

Service

Use the serviceStatus method directly in your code:

import { serviceStatus } from '@simple-nominatim/core'

const results = await serviceStatus({ format: 'json' })
Options
  • --format: Define the output format.
    • This is a required option.
    • Values include text and json.

License

Simple Nominatim Core is MIT licensed.