@ask-iggy/iggy-api-js v0.1.6

@ask-iggy/iggy-api-js

A Javascript wrapper for accessing the Iggy API

Table of Contents

• Installation
• Usage
• Contributing
• Support & Feedback
• What is Iggy
• Licensing
• Publishing

Installation

Using npm

npm install @ask-iggy/iggy-api-js

Using yarn

yarn add @ask-iggy/iggy-api-js

Usage

After installing the package, you can import it into your file like so:

import IggyApi from "@ask-iggy/iggy-api-js";

const api = IggyAPI({ token: YOUR_API_TOKEN });

This library currently supports all public endpoints:

// A default object for options could be
const options = {
    method: "GET",
    params: {
        latitude: 44.976469,
        longitude: -93.271205,
        // Other params here
    },
};

// Lookup
api.lookup(options);

// Points of Interest (GET)
api.poi(options);

// Points of Interest (POST)
api.poi(options, body);

// Isochrone
api.isochrone(options);

// Amenities
api.amenities(options);

// Cluters
api.clusters(options);

For all available paramters, check out our documentation

Documentation

Check out our documentation website

Contributing to this repo

Check out our document on contribution

Support & Feedback

If you ever find an issue or problem, please feel free to open up an issue on the issues tab! We'd also love to hear feedback on our discord server!

What is Iggy?

Iggy is the world's first location enrichment API that makes it easy to integrate relevant location data into your product. It has a level of data that isn’t readily available elsewhere and doesn’t require a specialized geospatial data team to leverage it. Check us out here

Licensing

This project is licensed under the MIT license. See the LICENSE file for more info.

Publishing to NPM

In order to publish, update the version accordingly based on semantic versioning from npm. From there, if any functionality is added, make sure to write unit tests for them. Then, from the root folder, run npm publish which should run a linter, test, and then publish the folder directly to npm.