Skip to content

A Ruby client for the Blockchair Blockchain explorer

License

Notifications You must be signed in to change notification settings

ArizenHQ/blockchair-client

Repository files navigation

Blockchair Client

Blockchair Client is an interface to interact with Blockchair's API. Blockchair is a free blockchain explorer supporting a number of cryptos, including among others Bitcoin, BitcoinCash, BitcoinSV, Ethereum and Litecoin, even with Bech32 adresses.

Installation

Bundle and install the gem as a standalone

  • Clone the repository
  • Install Ruby 2.5.0
  • Execute bundle install

Configuration

You can pass multiple variables that will be used in the configuration.

As an initializer

BlockchairClient.configure do |config|
  config.currency  = 'LTC'
end

Directly in the application Instance

You can also pass any of those options inline when loading an instance of BlockchairClient.

  client = BlockchairClient.new({currency: 'LTC'})

List of endpoints :

Address (docs)

  client.address(CRYPTO_ADDRESS).query
Address Transactions
  client.address(CRYPTO_ADDRESS).transactions
Address Type
client.address(CRYPTO_ADDRESS).type
Address Script_hex
client.address(CRYPTO_ADDRESS).script_hex
Address Balance
client.address(CRYPTO_ADDRESS).balance
Address Balance_usd
client.address(CRYPTO_ADDRESS).balance_usd
Address Received
client.address(CRYPTO_ADDRESS).received
Address Received_usd
client.address(CRYPTO_ADDRESS).received_usd
Address Spent
client.address(CRYPTO_ADDRESS).spent
Address Spent_usd
client.address(CRYPTO_ADDRESS).spent_usd
Address Output_count
client.address(CRYPTO_ADDRESS).output_count
Address Unspent_output_count
client.address(CRYPTO_ADDRESS).unspent_output_count
Address First_seen_receiving
client.address(CRYPTO_ADDRESS).first_seen_receiving
Address Last_seen_receiving
client.address(CRYPTO_ADDRESS).last_seen_receiving
Address First_seen_spending
client.address(CRYPTO_ADDRESS).first_seen_spending
Address Last_seen_spending
client.address(CRYPTO_ADDRESS).last_seen_spending
Address Transaction_count
client.address(CRYPTO_ADDRESS).transaction_count

Transaction (docs)

  client.transaction(CRYPTO_TX).query
Transaction confirmations
  client.transaction(CRYPTO_TX).confirmations
Transaction Inputs
  client.transaction(CRYPTO_TX).inputs
Transaction Outputs
  client.transaction(CRYPTO_TX).outputs
Transaction Block_id
client.transaction(CRYPTO_TX).block_id
Transaction Id
client.transaction(CRYPTO_TX).id
Transaction Hash
client.transaction(CRYPTO_TX).hash
Transaction Date
client.transaction(CRYPTO_TX).date
Transaction Time
client.transaction(CRYPTO_TX).time
Transaction Size
client.transaction(CRYPTO_TX).size
Transaction Weight
client.transaction(CRYPTO_TX).weight
Transaction Version
client.transaction(CRYPTO_TX).version
Transaction Lock_time
client.transaction(CRYPTO_TX).lock_time
Transaction Is_coinbase
client.transaction(CRYPTO_TX).is_coinbase
Transaction Has_witness
client.transaction(CRYPTO_TX).has_witness
Transaction Input_count
client.transaction(CRYPTO_TX).input_count
Transaction Output_count
client.transaction(CRYPTO_TX).output_count
Transaction Input_total
client.transaction(CRYPTO_TX).input_total
Transaction Input_total_usd
client.transaction(CRYPTO_TX).input_total_usd
Transaction Output_total
client.transaction(CRYPTO_TX).output_total
Transaction Output_total_usd
client.transaction(CRYPTO_TX).output_total_usd
Transaction Fee
client.transaction(CRYPTO_TX).fee
Transaction Fee_usd
client.transaction(CRYPTO_TX).fee_usd
Transaction Fee_per_kb
client.transaction(CRYPTO_TX).fee_per_kb
Transaction Fee_per_kb_usd
client.transaction(CRYPTO_TX).fee_per_kb_usd
Transaction Fee_per_kwu
client.transaction(CRYPTO_TX).fee_per_kwu
Transaction Fee_per_kwu_usd
client.transaction(CRYPTO_TX).fee_per_kwu_usd
Transaction Cdd_total
client.transaction(CRYPTO_TX).cdd_total

Transactions (docs)

client.transactions(CRYPTO_TX1, CRYPTO_TX2).query
First Transaction Hash
client.transactions(CRYPTO_TX1, CRYPTO_TX2)[CRYPTO_TX1].tx_hash
Second Transaction Hash
client.transactions(CRYPTO_TX, CRYPTO_TX2)[CRYPTO_TX2].tx_hash

The behaviour is the same as for Transaction for the rest of the cases.

First Transaction Inputs
client.transactions(CRYPTO_TX1, CRYPTO_TX2).inputs[CRYPTO_TX1]
First Transaction Outputs
client.transactions(CRYPTO_TX1, CRYPTO_TX2).outputs[CRYPTO_TX1]
First Transaction Confirmations
client.transactions(CRYPTO_TX1, CRYPTO_TX2).confirmations[CRYPTO_TX1]

About

A Ruby client for the Blockchair Blockchain explorer

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages