# ibitcoin-se-api

> iBitcoin.se API wrapper for node.js - receive & send cryptocurrencies on your app

Latest version **2.0.1** (published 2020-09-21) · ISC license · 0 weekly downloads

## Install

```sh
npm install ibitcoin-se-api
pnpm add ibitcoin-se-api
yarn add ibitcoin-se-api
bun add ibitcoin-se-api
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2020-09-21 |
| First published | 2020-09-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=5.10.1 |
| Dependencies | 1 |
| Unpacked size | 12.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Adam |
| Maintainers | ibitcoinse |
| Keywords | ibitcoin.se, ibitcoin, bitcoin, litecoin, bitcoin cash, bitcoin satoshi vision, wallet, receive bitcoin, send bitcoin, cryptocurrency |

## Links

- npm: https://www.npmjs.com/package/ibitcoin-se-api
- Repository: https://github.com/iBitcoin-se/iBitcoinJS
- Issues: https://github.com/iBitcoin-se/iBitcoinJS/issues
- npm.io page: https://npm.io/package/ibitcoin-se-api

## Dependencies (1)

- [request](https://npm.io/package/request.md) =2.88.0

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 2.0.1 (latest) — 2020-09-21
- 2.0.0 — 2020-09-21

## README

# iBitcoin-JS API

This nodejs module is the official reference client for the iBitcoin.se payments
API. To use this, you will need iBitcoin.se API key
from <a href="https://iBitcoin.se" target="_blank">ibitcoin.se</a>. Go ahead, sign
up :)

## Installation

Install the package using npm:

    $ npm install ibitcoin-se-api --save
    

## Usage

It's super easy to get started. In your node shell, do:

```
const iBitcoin = require('ibitcoin-se-api');
 
   process.env.API_KEY = 'YOUR_API_KEY_FROM_YOUR_IBITCOIN_WALLET';
   process.env.SHOW_ERROR_TO_USER = 'false';
   process.env.API_LINK = 'https://backend.ibitcoin.se/api/';

   (async function () {
     const ibitcoin = new iBitcoin('bch');
      console.log(await ibitcoin.createAddress());
      console.log(await ibitcoin.addressBalance('SOME_ADDRESS')); // method works only with addresses created on iBitcoin.se
      console.log(await ibitcoin.walletBalance());
      console.log(await ibitcoin.privateKeyBalance('WIF_PRIVATE_KEY'));
      console.log(await ibitcoin.getTransaction('TXID')); // Works with any TXID
       console.log(await ibitcoin.send(0.0002,'your_password',null , 'admin'));
   })();

```

For more information, see [Node.js API Docs](https://iBitcoin.se/api/).
This client provides a mapping for all methods listed on the iBitcoin.se API
site.

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