Api/BitcoinApi

Bitcoin API Reference

// Set your API Keys 👇 here
$sdk = new \Tatum\Sdk();

// MainNet API Call
$sdk->mainnet()->api()->bitcoin();

// TestNet API Call
$sdk->testnet()->api()->bitcoin();

Methods

btcBroadcast()

Example

#️⃣ Execute command in terminal

✨ php -f btcBroadcast.php

Request

POST /v3/bitcoin/broadcast

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcBroadcast(
    \Tatum\Model\BroadcastKMS $broadcast_kms
): \Tatum\Model\TransactionHash

Parameters

Return type

\Tatum\Model\TransactionHash

Description

Broadcast a signed Bitcoin transaction

2 credits per API call

Broadcasts a signed transaction to the Bitcoin blockchain. This method is used internally from Tatum KMS or Tatum Client Libraries. It is possible to create a custom signing mechanism and only use this method for broadcasting data to the blockchain.

Back to top

btcGenerateAddress()

Example

#️⃣ Execute command in terminal

✨ php -f btcGenerateAddress.php

Request

GET /v3/bitcoin/address/{xpub}/{index}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcGenerateAddress(
    string $xpub,
    float $index
): \Tatum\Model\GeneratedAddressBtc

Parameters

Return type

\Tatum\Model\GeneratedAddressBtc

Description

Generate a Bitcoin address from the wallet’s extended public key

1 credit per API call

Generate a Bitcoin address from the extended public key of the wallet. The address is generated for the specific index - each extended public key can generate up to 2^32 addresses with the index starting from 0 up to 2^31 - 1.

Back to top

btcGenerateAddressPrivateKey()

Example

#️⃣ Execute command in terminal

✨ php -f btcGenerateAddressPrivateKey.php

Request

POST /v3/bitcoin/wallet/priv

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcGenerateAddressPrivateKey(
    \Tatum\Model\PrivKeyRequest $priv_key_request
): \Tatum\Model\PrivKey

Parameters

Return type

\Tatum\Model\PrivKey

Description

Generate the private key for a Bitcoin address

1 credit per API call

Generates a private key for an address from a mnemonic for a given derivation path index. The private key is generated for the specific index - each mnemonic can generate up to 2^32 private keys starting from index 0 until 2^31 - 1.

Back to top

btcGenerateWallet()

Example

#️⃣ Execute command in terminal

✨ php -f btcGenerateWallet.php

Request

GET /v3/bitcoin/wallet

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcGenerateWallet(
    [ string $mnemonic ]
): \Tatum\Model\Wallet

Parameters

Return type

\Tatum\Model\Wallet

Description

Generate a Bitcoin wallet

1 credit per API call

Tatum supports BIP44 HD wallets. Because they can generate 2^31 addresses from 1 mnemonic phrase, they are very convenient and secure. A mnemonic phrase consists of 24 special words in a defined order and can restore access to all generated addresses and private keys. Each address is identified by 3 main values:

• Private Key - your secret value, which should never be revealed
• Public Key - public address to be published
• Derivation index - index of generated address

Tatum follows BIP44 specification and generates for Bitcoin wallet with derivation path m’/44’/0’/0’/0. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki. Generate BIP44 compatible Bitcoin wallet.

Back to top

btcGetBalanceOfAddress()

Example

#️⃣ Execute command in terminal

✨ php -f btcGetBalanceOfAddress.php

Request

GET /v3/bitcoin/address/balance/{address}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcGetBalanceOfAddress(
    string $address
): \Tatum\Model\BtcBasedBalance

Parameters

Return type

\Tatum\Model\BtcBasedBalance

Description

Get the balance of a Bitcoin address

1 credit per API call

Get the balance of a Bitcoin address.

The API returns the balance only if the address has up to 50,000 UTXOs (Unspent Transaction Outputs). For an address with more than 50,000 UTXOs, the API returns an error with the 403 response code.

Back to top

btcGetBlock()

Example

#️⃣ Execute command in terminal

✨ php -f btcGetBlock.php

Request

GET /v3/bitcoin/block/{hash}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcGetBlock(
    string $hash
): \Tatum\Model\BtcBlock

Parameters

Return type

\Tatum\Model\BtcBlock

Description

Get a Bitcoin block by its hash or height

1 credit per API call

Gets Bitcoin block detail by block hash or height.

Back to top

btcGetBlockChainInfo()

Example

#️⃣ Execute command in terminal

✨ php -f btcGetBlockChainInfo.php

Request

GET /v3/bitcoin/info

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcGetBlockChainInfo(): \Tatum\Model\BtcInfo

Parameters

This endpoint does not need any parameter.

Return type

\Tatum\Model\BtcInfo

Description

Get Bitcoin blockchain information

1 credit per API call

Gets Bitcoin blockchain information. Obtains basic info like the testnet / mainnet version of the chain, the current block number and its hash.

Back to top

btcGetBlockHash()

Example

#️⃣ Execute command in terminal

✨ php -f btcGetBlockHash.php

Request

GET /v3/bitcoin/block/hash/{i}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcGetBlockHash(
    float $i
): \Tatum\Model\BtcBlockHash

Parameters

Return type

\Tatum\Model\BtcBlockHash

Description

Get the hash of a Bitcoin block

1 credit per API call

Gets a Bitcoin block hash. Returns the hash of the block to get the block’s details.

Back to top

btcGetMempool()

Example

#️⃣ Execute command in terminal

✨ php -f btcGetMempool.php

Request

GET /v3/bitcoin/mempool

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcGetMempool(): string[]

Parameters

This endpoint does not need any parameter.

Return type

string[]

Description

Get transactions from the Bitcoin mempool

1 credit per API call

Gets Bitcoin transaction IDs in the mempool.

Back to top

btcGetRawTransaction()

Example

#️⃣ Execute command in terminal

✨ php -f btcGetRawTransaction.php

Request

GET /v3/bitcoin/transaction/{hash}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcGetRawTransaction(
    string $hash
): \Tatum\Model\BtcTx

Parameters

Return type

\Tatum\Model\BtcTx

Description

Get a Bitcoin transaction by its hash

1 credit per API call

Get Bitcoin Transaction detail by transaction hash.

Back to top

btcGetTxByAddress()

Example

#️⃣ Execute command in terminal

✨ php -f btcGetTxByAddress.php

Request

GET /v3/bitcoin/transaction/address/{address}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcGetTxByAddress(
    string $address,
    float $page_size,
    [ float $offset ]
): \Tatum\Model\BtcTx[]

Parameters

Return type

\Tatum\Model\BtcTx[]

Description

Get all transactions for a Bitcoin address

1 credit per API call

Get all transactions for a Bitcoin address.

Back to top

btcGetUTXO()

Example

#️⃣ Execute command in terminal

✨ php -f btcGetUTXO.php

Request

GET /v3/bitcoin/utxo/{hash}/{index}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcGetUTXO(
    string $hash,
    float $index
): \Tatum\Model\BtcUTXO

Parameters

Return type

\Tatum\Model\BtcUTXO

Description

Get information about a transaction output (UTXO) in a Bitcoin transaction

1 credit per API call

Get information about a transaction output in a transaction and check whether this output is a UTXO or has been spent.

“UTXO” stands for “Unspent Transaction Output”. A UTXO is the amount of BTC/satoshis that remains at a Bitcoin address after a cryptocurrency transaction involving this address has been performed. The UTXO can then be used as input for a new cryptocurrency transaction. For more information about Bitcoin transactions and UTXO, see the Bitcoin user documentation.

• If the transaction output is an UTXO, the API returns data about it.
• If the transaction output has been spent and there is no UTXO to return, the API returns an error with the 404 response code.

Back to top

btcTransactionFromAddress()

Example

#️⃣ Execute command in terminal

✨ php -f btcTransactionFromAddress.php

Request

POST /v3/bitcoin/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcTransactionFromAddress(
    \Tatum\Model\BtcTransactionFromAddress $btc_transaction_from_address
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Send BTC to Bitcoin addresses

2 credits per API call

Send BTC to blockchain addresses.

Bitcoin transactions are based on UTXOs. “UTXO” stands for “Unspent Transaction Output”. A UTXO is the amount of BTC/satoshis that remains at a Bitcoin address after a cryptocurrency transaction involving this address has been performed. The UTXO can then be used as input for a new cryptocurrency transaction. For more information about Bitcoin transactions and UTXO, see the Bitcoin user documentation. To check UTXOs in a transaction, see the API for getting information about a transaction output (UTXO) in a Bitcoin transaction.

You can build a BTC transaction by one of the following methods:

• Sending BTC from blockchain addressesThe assets are sent from a list of addresses. For each address, the last 100 transactions are scanned for any UTXO to be included in the transaction. For easier control over the assets to be sent, we recommend that you use this method only if you have one address to send the assets from. To use this method, use the BtcTransactionFromAddress or BtcTransactionFromAddressKMS schema of the request body.
• Sending BTC from UTXOsThe assets are sent from a list of UTXOs. Each UTXO is included in the transaction. Use this method if you want to manually calculate the amount to send. To use this method, use the BtcTransactionFromUTXO or BtcTransactionFromUTXOKMS schema of the request body.

When an UTXO is entered into a transaction, the whole UTXO amount is included and must be spent. For example, address A receives two transactions, T1 with 1 BTC and T2 with 2 BTC. A transaction that consumes the UTXOs from both T1 and T2 will have an available amount of 3 BTC to spend:1 BTC (from T1) + 2 BTC (from T2) = 3 BTC (to spend in total)

You can send the assets to one or multiple recipients in one transaction. If you send the assets to multiple addresses, each address must have its own amount to receive.

Paying the gas fee and receiving the change When the amount that the recipients should receive is lower than the amount from the UTXOs, the difference between these two amounts is by default used as the gas fee for the transaction. Because this amount may be considerable and you may not want to spend it all on the gas fee, you can explicitly specify the fee amount and the blockchain address where any extra funds remaining after covering the fee will be sent (the fee and changeAddress parameters in the request body, correspondingly).

Signing a transaction When sending BTC, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

Back to top

btcTransactionFromAddressKMS()

Example

#️⃣ Execute command in terminal

✨ php -f btcTransactionFromAddressKMS.php

Request

POST /v3/bitcoin/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcTransactionFromAddressKMS(
    \Tatum\Model\BtcTransactionFromAddressKMS $btc_transaction_from_address_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Send BTC to Bitcoin addresses

Back to top

btcTransactionFromUTXO()

Example

#️⃣ Execute command in terminal

✨ php -f btcTransactionFromUTXO.php

Request

POST /v3/bitcoin/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcTransactionFromUTXO(
    \Tatum\Model\BtcTransactionFromUTXO $btc_transaction_from_utxo
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Send BTC to Bitcoin addresses

Back to top

btcTransactionFromUTXOKMS()

Example

#️⃣ Execute command in terminal

✨ php -f btcTransactionFromUTXOKMS.php

Request

POST /v3/bitcoin/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->bitcoin()->btcTransactionFromUTXOKMS(
    \Tatum\Model\BtcTransactionFromUTXOKMS $btc_transaction_from_utxokms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Send BTC to Bitcoin addresses

Back to top