Bitcoin Cash

Bitcoin cash endpoints

Supported methods for Bitcoin Cash. Please note that to use these methods you must specify both the API token, bch in this case, and the network on which you want to make the call. For example, if you want to know the balance of a Bitcoin Cash address in the main network, the corresponding endpoint is as follows: http://server/bch/mainnet/getAddressBalance

Return the balance of any address

post

Return the balance of any address

Body
addressstringRequired

Bitcoin Cash address

Example: tb1qm0xyymv7s07rn00dcpuk2ln890sr3my3cmpfdp
Responses
chevron-right
200

Successful response

application/json
post
/getAddressBalance
200

Successful response

Return the balance of an array of addresses

post

Return the balance of an array of addresses

Body
addressesstring[]Required

Bitcoin Cash address

Example: tb1qm0xyymv7s07rn00dcpuk2ln890sr3my3cmpfdp
Responses
chevron-right
200

Successful response

application/json
post
/getAddressesBalance
200

Successful response

Return the transaction history of any address

post

Return the transaction history of any address

Body
addressstringRequired

Bitcoin Cash address

Example: tb1qm0xyymv7s07rn00dcpuk2ln890sr3my3cmpfdp
Responses
chevron-right
200

Successful response

application/json
post
/getAddressHistory
200

Successful response

Return the transaction history of the given addresses

post

Return the transaction history of the given addresses

Body
addressesstring[]Required

Bitcoin Cash address

Example: tb1qm0xyymv7s07rn00dcpuk2ln890sr3my3cmpfdp
Responses
chevron-right
200

Successful response

application/json
post
/getAddressesHistory
200

Successful response

Returns latest block hash and index

post

Returns latest block hash and index

Body
objectOptional
Responses
chevron-right
200Success
application/json
post
/getHeight
200Success

Returns the information of any block giving its hash

post

Returns the information of any block giving its hash. If verbosity is 0, it returns a string that is serialized, hex-encoded data for block hash. If verbosity is 1, it returns an object with information about the block. If verbosity is 2, it returns an Object with information about the block and each transaction

Body
blockHashstringRequired

Bitcoin block hash

Example: 217ba61bc3921764a218f4607a8905108d2dfa4bb8e6e10af61d06e279fa069d
verbosityinteger · enumOptional

Level of information returned

Default: 2Example: 0Possible values:
Responses
chevron-right
200Success
application/json
post
/getBlockByHash
200Success

Returns the information of any block giving its height

post

Returns the information of any block giving its height. If verbosity is 0, it returns a string that is serialized, hex-encoded data for block hash. If verbosity is 1, it returns an object with information about the block. If verbosity is 2, it returns an Object with information about the block and each transaction

Body
blockNumberstringRequired

Bitcoin block height. Supports the param latest to get the last block of the chain. The param can be in decimal or hexadecimal format

Example: 1
verbosityinteger · enumOptional

Level of information returned

Default: 2Example: 0Possible values:
Responses
chevron-right
200Success
application/json
post
/getBlockByNumber
200Success

Returns if blockchain is syncing

post

Returns True if blocks are syncing and returns False if theres no synchronization or is fully sychronize

Body
objectOptional
Responses
chevron-right
200Success
application/json
post
/syncing
200Success

Returns the information of any transaction

post

Returns the information of any transaction, giving its transaction hash

Body
txHashstringRequired

Bitcoin Cash transaction hash

Example: b66d096bcb068888d4a6987870647ba9c9d2f1da9e360ddafc73efe1f26f2435
Responses
chevron-right
200

Response succesfull

application/json
post
/getTransaction
200

Response succesfull

Returns the information of an array of transactions

post

Returns the information of an array of transaction, giving its transactions hash

Body
txHashesstring[]Optional

Bitcoin Cash transaction hash

Example: b66d096bcb068888d4a6987870647ba9c9d2f1da9e360ddafc73efe1f26f2435
Responses
chevron-right
200

Response succesfull

application/json
post
/getTransactions
200

Response succesfull

Watch an address. Everytime the address changes, a http POST is sent to the URL.

post

Watch an address. Everytime the address changes, a http POST is sent to the URL.

Body
addressstringRequired

Bitcoin Cash address

Example: tb1qm0xyymv7s07rn00dcpuk2ln890sr3my3cmpfdp
callBackEndpointstringRequired

Endpoint to make callback

Example: http://localhost:8080/path
Responses
chevron-right
200

Response succesfull

application/json
post
/notify
200

Response succesfull

Returns the number of pending or confirmed transactions an address has made

post

Returns the number of pending or confirmed transactions an address has made

Body
addressstringRequired

Bitcoin Cash address

Example: tb1qm0xyymv7s07rn00dcpuk2ln890sr3my3cmpfdp
pendingbooleanRequired

Get pending or confirmed transactions

Example: true
Responses
chevron-right
200

Response succesfull

application/json
post
/getAddressTransactionCount
200

Response succesfull

Returns the number of pending or confirmed transactions several addresses have made

post

Returns the number of pending or confirmed transactions several addresses have made

Body
Responses
chevron-right
200

Response succesfull

application/json
post
/getAddressesTransactionCount
200

Response succesfull

Estimate fee by confirmations

post

Estimates the approximate fee per kilobyte needed for a transaction to begin confirmation within "confirmations" blocks if possible and return the number of blocks for which the estimate is valid.

Body
confirmationsstringRequired

Number of confirmations, or -1 if the block is not on the main chain

Example: 5
Responses
chevron-right
200

Response succesfull

application/json
post
/getFeePerByte
200

Response succesfull

Returns the UTXO list of any address

post

Returns the UTXO list of any address

Body
addressstringRequired

Bitcoin Cash address

Example: tb1qm0xyymv7s07rn00dcpuk2ln890sr3my3cmpfdp
Responses
chevron-right
200

Successful response

application/json
post
/getAddressUnspent
200

Successful response

Returns the UTXO list of the given addresses

post

Returns the UTXO list of the given addresses

Bodystring[]
string[]Optional

Bitcoin Cash address

Example: tb1qm0xyymv7s07rn00dcpuk2ln890sr3my3cmpfdp
Responses
chevron-right
200

Successful response

application/json
post
/getAddressesUnspent
200

Successful response

Returns transaction

post

Returns raw schema of any transaction. If verbosity is set to true, transaction object is returned, otherwise raw transaction will be returned

Body
txHashstringRequired

Bitcoin Cash transaction hash

Example: b66d096bcb068888d4a6987870647ba9c9d2f1da9e360ddafc73efe1f26f2435
verbositybooleanOptional

Level of information returned

Default: falseExample: false
Responses
chevron-right
200

Response succesfull

application/json
post
/getTransactionHex
200

Response succesfull

Broadcasts a transaction to the network

post

Broadcasts a transaction to the network

Body
rawTransactionstringRequired

Raw transaction (Hex format)

Example: 01000000000101c0d72dcba53996705fff03465f23b594ec934c29a7645045abe07385a58470a101000000171600140e2c5153cf335a150df44013c4572cd52a70aa8bfdffffff020100000000000000165114391234a573b02814f03ff59673c86b68c2869537091839000000000017a914004863ca1a414c0a174b2666bf067c69524aabd4870247304402201cc95f4683cf0fc46923b1a7f78454adbd57150268ab4960efd3c7df6fc83e22022035917f815bfd80052812b8b1559d314f2459e5876abe9bf1b36f8d4e0dda6e0e012102c379336fce4796dc9bbaa953ef5003e070853b2bf53bdf00b9cfb83e3e1ef84f00000000
Responses
chevron-right
200

Response succesfull

application/json
post
/broadcastTransaction
200

Response succesfull

Last updated