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

ask-kodiak-sdk

v3.0.1

Published

Node wrapper around the Ask Kodiak API.

Downloads

32

Readme

Ask Kodiak Node.js SDK

Table of Contents

Overview

The Ask Kodiak Node.js SDK is a lightweight node implementation of the Ask Kodiak API for node.js environments. API Keys are required to use, you can obtain those keys from Company Settings once you've created an Ask Kodiak account.

The Ask Kodiak Node.js SDK supports node.js version 12.0 and higher.

Installation

The Ask Kodiak Node.js SDK is available on npm as ask-kodiak-sdk.

npm install --save ask-kodiak-sdk

Contributing

Please refer to the CONTRIBUTING page for more information about how you can contribute to this project. We welcome bug reports, feature requests, code review feedback, and also pull requests.

Usage

Import into your project as a module and go to town.

Before making requests you must call the init() method one time with your group id and key. This sets up the module with your credential for subsequent requests and verifies connectivity. You only need to do this once. You can find your key and group id in your company settings in Ask Kodiak.


const askkodiak = require('ask-kodiak-sdk'),
      key = 'your api key', //get this from your Company Settings in Ask Kodiak,
      gid = 'your group id', //get this from your Company Settings in Ask Kodiak,
      ready = await askkodiak.init(gid, key); // you must call init one time with your gid and key before making requests.
      // now ready to make requests...

For any API request that supports optional request parameters, pass a paramsObj object to the method with those values. For example, if making a request where it's important to filter by geography and owner, you would pass the following paramsObj object to the method:

{
  geos: ['US-MN','US-HI'],
  owners: 'ABC123'
}

To make GET requests:


// get ref data for Canadian territories or provinces only.
// url, request parameters object
var canadianPlaces = await askkodiak.get('ref-data/geos', {countries: 'CA', subdivisionTypes: ['territory', 'province']});

To make POST requests:


// url, post body, request parameters object
var companies = await askkodiak.post('products/by-company',
  {
    virtualCompanies: [
      {
        name: 'Virtual Carrier Mutual',
        logo: 'https://logo.askkodiak.com/mono-dark/ask-kodiak-small.png',
        productTag: 'virtual'
      }
    ]
  },
  {
    naicsGroups: '722514'
  }

For a full list of options supported by each interface, see the Ask Kodiak API documentation.

Upgrading

Version 3 brings with it breaking changes. Endpoint specific interfaces have been removed in favor of universal get and post methods. Please update your implementation accordingly.

//BEFORE
var response = await askkodiak.productsForCode('44-45');
// AFTER
var response = await askkodiak.get('products/class-code/naics/44-45');

License

Licensed under the MIT license