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
Что это такое?SubQuery — это открытый фреймворк для индексации данных в web3, который позволяет разработчикам получать и извлекать данные блокчейна через GraphQL, не создавая собственные индексаторы с нуля.
Это фреймворк, который я запускаю сам, или облачный сервис?И то, и другое: это фреймворк на базе SDK и CLI (@subql/cli, @subql/node, @subql/query), который вы запускаете самостоятельно, а также по желанию децентрализованная сеть SubQuery Network или управляемые хостинг-провайдеры, куда можно опубликовать свой индексатор вместо того, чтобы развертывать инфраструктуру самому.
Как создать и запустить проект SubQuery?Используйте инструмент @subql/cli, чтобы создать, инициализировать, собрать и опубликовать новый проект SubQuery, следуя инструкции Quick Start Guide.
Что нужно, чтобы запустить собственный узел-индексатор?Нужны база данных 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 в один проект.
Работает ли это с ИИ-инструментами для программирования?Есть бета-интеграция MCP (Model Context Protocol), которая предоставляет тот же функционал, что и CLI, и рассчитана на работу с LLM и ИИ-IDE, например Cursor.
Есть ли вариант, совместимый с Subgraph?Да, @subql/query-subgraph предоставляет совместимый с Subgraph сервис запросов для проектов SubQuery.
Стоят ли запросы денег?Запрашивать и извлекать данные из поддерживаемых сетей можно за несколько минут и бесплатно, однако для запуска собственного индексатора нужна собственная инфраструктура.
Creator
subquery
Size
45.9 MB
Stars
18.7K
Age
5y
Commits · 90 Days