Getting Started

In order to use Wallet and CreateWallet functionality, you must provide an URL to an instance of [service-my-wallet-v3](https://github.com/blockchain/service-my-wallet-v3).

Before using these functionalities, call \Blockchain\Blockchain::setServiceUrl to set the URL to the instance of of [service-my-wallet-v3](https://github.com/blockchain/service-my-wallet-v3).

$Blockchain->setServiceUrl('http://localhost:3000');

The [official documentation](https://blockchain.info/api) lists API call limits, which may be bypassed with an API code. If you use a code, enter it when you create the `Blockchain` object:

If you need an API code, you may request one [here](https://blockchain.info/api/api_create_code).

Set the `cURL` timeout, in seconds, with the `setTimeout` member function:

All Bitcoin values returned by the API are in string float format, in order to preserve full value precision. It is recommended that all arithmetic operations performed on Bitcoin values within PHP utilize the `bcmath` functions as follows:

```php

$result = bcadd("101.234115", "34.92834753", 8); // "136.16246253"

```

$result = bcsub("101.234115", "34.92834753", 8); // "66.30576747"

$result = bcmul("101.234115", "34.92834753", 8); // "3535.940350613"

$result = bcdiv("101.234115", "34.92834753", 8); // "2.89833679"

Blocks may be queried in multiple ways: by the block hash, by the height in the blockchain, or by the block's index. Calls return `Block` objects. `getBlocksAtHeight` returns an array of `Block` objects.

Get a single transaction based on hash or index. Returns a `Transaction` object.

Get the details of an address, including a paged list of transactions. Returns an `Address` object.

Get an array of `UnspentOutput` objects for a given address.

$unspent = $Blockchain->Explorer->getUnspentOutputs($address);

Get the latest block on the main chain. Returns a simpler `LatestBlock` object;

$latest = $Blockchain->Explorer->getLatestBlock();

Get a list of unconfirmed transactions. Returns an array of `Transaction` objects.

$unconfirmed = $Blockchain->Explorer->getUnconfirmedTransactions();

Get blocks from a particular day or from a given mining pool. Return arrays of `SimpleBlock` objects.

For a list of mining pool names, visit [this page](https://blockchain.info/pools).

Gets data for recent blockchain entities, up to one hour old. Returns an `InventoryData` object.

$data = $Blockchain->Explorer->getInventoryData($hash);

Calls to the API return first-class objects.

class Block {

}

class Transaction {

public $double_spend = false; // bool

public $sequence; // int

public $script_sig; // string

public $coinbase = true; // bool

// If coinbase is false, then the following fields are created

public $n; // int

public $value; // string, e.g. "12.64952835"

Please read the [offical documentation](https://blockchain.info/api/create_wallet) for important details.

Create a new wallet with a known private key. Returns a `WalletResponse` object.

$wallet = $Blockchain->Create->createWithKey($password, $privKey, $email=null, $label=null);

Create a new wallet, letting Blockchain generate a new private key. Returns a `WalletResponse` object.

$wallet = $Blockchain->Create->create($password, $email=null, $label=null);

The `WalletResponse` object contains fields for the wallet identifier (`guid`), the `address` for receiving Bitcoin, and a `label` for the first account of the wallet.

foreach($rates as $cur=>$ticker) { ... }

class Ticker {

$stats = $Blockchain->Stats->get();

class StatsResponse {

// ...

Values returned by this API are `string` representations of the floating point Bitcoin value, with 8 decimal places of precision, like this: `"105.62774000"`.

Read more about string values on the [main documentation](../README.md).

Use the `getIdentifier` function to check which wallet is active, without having to enter additional credentials. Returns a string.

Functions for fetching the balance of a whole wallet or of a particular address.

Get the balance of the whole wallet. Returns a `string` representing the floating point balance, e.g. `"12.64952835"`.

$balance = $Blockchain->Wallet->getBalance();

Get the balance of a single wallet address. Returns a `WalletAddress` object.

Functions for making outgoing Bitcoin transactions from the wallet.

Send Bitcoin to a single recipient address. The `$amount` field is either a `float` or `string` representation of the floating point value. See above note on Bitcoin values.

The optional `$from_address` field specifies which wallet address from which to send the funds. An optional `$fee` amount (`float`) may be specified but must be more than the default fee listed on the [official documentation](https://blockchain.info/api/blockchain_wallet_api).

$response = $Blockchain->Wallet->send("1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa", "0.005", null, "0.0001", "Here you go, Satoshi!");

Send a multi-recipient transaction to many addresses at once. The `$recipients` parameter is an associative array with `address` keys and `amount` values (see example). Optional parameters are the same as with the `send` call. Returns `PaymentResponse` object and throws a `Blockchain_ApiError` exception for insufficient funds, etc.

$response = $Blockchain->Wallet->sendMany($recipients, $from_address=null, $fee=null, $public_note=null);

A wallet may contain many addresses, not all of which must be active at all times. Active addresses are monitored for activity, while archived addresses are not. It is recommended that addresses be archived when it is reasonable to assume that there will not be further activity to that address. For instance, after an invoice is filled, the payment address may be archived once the received coins are moved.

Call `getAddresses` to return a list of the active addresses within the wallet. Returns an array of `WalletAddress` objects.

$addresses = $Blockchain->Wallet->getAddresses();

Generate a new Bitcoin address, with an optional label, less than 255 characters in length. Returns a `WalletAddress` object.

$address = $Blockchain->Wallet->getNewAddress($label=null);

Move an address to the archive. Returns `true` on success and `false` on failure.

$result = $Blockchain->Wallet->archiveAddress($address);

Move an address from the archive to the active address list. Returns `true` on success and `false` on failure.

$result = $Blockchain->Wallet->unarchiveAddress($address);

Calls to the API usually return first-class objects.

class PaymentResponse {