Skip to content

bitquery/bitquery-protobuf

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

⚡ Stream Real time Blockchain Data via Kafka Protobuf

bitquery-protobuf is an official npm package for consuming Kafka Protobuf messages from Bitquery — a leading on-chain data provider offering blockchain data APIs, WebSocket streams, and Kafka Protobuf feeds for real-time analytics.

This library allows developers to easily consume, decode, and handle low-latency blockchain event streams without the hassle of managing .proto files or Kafka configurations in real time.


🚀 Overview

bitquery-protobuf simplifies working with Bitquery’s Protobuf Kafka Streams, which deliver real-time on-chain data from multiple blockchains (Bitcoin, Ethereum, BSC, and more).
It’s perfect for developers building crypto dashboards, data pipelines, trading bots, or blockchain analytics applications requiring ultra-low latency.

👉 Learn more about Bitquery’s Kafka Streaming Concepts in the
official documentation.


⚙️ Installation

Install the npm package directly:

npm install bitquery-protobuf

You can find it on npm here: 📦 bitquery-protobuf on npm


🧩 Usage Example

Create a new JavaScript file, e.g., test.js, and add the following:

const { runProto } = require('bitquery-protobuf');

runProto("<username>", "<password>", "topic");

Then run the file:

node test.js

Parameters

  • <username> and <password> — Credentials for accessing the Bitquery Kafka Stream. To obtain your credentials, contact our team at 📧 sales@bitquery.io or via Telegram.

  • <topic> — The topic of the Kafka Protobuf stream you wish to subscribe to (e.g., Bitcoin transactions, Ethereum events, etc.).

This package serves as a “Getting Started” utility for testing and demonstrating real time Bitquery Protobuf streams. For custom or production-grade solutions, contact the Bitquery team for tailored support: 🌐 Contact Bitquery or fill out the form


🧾 Example Topics

You can explore available topics and blockchain event types here: 🔗 Bitquery Streaming Documentation


🤝 Contributing

We welcome community contributions! Please report issues or submit pull requests on the official repository: 👉 bitquery-protobuf GitHub Repository


🧭 Documentation Resources

Resource Description Link
Kafka Streaming Concepts Learn about how Bitquery streams blockchain data Read Docs
Protobuf Kafka (Bitcoin Example) Example for decoding Bitcoin data streams View Example
Bitquery API Hub Explore blockchain data APIs and GraphQL queries Explore APIs
Bitquery Home Learn more about Bitquery and its data products Visit Bitquery.io

📜 License

ISC License © 2025 bitquery-protobuf

This package is open-source and free to use. Attribution to Bitquery is appreciated.


✨ Built with Bitquery

Delivering real-time blockchain data through GraphQL, WebSocket, and Kafka Protobuf streams. Signup today.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •