opendata-address-register

    1.0.7 • Public • Published

    OpenData Address Register

    NPM Downloads

    Description

    This library helps you to get data from Ukrainian OpenData address register using public SOAP API.

    Installation

    npm install opendata-address-register --save

    Initialization

    // Import.
    const addressRegister = require('opendata-address-register');

    Using

    // Get regions.
    const regions = await addressRegister.getRegions();
    // Regions format: [{ id, number, name, shortName, regionCenter }].
    
    // Get cities of region with ID 32 (Kyiv Region).
    const cities = await addressRegister.getCities(32);
    // Cities format: [{ id, name, district, head, regionId }].
    
    // Get streets of city with ID 5074 (Brovary).
    const streets = await addressRegister.getStreets(5074);
    // Streets format: [{ id, name, buildings: [{ id, number, corps,
    // postalCode }], cityId }].

    License

    The MIT License (MIT)

    Copyright © 2019 - 2021 Volodymyr Sichka

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i opendata-address-register

    DownloadsWeekly Downloads

    13

    Version

    1.0.7

    License

    MIT

    Unpacked Size

    14.4 kB

    Total Files

    9

    Last publish

    Collaborators

    • avatar