io.block.api

Class BlockIO

java.lang.Object

io.block.api.BlockIO

public class BlockIO
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
BlockIO(java.lang.String apiKey)

Method Summary

Methods

Modifier and Type	Method and Description
AccountAddresses	getAccountAddresses() Requests a list of addresses in the account associated with this clients' API key
AccountBalance	getAccountBalance() Requests the balance of the account associated with this clients' API key
AddressBalances	getAddressBalancesByAddress(java.lang.String[] addresses) Requests balance(s) of given address(es) in the account associated with this clients' API key Make sure that the addresses actually exist in the account or the whole call will fail
AddressBalances	getAddressBalancesByLabels(java.lang.String[] labels) Requests balance(s) of given label(s) in the account associated with this clients' API key Make sure that the labels actually exist in the account or the whole call will fail
AddressByLabel	getAddressByLabel(java.lang.String label) Requests the address with the given label from the account associated with this clients' API key
NewAddress	getNewAddress(java.lang.String label) Requests the creation of a new address for the account associated with the clients' API key
Prices	getPrices(java.lang.String baseCurrency) Requests prices of the currency of the account associated with this clients' API key
TransactionsReceived	getTransactionsReceived(java.lang.String beforeTX) Lists up to 100 of the last transactions received by the account associated with this clients' API key
TransactionsReceived	getTransactionsReceivedByAddress(java.lang.String[] addresses, java.lang.String beforeTX) Lists up to 100 of the last transactions received by the provided addresses of the account associated with this clients' API key
TransactionsReceived	getTransactionsReceivedByLabel(java.lang.String[] labels, java.lang.String beforeTX) Lists up to 100 of the last transactions received by the provided labels of the account associated with this clients' API key
TransactionsReceived	getTransactionsReceivedByUserID(java.lang.String[] userIDs, java.lang.String beforeTX) Lists up to 100 of the last transactions received by the provided user IDs of the account associated with this clients' API key
TransactionsSent	getTransactionsSent(java.lang.String beforeTX) Lists up to 100 of the last transactions sent by the account associated with this clients' API key
TransactionsSent	getTransactionsSentByAddress(java.lang.String[] addresses, java.lang.String beforeTX) Lists up to 100 of the last transactions sent by the provided addresses of the account associated with this clients' API key
TransactionsSent	getTransactionsSentByLabel(java.lang.String[] labels, java.lang.String beforeTX) Lists up to 100 of the last transactions sent by the provided labels of the account associated with this clients' API key
TransactionsSent	getTransactionsSentByUserID(java.lang.String[] userIDs, java.lang.String beforeTX) Lists up to 100 of the last transactions sent by the provided user IDs of the account associated with this clients' API key
GreenAddresses	isGreenAddress(java.lang.String[] addresses) Checks the given address(es) for being Block.io Green Address(es)
GreenTransactions	isGreenTransaction(java.lang.String[] txIDs) Checks the given transaction(s) for being sent by a Block.io Green Address
Withdrawal	withdraw(java.lang.String[] sources, io.block.api.BlockIO.ParamType sourceType, java.util.Map<java.lang.String,java.lang.Double> targetsAndAmounts, io.block.api.BlockIO.ParamType targetType, java.lang.String secretPin) Withdraw from the account associated with this clients' API key.
Withdrawal	withdrawToAddress(java.lang.String address, double amount, java.lang.String secretPin) Convenience method for a simple withdrawal from the account associated with this clients' API key to the specified address

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlockIO

public BlockIO(java.lang.String apiKey)

Method Detail

getAccountBalance

public AccountBalance getAccountBalance()
                                 throws BlockIOException

Requests the balance of the account associated with this clients' API key

Returns:

An AccountBalance object containing the balances

Throws:

BlockIOException

getNewAddress

public NewAddress getNewAddress(java.lang.String label)
                         throws BlockIOException

Requests the creation of a new address for the account associated with the clients' API key

Parameters:

label - Optional label for the new address. null or "" for random label

Returns:

A NewAddress object containing information about the new address

Throws:

BlockIOException

getAccountAddresses

public AccountAddresses getAccountAddresses()
                                     throws BlockIOException

Requests a list of addresses in the account associated with this clients' API key

Returns:

An AccountAddresses object containing the addresses

Throws:

BlockIOException

getAddressBalancesByAddress

public AddressBalances getAddressBalancesByAddress(java.lang.String[] addresses)
                                            throws BlockIOException

Requests balance(s) of given address(es) in the account associated with this clients' API key
Make sure that the addresses actually exist in the account or the whole call will fail

Parameters:

addresses - A String array containing the addresses to request balances for

Returns:

An AddressBalances object containing the balances

Throws:

BlockIOException

getAddressBalancesByLabels

public AddressBalances getAddressBalancesByLabels(java.lang.String[] labels)
                                           throws BlockIOException

Requests balance(s) of given label(s) in the account associated with this clients' API key
Make sure that the labels actually exist in the account or the whole call will fail

Parameters:

labels - A String array containing the labels to request balances for

Returns:

An AddressBalances object containing the balances

Throws:

BlockIOException

getAddressByLabel

public AddressByLabel getAddressByLabel(java.lang.String label)
                                 throws BlockIOException

Requests the address with the given label from the account associated with this clients' API key

Parameters:

label - The label for which to request the address for

Returns:

An AddressByLabel object containing the address and additional info about it

Throws:

BlockIOException

withdrawToAddress

public Withdrawal withdrawToAddress(java.lang.String address,
                           double amount,
                           java.lang.String secretPin)
                             throws BlockIOException

Convenience method for a simple withdrawal from the account associated with this clients' API key to the specified address

Parameters:

address - Target address

amount - Amount to withdraw

secretPin - The secret PIN you set at block.io to authorize and sign the withdrawal

Returns:

A Withdrawal object containing information about the sent transaction.

Throws:

BlockIOException

withdraw

public Withdrawal withdraw(java.lang.String[] sources,
                  io.block.api.BlockIO.ParamType sourceType,
                  java.util.Map<java.lang.String,java.lang.Double> targetsAndAmounts,
                  io.block.api.BlockIO.ParamType targetType,
                  java.lang.String secretPin)
                    throws BlockIOException

Withdraw from the account associated with this clients' API key.

Parameters:

sources - Supply an array of sources for this withdrawal. If you set this to null, then block.io will select the sources automatically. You must not mix source types!

sourceType - If you supplied a sources array, this is mandatory. Must be one of BlockIO.ParamType.

targetsAndAmounts - A Map with target as key (String) and amount as value (Double). Each entry will be one target of the withdrawal. Limit is 100 per withdrawal. You must not mix target types!

targetType - This is mandatory and defines what type of targets this withdrawal goes to. One of BlockIO.ParamType.

secretPin - The secret PIN you set at block.io to authorize and sign the withdrawal

Returns:

A Withdrawal object containing information about the sent transaction.

Throws:

BlockIOException

getPrices

public Prices getPrices(java.lang.String baseCurrency)
                 throws BlockIOException

Requests prices of the currency of the account associated with this clients' API key

Parameters:

baseCurrency - Optional base currency to return prices in. null or "" to get prices in all available base currencies

Returns:

A Prices object containing price information in one or more base currency from one or more exchange

Throws:

BlockIOException

isGreenAddress

public GreenAddresses isGreenAddress(java.lang.String[] addresses)
                              throws BlockIOException

Checks the given address(es) for being Block.io Green Address(es)

Parameters:

addresses - A String array containing the addresses to request status for

Returns:

An GreenAddresses object containing the subset of the given addresses that are green

Throws:

BlockIOException

isGreenTransaction

public GreenTransactions isGreenTransaction(java.lang.String[] txIDs)
                                     throws BlockIOException

Checks the given transaction(s) for being sent by a Block.io Green Address

Returns:

An GreenTransactions object containing the subset of the given transactions that are green

Throws:

BlockIOException

getTransactionsReceived

public TransactionsReceived getTransactionsReceived(java.lang.String beforeTX)
                                             throws BlockIOException

Lists up to 100 of the last transactions received by the account associated with this clients' API key

Parameters:

beforeTX - An optional transaction ID used as upper bound of the requested transactions. Use this to request more than 100 of the last transactions

Returns:

A TransactionsReceived object containing the list of received transactions

Throws:

BlockIOException

getTransactionsReceivedByAddress

public TransactionsReceived getTransactionsReceivedByAddress(java.lang.String[] addresses,
                                                    java.lang.String beforeTX)
                                                      throws BlockIOException

Lists up to 100 of the last transactions received by the provided addresses of the account associated with this clients' API key

Parameters:

addresses - A String array containing the addresses to request transactions for

beforeTX - An optional transaction ID used as upper bound of the requested transactions. Use this to request more than 100 of the last transactions

Returns:

A TransactionsReceived object containing the list of received transactions

Throws:

BlockIOException

getTransactionsReceivedByLabel

public TransactionsReceived getTransactionsReceivedByLabel(java.lang.String[] labels,
                                                  java.lang.String beforeTX)
                                                    throws BlockIOException

Lists up to 100 of the last transactions received by the provided labels of the account associated with this clients' API key

Parameters:

labels - A String array containing the labels to request transactions for

beforeTX - An optional transaction ID used as upper bound of the requested transactions. Use this to request more than 100 of the last transactions

Returns:

A TransactionsReceived object containing the list of received transactions

Throws:

BlockIOException

getTransactionsReceivedByUserID

public TransactionsReceived getTransactionsReceivedByUserID(java.lang.String[] userIDs,
                                                   java.lang.String beforeTX)
                                                     throws BlockIOException

Lists up to 100 of the last transactions received by the provided user IDs of the account associated with this clients' API key

Parameters:

userIDs - A String array containing the user IDs to request transactions for

beforeTX - An optional transaction ID used as upper bound of the requested transactions. Use this to request more than 100 of the last transactions

Returns:

A TransactionsReceived object containing the list of received transactions

Throws:

BlockIOException

getTransactionsSent

public TransactionsSent getTransactionsSent(java.lang.String beforeTX)
                                     throws BlockIOException

Lists up to 100 of the last transactions sent by the account associated with this clients' API key

Parameters:

beforeTX - An optional transaction ID used as upper bound of the requested transactions. Use this to request more than 100 of the last transactions

Returns:

A TransactionsSent object containing the list of sent transactions

Throws:

BlockIOException

getTransactionsSentByAddress

public TransactionsSent getTransactionsSentByAddress(java.lang.String[] addresses,
                                            java.lang.String beforeTX)
                                              throws BlockIOException

Lists up to 100 of the last transactions sent by the provided addresses of the account associated with this clients' API key

Parameters:

addresses - A String array containing the addresses to request transactions for

beforeTX - An optional transaction ID used as upper bound of the requested transactions. Use this to request more than 100 of the last transactions

Returns:

A TransactionsSent object containing the list of sent transactions

Throws:

BlockIOException

getTransactionsSentByLabel

public TransactionsSent getTransactionsSentByLabel(java.lang.String[] labels,
                                          java.lang.String beforeTX)
                                            throws BlockIOException

Lists up to 100 of the last transactions sent by the provided labels of the account associated with this clients' API key

Parameters:

labels - A String array containing the labels to request transactions for

beforeTX - An optional transaction ID used as upper bound of the requested transactions. Use this to request more than 100 of the last transactions

Returns:

A TransactionsSent object containing the list of sent transactions

Throws:

BlockIOException

getTransactionsSentByUserID

public TransactionsSent getTransactionsSentByUserID(java.lang.String[] userIDs,
                                           java.lang.String beforeTX)
                                             throws BlockIOException

Lists up to 100 of the last transactions sent by the provided user IDs of the account associated with this clients' API key

Parameters:

userIDs - A String array containing the user IDs to request transactions for

beforeTX - An optional transaction ID used as upper bound of the requested transactions. Use this to request more than 100 of the last transactions

Returns:

A TransactionsSent object containing the list of sent transactions

Throws:

BlockIOException