# bitpay-node

> A Node.js library for the Bitpay Bitcoin API

Latest version **0.0.4** (published 2014-01-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install bitpay-node
pnpm add bitpay-node
yarn add bitpay-node
bun add bitpay-node
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2014-01-20 |
| First published | 2014-01-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 6 |
| Author | stevenzeiler |
| Maintainers | stevenzeiler |
| Keywords | bitpay, bitcoin, api |

## Links

- npm: https://www.npmjs.com/package/bitpay-node
- Repository: https://github.com/stevenzeiler/bitpay-node
- Issues: https://github.com/stevenzeiler/bitpay-node/issues
- npm.io page: https://npm.io/package/bitpay-node

## Dependencies (1)

- [request](https://npm.io/package/request.md) 2.x.x

## Recent versions

- 0.0.4 (latest) — 2014-01-20
- 0.0.3 — 2014-01-20
- 0.0.2 — 2014-01-20
- 0.0.1 — 2014-01-20

## README

## Bitpay -- Bitcoin Payment Library for V8 Javascript

I want a simple way to use the Bitpay Bitcoin API in node.js, 
and npm -- Node Package Manager -- is the standard way to distribute
javascript libraries for Node.js.

Like other HTTP client libraries a `Client` object will manage authentication
and connection to Bitpay's servers. All requests to the API will ultimately be 
made using the Client object initialized with the Bitpay account credentials.

## Installation

    npm install bitpay-node

## Example

    var Bitpay = require('bitpay-node');
    
    client = new Bitpay.Client({ apiKey: process.env.BITPAY_API_KEY });
    
    client.createInvoice({ price: 0.001, currency: 'BTC' }, function(err, invoice) {
      console.log(invoice);
    })

The call to createInvoice above should produce a JSON response as per the official
Bitpay API [documenation](https://bitpay.com/downloads/bitpayApi.pdf)

    { id: '2Rpei3aKcJZUDWDSJ92oSq',
      url: 'https://bitpay.com/invoice?id=2Rpei3aKcJZUDWDSJ92oSq',
      status: 'new',
      btcPrice: '0.0010',
      price: 0.001,
      currency: 'BTC',
      invoiceTime: 1390253166402,
      expirationTime: 1390254066402,
      currentTime: 1390253166452 }
    
## Tests

Run the tests wiith Mocha, and make sure to specify your Bitpay API Key in environment.
On the Bitpay account [API keys page](https://bitpay.com/api-keys) your can generate multiple API keys
for your various applications. Enable API key access and generate a key to use in the tests:

    BITPAY_API_KEY=46beb6dc657d4ceff4219a8e691b5015 mocha test/

---
_Source: https://npm.io/package/bitpay-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._