diff --git a/website/src/pages/en/subgraphs/querying/_meta.js b/website/src/pages/en/subgraphs/querying/_meta.js index c933a65f7eb4..ef869373c6bb 100644 --- a/website/src/pages/en/subgraphs/querying/_meta.js +++ b/website/src/pages/en/subgraphs/querying/_meta.js @@ -1,7 +1,7 @@ import titles from './_meta-titles.json' export default { - introduction: '', + introduction: 'How to Query', 'managing-api-keys': '', 'best-practices': '', 'from-an-application': '', diff --git a/website/src/pages/en/subgraphs/querying/introduction.mdx b/website/src/pages/en/subgraphs/querying/introduction.mdx index 8094339d889d..1d00f43fe664 100644 --- a/website/src/pages/en/subgraphs/querying/introduction.mdx +++ b/website/src/pages/en/subgraphs/querying/introduction.mdx @@ -1,31 +1,45 @@ --- -title: Querying The Graph -sidebarTitle: Introduction +title: How to Query a Subgraph Using The Graph +sidebarTitle: How to Query --- -To start querying right away, visit [The Graph Explorer](https://thegraph.com/explorer). +To start querying right away, visit [The Graph Explorer](https://thegraph.com/explorer). This guide shows you how to find a [Subgraph](/subgraphs/developing/subgraphs/), generate a unique URL, and run queries. ## Overview -When a Subgraph is published to The Graph Network, you can visit its Subgraph details page on Graph Explorer and use the "Query" tab to explore the deployed GraphQL API for each Subgraph. +Querying a Subgraph with The Graph lets you access onchain data in a fast, reliable, and structured way, without running your own indexing infrastructure. This guide shows you how to get started so you can power your dapp or analysis with blockchain data. -## Specifics +## Steps -Each Subgraph published to The Graph Network has a unique query URL in Graph Explorer to make direct queries. You can find it by navigating to the Subgraph details page and clicking on the "Query" button in the top right corner. +### Step 1: Locate Your Subgraph + +After a Subgraph is published to The Graph Network, you can visit its Subgraph details page on Graph Explorer. + +Click the “Query” tab to explore the deployed GraphQL API for each Subgraph. + +### Step 2: Retrieve the Query URL + +On the Subgraph details page, select **Query** in the top right corner. Each Subgraph published to The Graph Network has a unique query URL in Graph Explorer to make direct queries. ![Query Subgraph Button](/img/query-button-screenshot.png) ![Query Subgraph URL](/img/query-url-screenshot.png) -You will notice that this query URL must use a unique API key. You can create and manage your API keys in [Subgraph Studio](https://thegraph.com/studio), under the "API Keys" section. Learn more about how to use Subgraph Studio [here](/deploying/subgraph-studio/). +> Please see the [Query API](/subgraphs/querying/graphql-api/) for a complete reference on how to query the Subgraph's entities. + +### Step 3: Manage Your API Key + +Each query URL requires a valid API key. In [Subgraph Studio](https://thegraph.com/studio), locate the **API Keys** section to create or manage your keys. Learn more about how to use Subgraph Studio [here](/subgraphs/developing/deploying/using-subgraph-studio/). + +### Step 4: Check Your Usage Plan Subgraph Studio users start on a Free Plan, which allows them to make 100,000 queries per month. Additional queries are available on the Growth Plan, which offers usage based pricing for additional queries, payable by credit card, or GRT on Arbitrum. You can learn more about billing [here](/subgraphs/billing/). -> Please see the [Query API](/subgraphs/querying/graphql-api/) for a complete reference on how to query the Subgraph's entities. +## Handling Errors -> Note: If you encounter 405 errors with a GET request to the Graph Explorer URL, please switch to a POST request instead. +If you encounter 405 errors with a GET request to the Graph Explorer URL, please switch to a POST request instead. -### Additional Resources +## Additional Resources - Use [GraphQL querying best practices](/subgraphs/querying/best-practices/). - To query from an application, click [here](/subgraphs/querying/from-an-application/).