Getting Started
Last updated
Last updated
Integrating Substreams can be quick and easy. This guide will help you get started with consuming ready-made Substreams packages or developing your own. Substreams are permissionless. Grab a key here, no personal information required, and start streaming on-chain data.
There are many ready-to-use Substreams packages available. You can explore these packages using the Substreams Registry. The registry lets you search for and find packages that meet your needs.
Once you find a package that fits your needs, you can choose how you want to consume the data:
SQL Database: Send the data to a database.
Subgraph: Configure an API to meet your data needs and host it on The Graph Network.
Direct Streaming: Stream data directly to your application.
PubSub: Send data to a PubSub topic.
If you can't find a Substreams package that meets your specific needs, you can develop your own. Substreams are built with Rust, so you’ll write functions that extract and filter the data you need from the blockchain. The easiest way to get started is by referring to the tutorial section, enabling you to quickly filter data:
To build and optimize your Substreams from zero, use the minimal path within the Dev Container to setup your environment and follow the How-To Guides.
Substreams Reliability Guarantees: With a simple reconnection policy, Substreams guarantees you'll Never Miss Data.
Substreams Architecture: For a deeper understanding of how Substreams works, explore the architectural overview of the data service.
Supported Networks: Check-out which endpoints are supported here.
