SubQuery is a fast, flexible, and reliable open-source data indexer that provides you with custom APIs for your web3 project across all of our supported networks. To learn about how to get started with SubQuery, visit our docs.
If you get stuck, find out how to get help below.
The simplest way to run your project is by running yarn dev
or npm run-script dev
. This does all of the following:
yarn codegen
- Generates types from the GraphQL schema definition and contract ABIs and saves them in the/src/types
directory. This must be done after each change to theschema.graphql
file or the contract ABIsyarn build
- Builds and packages the SubQuery project into the/dist
directorydocker-compose pull && docker-compose up
- Runs a Docker container with an indexer, PostgeSQL DB, and a query service. This requires Docker to be installed and running locally. The configuration for this container is set from yourdocker-compose.yml
You can observe the three services start, and once all are running (it may take a few minutes on your first start), please open your browser and head to http://localhost:3000 - you should see a GraphQL playground showing with the schemas ready to query. Read the docs for more information or explore the possible service configuration for running SubQuery.
For this project, you can try to query with the following GraphQL code to get a taste of how it works.
{
query {
transfers(first: 5, orderBy: BLOCK_NUMBER_DESC) {
totalCount
nodes {
id
date
blockNumber
toId
fromId
amount
}
}
accounts(first: 5, orderBy: SENT_TRANSFERS_COUNT_DESC) {
nodes {
id
sentTransfers(first: 5, orderBy: BLOCK_NUMBER_DESC) {
totalCount
nodes {
id
toId
amount
}
}
lastTransferBlock
}
}
}
}