subql README

The project's README from github.com/subquery/subql. As one markdown file: README.md.

Welcome to SubQuery!

Flexible, reliable, and decentralised APIs for your web3 project

SubQuery is an Open, Flexible, Fast and Universal data indexing framework for web3. Our mission is to help developers create the decentralised products of the future.

SubQuery allows teams across multiple blockchain architectures to process and query their data. The project is inspired by the growth of data protocols serving the application layer and its aim is to help web3 projects build better dApps by allowing anyone to reliably find and consume data faster. Today, anyone can query and extract blockchain data from various supported networks in only minutes and at no cost.

The future is multi-chain - SubQuery is no different. SubQuery is well on our way to support all leading blockchain networks with support for the following:

You can also use SubQuery to index data from multiple networks in any combination of the above SDKs. See our Multi-Chain Indexing Quickstart for more details.

Get Started

Create a SubQuery project

You can follow our Quick Start Guide to learn how to create, initialize, build, and publish a new SubQuery Project using the @subql/cli tool.

Learn and improve with our comprehensive documentation

Dig into every term, usecases, and best-practices that help you build a dApp which your users love. Take a look at our detailed technical documentation.

Publish your SubQuery Project to the SubQuery Network

Take advantage of the decentralized SubQuery Network to host your project without managing any infrastructure. By publishing to the SubQuery Network, you'll benefit from a reliable, scalable, cost-optimised, and censorship-resistant indexing service. Follow our comprehensive publishing guide to learn how to upload your project to the network and start leveraging its distributed infrastructure today.

Publish to managed hosting providers

If you prefer a managed hosting option for your indexer deployment, contact our managed hosting partners. Learn more.

Run your own Indexer and Query Service

Follow our guide to run your own SubQuery local node that you can use to debug, test, and run you own GraphQL server. You're going to need to a Postgres database, a node to extract chain data, and a moderately powerful computer to run the indexer in the background. You'll also use our custom-built GraphQL query service @subql/query to interact with your SubQuery project.

MCP (Beta)

You can also create, build and deploy SubQuery projects using MCP (Model Context Protocol). Our MCP integration provides all the same functionality as the CLI but works well with LLMs and AI IDEs such as Cursor.

Install MCP Server

VSCode Install MCP Server

Manual configuration

For adding SubQuery MCP into other tools, the following command needs be run by the client.

npx -y @subql/cli mcp

An example manual configuration:

"subquery": {
  "command": "npx",
  "args": ["-y", "@subql/cli", "mcp"]
}

Components

This repository contains all the core components of the SubQuery SDK as well as the Substrate implementation. It includes the following packages:

For more detail on the specific network implementations please see their respective repositories:

Other Components:

Support

We have a vibrant community of developers and users who are always ready to help. If you have any questions, issues, or need assistance, please reach out to us through the following channels:

Contribute

We love contributions and feedback from the community. To contribute the code, we suggest starting by creating an issue in our main repository so we can give you support.

SubQuery is a project built with love from the team at SubQuery all the way from New Zealand

Copyright © 2025 SubQuery Pte Ltd authors & contributors

subql (subquery/subql)

Searching Database…

18.7K ·GitHub
Subql
What is this?SubQuery is an open-source data indexing framework for web3 that lets developers query and extract blockchain data via GraphQL instead of building custom indexers from scratch.
Is this a framework I run myself, or a hosted service?It's both: an SDK/CLI framework (@subql/cli, @subql/node, @subql/query) you run yourself, and optionally a decentralized SubQuery Network or managed hosting providers where you can publish your indexer instead of running infrastructure.
How do I create and run a SubQuery project?Use the @subql/cli tool to create, initialize, build, and publish a new SubQuery project, following the Quick Start Guide.
What do I need to run my own indexer node?You need a Postgres database, a node to extract chain data, and a reasonably powerful machine to run the indexer, plus the @subql/query service to expose a GraphQL API over your indexed data.
Which blockchains are actually supported, and are they all stable?Polkadot/Substrate, Ethereum/EVM, Cosmos, Algorand, NEAR, Stellar/Soroban, Starknet, and Concordium are supported, but Solana is explicitly marked Beta.
Where does the indexer run?It runs as a self-hosted Node.js service (your own infrastructure or Docker), or you can publish it to the decentralized SubQuery Network / managed hosting partners instead.
Can I index multiple chains in one project?Yes, SubQuery supports multi-chain indexing, letting you combine data from multiple networks and SDKs into a single project.
Does it work with AI coding tools?There is a Beta MCP (Model Context Protocol) integration that exposes the same functionality as the CLI, designed to work with LLMs and AI IDEs like Cursor.
Is there a subgraph-compatible option?Yes, @subql/query-subgraph provides a Subgraph-compatible query service for SubQuery projects.
Does querying cost anything?You can query and extract data from supported networks in minutes at no cost, though running your own indexer requires your own infrastructure.
What are similar projects?fuel-core, nuvex-services, nuvex, directus, SolcQueue, anythingmcp, crystal, go-ethereum
Which topics is it in?decentralized, web3, graphql, blockchain, node, postgresql, rest-api, mcp-server, database, gplv3, framework, mcp
Creator
subquery
Size
45.9 MB
Stars
18.7K
Updated
CommitApr 01Releasenode-core/19.3.1Apr 01
Age
5y
Commits · 90 Days