https://github.com/colkito/bitpay-rates

BitPay Exchange Rates API wrapper for Node.js - A tiny and easy to use library
https://github.com/colkito/bitpay-rates

bitcoin bitpay currency dollar nodejs rates

Last synced: 7 days ago
JSON representation

BitPay Exchange Rates API wrapper for Node.js - A tiny and easy to use library

• Host: GitHub
• URL: https://github.com/colkito/bitpay-rates
• Owner: colkito
• Created: 2015-10-10T03:10:51.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2024-06-21T09:24:30.000Z (5 months ago)
• Last Synced: 2024-11-07T18:16:35.929Z (9 days ago)
• Topics: bitcoin, bitpay, currency, dollar, nodejs, rates
• Language: TypeScript
• Homepage: https://npmjs.com/bitpay-rates
• Size: 746 KB
• Stars: 4
• Watchers: 2
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# bitpay-rates

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/colkito/bitpay-rates/npm-publish.yml?style=flat-square)

[![BundlePhobia](https://img.shields.io/bundlephobia/min/bitpay-rates.svg?style=flat-square)](https://bundlephobia.com/result?p=bitpay-rates)

[![BundlePhobia](https://img.shields.io/bundlephobia/minzip/bitpay-rates.svg?style=flat-square)](https://bundlephobia.com/result?p=bitpay-rates)

A lightweight Node.js wrapper for [BitPay's](https://bitpay.com/rates) exchange rates API, now in TypeScript.

Zero-dependency and `promise` support for easy integration into your project. ✨

## Requirements

- nodejs >= 12.x

## Examples

Getting a rate by `code`:

```js

import bitpayRates from 'bitpay-rates';

const code = 'ARS'; // see list of codes below

// Using async/await

try {

  const rate = await bitpayRates.get(code);

  console.log(`[Async/Await][${code}] Rate:`, rate);

} catch (err) {

  console.error(`[Async/Await][${code}] Error:`, err);

}

```

Handling an invalid currency code:

```js

import bitpayRates from 'bitpay-rates';

// Handling an invalid currency code

bitpayRates

  .get('INVALID')

  .then((rate) => console.log('[Promise][INVALID] Rate:', rate))

  .catch((err) => console.error('[Promise][INVALID] Error:', err));

```

Successful response:

```json

{

  "code": "ARS",

  "name": "Argentine Peso",

  "rate": 60612542.16

}

```

Getting `all` the rates:

```js

import bitpayRates from 'bitpay-rates';

// Using async/await

try {

  const rates = await bitpayRates.get();

  console.log('[Async/Await] Rates:', rates);

} catch (err) {

  console.error('[Async/Await] Error:', err);

}

// Handling an invalid currency code

bitpayRates

  .get('INVALID')

  .then((rate) => console.log('[Promise][INVALID] Rate:', rate))

  .catch((err) => console.error('[Promise][INVALID] Error:', err));

```

Successful response:

```json

[

  {

    "code": "ARS",

    "name": "Argentine Peso",

    "rate": 5291987.02

  },

  {

    "code": "BUSD",

    "name": "Binance USD",

    "rate": 57818.28

  },

  {...}

]

```

More examples [here](example/rates-example.js).

## Available Codes (updated: 2024-01-24)

[Follow this link](CODES.md) to see the complete list of codes.

## Related Packages

- [Blockchain Exchange Rates API](https://npmjs.com/blockchain-rates)