unizend / lbtc-api Goto Github PK

NodeJS Client Library for the LocalBitcoins API. Contributions are welcome.

License: MIT License

JavaScript 99.59% Shell 0.41%

nodejs api localbitcoins-api javascript bitcoin unizend good-first-issue contributions-welcome shield issues-shield forks-shield contributors-shield linkedin-shield

lbtc-api's Introduction

Unizend's Node.js Client Library for the LocalBitcoins API

Unizend's Node.js Localbitcoins API Client Library has been build to help you access to the localbitcoins API from your Node.js project.
It provides a series of methods that hopefully will ease your development with the Localbitcoins API using Node.js.
Explore the docs »
· unizend-localbtcrt Bug · Request Feature

About the Project
- Built With
Getting Started
- Installation
Usage
Roadmap
Contributing
License
Contact
Acknowledgements

About The Project

![Unizend's Localbitcoins API][product-screenshot]

Built With

Getting Started

To get this node.js module up and running follow these simple steps.

Installation

Go to yourn project folder and exec the following command

npm i unizend-localbtc

Usage

All you will need is your HMAC Auth key and secret wich you can get from here

For more information check the Localbitcoins API Documentation

// Require the library
const lbtc = require('unizend-localbtc')

// Initialize the app using your HMAC Auth key and secret
lbtc.init(YOUR_HMAC_AUTH_KEY, YOUR_HMAC_AUTH_SECRET)

// Get an specific currency average data
lbtc.publicMarketData.bitcoinAverage('VES')
  .then(response => {
      console.log(response)
  })

Roadmap

We are working on adding more features to the API. Follow the repo to keep up with our updates.

Feel free to propose features open issues and also add or see known issues.

Contributing

Crypto needs adoption and the goal of this tool is to help other developers build faster! If you find any bugs / issues or have suggestions, please consider collaborating. It would be greatly appreciated.

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

License

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

Contact

Santiago Rincon - @unizend_pay - [email protected]

Project Link: https://github.com/rincorpes/unizend-localbtc

Acknowledgements

lbtc-api's People

Contributors

Stargazers

Watchers

Forkers

fenixgnom neverekt creativelambda

lbtc-api's Issues

Allow custom list for publicMarketData.bitcoinsAverage()

I need something like this:

lbtc.publicMarketData.bitcoinAverage({VES: '1h', COP: '6h', MXN: '12h'}).then(async (response) => {
    console.log(response)
})

[
  {
    VES.1h: 720968802.21
    COP.6h: 31108176.37
    MXN.12h: 195634.42
  }
]

Problem with publicMarketData.bitcoinAvege()

When the LocalBitcoins API is generating the average price, the app breaks.

lbtc.publicMarketData.bitcoinAverage().then(async (response) => {
  console.log(response.VES)
})

I got this message

Request to https://localbitcoins.com/bitcoinaverage/ticker-all-currencies/
(node:16491) UnhandledPromiseRejectionWarning: FetchError: invalid json response body at https://localbitcoins.com/bitcoinaverage/ticker-all-currencies/ reason: Unexpected token T in JSON at position 0
    at /Users/desarrollomarkettech/unizend/unizend-live-rates/node_modules/node-fetch/lib/index.js:272:32
    at processTicksAndRejections (internal/process/task_queues.js:97:5)
    at async Object.bitcoinAverage (/Users/desarrollomarkettech/unizend/unizend-live-rates/node_modules/unizend-localbtc/unizend-localbtc.js:446:18)
    at async getAverage (/Users/usuario/unizend/app/new.js:34:3)
(node:16491) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 2)
(node:16491) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

Public market data pagination error

When I try to make a request to a page other than the first one, it throws an error from LocalBitcoins.

 Request to https://localbitcoins.com/sell-bitcoins-online/ve/venezuela/.json?page=2
{
   error: {
     message: 'HMAC authentication key and signature was given, but they are invalid.',
     error_code: 41
   }
 }