Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tylim88/crypto-symbol
:baby_chick: Provide easy conversion between crypto symbol and name, auto update daily
https://github.com/tylim88/crypto-symbol
bitcoin crypto cryptocurrency ethereum name symbol
Last synced: 3 months ago
JSON representation
:baby_chick: Provide easy conversion between crypto symbol and name, auto update daily
- Host: GitHub
- URL: https://github.com/tylim88/crypto-symbol
- Owner: tylim88
- License: mit
- Created: 2019-04-08T10:36:50.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-01T15:32:17.000Z (about 1 year ago)
- Last Synced: 2024-10-10T03:06:01.612Z (4 months ago)
- Topics: bitcoin, crypto, cryptocurrency, ethereum, name, symbol
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/crypto-symbol
- Size: 12.1 MB
- Stars: 15
- Watchers: 5
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
![]()
Crypto Symbol
🐤 Simple fuzzy conversion for crypto symbol and crypto name.
📔 Source: [CoinMarketCap](https://coinmarketcap.com)
🔔 Almost 5000 pairs to search for, with typescript const assertion.
💪 Can add your own custom name-symbol pair.
🌟 Optimized lookup time.
🆙 Check for update daily and publish new version if there is change.
🥰 0 dependencies.
⛲️ Out of box typescript support.
🦺 Development code, built code, and published code are all tested in CI.
## Installation
```bash
npm i crypto-symbol
```
## Usage
**Normally ticker symbol is [unique](https://coinmarketcap.com/alexandria/glossary/ticker-symbol), but for whatever reason on very rare occasional, CMC lists new coin that has the same ticker symbol(case-insensitive). If duplicated names or symbols are found in the CoinMarketCap list, the library keep higher rank(larger market cap) coins. If you need lower rank coins, please can add it yourself. Keep in mind to use unique name and unique symbol for them.**
🎵 Get Pairs Object
```ts
import { cryptoSymbol } from 'crypto-symbol'
const { get } = cryptoSymbol({})
// all the pair objects are properly typed with const assertion
get().NSPair // {Bitcoin: 'BTC',Ethereum: 'ETH','Binance Coin': 'BNB',......}
get().SNPair // {BTC: 'Bitcoin',ETH: 'Ethereum','BNB': 'Binance Coin',......}
```
⚒ Add new pair or modify existing pair
```ts
import { cryptoSymbol } from 'crypto-symbol'
// will overwrite existing pair and add new type to pairs object
const { get, nameLookup, symbolLookup } = cryptoSymbol({
newCoin: 'NC123' as const, // add new coin
bitcoin: 'BTC' as const, // modify existing coin
}) // use const assertion to narrow down the type
```
🎐 Symbol Lookup
```ts
import { cryptoSymbol } from 'crypto-symbol'
const { symbolLookup } = cryptoSymbol({})
// case insensitive
// ignore all special character and space
symbolLookup(' liT ec @oin ') // "LTC"
symbolLookup(' τbITcO in ') // BTC
// case insensitive
// can allow specific special character
// to allow multiple special character, simply concat all the character, eg "#$%)("
symbolLookup(' τbITcO in ', { allow: 'τ' }) // TBTC
// exact match (case sensitive)
symbolLookup(' liT ec @oin ', { exact: true }) // undefined
symbolLookup('litecoin', { exact: true }) // "undefined"
symbolLookup('Litecoin', { exact: true }) // "LTC"
```
⚡️ Name Lookup
```ts
import { cryptoSymbol } from 'crypto-symbol'
const { nameLookup } = cryptoSymbol({})
// case insensitive
// ignore all special character and space)
nameLookup(' @Ltc! ') // "Litecoin"
// can allow specific special character
// to allow multiple special character, simply concat all the character, eg "#$%)("
// all symbol are alphanumeric anyway, I don't think you will need it
nameLookup(' @Ltc! ', { allow: '@' }) // undefined, because symbol "@Ltc" does not exist
// exact match (case sensitive)
nameLookup(' Ltc ', { exact: true }) // undefined
nameLookup('Ltc', { exact: true }) // undefined
nameLookup('LTC', { exact: true }) // Litecoin
```
🍀 Sync
Sync the coin manually.
1. You can only use this api in server environment due to Coinmarketcap CORS policy.
2. You need to install [axios](https://www.npmjs.com/package/axios) to use this api, simply installing it is enough.
```bash
npm i axios
```
3. Added pairs and modified pairs have higher priority than sync, sync will not overwrite them.
```ts
import { cryptoSymbol } from 'crypto-symbol'
const { sync } = cryptoSymbol({})
// sync with latest coinmarketcap list
// this is a promise
sync('coinmarketcap apiKey')
```
## Credit
Crypto Symbol logo [source](https://flyclipart.com/cryptocurrency-gold-cryptocurrency-png-678000#)