Substreams Quick Start

Discover how to utilize ready-to-use substream packages or develop your own.

Panoramica

Integrating Substreams can be quick and easy. They are permissionless, and you can obtain a key here⁠ without providing personal information to start streaming on-chain data.

Start Building

Use Substreams Packages

There are many ready-to-use Substreams packages available. You can explore these packages by visiting the Substreams Registry⁠ and sinking them. The registry lets you search for and find any package that meets your needs.

Once you find a package that fits your needs, you can choose how you want to consume the data:

Subgraph: Configure an API to meet your data needs and host it on The Graph Network.
SQL Database⁠: Send the data to a database.
Direct Streaming⁠: Stream data directly to your application.
PubSub⁠: Send data to a PubSub topic.

Develop Your Own

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. To get started, check out the following tutorials:

To build and optimize your Substreams from zero, use the minimal path within the Dev Container.

Note: Substreams guarantees that you’ll never miss data⁠ with a simple reconnection policy.

Additional Resources

For additional guidance, reference the Tutorials⁠ and follow the How-To Guides⁠ on Streaming Fast docs.
For a deeper understanding of how Substreams works, explore the architectural overview⁠ of the data service.