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. For private keys for your wallets, visit the Settings page on your dashboard.

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.

Additionally, you are required to restrict API access to your own (secure) machines' IP addresses. That means you will explicitly allow access to IP addresses for machines that can access your account's API. If you do not know a machine's IP address, you can run the following on your machine's UNIX command-line:


$ curl --ipv4 'https://block.io/ip_echo' # IPv4
$ curl --ipv6 'https://block.io/ip_echo' # IPv6

Once you have the IP addresses, add them one by one via the Settings page.

Installing the Library

Fork me on GitHub

You can download and install the official Ruby gem like so:


$ gem install block_io
  

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


>> require 'block_io'
>> blockio = BlockIo::Client.new(:api_key => "BITCOIN, DOGECOIN, or LITECOIN API KEY", :pin => "SECRET PIN", :version => 2)
  

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


>> blockio.get_new_address(:label => 'shibe1')
  

For usage example scripts, see here.

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.
You can also optionally specify the type of address you wish to generate.

Available address types for Bitcoin, and Litecoin are P2SH (default), and WITNESS_V0. Dogecoin is limited to P2SH addresses at this time.

Note that use of Witness v0 addresses will save you significant amounts of network fees, but these addresses are very new, and users' wallets may not recognize them at this time.


blockio.get_new_address
blockio.get_new_address :label => 'LABEL'
blockio.get_new_address :address_type => 'ADDRESS TYPE'
      

Get a new address with a random label

API KEY: (Your API Keys are in your Wallet)

Get a new address with a given label

API KEY: (Your API Keys are in your Wallet)

LABEL:

Get a low network fee address (type=witness_v0)

API KEY: (Your API Keys are in your Wallet)

ADDRESS TYPE:


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.


blockio.get_balance
      

Get account balance

API KEY: (Your API Keys are in your Wallet)


Get My Addresses

Returns the (unarchived) addresses, their labels, user ids, and balances on your account. Upto 2500 addresses per page. Page parameter is optional.


blockio.get_my_addresses(:page => PAGE_NUMBER)
      

Get my addresses

API KEY: (Your API Keys are in your Wallet)

PAGE:


Get Address Balance

Returns the balance of the specified addresses, or labels. Upto 2500 addresses/labels can be specified per request.

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.


blockio.get_address_balance :addresses => 'ADDRESS1,ADDRESS2,...'
blockio.get_address_balance :labels => 'LABEL1,LABEL2,...'
      

Get the balance of a given address

API KEY: (Your API Keys are in your Wallet)

ADDRESSES:

Get the balance of an address with a given label

API KEY: (Your API Keys are in your Wallet)

LABELS:


Get Address By Label

Returns the address specified by a label.


blockio.get_address_by_label :label => 'LABEL'
      

Get the address for a given label

API KEY: (Your API Keys are in your Wallet)

LABEL:

Withdrawal Methods

Overview

Block.io eases your burden of storing information regarding users' addresses, and labels. Below, we provide various methods that allow you to make fine-grained transactions using your addresses. You can prepare transactions using any or specific addresses, or labels. You can send the specified amounts to up to 2500 destination addresses, or labels in a single API call.

Minimum Amounts You can prepare transactions for sending at least 2 DOGE, 0.00002 BTC, or 0.0002 LTC.

Block.io Fees Block.io does not charge fees (unless otherwise noted on the Settings page). You always pay your own network fees, however, which are in addition to the withdrawal amounts specified.

Network Fees The speed with which miners confirm your transaction depends on the network fees you pay, and the network fees you pay depend on the size of your transaction (in bytes). Larger transactions incur higher network fees. You can specify the priority for your transactions using an additional parameter priority={low,medium,high,custom} to adjust the network fee you wish to pay. Block.io will adjust appropriate network fees for priority={low,medium,high} automatically by monitoring the state of the relevant network. You can specify custom network fees using the parameters priority=custom and custom_network_fee=CUSTOM_NETWORK_FEE.

Transaction Batching You can send coins to upto 2500 destination addresses in a single transaction. We recommend using a single transaction to send coins to multiple recipients, wherever possible. This allows you to incur lower network fees overall, improves confirmation times for your transactions, as well as the health of the relevant network and its blockchain.

Ensuring Uniqueness of Withdrawals Since each transaction is created by you client-side, and signed by you client-side, you will monitor your own application's logic to ensure uniqueness of transactions.

Sequential vs. Parallel Execution When you prepare transactions, Block.io provides appropriate data for you to construct transactions client-side. If you execute transactions in parallel, you might be using the same coins (inputs) in two or more transactions. This will cause your transactions to fail (an error from Block.io when you submit signed transactions to Block.io) since each input can only be used once. To avoid this pitfall, you will execute your transactions sequentially (i.e., one after the other), rather than in parallel (i.e., simultaneously).

Process for Executing Transactions ("Withdrawals")

When you wish to transact using your addresses ("withdraw coins"), you will perform the following steps:

1. Preparing Transaction You will first ask Block.io for data appropriate to create a transaction. You do this by supplying source addresses (addresses to withdraw coins from), destination addresses (addresses to which you wish to send coins), and optionally the transaction's priority for network fees, or custom network fees you wish to pay for your transaction. You do not need Block.io for this data since you can get this from any other source you deem fit yourself. However, the latter may be complicated for users.

2. Inspecting Prepared Transaction Data You will then inspect the data with which you will create your transaction. This means you are responsible for assuring the coins you spend ("inputs"), the coins to be received by a destination ("outputs"), network fees, etc. are as you wish them.

3. Creating and Signing Transaction You will then use the set of inputs and outputs you've prepared to create the transaction using the Bitcoin, Litecoin, Dogecoin, etc. networks' protocols. This is made easier by Block.io through our reference libraries for creating transactions client-side. Additionally, if you are not providing private keys yourself, your software will decrypt the appropriate private keys client-side using your Secret PIN, and then sign the transaction you've created.

4. Submitting the Transaction The unsigned transaction, and signatures you've generated in the previous step can then be submitted to Block.io. Block.io will double-check to ensure you are not accidentally paying exorbitant network fees, and that the signatures you've generated for your transaction are appropriate for the relevant network. If all tests pass, Block.io will append its own key's signature to your transaction if you only partially signed the transaction. Once the transaction you generated is fully signed, it will be broadcast to the relevant coin's peer-to-peer network. For fully signed transactions, you can submit your transaction to the appropriate peer-to-peer network yourself, without using Block.io's infrastructure.

Prepare Transaction

Retrieve data to send coins from any addresses in your account to up to 2500 destination addresses.


blockio.prepare_transaction :amounts => 'AMOUNT1,AMOUNT2,...', :to_addresses => 'ADDRESS1,ADDRESS2,...'
      


Prepare Transaction using Custom Network Fee

Retrieve data to send coins from any addresses in your account to up to 2500 destination addresses. Use custom network fee.


blockio.prepare_transaction :amounts => 'AMOUNT1,AMOUNT2,...', :to_addresses => 'ADDRESS1,ADDRESS2,...', :priority => 'custom', :custom_network_fee => 'CUSTOM_NETWORK_FEE'
      


Prepare Transaction using Specific Source Addresses

Retrieve data to send coins from up to 2500 addresses, to up to 2500 destination addresses.


blockio.prepare_transaction :amounts => 'AMOUNT1,AMOUNT2,...', :from_addresses => 'ADDRESS1,ADDRESS2,...', :to_addresses => 'ADDRESS1,ADDRESS2,...'
      


Prepare Transaction using Specific Source Address Labels

Retrieve data to send coins from up to address labels, to up to 2500 destination addresses, or addresses labels.


blockio.prepare_transaction :amounts => 'AMOUNT1,AMOUNT2,...', :from_labels => 'LABEL1,LABEL2,...', :to_addresses => 'ADDRESS1,ADDRESS2,...'
blockio.prepare_transaction :amounts => 'AMOUNT1,AMOUNT2,...', :from_labels => 'LABEL1,LABEL2,...', :to_labels => 'LABEL1,LABEL2,...'
      

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.


Summarize Prepared Transaction

This SDK-only method will generate a summary of the transaction you prepared so you know what amounts you're sending, the network fees you're paying, and the Block.io fees you're paying. You will inspect the response from prepare transaction API calls yourself; this is just a summary of the data before you create the transaction client-side.


blockio.summarize_prepared_transaction(PREPARE_TRANSACTION_API_RESPONSE)
  

Create and Sign Transaction

You will use the inputs, outputs, encrypted user key, input address data from the prepare transaction API responses.


blockio.create_and_sign_transaction(PREPARE_TRANSACTION_API_RESPONSE)
  

Submit Transaction

Once you have created the transaction client-side, and signed it client-side, you can submit it to Block.io for additional signatures and/or broadcasting to the peer-to-peer blockchain network.


blockio.submit_transaction(:transaction_data => CREATE_AND_SIGN_TRANSACTION_RESPONSE)
  

Estimate Network Fee

Estimates the Network Fee you will need to pay when you execute a transaction. The Network Fee is required by the blockchain network, not Block.io.

When you change withdrawal parameters, the estimated network fees or lower/upper bounds for custom network fee may change as well.

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


blockio.get_network_fee_estimate :amounts => 'AMOUNT1,AMOUNT2,...', :to_addresses => 'ADDRESS1,ADDRESS2,...'
      

Estimate network fee for given transaction parameters

API KEY: (Your API Keys are in your Wallet)

AMOUNTS:

TO ADDRESSES:

Validate custom network fee for given transaction parameters

API KEY: (Your API Keys are in your Wallet)

AMOUNTS:

TO ADDRESSES:

PRIORITY:

CUSTOM NETWORK FEE:

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.

As of 07/04/2020, addresses that receive coins (other than from your own account's addresses) will be unarchived automatically.

Archive Addresses

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


blockio.archive_addresses :addresses => 'ADDRESS1,ADDRESS2,...'
blockio.archive_addresses :labels => 'LABEL1,LABEL2,...'
      

Archive an address on your account

API KEY: (Your API Keys are in your Wallet)

ADDRESSES:


Unarchive Addresses

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


blockio.unarchive_addresses :addresses => 'ADDRESS1,ADDRESS2,...'
blockio.unarchive_addresses :labels => 'LABEL1,LABEL2,...'
      

Unarchive an address on your account

API KEY: (Your API Keys are in your Wallet)

ADDRESSES:


Get My Archived Addresses

Returns your archived addresses, their labels, and user ids on your account. Upto 2500 addresses per page. Page parameter is optional.


blockio.get_my_archived_addresses(:page => PAGE_NUMBER)
      

Get my archived addresses

API KEY: (Your API Keys are in your Wallet)

PAGE:

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.


blockio.get_current_price
blockio.get_current_price :price_base => 'BASE CURRENCY'
      

Get current price of Bitcoin, Dogecoin, or Litecoin in all base currencies

API KEY: (Your API Keys are in your Wallet)

Get current price of Bitcoin, Dogecoin, or Litecoin in a given base currency

API KEY: (Your API Keys are in your Wallet)

PRICE BASE:

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.


blockio.get_transactions :type => 'sent'
blockio.get_transactions :type => 'received'

blockio.get_transactions :type => 'sent', :before_tx => 'TXID'
blockio.get_transactions :type => 'received', :before_tx => 'TXID'

blockio.get_transactions :type => 'received', :addresses => 'ADDRESS1,ADDRESS2,...'
blockio.get_transactions :type => 'received', :user_ids => 'USERID1,USERID2,...'
blockio.get_transactions :type => 'received', :labels => 'LABEL1,LABEL2,...'

blockio.get_transactions :type => 'sent', :before_tx => 'TXID', :addresses => 'ADDRESS1,ADDRESS2,...'
blockio.get_transactions :type => 'received', :before_tx => 'TXID', :addresses => 'ADDRESS1,ADDRESS2,...'

...
      

Get the last 25 transactions for all addresses

API KEY: (Your API Keys are in your Wallet)

TYPE:

Get the last 25 transactions for specific addresses

API KEY: (Your API Keys are in your Wallet)

TYPE:

ADDRESSES:

Get 25 transactions for all addresses before a transaction occurred

API KEY: (Your API Keys are in your Wallet)

TYPE:

BEFORE TX:

Get Raw Transaction

Returns the raw data, including transaction hex, for a given transaction ID.


blockio.get_raw_transaction :txid => 'TXID'
      

Get raw data for a single transaction

API KEY: (Your API Keys are in your Wallet)

TXID:

Validate Address

Returns whether a single specified address is valid for the network, or not.


blockio.is_valid_address :address => 'ADDRESS'
      

Validate a single address

API KEY: (Your API Keys are in your Wallet)

ADDRESS:

Account Info

Returns basic information about your account, such as its current Plan, number of addresses created, number of daily API requests used, etc. API Key agnostic.


blockio.get_account_info
      

Get current account info/status

API KEY: (Your API Keys are in your Wallet)

Decode Raw Transaction

Returns the decoded raw transaction for a given transaction in hexadecimal form.


blockio.decode_raw_transaction :tx_hex => 'TX_HEX'
      

Decode a single transaction from its hexadecimal form

API KEY: (Your API Keys are in your Wallet)

TX HEX: