Bitcoin Address Indexing Service

Bitcoin Address Indexing Service is a web service providing Bitcoin address-related APIs for queries.

Table of Contents

• Bitcoin Address Indexing Service
  • Table of Contents
  • How does it work
  • Prerequisite
  • Building and test
  • Run
  • Available APIs
    • /addr/address:/balance
    • /addr/address:/tx
    • /addr/address:/utxo
  • Author
  • License

How does it work

All address relevant information is powered by btcd node with method searchrawtransactions.
By taking advantage of caching and persistent data storage such as Redis, MongoDB, it makes a lot improvements on performance for faster response time compared to btcd.
RabbitMQ takes a role of messaging broker, exchanging messages between btcd-address-indexing-worker and btcd-address-web-service.
btcd-address-indexing-worker leverages the above technique solutions to index additional address relevant information for performance optimization. It also serves requests from btcd-address-indexing-service.

Disclaimer: It is still in an early stage of development. For personal purposes only. It takes no responsibility on working in commercial purpose.

Prerequisite

• Nodejs >= v10
• Yarn
• Go >= v1.12
• btcd >= v0.12.0-beta
• MongoDB >= v3.6
• RabbitMQ >= v3.8
• Redis >= v5.0
• btcd-address-indexing-worker

Building and test

• Build

$ yarn install --frozen-lockfile

Run

• For development

$ yarn start

Available APIs

/addr/address:/balance

/addr/address:/tx

/addr/address:/utxo

Author

Jeremy Li

License

MIT License