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

@gem.co/api

v1.66.0

Published

Node.js client library for the Gem API.

Downloads

296

Readme

Official Gem API Node.js Client

The official Node.js client for the Gem API.

Install

npm install @gem.co/api

Quickstart

Server

// Set the SDK constants.
const { GEM_API_KEY, GEM_API_SECRET } = process.env;
const { Gem } = require('@gem.co/api').SDK;

// Create client instance.
const gem = new Gem({
  apiKey: GEM_API_KEY,
  secretKey: GEM_API_SECRET,
  environment: 'sandbox',
});

/**
 *
 * MAIN
 *
 **/

(async () => {
  try {
    const applicationUsers = await gem.listUsers();
    const firstUser = applicationUsers[0];
    const transactions = await gem.listTransactions({ userId: firstUser.id });

    console.log('User Transactions', transactions);
  } catch (e) {
    console.error('Gem Error', e);
  }
})();

Client API Reference

Constructor

const gem = new Gem({
  /* Configuration Parameters */
});

Configuration Parameters:

| parameter | description | | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | apiKey | Gem API key for the respective environment. | | secretKey | Gem API secret for the respective environment. | | environment | The Gem API environment. Options: sandbox or production. | | options | Configuration options that are passed to the Axios Client for each request made to the API. |

SDK Requests

Users

| method | parameters | description | | --------- | ---------------------------------------- | ----------------- | | getUser | (userId: string) | Get a user by ID. | | listUsers | (pageNumber?: number, pageSize?: number) | List all users |

Profiles

| method | parameters | description | | ------------- | ----------------------------------------- | ----------------- | | createProfile | ( userId: string, profile: ProfileModel ) | Create a profile. |

Documents

| method | parameters | description | | --------------------- | ----------------------------------------- | --------------------------------------------------------------------------- | | createProfileDocument | ( profileId: string, document: FormData ) | Attach a document to a profile. (Documents may have many files associated.) |

Institutions

| method | parameters | description | | ---------------- | ------------------------- | -------------------------------- | | getInstitution | ( institutionId: string ) | Get an institution by ID. | | listInstitutions | none | List all supported institutions. |

Transactions

| method | parameters | description | | ---------------- | ------------------------------------------------------------------------------------------------------- | --------------------------- | | getTransaction | ( transactionId: string ) | Get a transaction by ID. | | listTransactions | ({ userId?: string, accountId?: string, beforeId?: string, afterId?: string, limit?: number }?: object) | Get a list of transactions. |

Assets

| method | parameters | description | | ---------- | ---------------------------------------- | ----------------------------------------------------------------- | | getAssets | ( assetId: string, source?: string ) | Get assets from a source. assetIds can be a comma seperated list. | | listAssets | ( category: 'cryptocurrency' or 'fiat' ) | List all supported assets of a certain category. |

Payment Methods + Supported Currencies

| method | parameters | description | | ----------------------- | -------------------------------- | --------------------------------------------------------------------------------- | | listSupportedCurrencies | (institutionId: wyre or coinify) | List payment methods for a particular institution and their supported currencies. |

Prices

| method | parameters | description | | --------------- | --------------------------------------------------------- | ---------------------------------------------------- | | getAssetPrice | ( assetId: string, currencyId: string, source?: string ) | Get an asset price in units of a requested currency. | | listAssetPrices | ( assetIds: string, currencyId: string, source?: string ) | List asset prices in units of a requested currency. |

Vanilla Requests

Each function makes a request to Gem's API and returns a promise in response.

const gem = new Gem({
  /* Configuration Parameters */
});

const client = gem.client;

client.get(path, parameters, options);
client.post(path, body, options);
client.put(path, body, options);
client.patch(path, body, options);
client.delete(path, body, options);

Debugging

Setting the DEBUG environment variable will turn on Gem client debug logging.

  DEBUG=gem:* node bin/my_program