Quick Start

This guide will quickly take you through how to initialize, create, and deploy your subgraph to the Subgraph Studio or the hosted service.

Ensure that your subgraph will be indexing data from a supported network.

This guide is written assuming that you have:

  • A smart contract address on the network of your choice
  • GRT to curate your subgraph
  • A crypto wallet

1. Create a subgraph on Subgraph Studio

Link to this section

Go to the Subgraph Studio https://thegraph.com/studio/ and connect your wallet.

Once connected, you can begin by clicking “create a subgraph.” Select the network of your choice and click continue.

2. Install the Graph CLI

Link to this section

The Graph CLI is written in JavaScript and you will need to have either npm or yarn installed to use it.

On your local machine, run one of the following commands:

$ npm install -g @graphprotocol/graph-cli
# Yarn
$ yarn global add @graphprotocol/graph-cli

3. Initialize your Subgraph

Link to this section

You can find commands for your specific subgraph on the subgraph page in Subgraph Studio.

When you initialize your subgraph, the CLI tool will ask you for the following information:

  • Protocol: choose the protocol your subgraph will be indexing data from
  • Subgraph slug: create a name for your subgraph. Your subgraph slug is an identifier for your subgraph.
  • Directory to create the subgraph in: choose your local directory
  • Ethereum network(optional): you may need to specify which EVM-compatible network your subgraph will be indexing data from
  • Contract address: Locate the smart contract address you’d like to query data from
  • ABI: If the ABI is not autopopulated, you will need to input it manually as a JSON file
  • Start Block: it is suggested that you input the start block to save time while your subgraph indexes blockchain data. You can locate the start block by finding the block where your contract was deployed.
  • Contract Name: input the name of your contract
  • Index contract events as entities: it is suggested that you set this to true as it will automatically add mappings to your subgraph for every emitted event
  • Add another contract(optional): you can add another contract

Initialize your subgraph from an existing contract by running the following command:

graph init --studio <SUBGRAPH_SLUG>

See the following screenshot for an example for what to expect when initializing your subgraph:

Subgraph command

4. Write your Subgraph

Link to this section

The previous commands create a scaffold subgraph that you can use as a starting point for building your subgraph. When making changes to the subgraph, you will mainly work with three files:

  • Manifest (subgraph.yaml) - The manifest defines what datasources your subgraphs will index.
  • Schema (schema.graphql) - The GraphQL schema defines what data you wish to retrieve from the subgraph.
  • AssemblyScript Mappings (mapping.ts) - This is the code that translates data from your datasources to the entities defined in the schema.

For more information on how to write your subgraph, see Creating a Subgraph.

5. Deploy to the Subgraph Studio

Link to this section

Once your subgraph is written, run the following commands:

$ graph codegen
$ graph build
  • Authenticate and deploy your subgraph. The deploy key can be found on the Subgraph page in Subgraph Studio.
$ graph auth --studio <DEPLOY_KEY>
$ graph deploy --studio <SUBGRAPH_SLUG>

You will be asked for a version label. It's strongly recommended to use semver for versioning like 0.0.1. That said, you are free to choose any string as version such as:v1, version1, asdf.

6. Test your subgraph

Link to this section

You can test your subgraph by making a sample query in the playground section.

The logs will tell you if there are any errors with your subgraph. The logs of an operational subgraph will look like this:

Subgraph logs

If your subgraph is failing, you can query the subgraph health by using the GraphiQL Playground. Note that you can leverage the query below and input your deployment ID for your subgraph. In this case, Qm... is the deployment ID (which can be located on the Subgraph page under Details). The query below will tell you when a subgraph fails, so you can debug accordingly:

indexingStatuses(subgraphs: ["Qm..."]) {
fatalError {
block {
nonFatalErrors {
block {
chains {
chainHeadBlock {
earliestBlock {
latestBlock {
lastHealthyBlock {

7. Publish Your Subgraph to The Graph’s Decentralized Network

Link to this section

Once your subgraph has been deployed to the Subgraph Studio, you have tested it out, and are ready to put it into production, you can then publish it to the decentralized network.

In the Subgraph Studio, click on your subgraph. On the subgraph’s page, you will be able to click the publish button on the top right.

Select the network you would like to publish your subgraph to. It is recommended to publish subgraphs to Arbitrum One to take advantage of the faster transaction speeds and lower gas costs.

Before you can query your subgraph, Indexers need to begin serving queries on it. In order to streamline this process, you can curate your own subgraph using GRT.

At the time of writing, it is recommended that you curate your own subgraph with 10,000 GRT to ensure that it is indexed and available for querying as soon as possible.

To save on gas costs, you can curate your subgraph in the same transaction that you published it by selecting this button when you publish your subgraph to The Graph’s decentralized network:

Subgraph publish

8. Query your Subgraph

Link to this section

Now, you can query your subgraph by sending GraphQL queries to your subgraph’s Query URL, which you can find by clicking on the query button.

You can query from your dapp if you don't have your API key via the free, rate-limited temporary query URL that can be used for development and staging.

For more information about querying data from your subgraph, read more here.

Edit page

L2 Transfer Tools Guide
Supported Networks