unizend-localbtc
v1.2.29
Published
NodeJS Client Library for the Localbitcoins API
Downloads
24
Maintainers
Readme
Table of Contents
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