node-open-geocoder

    4.0.1 • Public • Published

    node-open-geocoder

    Open Street Map API client for geocoding and reverse geocoding


    Build StatusCode Coverage 100%ISC LicenseNodeJS

    JavaScript Style Guide

    about Open Street Map API

    OpenStreetMap has an Editing API for fetching and saving raw geodata from/to the OpenStreetMap database.

    API v0.6 is the current version of the OSM Editing API deployed 17-21 April 2009.

    Usage Policy for Open Street Map.

    api

    const openGeocoder = require('node-open-geocoder')

    openGeocoder([options])

    • options
      • url, string, OpenStreetMap URL, default to nominatim.openstreetmap.org
      • port, integer, OpenStreetMap port, default to 80
      • timeout, integer, client timeout, default to 10000 mls
      • userAgent, string, OpenStreetMap needs to receive this header, default to node-open-geocoder

    geocode

    openGeocoder.geocode(addr, [options])

    more info about the address format

    • addr, string, ex: '135 pilkington avenue, birmingham'
    • options, object, ex: {addressdetails: 1, polygon_geojson: 1}
      • addressdetails: Include a breakdown of the address into elements, can be 0 | 1
      • the second prop define the type of polygon and can be define only one:
        • polygon_geojson: Output geometry of results in geojson format.
        • polygon_kml : Output geometry of results in kml format.
        • polygon_svg : Output geometry of results in svg format.
        • polygon_text : Output geometry of results as a WKT.
    example
    const openGeocoder = require('node-open-geocoder');
     
    openGeocoder()
      .geocode('135 pilkington avenue, birmingham')
      .end((err, res) => {})

    reverse

    openGeocoder.reverse(longitude, latitude)

    example
    const openGeocoder = require('node-open-geocoder');
     
    openGeocoder()
      .reverse(-8.945406, 38.575078)
      .end((err, res) => {})

    Install

    npm i node-open-geocoder

    DownloadsWeekly Downloads

    1,101

    Version

    4.0.1

    License

    ISC

    Unpacked Size

    8 kB

    Total Files

    4

    Last publish

    Collaborators

    • quim