Get started with Subgraphs

​

Install + log in

1. Create an account at app.goldsky.com.
2. Create an API key on the Settings page.
3. Install the Goldsky CLI:

   curl -fsSL https://cli.goldsky.com/install | bash
   

4. Log in with the API key created earlier:

   goldsky login
   

​

Build and deploy

5. Deploy your subgraph in one of four ways:

   • Build and deploy from source

     cd <your-subgraph-directory>
     graph build # Build your subgraph as normal.
     goldsky subgraph deploy my-subgraph/1.0.0
     

   • Migrate from The Graph’s hosted service

     goldsky subgraph deploy your-subgraph-name/your-version --from-url <your-subgraph-query-url>
     

   • Migrate from any existing endpoint

     goldsky subgraph deploy your-subgraph-name/your-version --from-ipfs-hash <deployment-hash>
     

   • Build and deploy from ABI + contract address

     goldsky subgraph deploy your-subgraph-name/your-version --from-abi <path-to-config-file>
     

​

Query endpoint

6. Access data by querying the endpoints. Use the following command to list all your subgraphs, and open the “GraphQL API” links that get printed in your browser to query your data in the GraphQL playground.

   goldsky subgraph list
   

7. Explore other Subgraph functionality through the CLI or our detailed documentation. To print the list of available commands, use:

   goldsky subgraph --help