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
这是什么？SubQuery 是一个面向 web3 的开源数据索引框架，让开发者可以通过 GraphQL 查询和提取区块链数据，无需从零开始构建自定义索引器。
这是我自己运行的框架，还是托管服务？两者皆是：它是一个你自己运行的 SDK/CLI 框架（@subql/cli、@subql/node、@subql/query），同时也可以选择去中心化的 SubQuery Network 或托管服务商，将索引器发布到那里，无需自行搭建基础设施。
如何创建并运行一个 SubQuery 项目？按照快速入门指南，使用 @subql/cli 工具创建、初始化、构建并发布一个新的 SubQuery 项目。
运行自己的索引节点需要什么？你需要一个 Postgres 数据库、一个用于提取链上数据的节点、一台性能足够强的机器来运行索引器，以及 @subql/query 服务，用于通过 GraphQL API 对外提供已索引的数据。
目前支持哪些区块链？它们都稳定吗？支持 Polkadot/Substrate、Ethereum/EVM、Cosmos、Algorand、NEAR、Stellar/Soroban、Starknet 和 Concordium，但 Solana 明确标注为 Beta 版。
索引器在哪里运行？它以自托管的 Node.js 服务形式运行（部署在你自己的基础设施或 Docker 中），也可以改为发布到去中心化的 SubQuery Network 或托管合作服务商。
我可以在一个项目中索引多条链吗？可以，SubQuery 支持多链索引，可以将多个网络和 SDK 的数据合并到同一个项目中。
它能和 AI 编程工具配合使用吗？目前有一个 Beta 版的 MCP（Model Context Protocol，模型上下文协议）集成，它提供与 CLI 相同的功能，旨在与大语言模型以及 Cursor 等 AI IDE 配合使用。
是否有兼容 Subgraph 的选项？有，@subql/query-subgraph 为 SubQuery 项目提供与 Subgraph 兼容的查询服务。
查询需要花钱吗？你可以在几分钟内免费查询并提取受支持网络的数据，但运行自己的索引器则需要自备基础设施。
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, database, mcp-server, 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