Basic MultiSig Wallet API ()

Our Basic Multi-Signature addresses by default require two signatures for all withdrawals: yours, and Block.io's. This method provides exponentially higher security for your Wallets and applications than single-signature addresses. This way, you spend coins yourself, without trusting Block.io with your credentials.

All addresses generated using this API are considered Green, i.e., they can send and receive funds without waiting for confirmations. This is possible since Block.io guarantees coins can never be spent twice. Furthermore, all transactions occur on the Blockchain.

If you require a more elaborate configuration to customize your applications' security, inquire about our Distributed Trust framework by going here. This framework allows up to 5 signatures per address. The use cases are endless!

Getting Started

First, you will need your API Keys, which we provide for Bitcoin, Dogecoin, Litecoin, and their Testnets. These API Keys are located in your Wallet. You are required to use an API Key when you interact with Block.io. It tells Block.io which network (e.g., Bitcoin) you wish to perform actions on.

Example: Processing Transactions Example: Creating Wallets for Users Example: Using Green Addresses

Installing the Library

You can download and install the official NodeJS library like so:

$ npm install block_io@1.0.9-2
  

Easy enough. Before using the library in your code, initialize it like so:

> var BlockIo = require('block_io');
> var version = 2; // API version
> var block_io = new BlockIo('YOUR API KEY', 'YOUR SECRET PIN', version);
  

Now you're good to go. Here's an example call:

> block_io.get_new_address({'label': 'shibe1'}, console.log);
  

Methods for Handling Addresses

Get New Address

Returns a newly generated address, and its unique(!) label generated by Block.io. You can optionally specify a custom label.

block_io.get_new_address({}, console.log);
block_io.get_new_address({'label': 'LABEL'}, console.log);
      

---

Get Balance

Returns the balance of your entire Bitcoin, Litecoin, or Dogecoin account (i.e., the sum of balances of all addresses/users within it) as numbers to 8 decimal points, as strings.

block_io.get_balance({}, console.log);
      

---

Get My Addresses

Returns the (unarchived) addresses, their labels, user ids, and balances on your account.

Do not use this if you plan on having more than 2,500 addresses on your account. Use get_address_balance (below) instead.

block_io.get_my_addresses({}, console.log);
      

---

Get My Addresses (No Balances)

Returns all the (unarchived) addresses, their labels, and user ids on your account.

block_io.get_my_addresses_without_balances({}, console.log);
      

---

Get Address Balance

Returns the balance of the specified addresses, or labels.

Can be used to query balances for external (non-account) addresses. If an external address' balance is returned, its user_id and label fields will be null.

block_io.get_address_balance({'address': 'ADDRESS'}, console.log);
block_io.get_address_balance({'label': 'LABEL'}, console.log);
block_io.get_address_balance({'user_id': USER_ID}, console.log);
      

---

Get Address By Label

Returns the address specified by a label.

block_io.get_address_by_label({'label': 'LABEL'}, console.log);
      

Withdrawal Methods

Overview

Block.io eases your burden of storing information regarding users' addresses, labels, and user IDs. Below, we provide various methods that allow you to make fine-grained withdrawals from your account(s). You can withdraw from any addresses, from specific addresses, from specific user ids, and from specific labels, and you can send the specified amounts to up to 2500 destination addresses, users, or labels in a single API call.

The amount withdrawn must at least be 2 DOGE, 0.00002 BTC, or 0.002 LTC. Please keep at least 1 DOGE, 0.0002 BTC, or 0.001 LTC for network fees. There are no Block.io fees. Larger transactions (in bytes) will incur larger amounts of network fees as per Bitcoin/Dogecoin/Litecoin specifications. As of 06/09/15, you can now specify an additional parameter priority={low,medium,high} to increase the network fee paid in the given transaction. 01/24/17: Use the get_network_fee_estimate API call to determine beforehand the network fee for a given set of withdrawal parameters.

Ensuring Uniqueness of Withdrawals Client-side human or machine error can lead to multiple executions of the same withdrawal request. If such an error occurs, you will lose money. To ensure the uniqueness of withdrawal requests, you can specify a nonce=value parameter with your withdrawal requests, where value is an alpha-numeric string between 1 and 64 characters long. Withdrawal requests that provide duplicate nonces less than 1 hour apart will be rejected. This is an optional but recommended security measure.

Withdraw

Withdraws amount of coins from any addresses in your account to up to 2500 destination addresses.

Effective 02/10/15: If you have more than 2500 unarchived addresses on your account, you cannot use this method for withdrawal. Please use the more granular withdraw_from_addresses, and withdraw_from_labels methods instead.

block_io.withdraw({'amounts': 'AMOUNT1,AMOUNT2,...', 'to_addresses': 'ADDRESS1,ADDRESS2,...'}, console.log);
      

---

Withdraw From Addresses

Withdraws AMOUNT coins from upto 2500 addresses at a time, and deposits it to up to 2500 destination addresses.

block_io.withdraw_from_addresses({'amounts': 'AMOUNT1,AMOUNT2,...', 'from_addresses': 'ADDRESS1,ADDRESS2,...', 'to_addresses': 'ADDRESS1,ADDRESS2,...'}, console.log);
      

---

Withdraw From Labels

Withdraws AMOUNT coins from upto 2500 labels at a time, and deposits it to upto 2500 destination addresses, or labels.

block_io.withdraw_from_labels({'amounts': 'AMOUNT1,AMOUNT2,...', 'from_labels': 'LABEL1,LABEL2,...', 'to_addresses': 'ADDRESS1,ADDRESS2,...'}, console.log);
block_io.withdraw_from_labels({'amounts': 'AMOUNT1,AMOUNT2,...', 'from_labels': 'LABEL1,LABEL2,...', 'to_labels': 'LABEL1,LABEL2,...'}, console.log);
      

The amounts=AMOUNT1,AMOUNT2,... and to_addresses=ADDRESS1,ADDRESS2,... parameters specify that destination ADDRESS1 will receive AMOUNT1, ADDRESS2 will receive AMOUNT2, etc. The source addresses (from_addresses=...) will need at least SUM(AMOUNT1,AMOUNT2...)+Network Fees in balances for this withdrawal to succeed.

---

Estimate Network Fee

Estimates the Network Fee you will need to pay when you make a withdrawal request. The Network Fee is required by the Bitcoin/Dogecoin/etc. networks, not Block.io.

Please use the same parameters as you would with any withdrawal API call; only one example is given below.

block_io.get_network_fee_estimate({'amounts': 'AMOUNT1,AMOUNT2,...', 'to_addresses': 'ADDRESS1,ADDRESS2,...'}, console.log);
      

Address Archival Methods

Archiving of addresses help you control account bloat due to a large number of addresses.

When an address is archived, it is:

• Not displayed in your wallet dashboard.
• Not included in the get_my_addresses API call.
• Not used to get available account balance.
• Not used as a withdrawal address, unless specified.

Address archival can greatly enhance the operational security of your applications by allowing you to move coins to new addresses without clogging your API call responses.

Archive Addresses

Archives upto 100 addresses in a single API call. Addresses can be specified by their labels.

block_io.archive_addresses({'address': 'ADDRESS'}, console.log);
block_io.archive_addresses({'label': 'LABEL'}, console.log);
block_io.archive_addresses({'user_id': USER_ID}, console.log);
      

---

Unarchive Addresses

Unarchives upto 100 addresses in a single API call. Addresses can be specified by their labels.

block_io.unarchive_addresses({'address': 'ADDRESS'}, console.log);
block_io.unarchive_addresses({'label': 'LABEL'}, console.log);
block_io.unarchive_addresses({'user_id': USER_ID}, console.log);
      

---

Get My Archived Addresses

Returns all the archived addresses, their labels, and user ids on your account.

block_io.get_my_archived_addresses({}, console.log);
      

Misc. Methods

Get Current Price

Returns the prices from the largest exchanges for Bitcoin, Dogecoin, or Litecoin, specified by the API Key. Specifying the base currency is optional.

block_io.get_current_price({}, console.log);
block_io.get_current_price({'price_base': 'BASE CURRENCY'}, console.log);
      

Is Green Address?

Returns an array of Block.io Green Addresses. Funds sent from Green Addresses are guaranteed by Block.io, and can be used immediately on receipt with zero network confirmations. This API call does not need an API Key.

block_io.is_green_address({'addresses': 'ADDRESS1,ADDRESS2,...'}, console.log);
      

Is Green Transaction?

Returns an array of transactions that were sent by Block.io Green Addresses. Funds sent from Green Addresses are guaranteed by Block.io, and can be used immediately on receipt with zero network confirmations. This API call does not need an API Key.

block_io.is_green_transaction({'transaction_ids': 'TXID1,TXID2,...'}, console.log);
      

Get Transactions

Returns various data for the last 25 transactions spent or received. You can optionally specify a before_tx parameter to get earlier transactions.

You can use this method to query for addresses that are not on your account.

Each result provides a confidence rating that shows the network's belief in the transaction's viability. This is useful if you need to validate transactions quickly (for e.g., in retail store settings) without waiting for confirmations. We recommend waiting for confidence ratings to reach 0.90-0.99 for unconfirmed transactions if you need to validate it. For unconfirmed transactions, you are also provided with the number of nodes (propagated_by_nodes) on the Network that approve of the given unconfirmed transaction (out of 150 sampled nodes).

If a double spend is detected for an unconfirmed transaction, its confidence rating falls to 0.0.

block_io.get_transactions({'type': 'sent'}, console.log);
block_io.get_transactions({'type': 'received'}, console.log);

block_io.get_transactions({'type': 'sent', 'before_tx': 'TXID'}, console.log);
block_io.get_transactions({'type': 'received', 'before_tx': 'TXID'}, console.log);

block_io.get_transactions({'type': 'received', 'addresses': 'ADDRESS1,ADDRESS2,...'}, console.log);
block_io.get_transactions({'type': 'received', 'user_ids': 'USERID1,USERID2,...'}, console.log);
block_io.get_transactions({'type': 'received', 'labels': 'LABEL1,LABEL2,...'}, console.log);

block_io.get_transactions({'type': 'sent', 'before_tx': 'TXID', 'addresses': 'ADDRESS1,ADDRESS2,...'}, console.log);
block_io.get_transactions({'type': 'received', 'before_tx': 'TXID', 'addresses': 'ADDRESS1,ADDRESS2,...'}, console.log);

...