Skip to content

crypto-crawler/cryptocurrency-info

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cryptocurrency-info

All cryptocurrencies meta information.

How to use

/* eslint-disable import/no-unresolved,no-console */
const { getCurrencyInfo } = require("cryptocurrency-info");

console.info(getCurrencyInfo("BTC"));

API Manual

There is only one API in this library:

/**
 * Get the currency info.
 *
 * @param symbol The currency symbol, e.g., BTC, ETH, EOS, USDT, etc.
 * @returns The CurrencyInfo
 */
export declare function getCurrencyInfo(symbol: string): CurrencyInfo;

Which returns an CurrencyInfo:

export interface CurrencyInfo {
  symbol: string;
  category: "coin" | "token";
  platform?: string; // Only tokens have platforms, coins don't
}

About

All cryptocurrencies meta information.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published