Skip to content

rafaellaurindo/mercadobitcoin-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mercado Bitcoin JS 💱

Promise-based wrapper for Mercado Bitcoin API.

GitHub issues NPM Version License

Promise-based wrapper to easily make Mercado Bitcoin API requests.

Features

Installation

Using npm:

yarn add mercadobitcoin-js

Using npm:

npm install mercadobitcoin-js

Running Tests

Using yarn:

yarn test

Usage

const mercadoBitcoin = require("mercadobitcoin-js");

// Get information with the last 24 hours of Bitcoin trading in Mercado Bitcoin.
const btcTicker = await mercadoBitcoin.getTicker("BTC");

// Get order book of Litecoin in Mercado Bitcoin.
const ltcOrderBook = await mercadoBitcoin.getOrderBook("LTC");

// Get history of Ripple Trades in Mercado Bitcoin.
const xrpTrades = await mercadoBitcoin.getTrades("XRP");

// Get the daily summary of Ethereum trades made in Mercado Bitcoin.
const ethDaySummary = await mercadoBitcoin.getDaySummary("ETH", "2020/04/05");

Usage examples

Get Ethereum Ticker

const { getTicker } = require("mercadobitcoin-js");

(async () => {
  const ethereumTicker = await getTicker("ETH");
  console.log(ethereumTicker);
})();

Output:

{
  high: '754.00000000',
  low: '747.42038000',
  vol: '196.18673392',
  last: '751.01320000',
  buy: '751.01385000',
  sell: '753.73999000',
  open: '752.79999000',
  date: 1586145601
}

Get Bitcoin Trades

const { getTrades } = require("mercadobitcoin-js");

(async () => {
  const bitcoinTrades = await getTrades("BTC");
  console.log(bitcoinTrades);
})();

Output:

[
    {
      tid: 5956493,
      date: 1586117823,
      type: 'buy',
      price: 35589.98,
      amount: 0.01023184
    },
    {
      tid: 5956494,
      date: 1586117823,
      type: 'buy',
      price: 35590,
      amount: 0.00931522
    },
    ...
];

Release History

  • 1.1.0:
    • Using node-fetch instead of axios to make the lib lighter.
  • 1.0.1:
    • Syntax changes.
  • 1.0.0:
    • Supports Promise and async/await
    • Supports all Mercado Bitcoin Data API methods

Meta

Rafael Laurindo – @rafaellaurindoeu@rafaellaurindo.dev

Distributed under the MIT license. See LICENSE for more information.

https://rafaellaurindo.dev

Donations are welcome!

If this project have helped you in any way, consider buying me a ☕

With Paypal:

Buy Me a Coffee at ko-fi.com

Or with Bitcoin: 1McMwihX3D2gwQqo3F9ez9namd2AB7U53B

Contributing

  1. Fork it (https://github.com/rafaellaurindo/mercadobitcoin-js/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request