A REST service for interacting with Substrate-based blockchain nodes, providing easy access to chain data and operations.
Substrate API Sidecar is a REST service that provides an HTTP interface to interact with blockchain nodes built using Substrate's FRAME framework. It allows developers to query blockchain data such as blocks, transactions, and staking information without dealing directly with low-level WebSocket RPC calls. The service handles data decoding and type management, making it easier to build applications on Substrate-based chains like Polkadot and Kusama.
Blockchain developers and teams building applications or services that need to interact with Substrate-based nodes, including those working on wallets, explorers, staking platforms, or decentralized applications (dApps) within the Polkadot ecosystem.
Developers choose Substrate API Sidecar because it abstracts the complexity of Substrate's RPC layer into a simple, stateless REST API, reducing development time and effort. Its built-in support for custom chain types, multi-chain configurations, and comprehensive metrics makes it a robust and flexible solution for production environments.
REST service that makes it easy to interact with blockchain nodes built using Substrate's FRAME framework.
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Provides HTTP endpoints for common blockchain queries like blocks and staking, abstracting away complex WebSocket RPC calls and data decoding, as highlighted in the README's key features.
Configurable to connect to relay chains, parachains, and asset hubs simultaneously via SAS_SUBSTRATE_MULTI_CHAIN_URL, enabling enhanced data access across the Polkadot ecosystem.
Supports custom chain types through environment variables like SAS_SUBSTRATE_TYPES, allowing integration with specialized blockchain deployments without code changes, as detailed in the configuration section.
Integrates with Prometheus and Loki for monitoring request metrics and logs, facilitating production deployment and debugging, with configurable endpoints and logging levels.
Requires managing numerous environment variables for node connections, types, logging, and metrics, which can be overwhelming and error-prone for setup and maintenance.
Updates like the Asset Hub migration introduced significant changes, such as array responses for endpoints with useRcBlock, forcing developers to adjust their code, as noted in the NOTICE section.
Depends on specific Node.js versions (e.g., >=18.14 for newer releases), necessitating version management and potential updates that may disrupt existing deployments.