# 0xAPI reference
Source: https://docs.ormilabs.com/api-reference/0xAPI/overview



## Introduction

0xAPI gives you instant access to structured, decoded blockchain data - both real-time and historical. Whether you’re building wallets, analytics dashboards, or DeFi apps, 0xAPI eliminates the need to run your own indexers with one unified, high-performance API.

## Components of 0xAPI

<div
  className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/api-reference/0xAPI/blocks/get-blocks"
    style={{ 
  textDecoration: 'none', 
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    maxWidth: '380px',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Blocks</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        An API for querying blocks, and searching for block number.
      </p>
    </div>
  </a>

  {" "}

  <a
    href="/api-reference/0xAPI/events/get-events"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "flex",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: "200px",
    display: "flex",
    flexDirection: "column",
    maxWidth: "380px",
    width: "100%",
  }}
    >
      <div className="flex items-center mb-4">
        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Events
        </div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">An API for fetching smart contract event logs.</p>
    </div>
  </a>

  {" "}

  <a
    href="/api-reference/0xAPI/nfts/get-nft-collection-traits"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "flex",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: "200px",
    display: "flex",
    flexDirection: "column",
    maxWidth: "380px",
    width: "100%",
  }}
    >
      <div className="flex items-center mb-4">
        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          NFT
        </div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">An API for managing and searching NFT contract, metadata, and token.</p>
    </div>
  </a>
</div>

<div
  className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/api-reference/0xAPI/wallet/get-nfts-by-wallet"
    style={{ 
  textDecoration: 'none', 
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    maxWidth: '380px',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Wallet</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        An API for fetching a complete viow of a wallet across tokens, and NFTs.
      </p>
    </div>
  </a>

  {" "}

  <a
    href="/api-reference/0xAPI/tokens/get-token-holders"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "flex",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: "200px",
    display: "flex",
    flexDirection: "column",
    maxWidth: "380px",
    width: "100%",
  }}
    >
      <div className="flex items-center mb-4">
        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Tokens
        </div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">An API for searching token metadata, token holders, wallet balances, and more.</p>
    </div>
  </a>

  {" "}

  <a
    href="/api-reference/0xAPI/transactions/get-transactions"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "flex",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: "200px",
    display: "flex",
    flexDirection: "column",
    maxWidth: "380px",
    width: "100%",
  }}
    >
      <div className="flex items-center mb-4">
        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Transactions
        </div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">An API for searching transaction hash, transaction by account, and more.</p>
    </div>
  </a>
</div>


# CLI reference
Source: https://docs.ormilabs.com/api-reference/0xGraph/cli/reference

A detailed list of commands for The Graph CLI, including their purposes, use cases, and examples.

## Initializing a subgraph

```
graph init
```

### Purpose

Creates a new Subgraph project using an example template or an existing smart contract.

### Use case

* Use this command when starting a new Subgraph project.
* It sets up the necessary folder structure, configuration files `subgraph.yaml`, and example code.
* You can specify a contract address and network to scaffold a Subgraph tailored to a specific smart contract.

### Example

```bash  theme={null}
graph init --from-contract <CONTRACT_ADDRESS> --network mainnet
```

## Generating code from subgraph files

```
graph codegen
```

### Purpose

Generates AssemblyScript types for smart contract ABIs and the Subgraph schema.

### Use case

* Use this command after making changes to your `schema.graphql` file or when adding/updating smart contract ABIs.
* It creates type-safe classes that make it easier to interact with blockchain data in your mappings.

## Build your subgraph

```
graph build
```

### Purpose

Compiles the Subgraph to WebAssembly (WASM), preparing it for deployment.

### Use Case

* Run this command after completing your mappings and configuration.
* It ensures your Subgraph is ready for deployment by converting it into the WASM format required by 0xGraph.

## Deploy your subgraph

```
graph deploy
```

### Purpose

Deploys the compiled Subgraph to the 0xGraph hosting service.

### Use case

* After building your Subgraph, use this command to upload and activate it on 0xGraph.
* Specify the deployment target (e.g., staging or production) and the Subgraph name.

### Example

```bash  theme={null}
graph deploy <your_subgraph> --node 
https://api.subgraph.ormilabs.com/deploy 
--ipfs https://api.subgraph.ormilabs.com/ipfs 
--deploy-key <your_api_key>
```

## Run the subgraph locally

```
graph local
```

### Purpose

Runs a local test environment (e.g., using Ganache or Hardhat) to test the Subgraph with simulated blockchain data.

### Use Case

* Use this command when developing and testing your Subgraph locally.
* It allows you to simulate blockchain events and validate mappings.
* Ideal for testing without deploying to a live environment.

## Executes unit tests

```
graph test
```

### Purpose

Downloads and runs the Matchstick Rust binary to execute unit tests for a Subgraph.

### Use Case

* Use this command to write and run unit tests for your mappings and ensure that your Subgraph logic works correctly.
* Matchstick is a testing framework built specifically for The Graph.

## Add new data source

```
graph add
```

### Purpose

Adds a new data source to your Subgraph’s manifest file (subgraph.yaml) and updates relevant files such as schema.graphql, ABIs, and mappings.

### Use case

* Use this command when adding additional smart contracts or data sources to your Subgraph.
* It automates the process of updating your Subgraph configuration and related files.

### Example

```bash  theme={null}
graph add <CONTRACT_NAME> --from-contract <CONTRACT_ADDRESS>
```

<Info>
  Ensure you have the latest version of The Graph CLI installed to avoid potential issues with deprecated or updated commands.
</Info>


# 0xGraph API reference
Source: https://docs.ormilabs.com/api-reference/0xGraph/overview



## Introduction

0xGraph is a next-generation hosted Subgraph solution, fully compatible with The Graph and built for real-time, high-throughput blockchain applications. It lets developers index, and query smart contract data at sub-second latency - without managing infrastructure.

## References

<div
  className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/api-reference/0xGraph/cli/reference"
    style={{ 
  textDecoration: 'none', 
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    maxWidth: '380px',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">CLI</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Deploy and manage your subgraphs using CLI, fully compatible with The Graph’s workflow for seamless setup and migration.
      </p>
    </div>
  </a>

  <a
    href="/api-reference/0xGraph/tags/create-tag"
    style={{ 
  textDecoration: 'none', 
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    maxWidth: '380px',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Tags</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Assign and manage tags to version your subgraphs, enabling hot-swaps and updates without changing endpoints.
      </p>
    </div>
  </a>

  <a
    href="/api-reference/0xGraph/subgraph/remove-subgraph"
    style={{ 
  textDecoration: 'none', 
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    maxWidth: '380px',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Subgraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Manage your subgraphs using the CLI including removing your subgraph.
      </p>
    </div>
  </a>
</div>


# Get Wallet Balances
Source: https://docs.ormilabs.com/api-reference/0xapi/tokens/get-wallet-balances

open-api/0xapi.yaml get /v2/{chain_name}/wallets/{wallet_address}/balances
Retrieves a paginated list of token balances for a specific wallet address. This can include both fungible tokens like ERC-20 tokens and native currency and non-fungible tokens like ERC-721 and ERC-1155. For non-fungible tokens, each token is grouped under its collection contract address.



# Get Transactions By Wallet
Source: https://docs.ormilabs.com/api-reference/0xapi/transactions/get-transactions-by-wallet

open-api/0xapi.yaml get /v2/{chain_name}/wallets/{wallet_address}/transactions
Retrieves a paginated list of all transactions associated with a specific wallet address.



# Get Wallet Transaction Summary
Source: https://docs.ormilabs.com/api-reference/0xapi/transactions/get-wallet-transaction-summary

open-api/0xapi.yaml get /v2/{chain_name}/wallets/{wallet_address}/transactions/summary
Provides a summary of a wallet's transaction history, including the total transaction count and details of the first and last transactions.



# Get NFTs By Wallet
Source: https://docs.ormilabs.com/api-reference/0xapi/wallet/get-nfts-by-wallet

open-api/0xapi.yaml get /v2/{chain_name}/wallets/{wallet_address}/nfts
Fetches a paginated list of all Non-Fungible Tokens (NFTs) currently owned by a specific wallet address.



# Get Blocks
Source: https://docs.ormilabs.com/api-reference/blocks/get-blocks

open-api/0xapi.yaml get /v2/{chain_name}/blocks
Retrieves a paginated list of the most recent blocks on the blockchain.



# Lookup Block By Number
Source: https://docs.ormilabs.com/api-reference/blocks/lookup-block-by-number

open-api/0xapi.yaml get /v2/{chain_name}/blocks/{block_number}
Retrieves the full details of a specific block, identified by its block number or the "latest" tag.



# Lookup Block By Timestamp
Source: https://docs.ormilabs.com/api-reference/blocks/lookup-block-by-timestamp

open-api/0xapi.yaml get /v2/{chain_name}/blocks/by-timestamp/{timestamp}
Finds and retrieves the details of the closest block to a given timestamp. The lookup can be directed to find the block immediately before or after the specified time.



# Create tag
Source: https://docs.ormilabs.com/api-reference/create-tag

open-api/0xgraph.yaml post /public_api/v1/0xGraph/tags/create-tag
Create a new tag for a subgraph version



# Delete tag
Source: https://docs.ormilabs.com/api-reference/delete-tag

open-api/0xgraph.yaml post /public_api/v1/0xGraph/tags/delete-tag
Delete an existing tag from a subgraph



# Get Events
Source: https://docs.ormilabs.com/api-reference/events/get-events

open-api/0xapi.yaml get /v2/{chain_name}/events
Fetches a paginated list of smart contract event logs. Can be filtered by contract address and event signatures (topic0).



# Get NFT Collection Traits
Source: https://docs.ormilabs.com/api-reference/nfts/get-nft-collection-traits

open-api/0xapi.yaml get /v2/{chain_name}/collections/{collection_address}/traits
Retrieves a list of all trait types and their values for a specific NFT collection.



# Get NFTs By Collection
Source: https://docs.ormilabs.com/api-reference/nfts/get-nfts-by-collection

open-api/0xapi.yaml get /v2/{chain_name}/collections/{collection_address}/nfts
Fetches a paginated list of all NFTs that belong to a specific collection contract address.



# Lookup NFT By Token ID
Source: https://docs.ormilabs.com/api-reference/nfts/lookup-nft-by-token-id

open-api/0xapi.yaml get /v2/{chain_name}/collections/{collection_address}/nfts/{token_id}
Retrieves detailed information about a specific NFT token within a collection, identified by its token ID.



# API reference by product
Source: https://docs.ormilabs.com/api-reference/overview



<script
  dangerouslySetInnerHTML={{__html: `
(function() {
  function hideSidebarSections() {
    const headers = document.querySelectorAll('.sidebar-group-header');
    
    headers.forEach(header => {
      const title = header.querySelector('#sidebar-title');
      if (title && (title.textContent.includes('0xGraph') || title.textContent.includes('0xAPI'))) {
        header.style.display = 'none';
        
        let next = header.nextElementSibling;
        while (next && !next.classList.contains('sidebar-group-header')) {
          next.style.display = 'none';
          next = next.nextElementSibling;
        }
      }
    });
  }
  
  hideSidebarSections();
  setTimeout(hideSidebarSections, 100);
  setTimeout(hideSidebarSections, 500);
  
  const observer = new MutationObserver(hideSidebarSections);
  observer.observe(document.body, { childList: true, subtree: true });
})();
`}}
/>

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/api-reference/0xGraph/overview"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round">
            <path d="M19.5 7a24 24 0 0 1 0 10" />

            <path d="M4.5 7a24 24 0 0 0 0 10" />

            <path d="M7 19.5a24 24 0 0 0 10 0" />

            <path d="M7 4.5a24 24 0 0 1 10 0" />

            <rect x="17" y="17" width="5" height="5" rx="1" />

            <rect x="17" y="2" width="5" height="5" rx="1" />

            <rect x="2" y="17" width="5" height="5" rx="1" />

            <rect x="2" y="2" width="5" height="5" rx="1" />
          </svg>
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">0xGraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Explore references to the GraphQL API for Ormi subgraphs.
      </p>
    </div>
  </a>

  <a
    href="/api-reference/0xAPI/overview"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-left-right-ellipsis.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=88cd9ce90f4df3943937e4bbc23c4b5f" alt="0xAPI icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/chevrons-left-right-ellipsis.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-left-right-ellipsis.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=b94ea02f3900a039a2d24e2c9e22cca9 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-left-right-ellipsis.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=0d13d22d4dbe716e6d086e4c280b49ce 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-left-right-ellipsis.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4495343aa18a244e16dfdec8e3d17b1c 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-left-right-ellipsis.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=0c3dd282e88a603fb0d8467082305583 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-left-right-ellipsis.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=23c24d034a865bf11d123056ff98ee89 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-left-right-ellipsis.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=a0ac54b525b152c61042ba0ee4a78d50 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">0xAPI</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Discover available data endpoints, their capabilities, and references.
      </p>
    </div>
  </a>
</div>


# Query tag
Source: https://docs.ormilabs.com/api-reference/query-tag

open-api/0xgraph.yaml post /public_api/v1/0xGraph/tags/query-tag
Retrieve information about a specific tag for a subgraph



# Remove subgraph
Source: https://docs.ormilabs.com/api-reference/remove-subgraph

open-api/0xgraph.yaml post /public_api/v1/0xGraph/subgraph/remove-subgraph
Remove a subgraph deployment



# Get Token Holders
Source: https://docs.ormilabs.com/api-reference/tokens/get-token-holders

open-api/0xapi.yaml get /v2/{chain_name}/tokens/{token_address}/holders
Returns a paginated list of all addresses holding a specific token, along with their balances.



# Get Wallet Daily Portfolio
Source: https://docs.ormilabs.com/api-reference/tokens/get-wallet-daily-portfolio

open-api/0xapi.yaml get /v2/{chain_name}/wallets/{wallet_address}/portfolio/daily
Provides a day-by-day historical overview of a wallet's token holdings and their values. Useful for tracking portfolio changes over time.



# Get Wallet Transfers
Source: https://docs.ormilabs.com/api-reference/tokens/get-wallet-transfers

open-api/0xapi.yaml get /v2/{chain_name}/wallets/{wallet_address}/transfers
Fetches a paginated list of all incoming and outgoing token transfers (e.g., ERC-20, ERC-721, ERC-1155) for a given wallet address.



# Lookup Token
Source: https://docs.ormilabs.com/api-reference/tokens/lookup-token

open-api/0xapi.yaml get /v2/{chain_name}/tokens/{token_address}
Fetches detailed metadata for a specific fungible token contract, including its name, symbol, decimals, and standard.



# Get Transactions
Source: https://docs.ormilabs.com/api-reference/transactions/get-transactions

open-api/0xapi.yaml get /v2/{chain_name}/transactions
Retrieves a paginated list of the most recent transactions on the blockchain.



# Lookup Transaction By Hash
Source: https://docs.ormilabs.com/api-reference/transactions/lookup-transaction-by-hash

open-api/0xapi.yaml get /v2/{chain_name}/transactions/{transaction_hash}
Fetches the full details of a single transaction, identified by its unique hash.



# Pricing
Source: https://docs.ormilabs.com/billing-and-pricing/pricing-overview

Understanding Ormi pricing and billing

## How Ormi billing works

Ormi uses a credit-based system. Credit is defined as a basic compute unit (CU) across all our products.

For example, with Ormi Subgraphs, the compute charge is based on the **total number of entities stored** in your subgraphs. For the final invoice, the total number of entities is converted into credits for billing.

Our pricing is metered and billed based on your actual usage.

## Understanding usage metrics

We track two primary metrics:

* **Active subgraphs**: The number of subgraphs you have running.
* **Stored entities**: The total amount of data stored across your subgraphs as defined by the number of entities.

### Entity storage billing

Entity storage is calculated hourly across all subgraphs:

* When you delete a subgraph, its stored entities are no longer billed.
* All entities count toward your project's cumulative usage.

### Entity conversion to credit

For Ormi Subgraphs, entities to credit conversion is defined as:

> 1 credit = 250 entities

Below is a pricing table for unit pricing credit conversion.

| Plan Type  | 1 Credit     | Price per Credit |
| ---------- | ------------ | ---------------- |
| Developer  | 250 entities | \$0.01           |
| Enterprise | 250 entities | \$0.0025         |

Below is a conversion table for bulk entity credit conversions and pricing.

| Plan Type  | Price per 1,000 Entities | Price per 100,000 Entities |
| ---------- | ------------------------ | -------------------------- |
| Developer  | 4 credits (\$0.04)       | 400 credits (\$4.00)       |
| Enterprise | 4 credits (\$0.01)       | 400 credits (\$1.00)       |

## Plans

### Community plan

* **Price:** Free
* **Features:**
  * Support for 50+ chains
  * Load balanced RPC proxy layer
  * Enhanced monitoring
  * Metrics and analytics dashboards
  * Up to 3 custom subgraphs
  * 100,000 entities storage included
  * Rate limit: 20 requests / 10 seconds
  * Email support

### Developer plan

* **Price:** Pay as you go
* **Features:**
  * Everything in Community plan
  * Unlimited custom subgraph indexing
  * Unlimited community data querying
  * Rate limit: 50 requests / 10 seconds
  * Priority email support
  * \$4.00 per 100,000 entities stored

### Enterprise plan

* **Price:** Custom pricing
* **Features:**
  * Everything in **Developer plan**
  * Optional dedicated environment
  * 0xdb, dedicated indexing access
  * Custom API and database sync
  * Custom query limit
  * 99.9% uptime, sub-50ms latency
  * Custom SLA support
  * Premium support via Email, Slack, and Telegram
  * \$1.00 per 100,000 entities stored

## Usage comparison

| Feature             | Community    | Developer          | Enterprise         |
| ------------------- | ------------ | ------------------ | ------------------ |
| Entities stored     | 100,000 free | \$4.00 per 100,000 | \$1.00 per 100,000 |
| Rate limit          | 100 / 10s    | 50 / 10s           | Custom             |
| Community subgraphs | Unlimited    | Unlimited          | Unlimited          |
| Custom Subgraphs    | 3            | Unlimited          | Unlimited          |

## FAQs

<Accordion title="When does billing occur?">
  Usage is calculated hourly and billed monthly. If you pause a subgraph, it stops indexing new data, but you can still
  query it. Deleting a subgraph removes it completely. Billing continues for resources used up to that point. If you
  cancel your subscription on, for example, day 10 of the billing period, charges continue until day 30, when the
  cancellation takes effect in the next cycle. During this time, the subgraph can still be queried unless deleted
  manually. Fees accumulate only for resources already used, ensuring fair billing throughout the cycle.
</Accordion>

<Accordion title="When does a sample usage based bill looks like">
  | Description                   | Qty     | Unit Price | Amount       | **Notes**                                                               |
  | ----------------------------- | ------- | ---------- | ------------ | ----------------------------------------------------------------------- |
  | **Feb 3 - Mar 3, 2025**       |         |            |              |                                                                         |
  | 0xGraph - **Enterprise Tier** |         |            |              |                                                                         |
  | First 400                     | 400     | \$0.00     | \$0.00       | **By default first 100k entities are free**                             |
  | Next 401 to 40,000            | 39,600  | \$0.01     | \$396.00     | **Up to 10M entities (40k credits), billed at \$0.04 per 1k entities**  |
  | 40,001 and above              | 200,000 | \$0.0025   | \$500.00     | **Beyond 10M entities (40k credits), billed at \$0.01 per 1k entities** |
  | **Subtotal**                  |         |            | **\$896.00** |                                                                         |
</Accordion>

<Accordion title="What happens if I exceed my plan limits?">
  <ul>
    <li>
      <strong>Community Plan</strong>: Service will be paused until usage returns below limits
    </li>

    <li>
      <strong>Developer Plan</strong>: Additional usage is billed at standard rates
    </li>

    <li>
      <strong>Enterprise Plan</strong>: Custom limits based on your agreement
    </li>
  </ul>
</Accordion>

<Accordion title="How is entity storage calculated?">
  Entity storage is measured hourly across all active subgraphs. For example:

  <ul>
    <li>3 subgraphs with 10,000 entities each = 30,000 total entities</li>
    <li>Deleting one subgraph reduces your billable entities accordingly</li>
  </ul>
</Accordion>

<Accordion title="How do I keep my monthly subgraph cost low?">
  Subgraph costs are based on the number of **entities**, which correlate with **storage and historical data** usage. To
  reduce costs, you can: - Set the **start block** closer to the tip of the chain to limit historical data. - Specify
  the **indexerHints: prune** setting in your subgraph YAML file to prune old data. 👉 [Learn more about pruning
  settings](https://thegraph.com/docs/en/subgraphs/best-practices/pruning/)
</Accordion>

<Accordion title="Why is my subgraph incurring high charge, even though pruning is enabled?">
  * Pruning only applies to subgraphs with multiple entity versions.
  * If your subgraph constantly updates entities (e.g., recalculating token balances or prices), pruning will remove
    older versions to save space. However, if your subgraph operates on immutable data or effectively immutable subgraphs
    (i.e., where every entity is always at its latest version and never overwritten), pruning does nothing. Examples
    include subgraphs that track indexed blocks.
    👉 [Learn more about pruning settings](https://thegraph.com/docs/en/subgraphs/best-practices/pruning/)
</Accordion>


# Changelog for 0xAPI
Source: https://docs.ormilabs.com/changelog/data-api

Releases and feature updates for Ormi Data API

<Update label="2025-10-01" description="v2.0">
  ## New doc interface

  * **Redesigned API reference interface**: The Data API reference now features an improved, more intuitive layout for easier navigation across endpoints (Blocks, Tokens, Transactions, NFTs, etc.)
  * **Interactive “Try It” console**: Developers can now run live queries directly from the docs, testing endpoints and parameters in real time without switching tools.
  * **Enhanced parameter documentation**: Each endpoint now includes detailed path and query parameter descriptions, required field labels, and sample values for quicker integration.
  * **Improved JSON response formatting**: Response examples are now fully expanded and syntax-highlighted for better readability.
  * **Streamlined endpoint grouping**: Endpoints are now organized by functional categories (Blocks, Tokens, Transactions, etc.) for faster discovery.
    as long as the corresponding IPFS files are available on the IPFS network.
    <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/docs-changelog1.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=80f28ca4ab3c54d59dd43f9b59f7d72a" alt="0xAPI docs" data-og-width="1267" width="1267" data-og-height="1148" height="1148" data-path="images/0xAPI/docs-changelog1.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/docs-changelog1.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=c7f334939a851bfab22a3315845df30b 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/docs-changelog1.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=eaabb29d130a12a66a0afc7e52ea8dad 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/docs-changelog1.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=45a44c0b8ad92097aaba0b561afdf2f7 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/docs-changelog1.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=65241dc81b28159968daed5974238847 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/docs-changelog1.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=c02fc3e6c5238ea641c54d614c8c497e 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/docs-changelog1.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=31b413eca58497c54877dd873d54ce7a 2500w" />

  ## Why this is important

  These improvements make it significantly easier for developers to explore, test, and integrate 0xAPI - reducing setup time and improving overall usability when working with real-time blockchain data.
</Update>


# Changelog by product
Source: https://docs.ormilabs.com/changelog/overview



<script
  dangerouslySetInnerHTML={{__html: `
(function() {
  function hideSidebarSections() {
    const headers = document.querySelectorAll('.sidebar-group-header');
    
    headers.forEach(header => {
      const title = header.querySelector('#sidebar-title');
      if (title && (title.textContent.includes('0xGraph') || title.textContent.includes('0xAPI'))) {
        header.style.display = 'none';
        
        let next = header.nextElementSibling;
        while (next && !next.classList.contains('sidebar-group-header')) {
          next.style.display = 'none';
          next = next.nextElementSibling;
        }
      }
    });
  }
  
  hideSidebarSections();
  setTimeout(hideSidebarSections, 100);
  setTimeout(hideSidebarSections, 500);
  
  const observer = new MutationObserver(hideSidebarSections);
  observer.observe(document.body, { childList: true, subtree: true });
})();
`}}
/>

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/changelog/subgraphs"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round">
            <path d="M19.5 7a24 24 0 0 1 0 10" />

            <path d="M4.5 7a24 24 0 0 0 0 10" />

            <path d="M7 19.5a24 24 0 0 0 10 0" />

            <path d="M7 4.5a24 24 0 0 1 10 0" />

            <rect x="17" y="17" width="5" height="5" rx="1" />

            <rect x="17" y="2" width="5" height="5" rx="1" />

            <rect x="2" y="17" width="5" height="5" rx="1" />

            <rect x="2" y="2" width="5" height="5" rx="1" />
          </svg>
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">0xGraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Track updates to Ormi Subgraphs, including new indexing features, performance improvements, and expanded chain support.
      </p>
    </div>
  </a>

  <a
    href="/changelog/data-api"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-left-right-ellipsis.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=88cd9ce90f4df3943937e4bbc23c4b5f" alt="0xAPI icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/chevrons-left-right-ellipsis.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-left-right-ellipsis.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=b94ea02f3900a039a2d24e2c9e22cca9 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-left-right-ellipsis.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=0d13d22d4dbe716e6d086e4c280b49ce 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-left-right-ellipsis.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4495343aa18a244e16dfdec8e3d17b1c 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-left-right-ellipsis.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=0c3dd282e88a603fb0d8467082305583 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-left-right-ellipsis.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=23c24d034a865bf11d123056ff98ee89 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-left-right-ellipsis.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=a0ac54b525b152c61042ba0ee4a78d50 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">0xAPI</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Track updates to Ormi's Data API, including new endpoints, parameter enhancements,  performance improvements, and new chain support.
      </p>
    </div>
  </a>
</div>


# Changelog for 0xGraph
Source: https://docs.ormilabs.com/changelog/subgraphs

Releases and feature updates

<Update label="2025-04-03" description="v1.7.0">
  ## Quickly migrate subgraphs

  You can quickly migrate subgraphs from other platforms to Ormi through the frontend page by simply providing the deployment ID,
  as long as the corresponding IPFS files are available on the IPFS network.
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/subgraph-migrate-path.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=27a1c4d6f475cc582f500e78f97b09b6" alt="Subgraph Migration" data-og-width="672" width="672" data-og-height="424" height="424" data-path="changelog/images/2025-04-03/subgraph-migrate-path.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/subgraph-migrate-path.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=996deb4dc3b36bab954eae3ffab76468 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/subgraph-migrate-path.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=8ff6d6a73227cdbeec7a7ba06ff42c01 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/subgraph-migrate-path.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=867eecc6a4066d659c40a73ca3af6251 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/subgraph-migrate-path.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=24de123c4639dca0d72759ddf5218a0c 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/subgraph-migrate-path.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=00c3676de958f9a266b22c7d19900784 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/subgraph-migrate-path.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=a3d9f7f13d239821be0d44d6a7411d72 2500w" />
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/subgraph-migrate.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=d8ccf7a1e0cab3f10144891d3036b002" alt="Subgraph Migration" data-og-width="654" width="654" data-og-height="772" height="772" data-path="changelog/images/2025-04-03/subgraph-migrate.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/subgraph-migrate.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=cb03c1745f9b2de13d47a3df305b4ff8 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/subgraph-migrate.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=a5dfbec71d18341443e8aa10bc45c68a 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/subgraph-migrate.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=45466189a958766dee7a0288cc6b8edf 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/subgraph-migrate.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=3a1fc1163df50af3ef55f98599d6ad16 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/subgraph-migrate.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=6d2ec1eacb61534a99f64916c31ff5bf 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/subgraph-migrate.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=165d6909cb7a6927a22d1ee193695bce 2500w" />

  ## Data size chart

  Added GraphQL query data size chart
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/data-size-chart.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=dbbcc1b1ecdc5150bc1ae271089ec087" alt="Data Size Chart" data-og-width="720" width="720" data-og-height="257" height="257" data-path="changelog/images/2025-04-03/data-size-chart.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/data-size-chart.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=e21abfd2216956737d7a0398ce8043d9 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/data-size-chart.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=76f8d3b01ae37b3ef6a04f1b736d41e1 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/data-size-chart.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=c47da4a837d8438bd1c203b294b2a4c8 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/data-size-chart.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=8ff1aafc21fadf9126b278c740f186eb 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/data-size-chart.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=d1dba529ddfa76f8a4ae9ef10bda19a4 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/data-size-chart.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=5806faa34e824d118ec0e1811ae102b1 2500w" />

  ## budget

  Added user budget settings and usage alerts
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/budget.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=728b2c63676ba4ec50bfe1582515c2cc" alt="Budget" data-og-width="720" width="720" data-og-height="162" height="162" data-path="changelog/images/2025-04-03/budget.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/budget.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=5e4f3f54eeec29b6b52c75832c34eda4 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/budget.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=4c48bbf1923e1c61dc12a5b97d3bff45 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/budget.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=ee0274adc93e91a5bfb6e125191abe66 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/budget.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=005c4c1303c3443ff891668f255cf2d7 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/budget.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=7e4cfcdb9d6ce281faf8dfbbc66490d0 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/budget.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=d8795f9904aa34c8994a430fe34828f3 2500w" />

  ## Credit usage

  Free users can now also view credit usage
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/credit-usage.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=b9d3ccbd9dec6284d1ae73627b589f04" alt="Credit Usage" data-og-width="720" width="720" data-og-height="283" height="283" data-path="changelog/images/2025-04-03/credit-usage.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/credit-usage.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=77976d156157b3dfe573ce3d14a5d95c 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/credit-usage.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=db6da703bcc601476baee2144a0bab52 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/credit-usage.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=7c8ac6f4131a56cc0c4de3efd7522972 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/credit-usage.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=3e2fe213632a23d081bf37e20b5b3f28 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/credit-usage.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=d25453855e76f5775fbae2e0dfa613fd 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2025-04-03/credit-usage.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=515f1bb006b3dbabed503a0521e35cc3 2500w" />
</Update>

<Update label="2024-12-24" description="v1.6.0">
  ## Email preferences

  Users can manage their notification messages from ORMI through email links. Users can choose to receive or cancel notification messages.
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-preferences-url.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=27fca0c3ebe744c7d501f6cf45b82a21" alt="Email Preferences" data-og-width="344" width="344" data-og-height="146" height="146" data-path="changelog/images/2024-12-24/email-preferences-url.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-preferences-url.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=84b89a907a5a6e591440d62a86a4d29f 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-preferences-url.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=b66434c1d62c56077d6c85daf442b37d 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-preferences-url.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=fd7a0be0767029ff86897ed019a50518 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-preferences-url.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=86f3bd3ae65e280849b3b308561f8660 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-preferences-url.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=b7f8da16b111889d983b5011f4389395 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-preferences-url.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=8a936218709ce0b72a0e235c9d3ee0ef 2500w" />
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-preferences.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=2714669f44080553d66d772cfe50a4b4" alt="Email Preferences" data-og-width="1077" width="1077" data-og-height="882" height="882" data-path="changelog/images/2024-12-24/email-preferences.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-preferences.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=47712a99e234088240f1273aef2cc04a 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-preferences.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=4b698b82a88209be983eab77321019e2 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-preferences.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=9e06748dd4affe3b5155f946e69cab34 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-preferences.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=1914e405cd8dfd4e04dadff521b32a72 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-preferences.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=34b4597b693df3288f3fbda1be88bc6b 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-preferences.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=627d51d372b5189899915b3ec157dc9b 2500w" />

  ## Subgraph status notifications

  When there are significant changes in the status of the subgraph you have deployed, we will notify you via email
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-subgraph-status.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=bb18392f44bcc0910acdbae54fe177b4" alt="Email Preferences" data-og-width="1031" width="1031" data-og-height="727" height="727" data-path="changelog/images/2024-12-24/email-subgraph-status.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-subgraph-status.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=38bd97c1a0204d423368473afb8b9d91 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-subgraph-status.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=a01b0ee56f3922273068de101c51c237 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-subgraph-status.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=6a99caf5f3ce9cc47dcfd3d9287857fd 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-subgraph-status.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=f7dc6f69a9eac5ef198f2415dd0f8e19 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-subgraph-status.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=4a9c45fc4167f422f3f2a1d6f01f819f 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/email-subgraph-status.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=9ac7a064b994887b6dbc458b04e420e2 2500w" />

  ## Private GraphQL

  Add private GraphQL functionality, this request requires adding the API Keys to the request header
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/private-graphql.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=088ea7a5d6d8168e149f4d53d28fb0b5" alt="Email Preferences" data-og-width="1119" width="1119" data-og-height="157" height="157" data-path="changelog/images/2024-12-24/private-graphql.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/private-graphql.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=e5bb6bc1c9b9e634fab357c4428b8a30 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/private-graphql.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=cadf7bea0e5c94bf61fb779eca90c3c4 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/private-graphql.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=79f093d25308be8f3f7193a27fe2efe7 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/private-graphql.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=218d62d729a23548861188a78326806b 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/private-graphql.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=0c58b48ff513a27f816bb42c243ce7d8 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/private-graphql.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=d3f76d1c9263caaad4e28d0831ac6dd6 2500w" />
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/private-graphql-query.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=4beb8ce3cf9ec1016385ea3ead7c97b9" alt="Email Preferences" data-og-width="1325" width="1325" data-og-height="532" height="532" data-path="changelog/images/2024-12-24/private-graphql-query.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/private-graphql-query.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=8ecbdb5e5ac00ef484906280b412cc9c 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/private-graphql-query.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=4b227c7731ebd32055269ebdd2af759f 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/private-graphql-query.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=525412d97fdd1c34bd6c5e403bd84ad6 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/private-graphql-query.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=484d84a8cc6de2d93bf4fb9cc6535556 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/private-graphql-query.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=ae4bdcd5e9631d65b5b53dc56503d877 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/private-graphql-query.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=45b0ee4eb9800469b88a91b6692fa228 2500w" />

  ## Usage statistics

  We have improved the function of statistics and display of usage in this version, and now we can more clearly query our own usage
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/usage.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=3b8e95fef8914ad84fac4e9bb0950af7" alt="Email Preferences" data-og-width="1322" width="1322" data-og-height="657" height="657" data-path="changelog/images/2024-12-24/usage.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/usage.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=c09d7b251a1d0c59e06c5684d298848e 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/usage.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=55bfba0d6e5900d3c7ee09207cc5c58e 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/usage.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=287e06d2e3de5ab6bf55cc2a42963cc6 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/usage.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=a33f301c9af006f748a4497e7384eb59 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/usage.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=dbd8994f66034066136fa68b0fac8547 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/usage.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=f866e05901608490388cd6451017b16f 2500w" />

  ## pipeline feature

  This feature can directly import subgraph data into the configured database, and we will continue to update and iterate this feature in the future
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/pipeline.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=0e7a62da8148c3c7c2561974947af107" alt="Email Preferences" data-og-width="690" width="690" data-og-height="471" height="471" data-path="changelog/images/2024-12-24/pipeline.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/pipeline.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=5e69fe9d88562335f55f719b2cdbc6f6 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/pipeline.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=d4b7f56054a21e4aaae40eec9d703fbf 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/pipeline.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=42f5939adec9aee84d8bfc268f5d7a9e 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/pipeline.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=3ed9b4832535facfb4446c2e17175e3f 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/pipeline.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=180430e337a3134bed6f8e7e194c3e7a 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-12-24/pipeline.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=1bcc0cd8c57514c083d4bb3d5e529f9d 2500w" />
</Update>

<Update label="2024-10-01" description="v1.4.0">
  ## Email notifications

  Each time a new user logs into the Ormi App for the first time, they will receive a welcome email automatically sent by the system. Currently email is for new sign ups and team invites.
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/email-signup.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=8107e461a48275669bdb7174559ed501" alt="Email Notifications" data-og-width="1520" width="1520" data-og-height="1168" height="1168" data-path="changelog/images/2024-10-01/email-signup.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/email-signup.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=586b73284259ab156205346514e67a65 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/email-signup.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=8f1733661cf5537c882cac64286f2421 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/email-signup.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=9e73c63f28ab35c5361384775e664dab 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/email-signup.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=b3d51f7e8344b92043edecec314ee1e1 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/email-signup.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=b5dba0bea83ba2cec554eab578322773 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/email-signup.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=0f1b4177f72b073b27923ca2ee00d2b3 2500w" />

  ## Team collaboration

  When a user invites others to join their team from the settings page, the invited users will receive an email invitation to join the team.
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/team-invite-settings.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=519fac51786a2a990f68cadd20d421d4" alt="Team Collaboration" data-og-width="1999" width="1999" data-og-height="762" height="762" data-path="changelog/images/2024-10-01/team-invite-settings.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/team-invite-settings.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=c956e7d820273377028933e157b6eeb2 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/team-invite-settings.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=dfe9757b80165309a64533bf1539b1d5 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/team-invite-settings.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=b7014cc9366266bbc16a7604e0512387 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/team-invite-settings.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=b40b1a10fe23f938b0c0425e0ea7ab40 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/team-invite-settings.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=d81e18bc85b250206b5d6824ee89c3b5 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/team-invite-settings.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=83f3ff3455ed2d0871e3072409dff475 2500w" />
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/team-email.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=57239574ff3602c5707b3498a622b386" alt="Team Email" data-og-width="1350" width="1350" data-og-height="802" height="802" data-path="changelog/images/2024-10-01/team-email.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/team-email.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=7ef50c26d0ce88815e92e49b0314e8df 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/team-email.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=424243aad6ce62696bd01dcd056a226c 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/team-email.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=d5f9f9912b19d8fd266692c64a5a7843 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/team-email.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=4fa4c73632be89e292e9c8d821c8d743 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/team-email.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=994fc67ca093ad9b60e73c3d8d09049e 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/team-email.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=20bd0ce6a9eabb4ede5239289aa6bac8 2500w" />

  ## Subgraph tagging

  On the details page, users can click "New Tag" to create a tag for the subgraph. Tag is essentially similar to an alias for the subgraph. This tag will be displayed on both the details page and the 0xGraph page. The tag is used to customize GraphQL, replacing the version field within GraphQL for easier management. When a version is updated, the tag can be assigned to the latest version, keeping the GraphQL query stable.
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/create-tag.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=9883ece3bb4e598aa3f0d439bb7bff42" alt="Create Tag" data-og-width="1999" width="1999" data-og-height="281" height="281" data-path="changelog/images/2024-10-01/create-tag.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/create-tag.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=7cf6bfd3a3fa09455b1f59eadea5e8cb 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/create-tag.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=348289e9f9860cea1ca885b67ed3f504 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/create-tag.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=a74886c6b9d2be2e8f83224e3ca67cc9 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/create-tag.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=6aec884054a88898fe683f4e8331baca 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/create-tag.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=53d1cd67fefdc0b78886344de0dab25e 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/create-tag.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=2f2b9364aad57d0899d5aaf0ac7053c3 2500w" />
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/display-tag.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=4d813761b47da99392326114de81e95d" alt="Display Tag" data-og-width="1999" width="1999" data-og-height="343" height="343" data-path="changelog/images/2024-10-01/display-tag.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/display-tag.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=3b0ace62a0bce6eccaa34337b64cdf6f 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/display-tag.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=2f0554760fc91c386590f8a69a59d0ec 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/display-tag.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=dd4cf130d87166d70683c2dd19a5ede7 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/display-tag.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=09973a0c97a485c2be69b9d8a4655208 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/display-tag.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=e811638cd1d624147bce855b571bca68 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/display-tag.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=613f61f6c61494f6cdc0ab74319a105a 2500w" />

  ## Pause/resume subgraphs

  Users can pause and resume their own created subgraphs that are not publicly accessible. This feature allows users to stop or resume data collection for the subgraph as needed.
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/subgraph-pause.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=6828c2f98bb2cc27452201228c62dd40" alt="Subgraph Pause Resume" data-og-width="1999" width="1999" data-og-height="857" height="857" data-path="changelog/images/2024-10-01/subgraph-pause.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/subgraph-pause.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=363e53045ab62ff95540fadd52e4cd11 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/subgraph-pause.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=aefd5bcd1b6db571807d58a925a58dcf 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/subgraph-pause.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=f3df406c44d3b042123557cb24a94583 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/subgraph-pause.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=ff19dc946b402b6a6ce005f3fda9e325 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/subgraph-pause.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=6ebd3722b6aff19b5a8cd2781c4d5d6b 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/subgraph-pause.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=8514a33376c4f8654f2c2ddf13a9c165 2500w" />

  ## Subgraph entities details

  This feature displays detailed information for each subgraph’s total entity consumed, including its name, quantity, and corresponding fields.
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/entity-metrics.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=32db890ff974cc4c2fa8aabb7083f480" alt="Subgraph Entities" data-og-width="1999" width="1999" data-og-height="942" height="942" data-path="changelog/images/2024-10-01/entity-metrics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/entity-metrics.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=8110c4a849d1e6a85756399d274cf2bc 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/entity-metrics.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=0369cd57bce8e648c1d1ff95fb43486b 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/entity-metrics.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=ba41363f3b38fcaba6a4baac8549c236 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/entity-metrics.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=b664461b16266fe105b0bb4c4ece1df2 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/entity-metrics.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=4eeb3026e40d86f1e99867861791f475 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/entity-metrics.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=7b40b77b5a8d54944dcbf63236cacb45 2500w" />

  ## Block head/ingestion speed metrics

  This chart displays the current block head height and calculates the current indexing speed, presenting this information directly to the user in a visual format.
  <img src="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/block-head.png?fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=52b30a0f0d4e2d8b718c06f0875f92b5" alt="S" data-og-width="1999" width="1999" data-og-height="1139" height="1139" data-path="changelog/images/2024-10-01/block-head.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/block-head.png?w=280&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=5d9218457a1473ddbd39da3f515f9d64 280w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/block-head.png?w=560&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=d4e45071815a72d26459ad6e9ecdb186 560w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/block-head.png?w=840&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=57569d384e9c06c57c46e61d89e64f1e 840w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/block-head.png?w=1100&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=9fc5540f8074247fc4a1563379d0b481 1100w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/block-head.png?w=1650&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=d3953a25305c22bd56104ea7e924a7dd 1650w, https://mintcdn.com/ormilabs/Q4fpPjjhRe8PRAWp/changelog/images/2024-10-01/block-head.png?w=2500&fit=max&auto=format&n=Q4fpPjjhRe8PRAWp&q=85&s=7fafe618fba0430942ea86ac4565fc05 2500w" />
</Update>


# 0xAPI feature overview
Source: https://docs.ormilabs.com/data-api/features

Explore 0xAPI features and capabilites.

<div data-page="features-no-toc">
  ## About 0xAPI

  0xAPI is organized into several distinct services, each catering to specific data needs with consistent, blockchain-agnostic response schemas.

  ## Core capabilities

  | **Feature**         | **Description**                                                                                                                                                                   | **Use cases**                                                                                      |
  | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
  | **Token API**       | Retrieve detailed information on fungible tokens (ex. ERC-20). Fetch wallet balances, token transfers, daily portfolio snapshots, approvals, holder lists, and live token prices. | Power wallets, portfolio dashboards, token-gated apps, and analytics tools for on-chain assets.    |
  | **NFT API**         | Access complete NFT data, including all NFTs owned by a wallet or within a collection. Get detailed collection metadata, traits, and rarity statistics.                           | Build NFT galleries, marketplaces, collection analytics, or portfolio trackers.                    |
  | **Transaction API** | Query detailed transaction data. Retrieve all transactions for a wallet, look up a specific transaction by hash, or get a full summary of a wallet’s on-chain activity.           | Ideal for transaction histories, accounting tools, on-chain analytics, and activity monitoring.    |
  | **ENS API**         | Resolve ENS domains to wallet addresses or perform reverse lookups to find ENS names linked to a wallet.                                                                          | Build explorers, alert systems, or real-time dashboards that track specific contract interactions. |
</div>

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="https://app.ormilabs.com/dashboard/data-api"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "block",
  height: "100%",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    padding: "1.25rem 1.5rem",
    height: "100%",
    display: "flex",
    flexDirection: "column",
  }}
    >
      <div style={{ display: "flex", alignItems: "center", marginBottom: "0.5rem" }}>
        <div style={{ color: "#3E744D", marginRight: "0.75rem" }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/gauge.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=34e05ec9d97e3debd6457992aa262cf1" alt="access app icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/gauge.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/gauge.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=6d3c7aa14240a45075e373d6e0d23a3c 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/gauge.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=84b4ad6de4549ce045410f9176291307 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/gauge.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ed77e560e48dc70fbe4fbd7e0fefac2b 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/gauge.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7d22924e2ce778aa02e23c100009f77a 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/gauge.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=12bab3968027831122861bbb894e912b 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/gauge.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=9778fe5ff45fe18a74f353810cb702fb 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Access 0xAPI
        </div>
      </div>

      <p className="text-gray-600 text-sm" style={{ margin: 0, lineHeight: "1.4" }}>
        Use 0xAPI to stream live and historical blockchain data across wallets, tokens, and transactions - start for free.
      </p>
    </div>
  </a>

  <a
    href="/api-reference/0xAPI/overview"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "block",
  height: "100%",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    padding: "1.25rem 1.5rem",
    height: "100%",
    display: "flex",
    flexDirection: "column",
  }}
    >
      <div style={{ display: "flex", alignItems: "center", marginBottom: "0.5rem" }}>
        <div style={{ color: "#3E744D", marginRight: "0.75rem" }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=dc1325f759209b38621fab13f4f37e17" alt="api reference icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/api-reference.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=30c07c6cfa89263e1350f2bf42ec5ca9 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=cfeea64b2a5a95339bd85f0a74b602d6 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f16bff35784f67eecd08de87049ce293 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=989c763850054f29f1689e04ab2a9ebf 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d0568d036c49c97058391408f1e27167 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=04d36ac4b8d783ebabe121b9b72c8b66 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          See API reference
        </div>
      </div>

      <p className="text-gray-600 text-sm" style={{ margin: 0, lineHeight: "1.4" }}>
        Learn how to retrieve wallet, token, and transaction-level data with structured, low-latency endpoints.
      </p>
    </div>
  </a>
</div>


# Intro to Ormi 0xAPI (Data API)
Source: https://docs.ormilabs.com/data-api/overview

Fast, flexible blockchain data streamed through one powerful API

## What is Ormi 0xAPI

0xAPI gives developers **real-time** and **historical access** to structured, and **fully decoded blockchain data** from multiple blockchain networks.

Built for reliability and ease of use, the API delivers comprehensive data through a suite of targeted endpoints.

## Get started

<div
  className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/data-api/quickstart"
    style={{ 
  textDecoration: 'none', 
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    maxWidth: '380px',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=cca7b26ac73e65453815fbe85b6c6d01" alt="quickstart icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/quickstart.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=499bcd7a2f5b526ff905dd5e83885798 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=57aa39e42ca0bf768ce458874ad42321 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8062bcadbdaa365483ea6e545d413bb4 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7f3546557b416294e5b6f71c1949d230 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4dad90676bccde6863759fb27ad456c7 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7960022f64f10a2b868b24c3bbdc1791 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Quickstart</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Create an account to start querying data from 0xAPI.
      </p>
    </div>
  </a>

  {" "}

  <a
    href="/api-reference/0xAPI/overview"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "flex",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: "200px",
    display: "flex",
    flexDirection: "column",
    maxWidth: "380px",
    width: "100%",
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: "#3E744D" }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=dc1325f759209b38621fab13f4f37e17" alt="api reference icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/api-reference.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=30c07c6cfa89263e1350f2bf42ec5ca9 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=cfeea64b2a5a95339bd85f0a74b602d6 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f16bff35784f67eecd08de87049ce293 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=989c763850054f29f1689e04ab2a9ebf 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d0568d036c49c97058391408f1e27167 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=04d36ac4b8d783ebabe121b9b72c8b66 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          API reference
        </div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">Discover available data endpoints, their capabilities, and references.</p>
    </div>
  </a>

  {" "}

  <a
    href="/supported-chains/data-api"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "flex",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: "200px",
    display: "flex",
    flexDirection: "column",
    maxWidth: "380px",
    width: "100%",
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: "#3E744D" }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=763219942a929fb35f1e728ffbcca310" alt="supported chain icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/link.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d2eb9296c3fc41d23b4a3cf2dee8c1e7 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=451350aeeed6a9b4d4366b7ae6d63dcd 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8f9ea18cdf4deeee05e3c44db0cf432d 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7f838361856d778ae65ddc91ca5609cc 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=34b862e55631e82b514e2db6302c5dfc 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5dde712015493301b0829c0b1565020f 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Supported chains
        </div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">See the full list of supported chains and networks on Ormi 0xAPI.</p>
    </div>
  </a>
</div>

***

## Need another chain?

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="https://forms.fillout.com/t/66AyD9bdZvus"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ebadba019a911b27f922ea79588b939d" alt="ecosystem icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/boxes.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d13c22a16e1077c57a96e4eea973eb85 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=fc8ccea3fe21d83c7391877396575949 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=1c91a2a34350eed8e9f6018ca47919a0 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8cd2cb4551e3d0655fb8e73da106826e 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4b534dcd403e58e53cf1b2ff6dd5160b 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ee44bdce4df96eaa59c74d5c426a19dc 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">For ecosystems</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Partner with Ormi to power your ecosystem with subgraphs and APIs that are real-time, reliable, and fully white-labeled. Give your developers enterprise-grade data under your own brand.
      </p>
    </div>
  </a>

  {" "}

  <a
    href="https://forms.fillout.com/t/2U1EKfDebbus"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "flex",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: "200px",
    display: "flex",
    flexDirection: "column",
    width: "100%",
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: "#3E744D" }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7abf3ee5e020a6c691989d0333b1bf3f" alt="builders icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/laptop.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=162396f09b219713bf2ba0bfdb68228d 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=611c4abf9ce174932c3c122eef2b3729 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ceb463055475f5fdc8a77379c03bee1f 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=aee69538cc9b9a846316fdcb58300876 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=c091bafac5ce7476fbc10c00a314f7bb 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=bf47d74856b0891e7ae019fb1404cd54 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          For builders
        </div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Request support for any chain, and we will spin up real-time subgraphs and APIs with enterprise grade reliability. No throttling, or stale data – just the
        data you need to build high-throughput applications.
      </p>
    </div>
  </a>
</div>


# How to query 0xAPI
Source: https://docs.ormilabs.com/data-api/query-data/querying-data-api

How to perform a query on a REST endpoint to retrieve onchain data

In this guide, we will walk you through the steps to perform a query on a REST endpoint to retrieve onchain data.

## Prerequisites

Before you begin, make sure you have:

* A registered [Ormi account](https://app.ormilabs.com)
* An [API key](/data-api/quickstart/generate-an-api-key)
* A REST client (e.g., curl, Postman, or any HTTP client)

## Performing a query to fetch ERC-20 transfers

Here is an example of a query to retrieve the token balance of a wallet address on the Ethereum mainnet.

### Step 1: Identify the endpoint URL

Check out the [API Reference](/data-api-v2/api-reference).

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/erc20-transfers.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=9db5da0773febafdb17bbf8ba6c67e68" alt="Retrieve ERC20 transfers" data-og-width="2665" width="2665" data-og-height="2255" height="2255" data-path="images/0xAPI/erc20-transfers.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/erc20-transfers.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=4b34f7765aef693ec85e1cbc40aa01e0 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/erc20-transfers.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=2630ca60882a05b87991e30f8a418ffd 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/erc20-transfers.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=61b2ea90cda3bb98a96692c6a1f0ecbe 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/erc20-transfers.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=dbe912bce71d5f42c1aab6d6193d9e9c 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/erc20-transfers.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=57519d164fca5eea3704ada80a9e189d 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/erc20-transfers.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=60831e62754f75726e5113afaf15622a 2500w" />

  <figcaption>Retrieve ERC20 transfers</figcaption>
</Frame>

### Step 2: Get the required variables

Copy and paste the required endpoint path and query parameters into the editor, then click "Send" to make the request.

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/perform-query.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=2d4a69182934e441a80bc9dda15aa18f" alt="Perform Query" data-og-width="2012" width="2012" data-og-height="2118" height="2118" data-path="images/0xAPI/perform-query.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/perform-query.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=97297acd0f0691970ca84935b0a89dc3 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/perform-query.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=11c707c93913501298527dee231a93ef 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/perform-query.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=6859140789d3080bb316250b60982eae 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/perform-query.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=71c559585204ad25b027dea070c5ea2b 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/perform-query.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=0ee41d9afb4249f614fcc29d68322d21 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/perform-query.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=9cc808c8ed5f1c4ca52f7b312d6f0666 2500w" />

  <figcaption>Perform query</figcaption>
</Frame>

### Step 3: Query with a third-party tool

You may use any third-party tool such as curl or Postman to directly query the endpoint.

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/curl.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=95c934286705686378f668f76729fb57" alt="Using Curl" data-og-width="1402" width="1402" data-og-height="292" height="292" data-path="images/0xAPI/curl.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/curl.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=fc09712a9e8c98fa31d6257e59851e51 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/curl.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=b0e6fdc67757083407d496be1a5e7e33 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/curl.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=eba6c1fd4c279b2894288693d968c29c 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/curl.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=4abb4ab4d52e9d9027f990c6835d28d1 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/curl.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=a1b957a5bfb6925c9c851063bd3a7477 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/curl.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=c22495a4dbc38f06611f3f1efbde2b53 2500w" />

  <figcaption>Using curl for query</figcaption>
</Frame>

### Step 4: Check out code snippets

The API Reference page also provides handy code snippets for various programming languages to help you get started.

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/languages.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=bd78192435a35ae9f2f98c4a7f591d58" alt="Using Other Programming Languages" data-og-width="1408" width="1408" data-og-height="1106" height="1106" data-path="images/0xAPI/languages.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/languages.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=0a2c41fc61612dee53c5f26ecfd9184c 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/languages.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=ff80f4e37480d205cef7fd325998eeb1 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/languages.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=71af9c680cfeb2937f1c5a79a0522958 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/languages.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=24c71b5e1f6ebc2cc1858faa831949f3 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/languages.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=ba599682a887ec3765969a85f9104ed3 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/languages.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=f6b4d7bef911e94ec7790939423ab6e9 2500w" />

  <figcaption>Using other programming languages</figcaption>
</Frame>


# Quickstart
Source: https://docs.ormilabs.com/data-api/quickstart



0xAPI gives developers fast, structured access to on-chain data across multiple networks.
Designed for reliability and ease of use, it offers targeted endpoints for core blockchain entities like:

* tokens,
* NFTs,
* transactions,
* blocks,
* wallets, and
* events

<div
  style={{
  margin: "0",
  padding: "1rem 1.25rem",
  overflow: "hidden",
  borderRadius: "1rem",
  display: "flex",
  gap: "0.75rem",
  border: "1px solid rgba(113, 113, 122, 0.2)",
  backgroundColor: "rgba(244, 244, 245, 0.5)",
}}
>
  <div style={{ marginTop: "0.125rem", width: "1rem" }}>
    <svg
      viewBox="0 0 20 20"
      fill="currentColor"
      xmlns="http://www.w3.org/2000/svg"
      style={{
      width: "1.25rem",
      height: "1.25rem",
      color: "rgba(113, 113, 122, 0.6)",
    }}
    >
      <path d="M8 0C3.58125 0 0 3.58125 0 8C0 12.4187 3.58125 16 8 16C12.4187 16 16 12.4187 16 8C16 3.58125 12.4187 0 8 0ZM8 14.5C4.41563 14.5 1.5 11.5841 1.5 8C1.5 4.41594 4.41563 1.5 8 1.5C11.5844 1.5 14.5 4.41594 14.5 8C14.5 11.5841 11.5844 14.5 8 14.5ZM9.25 10.5H8.75V7.75C8.75 7.3375 8.41563 7 8 7H7C6.5875 7 6.25 7.3375 6.25 7.75C6.25 8.1625 6.5875 8.5 7 8.5H7.25V10.5H6.75C6.3375 10.5 6 10.8375 6 11.25C6 11.6625 6.3375 12 6.75 12H9.25C9.66406 12 10 11.6641 10 11.25C10 10.8359 9.66563 10.5 9.25 10.5ZM8 6C8.55219 6 9 5.55219 9 5C9 4.44781 8.55219 4 8 4C7.44781 4 7 4.44687 7 5C7 5.55313 7.44687 6 8 6Z" />
    </svg>
  </div>

  <div style={{ fontSize: "0.875rem", minWidth: "0", width: "100%" }}>
    <h3 style={{ fontWeight: "600", margin: "0 0 0.5rem 0" }}>No account yet?</h3>
    <p style={{ margin: "0" }}> [Create an account](http://app.ormilabs.com) - free dev plan, no card required. </p>
  </div>
</div>

## Prerequisites

Before you begin, make sure you have:

* A registered [Ormi account](https://app.ormilabs.com)
* An [API key](/data-api/quickstart/generate-an-api-key)
* A REST client (e.g., curl, Postman, or any HTTP client)

## Get started

### **Step 1**: Identify the base URL

The base URL for all requests is:

```
https://api.data.ormilabs.com/
```

Each query starts with this base URL, followed by a specific endpoint path.

### **Step 2**: Add the endpoint path

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/query1.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=8f5ea8f869659c054215b241ed8b82eb" alt="0xGraph API Keys" data-og-width="1424" width="1424" data-og-height="506" height="506" data-path="images/0xAPI/query1.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/query1.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=cd862514bf900417073134556e29ffdc 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/query1.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=069edcc3629943cdd9f929848adaa920 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/query1.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=f6a44f18f2ecaf3602a42420ae9ca83e 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/query1.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=4cf750f9248324835200beb139b2d077 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/query1.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=9975a21574e2e8cad13c5f703b372606 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/query1.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=cb8cd4d836760ec13d2e2a98c09e8151 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

For example, to fetch block data from Ethereum mainnet:

```
/v2/eth-mainnet/blocks
```

### Resources

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  {" "}

  <a
    href="/supported-chains/data-api"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "block",
  height: "100%",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    padding: "1.25rem 1.5rem",
    height: "100%",
    display: "flex",
    flexDirection: "column",
  }}
    >
      <div style={{ display: "flex", alignItems: "center", marginBottom: "0.5rem" }}>
        <div style={{ color: "#3E744D", marginRight: "0.75rem" }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=763219942a929fb35f1e728ffbcca310" alt="supported chain icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/link.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d2eb9296c3fc41d23b4a3cf2dee8c1e7 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=451350aeeed6a9b4d4366b7ae6d63dcd 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8f9ea18cdf4deeee05e3c44db0cf432d 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7f838361856d778ae65ddc91ca5609cc 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=34b862e55631e82b514e2db6302c5dfc 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5dde712015493301b0829c0b1565020f 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Find supported chains
        </div>
      </div>

      <p className="text-gray-600 text-sm" style={{ margin: 0, lineHeight: "1.4" }}>
        See all the supported chains for `chain_name`
      </p>
    </div>
  </a>

  {" "}

  <a
    href="/api-reference/0xAPI/overview"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "block",
  height: "100%",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    padding: "1.25rem 1.5rem",
    height: "100%",
    display: "flex",
    flexDirection: "column",
  }}
    >
      <div style={{ display: "flex", alignItems: "center", marginBottom: "0.5rem" }}>
        <div style={{ color: "#3E744D", marginRight: "0.75rem" }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=dc1325f759209b38621fab13f4f37e17" alt="api-reference icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/api-reference.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=30c07c6cfa89263e1350f2bf42ec5ca9 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=cfeea64b2a5a95339bd85f0a74b602d6 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f16bff35784f67eecd08de87049ce293 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=989c763850054f29f1689e04ab2a9ebf 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d0568d036c49c97058391408f1e27167 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=04d36ac4b8d783ebabe121b9b72c8b66 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Find endpoint path
        </div>
      </div>

      <p className="text-gray-600 text-sm" style={{ margin: 0, lineHeight: "1.4" }}>
        Check out the API reference to find each endpoint's path.
      </p>
    </div>
  </a>
</div>

### **Step 3**: Include query parameters

Use query parameters to customize your request and narrow down the results.

Common examples include filtering by wallet address, limiting response size, or selecting specific block ranges.

```
?wallet_address=0x...&limit=20&from_block=10000000
```

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/query2.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=c31694fcae984f2e32d1402c7c85b3e1" alt="0xGraph API Keys" data-og-width="1489" width="1489" data-og-height="515" height="515" data-path="images/0xAPI/query2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/query2.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=b3e93aaea1b4b57a2a3efb0982712bc6 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/query2.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=9db747928799c0681408673c695dd8de 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/query2.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=e1bdd63d61a1b262a343525b417619ca 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/query2.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=f059cd3c3520d24ae3efc92effbce541 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/query2.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=108f9b424963edfda616d450863cd396 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/query2.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=7db2322b91d5c02847a294e3760fd088 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

Each endpoint supports its own parameter set - see the [API Reference](/api-reference/0xAPI/overview) for details.

### **Step 4**: Add authentication headers

```
Authorization: Bearer YOUR_API_KEY
```

### **Step 5**: Make the request

Use your REST client to send a GET request to the constructed URL.

Below is a minimal example using `curl`:

```
curl --request GET \
  --url https://api.data.ormilabs.com/v2/{chain_name}/blocks \
  --header 'Authorization: Bearer <token>'
```

Replace `<token>` with your API key and `{chain_name}` with the network you’re querying (ex. `eth-mainnet`).

## Next steps

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  {" "}

  <a
    href="/data-api/query-data/querying-data-api"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "flex",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: "200px",
    display: "flex",
    flexDirection: "column",
    width: "100%",
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: "#3E744D" }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=db8e90d965f8893a197d1503caa565c6" alt="query icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/scan.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=3bb8dd7040c8c654e5e0d31212f85083 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5b8e0aa2a08d2129f65c93d0cd4c91ce 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=9691a16bda2d6de153d88cfc1699fb07 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f44f2bd60236d15d1f4e354a13154a95 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8d30ab3b344e1a90cc49c88fa194de89 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=81bf8db31d0fa7547f04990c2270c77e 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          How to query Data API
        </div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">Learn how to retrieve wallet, token, and transaction-level data with structured, low-latency endpoints.</p>
    </div>
  </a>

  {" "}

  <a
    href="/api-reference/0xAPI/overview"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "flex",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: "200px",
    display: "flex",
    flexDirection: "column",
    width: "100%",
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: "#3E744D" }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=dc1325f759209b38621fab13f4f37e17" alt="api reference icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/api-reference.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=30c07c6cfa89263e1350f2bf42ec5ca9 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=cfeea64b2a5a95339bd85f0a74b602d6 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f16bff35784f67eecd08de87049ce293 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=989c763850054f29f1689e04ab2a9ebf 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d0568d036c49c97058391408f1e27167 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=04d36ac4b8d783ebabe121b9b72c8b66 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          See API reference
        </div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">Learn how to retrieve wallet, token, and transaction-level data with structured, low-latency endpoints.</p>
    </div>
  </a>
</div>


# Creating an Ormi account
Source: https://docs.ormilabs.com/data-api/quickstart/creating-an-account

How to create your 0xGraph account in 1 minute

## **Step 1**: Head to the [Ormi App](https://app.ormilabs.com) to create an account

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-signup.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=bec33610b329a4114e00cee79fbf6639" alt="0xGraph App registration" data-og-width="1884" width="1884" data-og-height="894" height="894" data-path="images/0xgraph-signup.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-signup.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=c4eae8ad840903220162446bbd137361 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-signup.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=be338737f99080c19ea963e0603d0dc6 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-signup.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=eb3adfdb5ddf3976df58e128d54d2917 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-signup.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=98b3d7429b9a46435568cda811c2ca94 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-signup.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=63c695483dd68875bc4af0fe3a7775a6 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-signup.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=0f73c21cdc1cf224b4d20d75011a7506 2500w" />
</Frame>

## **Step 2**: Click on 0xAPI tab

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/data-api.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=62f55fbdfab51ff8f7a4236042756c9b" alt="0xGraph App registration" data-og-width="1895" width="1895" data-og-height="900" height="900" data-path="images/how-to/data-api.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/data-api.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=d95a943ffa74c25c46f831adb168bc08 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/data-api.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=cebeb4856ccacb6a5c79b2dd0d8d64d3 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/data-api.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=de0ac7f2219f8111336f34c1cb8d518f 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/data-api.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=b43a38e2decc062efc7717f36599fa6c 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/data-api.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=bba461791346d731ee6e0e09bb5803a9 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/data-api.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=b34ecfc5ffdbb96c125aba5c2bb852c7 2500w" />
</Frame>

## **Step 3**: Click on Data API V2

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/data-api2.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=f783dc6b64af8e4a2f1700b02705b07b" alt="0xGraph App registration" data-og-width="1907" width="1907" data-og-height="891" height="891" data-path="images/how-to/data-api2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/data-api2.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=a82ad0df1379d817a15caa7e1205df70 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/data-api2.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=ca02d9f09caa9f6ceecf62b21a5a777f 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/data-api2.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=1af6da50c583879f2c871b708453b85e 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/data-api2.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=f786f49e7dec9bed76f4d896138fb1f1 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/data-api2.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=b9130ad0669ea0325e0adaad0aeef2a3 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/data-api2.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=6022e246c13f41f70cdf3b53ad06b84e 2500w" />
</Frame>

Your account is now set-up. You can start exploring the different endpoints.

## Next steps

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  {" "}

  <a
    href="/data-api/quickstart/generate-an-api-key"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "flex",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: "200px",
    display: "flex",
    flexDirection: "column",
    width: "100%",
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: "#3E744D" }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/key-round.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=2f535800d839afccfcbab75bd3d1d65c" alt="api key icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/key-round.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/key-round.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=6f0aadc8a87093d9d604e11108e23332 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/key-round.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=2ccf98b880c72f731de66bbb70650bb6 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/key-round.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5f9c5dcf9b9fd91d8baa156a53db5000 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/key-round.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=c89742f7b92e535265f89beeca895f16 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/key-round.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=791e37ef89d468e2126033ce09ee9464 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/key-round.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=cc4c3a0eceabf3e0219b298d8e2fb5e3 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Create an API key
        </div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">Generate an API key to start querying your data API.</p>
    </div>
  </a>

  {" "}

  <a
    href="/api-reference/0xAPI/overview"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "flex",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: "200px",
    display: "flex",
    flexDirection: "column",
    width: "100%",
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: "#3E744D" }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=dc1325f759209b38621fab13f4f37e17" alt="api reference icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/api-reference.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=30c07c6cfa89263e1350f2bf42ec5ca9 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=cfeea64b2a5a95339bd85f0a74b602d6 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f16bff35784f67eecd08de87049ce293 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=989c763850054f29f1689e04ab2a9ebf 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d0568d036c49c97058391408f1e27167 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=04d36ac4b8d783ebabe121b9b72c8b66 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          See API reference
        </div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">Learn how to retrieve wallet, token, and transaction-level data with structured, low-latency endpoints.</p>
    </div>
  </a>
</div>


# How to generate an API key
Source: https://docs.ormilabs.com/data-api/quickstart/generate-an-api-key



## **Step 1**: Go to the [API key page](https://app.ormilabs.com/dashboard/api) to generate an API key

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=ac4ade1e29e7be09629130b131f3dd1b" alt="0xGraph API Keys" data-og-width="1878" width="1878" data-og-height="784" height="784" data-path="images/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=9a7ce75c4a23f097f9c37aa2bb9bc23c 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=2d08282114911e455dfd5530d3ade80b 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=f10e634bc4879559c80c6512fbac4925 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=0abb78bac049e0f3c2c71b4a0f608ae6 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=bf2ee85dba964b271417f70f8aebf435 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=156187b64fa5fcb67843bc3a5082d638 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## **Step 2**: Click on 'Create API Key' to generate an API key.

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=27378c8be18ab8c673ad359d766c74b9" alt="0xGraph API Keys" data-og-width="1905" width="1905" data-og-height="850" height="850" data-path="images/0xgraph-generated-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=3b84276a591ade543b0235093dab3ba2 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=ec35293209dda94aeda54b1210c84d36 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=7236ffe8e39e0459a54908d7ef2c6bcd 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=d6f81496480361d508cb5bcb87197969 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=d2d0046a932f52af19be8d53090f8902 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=0e5e3a1fc56de44929e488f2f40e4147 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

After generating an API key, you can then copy and paste it into your commands as needed.

<Info>
  Warning: Always handle your API keys securely. Do not expose them in client-side code or share them publicly. Store them in a secure location, such as
  environment variables, and rotate them regularly to minimize security risks. If compromised, regenerate your API key immediately. For public repositories,
  store API keys in a .env file and add .env to .gitignore to prevent accidental exposure in your codebase.
</Info>

## Next steps

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  {" "}

  <a
    href="/data-api/query-data/querying-data-api"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "flex",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: "200px",
    display: "flex",
    flexDirection: "column",
    width: "100%",
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: "#3E744D" }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=db8e90d965f8893a197d1503caa565c6" alt="query icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/scan.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=3bb8dd7040c8c654e5e0d31212f85083 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5b8e0aa2a08d2129f65c93d0cd4c91ce 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=9691a16bda2d6de153d88cfc1699fb07 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f44f2bd60236d15d1f4e354a13154a95 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8d30ab3b344e1a90cc49c88fa194de89 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=81bf8db31d0fa7547f04990c2270c77e 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          How to query Data API
        </div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">Learn how to retrieve wallet, token, and transaction-level data with structured, low-latency endpoints.</p>
    </div>
  </a>

  {" "}

  <a
    href="/api-reference/0xAPI/overview"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "flex",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: "200px",
    display: "flex",
    flexDirection: "column",
    width: "100%",
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: "#3E744D" }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=dc1325f759209b38621fab13f4f37e17" alt="api reference icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/api-reference.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=30c07c6cfa89263e1350f2bf42ec5ca9 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=cfeea64b2a5a95339bd85f0a74b602d6 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f16bff35784f67eecd08de87049ce293 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=989c763850054f29f1689e04ab2a9ebf 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d0568d036c49c97058391408f1e27167 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=04d36ac4b8d783ebabe121b9b72c8b66 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          See API reference
        </div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">Learn how to retrieve wallet, token, and transaction-level data with structured, low-latency endpoints.</p>
    </div>
  </a>
</div>


# Get ERC-1155 balance
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/balances/get-erc-1155-balance

get /apechain/v1/address/{walletAddress}/balance/erc1155
Lists ERC-1155 token balances of a wallet address.



# Get ERC-20 balance
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/balances/get-erc-20-balance

get /apechain/v1/address/{walletAddress}/balance/erc20
Lists ERC-20 token balances of a wallet address.



# Get ERC-721 balance
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/balances/get-erc-721-balance

get /apechain/v1/address/{walletAddress}/balance/erc721
Lists ERC-721 token balances of a wallet address.



# Get historical balance
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/balances/get-historical-balance

get /apechain/v1/address/{walletAddress}/balance/historical
Fetch the historical native, fungible (ERC-20), and non-fungible (ERC-721 & ERC-1155) tokens held by an address at a given block height or date.




# Get native token balance
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/balances/get-native-token-balance

get /apechain/v1/address/{walletAddress}/balance/native
Get the native token balance for an address.




# Get token balance portfolio for address
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/balances/get-token-balance-portfolio-for-address

get /apechain/v1/address/{walletAddress}/balance/portfolio
Render a daily portfolio balance for an address broken down by the token. The timeframe is user-configurable, defaults to 30 days.



# Get block heights
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/blocks/get-block-heights

get /apechain/v1/blocks/{startDate}/{endDate}
Get all block heights within a particular date range.



# Get block transactions
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/blocks/get-block-transactions

get /apechain/v1/block/{blockNumber}/transactions
Get transactions that occurred in a given block.



# Get one block
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/blocks/get-one-block

get /apechain/v1/block/{blockHeight}
Get the details of an individual block.



# null
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/events/get-transaction-logs

get /apechain/v1/events/



# Get NFT tokens by address
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/nfts/get-nft-tokens-by-address

get /apechain/v1/nft/collections/{address}/tokens
Lists non-fungible tokens for a particular contract address.



# Get NFT tokens by id for address
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/nfts/get-nft-tokens-by-id-for-address

get /apechain/v1/nft/collections/{address}/tokens/{tokenID}
Get token details for a specific token of an NFT contract.



# Get NFT traits by collection
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/nfts/get-nft-traits-by-collection

get /apechain/v1/nft/collections/{address}/traits
Get a list of traits for a particular NFT address



# Get token holders
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/tokens/get-token-holders

get /apechain/v1/tokens/{tokenAddress}/holders
Get a list of all the token holders for a specified ERC-20, ERC-721 or ERC-1155 token.



# Get bulk transactions
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/transactions/get-bulk-transactions

get /apechain/v1/bulk/transactions/{walletAddress}/{timeBucket}
Lists bulk transaction data for a wallet address in a 15-minute time bucket interval.



# Get earliest wallet transactions
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/transactions/get-earliest-wallet-transactions

get /apechain/v1/earliest/{walletAddress}/transactions
Lists the earliest transactions involving an address.



# Get latest transactions
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/transactions/get-latest-transactions

get /apechain/v1/transactions
Lists the latest transactions.



# Get one transaction
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/transactions/get-one-transaction

get /apechain/v1/transaction/{txHash}
Get a single transaction by transaction hash.



# Get recent wallet transactions
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/transactions/get-recent-wallet-transactions

get /apechain/v1/recent/{walletAddress}/transactions
Lists the most recent transactions involving an address.



# Get transactions for address
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/transactions/get-transactions-for-address

get /apechain/v1/address/{walletAddress}/transactions
Get paginated transactions involving an address.



# Get wallet transactions summary
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/transactions/get-wallet-transactions-summary

get /apechain/v1/address/{walletAddress}/transactions/summary
Get the earliest and latest transactions, and the transaction cound involving a wallet.



# Get ERC-1155 transfers
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/transfers/get-erc-1155-transfers

get /apechain/v1/address/{walletAddress}/transfers/erc1155
Lists ERC-1155 transfers for an address. Filterable by block range and contract address.



# Get ERC-20 transfers
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/transfers/get-erc-20-transfers

get /apechain/v1/address/{walletAddress}/transfers/erc20
Lists ERC-20 transfers for an address. Filterable by block range and contract address.



# Get ERC-721 transfers
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/api-reference/transfers/get-erc-721-transfers

get /apechain/v1/address/{walletAddress}/transfers/erc721
Lists ERC-20 transfers for an address. Filterable by block range and contract address.



# Account Creation
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/getting-started/account-creation

How to create an account and access for ApeChain Data APIs

## Setup Steps

### 1. Create Account

Visit [the application dashboard](https://apechain.0xgraph.xyz) to create your account.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-signup.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c2f4ac1b74ee25ba926876e1eaee22ae" alt="ApeChain Registration" data-og-width="1536" width="1536" data-og-height="819" height="819" data-path="images/apechain/0xgraph-signup.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-signup.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=e75d4936d154a99619780952a2648b37 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-signup.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=76597d098fb63d3dda00efc4acc89bc3 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-signup.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=e52058e349670d0540ffd86f7fb7231b 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-signup.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=5fdc2be4422bd92ab1ee5af9e6322515 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-signup.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=a7a145edf2d79324480154f638ad1081 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-signup.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=d123735723d6c7efc751fad77deef7bf 2500w" />
</Frame>

### 2. Choose Subscription Plan

The current access for data APIs is **free**, but rate limited. In the future, user will be required to navigate to the [Pricing page](https://apechain.0xgraph.xyz/dashboard/price) to select a plan that matches your needs.

If you'd like to remove rate limits or are looking for custom APIs, please select **Enterprise** and connect with our team.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-pricing.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7f1e2b0e211fbea7bab95ce9b340477e" alt="0xGraph Subscription Plans" data-og-width="2304" width="2304" data-og-height="1097" height="1097" data-path="images/apechain/0xgraph-pricing.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-pricing.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7e4bcdf59242ec097327100f9af05087 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-pricing.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c1ccf0894d708db980ecc0c6b03d175a 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-pricing.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=f1ee922f2905caee0accd225b94061cf 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-pricing.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=a755eea8419cf4b9edeb5f8ce80dd6d2 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-pricing.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7e29c61f5fd614aaf024f9389d015a55 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-pricing.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=ad727ca13e0bd7e4c34a25d944fda4b7 2500w" />

  <figcaption>Choose a subscription plan</figcaption>
</Frame>

### 3. Generate API Key

An API key is required to access the ApeChain Data APIs endpoints. This API key is currently shared among all of Ormi's data solutions.

Go to the [API Keys Page](https://apechain.0xgraph.xyz/dashboard/api) to create your API key.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-api-key.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=d9bdcecb620ed8acdb1b89a70e3a34f1" alt="0xGraph API Keys" data-og-width="2304" width="2304" data-og-height="1213" height="1213" data-path="images/apechain/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-api-key.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=e010ed75ac2715e56bea8eff6ca56f51 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-api-key.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=2a58dc5bea9d285c8261f6e5ce075452 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-api-key.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=38083240abdaf502d81231d6ad7a6649 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=50f4c0136258179f44a63a11cbc160ee 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=bc960c19075092e7b25bddc877971324 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=e287eafaad6d087300cb70365bb01f19 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

After clicking the 'Create API Key' button in the top-right corner, your API key will be generated.
You can then copy and paste it for querying ApeChain Data APIs endpoints.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-generated-api-key.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=078b26b296a7176939803cf31df86bcf" alt="0xGraph API Keys" data-og-width="3472" width="3472" data-og-height="1848" height="1848" data-path="images/apechain/0xgraph-generated-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-generated-api-key.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=9728d93a24017e374a2ed39cc75b8900 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-generated-api-key.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=5390acb3da3ea6a27dddad62f707c466 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-generated-api-key.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=d42a11d0b86ee636ff1d7a0c1a12e0b3 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-generated-api-key.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3bd3afd9e1381e052602ddbd9924c580 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-generated-api-key.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=73f4ba4b21b615b742935c1954860253 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-generated-api-key.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=9ae11ee53b3e0df2c8fa424d354c139d 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

<Info>
  Warning: Always handle your API keys securely. Do not expose them in client-side code or share them publicly. Store
  them in a secure location, such as environment variables, and rotate them regularly to minimize security risks. If
  compromised, regenerate your API key immediately. For public repositories, store API keys in a .env file and add .env
  to .gitignore to prevent accidental exposure in your codebase.
</Info>

You are all set and ready to query ApeChain Data APIs endpoints here:

<Card title="Access Now" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=a9571396cc76c68d8a93a2a2e05b8e82" href="/dedicated-env/apechain/data-apis/api-reference/balances/get-erc-20-balance" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/apechain-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=22149a81839206b445adde58fba72a2b 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=ab48183701879eed55a7a2aea4bed7c3 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=0acfc63a6e4ea6055dcea7a0bbe13b19 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=cbc537fd1ca2faad235449e4bfc1cc6d 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7499d9bd6e9b5770566b16a17fb9245c 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=1aecb07172defcb70732a70939640f04 2500w">
  Access Data APIs Now for Free
</Card>


# Monitor Your Data APIs
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/getting-started/monitoring

How to monitor your data APIs performance and usage

This feature is coming soon.


# Perform Query
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/getting-started/perform-query

How to perform a query on a REST endpoint to retrieve onchain data

In this guide, we will walk you through the steps to perform a query on a REST endpoint to retrieve onchain data.

## Prerequisites

Before you begin, ensure you have the following:

* An API key
* A REST client (e.g., Postman, curl)

## Steps to Perform a Query

1. **Identify the endpoint URL**: The base URL for the API is `https://data-api.cloud.ormi.dev/apechain`.
2. **Add the endpoint path**: Append the specific endpoint path to the base URL, e.g., `v1/address/{walletAddress}/balance`.
3. **Include query parameters**: Add any necessary query parameters to the URL, e.g., `?param1=value1&param2=value2`.
4. **Set up headers**: Include the required headers, such as `Authorization` with your API key.
5. **Make the request**: Use your REST client to send a GET request to the constructed URL.

You may find all our API definitions in the [API Reference](/dedicated-env/apechain/data-apis/api-reference/balances/get-erc-20-balance) or access them below:

<Card title="Access Now" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=a9571396cc76c68d8a93a2a2e05b8e82" href="/dedicated-env/apechain/data-apis/api-reference/balances/get-erc-20-balance" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/apechain-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=22149a81839206b445adde58fba72a2b 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=ab48183701879eed55a7a2aea4bed7c3 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=0acfc63a6e4ea6055dcea7a0bbe13b19 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=cbc537fd1ca2faad235449e4bfc1cc6d 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7499d9bd6e9b5770566b16a17fb9245c 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=1aecb07172defcb70732a70939640f04 2500w">
  Access Data APIs Now for Free
</Card>

***

## Example - Performing a Query to Fetch ERC20 Transfers

Here is an example of a query to retrieve the token balance of a wallet address on the Ethereum mainnet:

1. Identify the endpoint URL by navigating to the [API Reference](/dedicated-env/apechain/data-apis/api-reference).

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-erc20-transfers.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=9e3d2563157d6e1ffe11ca9124574e6a" alt="Retrieve ERC20 transfers" data-og-width="2685" width="2685" data-og-height="1605" height="1605" data-path="images/apechain/0xapi-erc20-transfers.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-erc20-transfers.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=912f9f7209d687d853f9022ca5240586 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-erc20-transfers.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=1a45fe1d19d9cea061d103e1afc345f1 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-erc20-transfers.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c1c45d51550f36a132f533e08801bdaf 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-erc20-transfers.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=5a561cfa8fcbf6642ca802cbf4bfcf16 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-erc20-transfers.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=66b7c699cee840dfa53d4eaa76cdc33c 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-erc20-transfers.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=8b454542a11593d48889dd3e2bbd7262 2500w" />

  <figcaption>Retrieve ERC20 transfers</figcaption>
</Frame>

2. Copy and paste the required endpoint path and query parameters into the editor, then click "Send" to make the request.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-perform-query.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=368d62a90e9731b2b4fad2be03e967ee" alt="Perform Query" data-og-width="2192" width="2192" data-og-height="1312" height="1312" data-path="images/apechain/0xapi-perform-query.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-perform-query.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=0c57b4d5f12933fb5ba2ed84828d6d70 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-perform-query.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=5384b50a80e92bbf3142a4700462cb92 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-perform-query.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=4d8db0f02c71b1797a4fc474552930c9 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-perform-query.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=cd6b11a40b582e242d7fa2dc3a8ad2c0 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-perform-query.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=1cb4a297a2bf3a189cbec3975cf89a24 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-perform-query.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=f7812ccec2fabc828a2ef1a0d754b53a 2500w" />

  <figcaption>Perform query</figcaption>
</Frame>

3. You may use any third-party tool such as curl or Postman to directly query the endpoint.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-curl.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c7fb3ef8105a41e925301b9b463ffd55" alt="Using Curl" data-og-width="1568" width="1568" data-og-height="242" height="242" data-path="images/apechain/0xapi-curl.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-curl.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7282dce2552778e2fcd252dd1298c6ef 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-curl.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=03481616f40f4e35246e27243234f6bf 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-curl.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=5632a78a53890b673523183aac808bea 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-curl.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c1f5193ed8a9a225a980653c5b1bdce7 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-curl.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=e34980f7eb0de49fdfe73ae596b64255 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-curl.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=16778d27bbc032023fdc18996e4aa65f 2500w" />

  <figcaption>Using curl for query</figcaption>
</Frame>

4. The API Reference page also provides handy code snippets for various programming languages to help you get started.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-languages.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=bb9ec4b1ed78782216e2661f4ea74b85" alt="Using Other Programming Languages" data-og-width="1568" width="1568" data-og-height="1102" height="1102" data-path="images/apechain/0xapi-languages.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-languages.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=90737f81e8f1a1c19bfc712e6ab0f122 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-languages.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=f2c088a105cb8e3871e645ec41aad3a9 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-languages.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=6770bb3cb54af9f3c349982278e48fc6 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-languages.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=ba99908cbdd77c35b56aca2d51b63de7 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-languages.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3fc3512e873ac08db01ca0b3514eb35c 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xapi-languages.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=4683d43c2d65fff17a0a010829cc1c0a 2500w" />

  <figcaption>Using other programming languages</figcaption>
</Frame>


# Overview
Source: https://docs.ormilabs.com/dedicated-env/apechain/data-apis/overview

The one-stop REST API solutions for standard and structured blockchain data access.

0xAPI provides a comprehensive suite of data APIs and development tools designed to simplify Web3 integration for ApeChain Network.

<Card title="Access Now" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=a9571396cc76c68d8a93a2a2e05b8e82" href="/dedicated-env/apechain/data-apis/api-reference/balances/get-erc-20-balance" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/apechain-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=22149a81839206b445adde58fba72a2b 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=ab48183701879eed55a7a2aea4bed7c3 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=0acfc63a6e4ea6055dcea7a0bbe13b19 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=cbc537fd1ca2faad235449e4bfc1cc6d 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7499d9bd6e9b5770566b16a17fb9245c 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=1aecb07172defcb70732a70939640f04 2500w">
  Access Data APIs Now for Free
</Card>

Built on the enterprise-grade, highly available Ormi data layer, these ApeChain Data APIs deliver structured on-chain data at the edge through robust interfaces, SDKs, and real-time streaming. Key features include:

* Token balance retrieval
* Access to historical transaction data
* Decoded event log insights
* Detailed traces with internal transactions, state changes, and input data (for foundational chains)

0xAPI provides developers with powerful tools to simplify and enhance web3 application development. Whether you're building wallets, NFT marketplaces, DeFi platforms, or blockchain explorers, these APIs offer comprehensive access to blockchain data across multiple chains. From tracking token balances and historical transactions to managing NFTs and enabling cross-chain functionality, Ormi APIs streamline the integration of critical features. With a focus on flexibility, security, and real-world utility, this toolkit empowers developers to create innovative solutions for a decentralized future.

## Summary of the Data APIs:

0xAPI enables developers to quickly and easily access structured onchain data. This means consistent response schemas that are blockchain agnostic. Available APIs and corresponding use cases include:

### Wallet API

**Features:** Retrieve all token balances (ERC20, ERC721, ERC1155, and native tokens), token transfers, and both current and historical token prices.\
**Use Cases:** Ideal for wallets, portfolio management tools, token gating systems, and airdrop snapshot functionality.

### Transactions API

**Features:** Comprehensive access to all historical transactions with easily interpretable log events, including gas usage and spending summaries.\
**Use Cases:** Perfect for accounting and tax solutions, as well as generating custom in-app transaction receipts.

### NFT API

**Features:** Access to media assets, metadata, sales data, ownership details, trait and attribute filters, and thumbnail previews.\
**Use Cases:** Designed for NFT galleries, marketplaces, real-world asset (RWA) tracking, and token gating mechanisms.

### Cross-Chain API

**Features:** Simplified APIs for retrieving wallet activity across multiple chains in a single call, including cross-chain transaction and balance data.\
**Use Cases:** Streamlined app onboarding and consolidated wallet activity feeds.

### Blockchain API

**Features:** Provides block details, log events by contract address or topic hash, gas price data, token price insights, and holder statistics.\
**Use Cases:** Tailored for building custom blockchain explorers.

### Security API (Coming Soon)

**Features:** Detailed insights into NFT and ERC20 token allowances, including value-at-risk calculations.\
**Use Cases:** Supports wallet revoke features and advanced security applications.


# Create tag
Source: https://docs.ormilabs.com/dedicated-env/apechain/subgraphs/api-reference/create-tag

POST /public_api/v1/0xgraph/create_tag



# Delete tag
Source: https://docs.ormilabs.com/dedicated-env/apechain/subgraphs/api-reference/delete-tag

POST /public_api/v1/0xgraph/delete_tag



# Query tag
Source: https://docs.ormilabs.com/dedicated-env/apechain/subgraphs/api-reference/query-tag

POST /public_api/v1/0xgraph/query_tag



# Remove subgraph
Source: https://docs.ormilabs.com/dedicated-env/apechain/subgraphs/api-reference/remove-subgraph

POST /public_api/v1/0xgraph/remove_subgraph

<Note>⚠️ CLI deletion is temporarily unsupported. Use the Ormi Dashboard UI to remove subgraphs.</Note>


# Cheat Sheet
Source: https://docs.ormilabs.com/dedicated-env/apechain/subgraphs/cheatsheet

Streamlined Guide: Deploying Subgraphs on 0xGraph with The Graph CLI

## Overview

This quick start guide outlines streamlined instructions for deploying Subgraphs using the Command Line Interface (CLI). Developers looking to swiftly incorporate Subgraph capabilities into their projects will find straightforward guidance and pro tips for getting set up fast.

<Info>
  This cheat sheet condenses essential commands, tips, and best practices into
  an indispensable reference for anyone deploying a Subgraph. Developers will
  find this streamlined guide invaluable for swiftly progressing through the
  deployment workflow and resolving frequent pain points. With key information
  consolidated in one place, engineers can deploy Subgraphs more efficiently and
  focus their efforts on building applications powered by real-time,
  customizable blockchain data indexes.
</Info>

## 1. Get started by installing The Graph CLI

Download The Graph CLI via npm

```bash  theme={null}
npm i @graphprotocol/graph-cli
```

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="https://www.npmjs.com/package/@graphprotocol/graph-cli">
  Install The Graph npm package
</Card>

## 2. Generate API key

Create an API key: Visit [0xGraph Dashboard](https://apechain.0xgraph.xyz/dashboard/api) to generate your API key

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

## 3. Generate types and mappings for your Subgraph

Go to your Subgraph root directory where `subgraph.yaml` file is located

```bash  theme={null}
cd <your_subgraph_project>
```

Run the following command to generate AssemblyScript types for smart contract ABIs and the subgraph schema

```bash  theme={null}
graph codegen
```

## 4. Compile your Subgraph

Run the following command to compile your Subgraph into WASM (WebAssembly)

```bash  theme={null}
graph build
```

## 5. Deploy your Subgraph to 0xGraph

Paste the API key generated in step 2 and run the following command to deploy your Subgraph to 0xGraph

```bash  theme={null}
graph deploy <your_subgraph> --node
https://apeapi.0xgraph.xyz/deploy
--ipfs https://apeapi.0xgraph.xyz/ipfs
--deploy-key <api_key>
```

<Info>
  If prompted to enter the version, use the version of The Graph CLI that you
  downloaded.
</Info>

You can now monitor your Subgraph deployment in the 0xGraph app

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-analytics.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=bf013e592546d405c8075ce3a8e149be" alt="Subgraph analytics page" data-og-width="1706" width="1706" data-og-height="1624" height="1624" data-path="images/apechain/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-analytics.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=2a8bc9784072b93bb762f066f7a1a5f4 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-analytics.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=6a152e2d466180af51720aa0a8174d21 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-analytics.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=abeaf65c6c94cbce75414746504dfd18 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=1edfd5ad1a9d2a09c9ea9b8705d1b66e 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=e45edbdb0bfc3c97c7b8aa3e57cf432e 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=1ef96eb19bbc741add12edb1240475c2 2500w" />
</Frame>

## Quick Start in the App

The [0xGraph Web App](https://apechain.0xgraph.xyz) also offers a concise guide to assist users in deploying their Subgraphs effectively

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-quickstart.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=34d40c9ab3d41721a7d86a1485500647" alt="Subgraph analytics page" data-og-width="3504" width="3504" data-og-height="1852" height="1852" data-path="images/apechain/0xgraph-quickstart.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-quickstart.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=53f350bb43451a548d4aaf84f0f3fd8b 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-quickstart.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=332bd91644d261d1ee7d9b00b1ddb1fd 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-quickstart.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=1fb82d85da3b1e4f92f89d3e65108c95 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-quickstart.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3c632ac1cb6444b1a533e1fc73fdadb1 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-quickstart.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3799e9797bfd8933e6d895056f879ada 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-quickstart.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=1e1f31564340f1dd25280056d69274e9 2500w" />
</Frame>


# Account Creation
Source: https://docs.ormilabs.com/dedicated-env/apechain/subgraphs/getting-started/account-creation

How to create your 0xGraph account

## Setup Steps

### 1. Create Account

Visit [apechain.0xgraph.xyz](https://apechain.0xgraph.xyz) to create your account.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-signup.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c2f4ac1b74ee25ba926876e1eaee22ae" alt="ApeChain App Registration" data-og-width="1536" width="1536" data-og-height="819" height="819" data-path="images/apechain/0xgraph-signup.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-signup.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=e75d4936d154a99619780952a2648b37 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-signup.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=76597d098fb63d3dda00efc4acc89bc3 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-signup.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=e52058e349670d0540ffd86f7fb7231b 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-signup.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=5fdc2be4422bd92ab1ee5af9e6322515 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-signup.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=a7a145edf2d79324480154f638ad1081 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-signup.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=d123735723d6c7efc751fad77deef7bf 2500w" />
</Frame>

### 2. Choose Subscription Plan

Choose a plan that best fits your needs in [Settings page](https://apechain.0xgraph.xyz/dashboard/settings).

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-pricing.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7f1e2b0e211fbea7bab95ce9b340477e" alt="ApeChain Subscription Plans" data-og-width="2304" width="2304" data-og-height="1097" height="1097" data-path="images/apechain/0xgraph-pricing.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-pricing.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7e4bcdf59242ec097327100f9af05087 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-pricing.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c1ccf0894d708db980ecc0c6b03d175a 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-pricing.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=f1ee922f2905caee0accd225b94061cf 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-pricing.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=a755eea8419cf4b9edeb5f8ce80dd6d2 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-pricing.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7e29c61f5fd614aaf024f9389d015a55 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-pricing.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=ad727ca13e0bd7e4c34a25d944fda4b7 2500w" />

  <figcaption>Choose a subscription plan</figcaption>
</Frame>

### 3. Generate API Key

Go to the [API Keys Page](https://apechain.0xgraph.xyz/dashboard/api) to create your API key.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-api-key.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=d9bdcecb620ed8acdb1b89a70e3a34f1" alt="ApeChain API Keys" data-og-width="2304" width="2304" data-og-height="1213" height="1213" data-path="images/apechain/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-api-key.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=e010ed75ac2715e56bea8eff6ca56f51 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-api-key.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=2a58dc5bea9d285c8261f6e5ce075452 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-api-key.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=38083240abdaf502d81231d6ad7a6649 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=50f4c0136258179f44a63a11cbc160ee 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=bc960c19075092e7b25bddc877971324 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=e287eafaad6d087300cb70365bb01f19 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

After clicking the 'Create API Key' button in the top-right corner, your API key will be generated. You can then copy and paste it into your commands as needed.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-generated-api-key.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=078b26b296a7176939803cf31df86bcf" alt="ApeChain API Keys" data-og-width="3472" width="3472" data-og-height="1848" height="1848" data-path="images/apechain/0xgraph-generated-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-generated-api-key.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=9728d93a24017e374a2ed39cc75b8900 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-generated-api-key.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=5390acb3da3ea6a27dddad62f707c466 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-generated-api-key.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=d42a11d0b86ee636ff1d7a0c1a12e0b3 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-generated-api-key.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3bd3afd9e1381e052602ddbd9924c580 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-generated-api-key.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=73f4ba4b21b615b742935c1954860253 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-generated-api-key.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=9ae11ee53b3e0df2c8fa424d354c139d 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

<Info>
  Warning: Always handle your API keys securely. Do not expose them in
  client-side code or share them publicly. Store them in a secure location, such
  as environment variables, and rotate them regularly to minimize security
  risks. If compromised, regenerate your API key immediately. For public
  repositories, store API keys in a .env file and add .env to .gitignore to
  prevent accidental exposure in your codebase.
</Info>

You are all set and ready to go for deploying a subgraph.


# CLI Usage
Source: https://docs.ormilabs.com/dedicated-env/apechain/subgraphs/getting-started/cli-usage

A detailed list of all active and relevant commands for The Graph CLI, including their purposes, use cases, and examples.

## `graph init`

**Purpose:**\
Creates a new Subgraph project using an example template or an existing smart contract.

**Use Case:**

* Use this command when starting a new Subgraph project.
* It sets up the necessary folder structure, configuration files `subgraph.yaml`, and example code.
* You can specify a contract address and network to scaffold a Subgraph tailored to a specific smart contract.

**Example:**

```bash  theme={null}
graph init --from-contract <CONTRACT_ADDRESS> --network mainnet
```

## `graph codegen`

**Purpose:**\
Generates AssemblyScript types for smart contract ABIs and the Subgraph schema.

**Use Case:**

* Use this command after making changes to your `schema.graphql` file or when adding/updating smart contract ABIs.
* It creates type-safe classes that make it easier to interact with blockchain data in your mappings.

## `graph build`

**Purpose:**\
Compiles the Subgraph to WebAssembly (WASM), preparing it for deployment.

**Use Case:**

* Run this command after completing your mappings and configuration.
* It ensures your Subgraph is ready for deployment by converting it into the WASM format required by 0xGraph.

## `graph deploy`

**Purpose:**\
Deploys the compiled Subgraph to the 0xGraph hosting service.

**Use Case:**

* After building your Subgraph, use this command to upload and activate it on 0xGraph.
* Specify the deployment target (e.g., staging or production) and the Subgraph name.

**Example:**

```bash  theme={null}
graph deploy <your_subgraph> --node
https://apeapi.0xgraph.xyz/deploy
--ipfs https://apeapi.0xgraph.xyz/ipfs
--deploy-key <your_api_key>
```

## `graph local`

**Purpose:**\
Runs a local test environment (e.g., using Ganache or Hardhat) to test the Subgraph with simulated blockchain data.

**Use Case:**

* Use this command when developing and testing your Subgraph locally.
* It allows you to simulate blockchain events and validate mappings.
* Ideal for testing without deploying to a live environment.

## `graph test`

**Purpose:**\
Downloads and runs the Matchstick Rust binary to execute unit tests for a Subgraph.

**Use Case:**

* Use this command to write and run unit tests for your mappings and ensure that your Subgraph logic works correctly.
* Matchstick is a testing framework built specifically for The Graph.

## `graph add`

**Purpose:**\
Adds a new data source to your Subgraph’s manifest file (subgraph.yaml) and updates relevant files such as schema.graphql, ABIs, and mappings.

**Use Case:**

* Use this command when adding additional smart contracts or data sources to your Subgraph.
* It automates the process of updating your Subgraph configuration and related files.

**Example:**

```bash  theme={null}
graph add <CONTRACT_NAME> --from-contract <CONTRACT_ADDRESS>
```

<Info>
  Ensure you have the latest version of The Graph CLI installed to avoid
  potential issues with deprecated or updated commands.
</Info>


# Deploy a Subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/apechain/subgraphs/getting-started/deploy-subgraph-graph-cli

Quick start guide for deploying a Subgraph using the Command Line Interface (CLI).

<Info>
  The Graph CLI is an essential tool enabling developers to seamlessly create,
  deploy, and manage subgraphs—providing streamlined blockchain data querying
  and indexing. It gives you superuser access to our enterprise-grade subgraph
  infrastructure. Additionally, we are fully compatible with The Graph's
  tooling, and the CLI works seamlessly out of the box with our platform.
</Info>

## Deployment Network Definitions

For developers who are already familiar with Graph Protocol tooling, below are the network definitions to deploy subgraphs on 0xGraph. These settings can be configured in the subgraph.yaml file:

## Installation

<Steps>
  <Step title="Install CLI Package">
    <CodeGroup>`npm i @graphprotocol/graph-cli `</CodeGroup>
  </Step>
</Steps>

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="_blank">
  Install the graph npm package
</Card>

## Generate API Key

Create an API key: Visit [0xGraph Dashboard](https://apechain.0xgraph.xyz/dashboard/api) to generate your API key. For a comprehensive tutorial on generating API keys, visit the [Account Creation Page](/dedicated-env/apechain/subgraphs/getting-started/account-creation).

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

***

## Create your own Subgraph

Details regarding creating your own Subgraph is beyond the scope of this documentation. The Graph's official documentation provides detailed guides and examples for each step of the Subgraph creation process. It also covers advanced topics such as indexing strategies, filtering, and pagination. We recommend referring to their documentation for a comprehensive reference on Subgraph development with The Graph.

## Core Components

A typical Subgraph project has the following components:

<CardGroup cols={2}>
  <Card title="Manifest File" icon="file-lines">
    The `subgraph.yaml` manifest file serves as the root configuration, containing smart contract references, entity mappings, handler functions, and deployment parameters like `startBlock` and `description`.
  </Card>

  {' '}

  <Card title="Schema File" icon="database">
    The `schema.graphql` file defines all the entities and their relationships for
    your Subgraph's GraphQL API, determining what blockchain data will be indexed
    and made queryable.
  </Card>

  <Card title="Mappings File" icon="code">
    Written in [AssemblyScript](https://www.assemblyscript.org/), a TypeScript-like language specifically designed for WebAssembly, the mappings file transforms raw blockchain data into structured entities that match your GraphQL schema through a set of data handling functions.
  </Card>
</CardGroup>

<Note>
  Messari maintains a [well-curated GitHub
  repository](https://github.com/messari/subgraphs) that offers a comprehensive
  collection of example Subgraphs, which serves as a valuable resource for those
  seeking to start their subgraph development journey.
</Note>

***

## Subgraph Compilation

<Steps>
  <Step title="Generate Types and Mappings">
    <Note>
      The codegen step generates code files for indexing and querying data based on your schema and mappings.
    </Note>

    Run in your project root:

    ```bash  theme={null}
    graph codegen
    ```

    Success output:

    ```bash  theme={null}
        Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
        Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
        Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
        Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
        Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
        Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
        Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
      ✔ Apply migrations
      ✔ Load subgraph from subgraph.yaml
        Load contract ABI from abis/factory.json
        Load contract ABI from abis/ERC20.json
        Load contract ABI from abis/ERC20SymbolBytes.json
        Load contract ABI from abis/ERC20NameBytes.json
      ✔ Load contract ABIs
        Generate types for contract ABI: Factory (abis/factory.json)
        Generate types for contract ABI: ERC20 (abis/ERC20.json)
        Generate types for contract ABI: ERC20SymbolBytes (abis/ERC20SymbolBytes.json)
        Generate types for contract ABI: ERC20NameBytes (abis/ERC20NameBytes.json)
        Write types to generated/Factory/Factory.ts
        Write types to generated/Factory/ERC20.ts
        Write types to generated/Factory/ERC20SymbolBytes.ts
        Write types to generated/Factory/ERC20NameBytes.ts
      ✔ Generate types for contract ABIs
        Generate types for data source template Pair
        Write types for templates to generated/templates.ts
      ✔ Generate types for data source templates
        Load data source template ABI from abis/pair.json
        Load data source template ABI from abis/factory.json
      ✔ Load data source template ABIs
        Generate types for data source template ABI: Pair > Pair (abis/pair.json)
        Generate types for data source template ABI: Pair > Factory (abis/factory.json)
        Write types to generated/templates/Pair/Pair.ts
        Write types to generated/templates/Pair/Factory.ts
      ✔ Generate types for data source template ABIs
      ✔ Load GraphQL schema from schema.graphql
        Write types to generated/schema.ts
      ✔ Generate types for GraphQL schema

      Types generated successfully
    ```

    <Accordion title="Codegen Options">
      <Info>
        View all options with `graph codegen --help`:
      </Info>

      ```bash  theme={null}
      USAGE
        $ graph codegen [SUBGRAPH-MANIFEST] [-h] [-o <value>] [--skip-migrations] [-w] [--uncrashable-config <value> -u]

      FLAGS
        -h, --help                    Show CLI help.
        -o, --output-dir=<value>      [default: generated/] Output directory for generated types.
        -u, --uncrashable             Generate Float S
                                      subgraph Uncrashable helper file.
        -w, --watch                   Regenerate types when subgraph files change.
        --skip-migrations             Skip subgraph migrations.
        --uncrashable-config=<value>  Directory for uncrashable config.
      ```
    </Accordion>
  </Step>

  <Step title="Build Your Subgraph">
    After generating types, build your subgraph:

    ```bash  theme={null}
    graph build
    ```

    Success Output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/

    Build completed: build/subgraph.yaml
    ```

    <Accordion title="Build Options">
      <Info>
        View all options with `graph build --help`:
      </Info>

      ```bash  theme={null}
      Builds a subgraph and (optionally) uploads it to IPFS.

        USAGE
          $ graph build [SUBGRAPH-MANIFEST] [-h] [-i <value>] [-o <value>] [-t wasm|wast]
            [--skip-migrations] [-w] [--network <value>] [--network-file <value>]

        FLAGS
          -h, --help                    Show CLI help.
          -i, --ipfs=<value>            Upload build results to an IPFS node.
          -o, --output-dir=<value>      [default: build/] Output directory for build results.
          -t, --output-format=<option>  [default: wasm] Output format for mappings.
                                        <options: wasm|wast>
          -w, --watch                   Regenerate types when subgraph files change.
          --network=<value>             Network configuration to use from the networks config file.
          --network-file=<value>        [default: networks.json] Networks config file path.
          --skip-migrations             Skip subgraph migrations.

      DESCRIPTION
      Builds a subgraph and (optionally) uploads it to IPFS.

      ```
    </Accordion>
  </Step>

  <Step title="Deploy your Subgraph">
    Then deploy your Subgraph:

    ```bash  theme={null}
    graph deploy <your_subgraph> --node
    https://apeapi.0xgraph.xyz/deploy
    --ipfs https://apeapi.0xgraph.xyz/ipfs
    --deploy-key <your_API_key>
    ```

    Success output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/
      Add file to IPFS build/schema.graphql
                    .. Qmckrwbgbx3FjsVH4AU8xP3zgdg3rPnzNo7pmApAmhQkA4
      Add file to IPFS build/Factory/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9
      Add file to IPFS build/Factory/ERC20.json
                    .. QmPfKNZPkVATzL3EHypkcsyKhehR4jkiYEVqSzh2hxWYj1
      Add file to IPFS build/Factory/ERC20SymbolBytes.json
                    .. QmbHnhUFZa6qqqRyubUYhXntox1TCBxqryaBM1iNGqVJzT
      Add file to IPFS build/Factory/ERC20NameBytes.json
                    .. QmQCP6Pdp1MqpwRv2qoPHuUTwZGy7Q3eDHg4w5kzwE9mBj
      Add file to IPFS build/Factory/Factory.wasm
                    .. QmNksN9HGSyMfc4XrjQeHuDKsBQk1xHEKVE2dLwHQQu4kb
      Add file to IPFS build/Pair/pair.json
                    .. QmbPLMADBP8L6LBVP3ZBQ8RgG7ghamD8DvbdUxHAjZrLgm
      Add file to IPFS build/Pair/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9 (already uploaded)
      Add file to IPFS build/templates/Pair/Pair.wasm
                    .. QmSZSUoNinhNshD26iwKyzut6s3w5Lmec3P9szBovfQg8V
    ✔ Upload subgraph to IPFS

    Build completed: QmdXJQUxgrzP8pVotTqiwirJ6NxfmdNdQ6rWQv2rmJpBQp

    Deployed to /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn

    Subgraph endpoints:
    Queries (HTTP):     /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn
    ```
  </Step>
</Steps>

<Card title="View Your Subgraphs" icon="browser">
  Access your deployed Subgraphs through the web-based UI at [apechain.0xgraph.xyz](http://apechain.0xgraph.xyz)
</Card>

```
```


# Deploy a token transfer subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/apechain/subgraphs/getting-started/deploy-token-transfer-subgraph

Tutorial on how to deploy an erc20 token transfer subgraph with the Graph CLI



# Monitor Your Subgraph
Source: https://docs.ormilabs.com/dedicated-env/apechain/subgraphs/getting-started/monitor-subgraph

Learn how to monitor your subgraph syncing progress and logs after deployment

# Monitor your subgraph via the Analytics Page

After deploying your subgraph, you can easily monitor the syncing progress and subgraph logs for up to 48 hours to gain insight and troubleshoot any issues that may come with your subgraph.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-monitor.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=bf84ad0bb03133ef35ff8442e888481b" alt="Subgraph deployment view" data-og-width="3322" width="3322" data-og-height="1168" height="1168" data-path="images/apechain/0xgraph-monitor.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-monitor.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c09b53ba1bb2341dabe99ece1ba53533 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-monitor.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=b7443e8be7a092d421e82568c3bbec60 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-monitor.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=72429ce7e11d5f7f0334b5e84fef0551 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-monitor.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=29136ae145ddeaf1de46a16e52ce0473 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-monitor.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=83f3dd0154c4914bc81d1bf088c8540d 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-monitor.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=d4d4cd7e154211b937c3d353c59e341d 2500w" />
</Frame>

You can access your deployed subgraph analytics page by clicking on the subgraph name; afterward, you will be directed to the following analytics page.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-analytics.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=bf013e592546d405c8075ce3a8e149be" alt="Subgraph analytics page" data-og-width="1706" width="1706" data-og-height="1624" height="1624" data-path="images/apechain/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-analytics.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=2a8bc9784072b93bb762f066f7a1a5f4 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-analytics.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=6a152e2d466180af51720aa0a8174d21 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-analytics.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=abeaf65c6c94cbce75414746504dfd18 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=1edfd5ad1a9d2a09c9ea9b8705d1b66e 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=e45edbdb0bfc3c97c7b8aa3e57cf432e 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=1ef96eb19bbc741add12edb1240475c2 2500w" />
</Frame>


# Perform Query
Source: https://docs.ormilabs.com/dedicated-env/apechain/subgraphs/getting-started/perform-query

Short description on what this section is about

After deploying your subgraph, you can easily access and query it via GraphQL playground for query. You can open the "GraphQL API" link in your dashboard to access your data.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-graphql-api.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=6ed7df8710ef737fac3d0430ba1e7800" alt="subgraphs" data-og-width="1489" width="1489" data-og-height="504" height="504" data-path="images/apechain/0xgraph-graphql-api.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-graphql-api.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=34db4ef7b7e21bed5dd67bc075359505 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-graphql-api.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=4177b2ab12fe517591dca2cb56bafc24 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-graphql-api.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=175285f8675c598eb663b1bce19f2279 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-graphql-api.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=fc51d1c3b7eab28b9495c6410eb2ff6e 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-graphql-api.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=fcd7b4f510a6981af137ed467208749e 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-graphql-api.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=dfc1f29d3e4fb416fb06c0b8b7109749 2500w" />
</Frame>

For example, you may access the publicly available Apechain token approval subgraph at `https://apeapi.0xgraph.xyz/subgraphs/name/token-transfer/graphql`

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-graphql.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=8d0da4e33f89c99429dbb274d8ff4dd1" alt="GraphQL" data-og-width="1847" width="1847" data-og-height="867" height="867" data-path="images/apechain/0xgraph-graphql.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-graphql.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=4b0a2cad562e4bf06f7c37a2129a17a1 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-graphql.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=dd5e7779e9b221ca8e801b5b3743f908 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-graphql.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=20ef77be44dad0fb8b00f2b2ca7c505c 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-graphql.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c06f6440c82874a70734f8875214c563 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-graphql.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=dbcea20dff9318b40e09e5dab0adb4a3 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/apechain/0xgraph-graphql.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=d4f4993ab5e34418f54d26c654f2a048 2500w" />
</Frame>

***

## Query for Subgraph Sync Status

To get to know the sync status directly inside the subgraph, a user may run the following query by using `_meta`:

```graphql  theme={null}
{
  _meta {
    block {
      hash
      timestamp
      number
    }
  }
}
```

The result would be similar to the following:

```json  theme={null}
{
  "data": {
    "_meta": {
      "block": {
        "hash": "0x9f2480d4a21fb9743ae35d349fccbc86c0fad084d6a87b53d1f649f1051c6ddb",
        "timestamp": 1700267031,
        "number": 151479342
      }
    }
  }
}
```

***

## Query a Subgraph

Subgraphs expose blockchain data via a GraphQL API, making it easy for anyone familiar with the GraphQL language to get started.

A GraphQL API differs from traditional REST APIs in that it relies on a schema definition to outline the available queries, mutations, and data types that clients can access.

## Benefits of Schema-Driven Approach

This schema-driven approach enables clients to precisely specify the data they need, eliminating the need to over-fetch data. Here's why this is beneficial:

<CardGroup>
  <Card title="Precision" icon="bullseye">
    GraphQL clients can tailor their queries to retrieve only the data they require, enhancing efficiency.
  </Card>

  <Card title="Flexibility" icon="arrows-to-circle">
    Clients can request related data in a single query, reducing the number of API calls needed.
  </Card>

  <Card title="Predictability" icon="chart-line">
    The schema provides clear documentation for available data and operations.
  </Card>
</CardGroup>

## GraphQL Syntax

GraphQL queries are composed using a specific syntax that allows for hierarchical data retrieval. Clients specify the fields they want to retrieve and their relationships within a single query. This approach minimizes unnecessary data retrieval, resulting in more concise and efficient requests.

## Best Practices

When working with the 0xGraph service, it's essential to follow best practices to ensure optimal performance and efficiency. These best practices are outlined in official Graph Protocol documentation.

<Info>
  For detailed instructions on querying 0xGraph using GraphQL and to ensure adherence to best practices, refer to the [official
  documentation](https://thegraph.com/docs/en/querying/querying-best-practices/) provided by the Ormi Labs and Graph Protocol teams. These resources offer
  valuable insights and recommendations to streamline your interaction with blockchain data through GraphQL.
</Info>


# Private Graphql URL
Source: https://docs.ormilabs.com/dedicated-env/apechain/subgraphs/getting-started/private-url

Learn how to create a private GraphQL URL for your subgraph

## Private Graphql URL

When you deploy a new subgraph, a public GraphQL endpoint is provided by default. However, you can also create a private endpoint for your subgraph, which requires an authentication token for requests. This private endpoint ensures that only authorized users or applications can access your subgraph's data, maintaining data security and control.

## Enable Private GraphQL Link

To use the private endpoint, you first need to enable it in your subgraph's detail on the 0xGraph console.

1. Navigate to your project details page.
2. Find the "PRIVATE GRAPHQL LINK" section.
3. Toggle the switch to "Enabled".

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=560e6af6112a63cffb865cbc60afd565" alt="Enable Private URL" width="700" data-og-width="1229" data-og-height="834" data-path="images/how-to/private.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=84eabc519189ef2a3b52f280ff7e2646 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a44106946348f0dcaf322b5b35e66c41 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6dcfd639d6e2d14fdacf34fc469e0afd 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e8470fabfb0845232d16b5434ada8136 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=93dc339e9fdfbd6dcc7ed4ad027c6baf 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=aee1e2143fe2327a40640aacd8e8b906 2500w" />

## Find Your Private URL

Once enabled, your unique private GraphQL URL will be displayed. You can also find this URL listed on the main page of your project environment under the "PRIVATE GRAPHQL LINK" column.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=45d17f6b83f1234c38290ece93132fab" alt="Private URL List" width="700" data-og-width="1881" data-og-height="880" data-path="images/how-to/private2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=170c03e25794a0fa9099ae07c2ce6f67 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a733750201ba10c93bb3d985c5b775de 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=c0b478fca2ec7586f8f12db7bf9434e6 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a0e72f5d6ff87f1768e3688ed1995abb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f478e814674d0454cf0d1eb46704f1c3 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f7fb3ddbec13791ab5948282de354b3e 2500w" />

## Authentication

To query your private GraphQL endpoint, you must include an authentication token in the request header.

1. Obtain your API key from the 0xGraph console API Keys.
2. In your GraphQL client (like GraphiQL or Postman), add an `Authorization` header.
3. Set the header value to `Bearer YOUR_API_KEY`, replacing `YOUR_API_KEY` with the actual key.

Here's how it looks in the GraphiQL interface provided by 0xGraph:

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b36c81515bf5633e8446b1a9bc18a852" alt="Private URL Token" width="700" data-og-width="1261" data-og-height="836" data-path="images/how-to/private3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=62296e918593924606edca6ea9bb0e52 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7b7d3af194a2243c9a63ddd31c209e5c 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=87e773a3ca3156ba9ab3700bb365713d 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a5d877ffa5cc966da46065fa94a2ed90 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e4f121ec83725881815c920ece44b3d1 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=67f6cb202406476251abef74a4f70e3f 2500w" />

By following these steps, you can securely interact with your subgraph using its private GraphQL endpoint.


# Subgraph Webhooks
Source: https://docs.ormilabs.com/dedicated-env/apechain/subgraphs/getting-started/webhook

Learn how to create and manage webhooks for your subgraphs to receive real-time updates.

## Subgraph Webhooks

Subgraph webhooks allow you to receive HTTP POST requests in real-time whenever an entity in your subgraph changes due to an `INSERT`, `UPDATE`, or `DELETE` operation. This is useful for triggering backend processes, sending notifications, or syncing data with external systems.

## How it Works

When a subgraph handler executes an operation like `entity.save()` (resulting in an `INSERT` or `UPDATE`) or an entity is removed (resulting in a `DELETE`), the change is recorded. A real-time watcher detects this update and sends a payload to your configured webhook URL. The payload will indicate the type of operation: `INSERT`, `UPDATE`, or `DELETE`.

## Creating a Webhook

You can create a new webhook through the 0xGraph dashboard.

1. Navigate to the "Webhooks" section of your subgraph.

2. Click on the "New Webhook" button.

3. Fill in the required information in the "Create Webhook" modal:

   * **Name**: A descriptive name for your webhook (e.g., `webhook_demo`).
   * **URL**: The HTTP endpoint where the webhook payloads will be sent.
   * **Entity**: The specific entity you want to track (e.g., `approved`).
   * **Number of retries**: Configure the total number of retries. Defaults to 3, with a maximum of 10.
   * **Retry interval**: Configure the retry interval in seconds. Defaults to 60, with a maximum of 3600.
   * **Retry timeout**: Configure the retry timeout in seconds. Defaults to 30, with a maximum of 60.
   * **"secret" header value**: An optional secret string that will be sent in a designated webhook secret header. This allows your endpoint to verify that the request is authentic.

   <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9234eae31186a5b6f649ed942830ff6c" alt="Create Webhook Modal" data-og-width="1872" width="1872" data-og-height="879" height="879" data-path="images/how-to/webhook.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9f6074a41fc7104edd1f8a831dcf426b 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=70599e318f7d4dbb52bd9b9271f5fb9b 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=12c058b62fbe1aad60ae53b93b4edb0f 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d09122a7d15636238f837d4fb83fb9cb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d4299f143c74dac74aefe4d276549743 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9b8b5cfcba5dbd305b27b026d77ab5d4 2500w" />

4. Click "Create".

## Listing Webhooks

Once created, your webhook will appear in the list of webhooks for your subgraph. You can see its name, the entity it tracks, the target URL, and statistics about successful and failed deliveries.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=1a8a8610f0aa060edd6cec706e366d69" alt="Webhook List" data-og-width="1000" width="1000" data-og-height="818" height="818" data-path="images/how-to/webhook3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=fba9d6def6020d6c02eacc3c4670f763 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ee4af7ca24eeadf9bfab5bde38ab1811 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6e22347e0fe60c0d103c87000e981f06 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=59a7e24f1e30c3da890b3ea603216cc5 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ac5ba543c4c479ce7052f173ee858471 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6887464b8fb3a4b2866c91c8f90a8cb7 2500w" />

## Webhook Payload Structure

The webhook will send a JSON payload to your configured URL. The main payload object contains the following fields:

* `op` (string): The type of operation that triggered the webhook. Possible values are `"INSERT"`, `"UPDATE"`, or `"DELETE"`.
* `data_source` (string): Identifier for the subgraph or indexer being tracked.
* `data` (object): Contains the actual entity data that changed. It has two sub-fields:
  * `old` (object | null): The state of the entity before the change. This will be `null` if the `op` is `"INSERT"`.
  * `new` (object | null): The state of the entity after the change. This will be `null` if the `op` is `"DELETE"`.
* `webhook_name` (string): The name you assigned to your webhook during creation.
* `webhook_id` (string): A unique identifier for the webhook configuration.
* `id` (string): A unique identifier for this specific event notification.
* `delivery_info` (object): Information about the delivery attempt for this webhook. It has two sub-fields:
  * `max_retries` (integer): The maximum number of retry attempts configured for this webhook.
  * `current_retry` (integer): The current retry attempt number for this specific event (0 for the initial attempt).
* `entity` (string): The name of the subgraph entity being tracked.

### Example Payloads:

**`INSERT` operation:**

```json  theme={null}
{
  "op": "INSERT",
  "data_source": "privateURL/v0.0.1",
  "data": {
    "new": {
      "id": "ERC20Approve-0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc-w\\u001c\\u001b\\u0002\\ufffd\\ufffd\\ufffd\\u07Ջ^\\ufffdcO\\ufffd\\ufffd(7C\\u001c\\u001b-\\ufffd\\u0016僞\\ufffdm\\ufffd\\ufffdI+y\\ufffd\\ufffd^\\u0015\\ufffd\\ufffdY\\ufffd",
      "vid": 7271978,
      "owner": "\\\\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc",
      "amount": 1.157920892373162e+77,
      "is_all": false,
      "spender": "\\\\xbde5839ec36db2ac492b79e9e3b75e15fa8a59ec",
      "updated_at": 1747127781,
      "block_range": "[20405156,)"
    },
    "old": null
  },
  "webhook_name": "webhook_demo",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "id": "5b623fd0-b539-400b-bbb3-060d95403a64",
  "delivery_info": {
    "max_retries": 3,
    "current_retry": 0
  },
  "entity": "approved"
}
```

**`UPDATE` operation :**

```json  theme={null}
{
  "data": {
    "new": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,20405060)"
    },
    "old": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,)"
    }
  },
  "data_source": "privateURL/v0.0.1",
  "delivery_info": {
    "current_retry": 0,
    "max_retries": 3
  },
  "entity": "approved",
  "id": "dd2b6013-22e1-4e8e-a665-be5276144a68",
  "op": "UPDATE",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "webhook_name": "webhook_demo"
}
```


# 0xGraph - Reliable Subgraph Indexing
Source: https://docs.ormilabs.com/dedicated-env/apechain/subgraphs/overview



Deploy subgraphs with 99.9%+ availability and fetch smart contract data at 3x the speed. 100% spec-compliant with every subgraph on The Graph's hosted and decentralized networks.

## Overview

Subgraphs are customizable, open-source solutions for indexing and accessing real-time blockchain data through GraphQL APIs.

0xGraph is a zero-hassle subgraph hosting solution that is 100% spec-compliant with every subgraph on The Graph Protocol’s hosted and decentralized networks, minus the lag and downtime.

* Plug and play deployment and subgraph migration from hosted services.
* Deploy subgraphs with the same tooling, UI, and similar CLI as The Graph.
* Query subgraphs without running any nodes or infrastructure.

### Supported Networks

0xGraph currently supports the following networks:

| Name            | Type    | Network Slug      |
| --------------- | ------- | ----------------- |
| Apechain        | Mainnet | `apechain`        |
| Apechain Curtis | Testnet | `apechain-curtis` |

### Available Upon Request

Any other network you need? Please email us: [hello@ormilabs.com](mailto:hello@ormilabs.com)


# Overview
Source: https://docs.ormilabs.com/dedicated-env/berachain/data-apis/overview

Coming soon



# Create tag
Source: https://docs.ormilabs.com/dedicated-env/berachain/subgraphs/api-reference/create-tag

POST /public_api/v1/0xgraph/create_tag



# Delete tag
Source: https://docs.ormilabs.com/dedicated-env/berachain/subgraphs/api-reference/delete-tag

POST /public_api/v1/0xgraph/delete_tag



# Query tag
Source: https://docs.ormilabs.com/dedicated-env/berachain/subgraphs/api-reference/query-tag

POST /public_api/v1/0xgraph/query_tag



# Remove subgraph
Source: https://docs.ormilabs.com/dedicated-env/berachain/subgraphs/api-reference/remove-subgraph

POST /public_api/v1/0xgraph/remove_subgraph

<Note>
  ⚠️ CLI deletion is temporarily unsupported. Use the Ormi Dashboard UI to remove subgraphs.
</Note>


# Cheat Sheet
Source: https://docs.ormilabs.com/dedicated-env/berachain/subgraphs/cheatsheet

Streamlined Guide: Deploying Subgraphs on 0xGraph with The Graph CLI

## Overview

This quick start guide outlines streamlined instructions for deploying Subgraphs using the Command Line Interface (CLI). Developers looking to swiftly incorporate Subgraph capabilities into their projects will find straightforward guidance and pro tips for getting set up fast.

<Info>
  This cheat sheet condenses essential commands, tips, and best practices into
  an indispensable reference for anyone deploying a Subgraph. Developers will
  find this streamlined guide invaluable for swiftly progressing through the
  deployment workflow and resolving frequent pain points. With key information
  consolidated in one place, engineers can deploy Subgraphs more efficiently and
  focus their efforts on building applications powered by real-time,
  customizable blockchain data indexes.
</Info>

## 1. Get started by installing The Graph CLI

Download The Graph CLI via npm

```bash  theme={null}
npm i @graphprotocol/graph-cli
```

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="https://www.npmjs.com/package/@graphprotocol/graph-cli">
  Install The Graph npm package
</Card>

## 2. Generate API key

Create an API key: Visit [0xGraph Dashboard](https://berachain.0xgraph.xyz/dashboard/api) to generate your API key

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

## 3. Generate types and mappings for your Subgraph

Go to your Subgraph root directory where `subgraph.yaml` file is located

```bash  theme={null}
cd <your_subgraph_project>
```

Run the following command to generate AssemblyScript types for smart contract ABIs and the subgraph schema

```bash  theme={null}
graph codegen
```

## 4. Compile your Subgraph

Run the following command to compile your Subgraph into WASM (WebAssembly)

```bash  theme={null}
graph build
```

## 5. Deploy your Subgraph to 0xGraph

Paste the API key generated in step 2 and run the following command to deploy your Subgraph to 0xGraph

```bash  theme={null}
graph deploy <your_subgraph> --node
https://api.berachain.0xgraph.xyz/deploy
--ipfs https://api.berachain.0xgraph.xyz/ipfs
--deploy-key <api_key>
```

<Info>
  If prompted to enter the version, use the version of The Graph CLI that you
  downloaded.
</Info>

You can now monitor your Subgraph deployment in the 0xGraph app

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-analytics.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=a9d6d087883286b872babaffb2e9ba5c" alt="Subgraph analytics page" data-og-width="2350" width="2350" data-og-height="1808" height="1808" data-path="images/berachain/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-analytics.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=adb81f91ae6b9b85ae2c63fcf8641888 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-analytics.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=0205c47cb06fa9d73ef27ff4838ba7f2 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-analytics.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=b3fcbfe21682bc2803c9401d54487f80 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=6c03cf918e396d7a374e6fa75c6f3e5f 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=457ee77aef14bb73e21d08731d2e83a6 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=398848e8a611f81bf2084982f829dccb 2500w" />
</Frame>

## Quick Start in the App

The [0xGraph Web App](https://berachain.0xgraph.xyz) also offers a concise guide to assist users in deploying their Subgraphs effectively

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-quickstart.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=1b4b461a406ed5942201891610ce2ab5" alt="Subgraph analytics page" data-og-width="3490" width="3490" data-og-height="1776" height="1776" data-path="images/berachain/0xgraph-quickstart.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-quickstart.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=86c1512524fe223aad474bb6c77982e6 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-quickstart.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7addac097fdb364cefd9e8f2f563379e 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-quickstart.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c64ff8cd83af7eea06697ce30168c00a 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-quickstart.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3ae03aa4d44298121efa176a533d5e8e 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-quickstart.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=79165e080f6facc99635357122c3fb04 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-quickstart.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=b53a18d8af129e12dccda3960d33ca59 2500w" />
</Frame>


# Account Creation
Source: https://docs.ormilabs.com/dedicated-env/berachain/subgraphs/getting-started/account-creation

How to create your 0xGraph account

## Setup Steps

### 1. Create Account

Visit [berachain.0xgraph.xyz](https://berachain.0xgraph.xyz) to create your account.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-signup.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3626d693ccbc800066e8e02951d1ca57" alt="BeraChain App Registration" data-og-width="2254" width="2254" data-og-height="1750" height="1750" data-path="images/berachain/0xgraph-signup.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-signup.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=fed1d79e10db94d278977961d8a9e333 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-signup.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=fc9956e1c88ff748ef2132267c39c151 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-signup.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=cfe7237592c0852cc57e1310653c01dc 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-signup.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3be88cbdff0240a99de8c7bb06c10da1 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-signup.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=64662e2bd2812243fb453798a665774f 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-signup.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=0ac559d4bf4c6c7dec0ab22f1520e226 2500w" />
</Frame>

### 2. Choose Subscription Plan

Choose a plan that best fits your needs in [Settings page](https://berachain.0xgraph.xyz/dashboard/settings).

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-pricing.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=629518c6cea2cfcaa2c7c1ea852bed0a" alt="BeraChain Subscription Plans" data-og-width="2396" width="2396" data-og-height="1822" height="1822" data-path="images/berachain/0xgraph-pricing.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-pricing.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c4472cc10407df47c76b82b61a31ed85 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-pricing.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=6ce890d57a7ec9009a31680f6b4160b7 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-pricing.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=d03be2c60cfd9f2cb8caac950687b0d7 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-pricing.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=77c1a1432977e69cdc79c4eea4763a04 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-pricing.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=08cdc4d96c8f0766e3ed60dedbcf1817 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-pricing.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3047330f9838853cd07bc957e9bd2150 2500w" />

  <figcaption>Choose a subscription plan</figcaption>
</Frame>

### 3. Generate API Key

Go to the [API Keys Page](https://berachain.0xgraph.xyz/dashboard/api) to create your API key.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-api-key.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=ffad9c0639fb10ba6824da8ce165a2bf" alt="BeraChain API Keys" data-og-width="2396" width="2396" data-og-height="1846" height="1846" data-path="images/berachain/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-api-key.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=e814f7381fbdbf7011e4000f6ddd13e0 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-api-key.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=d0ea4fc4f0625f260c3927bf49c765a6 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-api-key.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=8c664b56284c962da21b3e7a098ae407 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=ad1367b42ad96ad2c72c21eb4aa7f66d 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=b09101764a8dad53e7f3e46e288fcbb9 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=ad57b249e4d526672c8c518d78a18f80 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

After clicking the 'Create API Key' button in the top-right corner, your API key will be generated. You can then copy and paste it into your commands as needed.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-generated-api-key.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3245669eb77a2e123f904fff71468c15" alt="BeraChain API Keys" data-og-width="2376" width="2376" data-og-height="1838" height="1838" data-path="images/berachain/0xgraph-generated-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-generated-api-key.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=583e3f5b9d3ee83ea8d15a5039867154 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-generated-api-key.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=8e1ee121c0726cb1aba05fbac9fb0209 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-generated-api-key.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7f917cebde22f9e3045b559a7f5dcd23 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-generated-api-key.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=26039568958dd840542d9e7cc0ddfb61 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-generated-api-key.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=34a92d630776781d140cc28a4d323b7d 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-generated-api-key.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3a692fef46c269b6a4b9ae49aeafdd88 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

<Info>
  Warning: Always handle your API keys securely. Do not expose them in
  client-side code or share them publicly. Store them in a secure location, such
  as environment variables, and rotate them regularly to minimize security
  risks. If compromised, regenerate your API key immediately. For public
  repositories, store API keys in a .env file and add .env to .gitignore to
  prevent accidental exposure in your codebase.
</Info>

You are all set and ready to go for deploying a subgraph.


# CLI Usage
Source: https://docs.ormilabs.com/dedicated-env/berachain/subgraphs/getting-started/cli-usage

A detailed list of all active and relevant commands for The Graph CLI, including their purposes, use cases, and examples.

## `graph init`

**Purpose:**\
Creates a new Subgraph project using an example template or an existing smart contract.

**Use Case:**

* Use this command when starting a new Subgraph project.
* It sets up the necessary folder structure, configuration files `subgraph.yaml`, and example code.
* You can specify a contract address and network to scaffold a Subgraph tailored to a specific smart contract.

**Example:**

```bash  theme={null}
graph init --from-contract <CONTRACT_ADDRESS> --network mainnet
```

## `graph codegen`

**Purpose:**\
Generates AssemblyScript types for smart contract ABIs and the Subgraph schema.

**Use Case:**

* Use this command after making changes to your `schema.graphql` file or when adding/updating smart contract ABIs.
* It creates type-safe classes that make it easier to interact with blockchain data in your mappings.

## `graph build`

**Purpose:**\
Compiles the Subgraph to WebAssembly (WASM), preparing it for deployment.

**Use Case:**

* Run this command after completing your mappings and configuration.
* It ensures your Subgraph is ready for deployment by converting it into the WASM format required by 0xGraph.

## `graph deploy`

**Purpose:**\
Deploys the compiled Subgraph to the 0xGraph hosting service.

**Use Case:**

* After building your Subgraph, use this command to upload and activate it on 0xGraph.
* Specify the deployment target (e.g., staging or production) and the Subgraph name.

**Example:**

```bash  theme={null}
graph deploy <your_subgraph> --node
https://api.berachain.0xgraph.xyz/deploy
--ipfs https://api.berachain.0xgraph.xyz/ipfs
--deploy-key <your_api_key>
```

## `graph local`

**Purpose:**\
Runs a local test environment (e.g., using Ganache or Hardhat) to test the Subgraph with simulated blockchain data.

**Use Case:**

* Use this command when developing and testing your Subgraph locally.
* It allows you to simulate blockchain events and validate mappings.
* Ideal for testing without deploying to a live environment.

## `graph test`

**Purpose:**\
Downloads and runs the Matchstick Rust binary to execute unit tests for a Subgraph.

**Use Case:**

* Use this command to write and run unit tests for your mappings and ensure that your Subgraph logic works correctly.
* Matchstick is a testing framework built specifically for The Graph.

## `graph add`

**Purpose:**\
Adds a new data source to your Subgraph’s manifest file (subgraph.yaml) and updates relevant files such as schema.graphql, ABIs, and mappings.

**Use Case:**

* Use this command when adding additional smart contracts or data sources to your Subgraph.
* It automates the process of updating your Subgraph configuration and related files.

**Example:**

```bash  theme={null}
graph add <CONTRACT_NAME> --from-contract <CONTRACT_ADDRESS>
```

<Info>
  Ensure you have the latest version of The Graph CLI installed to avoid
  potential issues with deprecated or updated commands.
</Info>


# Deploy a Subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/berachain/subgraphs/getting-started/deploy-subgraph-graph-cli

Quick start guide for deploying a Subgraph using the Command Line Interface (CLI).

<Info>
  The Graph CLI is an essential tool enabling developers to seamlessly create,
  deploy, and manage subgraphs—providing streamlined blockchain data querying
  and indexing. It gives you superuser access to our enterprise-grade subgraph
  infrastructure. Additionally, we are fully compatible with The Graph's
  tooling, and the CLI works seamlessly out of the box with our platform.
</Info>

## Deployment Network Definitions

For developers who are already familiar with Graph Protocol tooling, below are the network definitions to deploy subgraphs on 0xGraph. These settings can be configured in the subgraph.yaml file:

## Installation

<Steps>
  <Step title="Install CLI Package">
    <CodeGroup>`npm i @graphprotocol/graph-cli `</CodeGroup>
  </Step>
</Steps>

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="_blank">
  Install the graph npm package
</Card>

## Generate API Key

Create an API key: Visit [0xGraph Dashboard](https://berachain.0xgraph.xyz/dashboard/api) to generate your API key. For a comprehensive tutorial on generating API keys, visit the [Account Creation Page](/dedicated-env/berachain/subgraphs/getting-started/account-creation).

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

***

## Create your own Subgraph

Details regarding creating your own Subgraph is beyond the scope of this documentation. The Graph's official documentation provides detailed guides and examples for each step of the Subgraph creation process. It also covers advanced topics such as indexing strategies, filtering, and pagination. We recommend referring to their documentation for a comprehensive reference on Subgraph development with The Graph.

## Core Components

A typical Subgraph project has the following components:

<CardGroup cols={2}>
  <Card title="Manifest File" icon="file-lines">
    The `subgraph.yaml` manifest file serves as the root configuration, containing smart contract references, entity mappings, handler functions, and deployment parameters like `startBlock` and `description`.
  </Card>

  {' '}

  <Card title="Schema File" icon="database">
    The `schema.graphql` file defines all the entities and their relationships for
    your Subgraph's GraphQL API, determining what blockchain data will be indexed
    and made queryable.
  </Card>

  <Card title="Mappings File" icon="code">
    Written in [AssemblyScript](https://www.assemblyscript.org/), a TypeScript-like language specifically designed for WebAssembly, the mappings file transforms raw blockchain data into structured entities that match your GraphQL schema through a set of data handling functions.
  </Card>
</CardGroup>

<Note>
  Messari maintains a [well-curated GitHub
  repository](https://github.com/messari/subgraphs) that offers a comprehensive
  collection of example Subgraphs, which serves as a valuable resource for those
  seeking to start their subgraph development journey.
</Note>

***

## Subgraph Compilation

<Steps>
  <Step title="Generate Types and Mappings">
    <Note>
      The codegen step generates code files for indexing and querying data based on your schema and mappings.
    </Note>

    Run in your project root:

    ```bash  theme={null}
    graph codegen
    ```

    Success output:

    ```bash  theme={null}
        Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
        Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
        Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
        Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
        Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
        Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
        Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
      ✔ Apply migrations
      ✔ Load subgraph from subgraph.yaml
        Load contract ABI from abis/factory.json
        Load contract ABI from abis/ERC20.json
        Load contract ABI from abis/ERC20SymbolBytes.json
        Load contract ABI from abis/ERC20NameBytes.json
      ✔ Load contract ABIs
        Generate types for contract ABI: Factory (abis/factory.json)
        Generate types for contract ABI: ERC20 (abis/ERC20.json)
        Generate types for contract ABI: ERC20SymbolBytes (abis/ERC20SymbolBytes.json)
        Generate types for contract ABI: ERC20NameBytes (abis/ERC20NameBytes.json)
        Write types to generated/Factory/Factory.ts
        Write types to generated/Factory/ERC20.ts
        Write types to generated/Factory/ERC20SymbolBytes.ts
        Write types to generated/Factory/ERC20NameBytes.ts
      ✔ Generate types for contract ABIs
        Generate types for data source template Pair
        Write types for templates to generated/templates.ts
      ✔ Generate types for data source templates
        Load data source template ABI from abis/pair.json
        Load data source template ABI from abis/factory.json
      ✔ Load data source template ABIs
        Generate types for data source template ABI: Pair > Pair (abis/pair.json)
        Generate types for data source template ABI: Pair > Factory (abis/factory.json)
        Write types to generated/templates/Pair/Pair.ts
        Write types to generated/templates/Pair/Factory.ts
      ✔ Generate types for data source template ABIs
      ✔ Load GraphQL schema from schema.graphql
        Write types to generated/schema.ts
      ✔ Generate types for GraphQL schema

      Types generated successfully
    ```

    <Accordion title="Codegen Options">
      <Info>
        View all options with `graph codegen --help`:
      </Info>

      ```bash  theme={null}
      USAGE
        $ graph codegen [SUBGRAPH-MANIFEST] [-h] [-o <value>] [--skip-migrations] [-w] [--uncrashable-config <value> -u]

      FLAGS
        -h, --help                    Show CLI help.
        -o, --output-dir=<value>      [default: generated/] Output directory for generated types.
        -u, --uncrashable             Generate Float S
                                      subgraph Uncrashable helper file.
        -w, --watch                   Regenerate types when subgraph files change.
        --skip-migrations             Skip subgraph migrations.
        --uncrashable-config=<value>  Directory for uncrashable config.
      ```
    </Accordion>
  </Step>

  <Step title="Build Your Subgraph">
    After generating types, build your subgraph:

    ```bash  theme={null}
    graph build
    ```

    Success Output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/

    Build completed: build/subgraph.yaml
    ```

    <Accordion title="Build Options">
      <Info>
        View all options with `graph build --help`:
      </Info>

      ```bash  theme={null}
      Builds a subgraph and (optionally) uploads it to IPFS.

        USAGE
          $ graph build [SUBGRAPH-MANIFEST] [-h] [-i <value>] [-o <value>] [-t wasm|wast]
            [--skip-migrations] [-w] [--network <value>] [--network-file <value>]

        FLAGS
          -h, --help                    Show CLI help.
          -i, --ipfs=<value>            Upload build results to an IPFS node.
          -o, --output-dir=<value>      [default: build/] Output directory for build results.
          -t, --output-format=<option>  [default: wasm] Output format for mappings.
                                        <options: wasm|wast>
          -w, --watch                   Regenerate types when subgraph files change.
          --network=<value>             Network configuration to use from the networks config file.
          --network-file=<value>        [default: networks.json] Networks config file path.
          --skip-migrations             Skip subgraph migrations.

      DESCRIPTION
      Builds a subgraph and (optionally) uploads it to IPFS.

      ```
    </Accordion>
  </Step>

  <Step title="Deploy your Subgraph">
    Then deploy your Subgraph:

    ```bash  theme={null}
    graph deploy <your_subgraph> --node
    https://api.berachain.0xgraph.xyz/deploy
    --ipfs https://api.berachain.0xgraph.xyz/ipfs
    --deploy-key <your_API_key>
    ```

    Success output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/
      Add file to IPFS build/schema.graphql
                    .. Qmckrwbgbx3FjsVH4AU8xP3zgdg3rPnzNo7pmApAmhQkA4
      Add file to IPFS build/Factory/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9
      Add file to IPFS build/Factory/ERC20.json
                    .. QmPfKNZPkVATzL3EHypkcsyKhehR4jkiYEVqSzh2hxWYj1
      Add file to IPFS build/Factory/ERC20SymbolBytes.json
                    .. QmbHnhUFZa6qqqRyubUYhXntox1TCBxqryaBM1iNGqVJzT
      Add file to IPFS build/Factory/ERC20NameBytes.json
                    .. QmQCP6Pdp1MqpwRv2qoPHuUTwZGy7Q3eDHg4w5kzwE9mBj
      Add file to IPFS build/Factory/Factory.wasm
                    .. QmNksN9HGSyMfc4XrjQeHuDKsBQk1xHEKVE2dLwHQQu4kb
      Add file to IPFS build/Pair/pair.json
                    .. QmbPLMADBP8L6LBVP3ZBQ8RgG7ghamD8DvbdUxHAjZrLgm
      Add file to IPFS build/Pair/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9 (already uploaded)
      Add file to IPFS build/templates/Pair/Pair.wasm
                    .. QmSZSUoNinhNshD26iwKyzut6s3w5Lmec3P9szBovfQg8V
    ✔ Upload subgraph to IPFS

    Build completed: QmdXJQUxgrzP8pVotTqiwirJ6NxfmdNdQ6rWQv2rmJpBQp

    Deployed to /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn

    Subgraph endpoints:
    Queries (HTTP):     /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn
    ```
  </Step>
</Steps>

<Card title="View Your Subgraphs" icon="browser">
  Access your deployed Subgraphs through the web-based UI at [berachain.0xgraph.xyz](http://berachain.0xgraph.xyz)
</Card>

```
```


# Deploy a token transfer subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/berachain/subgraphs/getting-started/deploy-token-transfer-subgraph

Tutorial on how to deploy an erc20 token transfer subgraph with the Graph CLI



# Monitor Your Subgraph
Source: https://docs.ormilabs.com/dedicated-env/berachain/subgraphs/getting-started/monitor-subgraph

Learn how to monitor your subgraph syncing progress and logs after deployment

# Monitor your subgraph via the Analytics Page

After deploying your subgraph, you can easily monitor the syncing progress and subgraph logs for up to 48 hours to gain insight and troubleshoot any issues that may come with your subgraph.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-monitor.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=8af2de75e2f879134f54301cdfb51cf4" alt="Subgraph deployment view" data-og-width="3322" width="3322" data-og-height="1168" height="1168" data-path="images/berachain/0xgraph-monitor.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-monitor.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=6049b442bceba096c3ba7c40ee22ba61 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-monitor.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=f74892a730c4a911ac332d10683dc8c0 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-monitor.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=fbba3f80dffa7aa151008bee8174a06e 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-monitor.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=75dab8ecf5f054579f3050260c681665 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-monitor.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=33eb296fa1fb1dc0aacbdf2733b8c58b 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-monitor.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=9b4bc122969af761424e53e1996a001e 2500w" />
</Frame>

You can access your deployed subgraph analytics page by clicking on the subgraph name; afterward, you will be directed to the following analytics page.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-analytics.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=a9d6d087883286b872babaffb2e9ba5c" alt="Subgraph analytics page" data-og-width="2350" width="2350" data-og-height="1808" height="1808" data-path="images/berachain/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-analytics.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=adb81f91ae6b9b85ae2c63fcf8641888 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-analytics.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=0205c47cb06fa9d73ef27ff4838ba7f2 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-analytics.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=b3fcbfe21682bc2803c9401d54487f80 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=6c03cf918e396d7a374e6fa75c6f3e5f 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=457ee77aef14bb73e21d08731d2e83a6 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=398848e8a611f81bf2084982f829dccb 2500w" />
</Frame>


# Perform Query
Source: https://docs.ormilabs.com/dedicated-env/berachain/subgraphs/getting-started/perform-query

Short description on what this section is about

After deploying your subgraph, you can easily access and query it via GraphQL playground for query. You can open the "GraphQL API" link in your dashboard to access your data.

For example, you may access the publicly available Berachain token approval subgraph at `https://api.berachain.0xgraph.xyz/subgraphs/name/token-transfer/graphql`

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-graphql.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=4770fd9899405576ff9cc22337e7bbd4" alt="GraphQL" data-og-width="1847" width="1847" data-og-height="867" height="867" data-path="images/berachain/0xgraph-graphql.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-graphql.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=183fb9ac315414e3e2c581bc41574789 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-graphql.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=ef95117a525e73e1ca4ec25cd441dcce 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-graphql.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=020ce183c105068163f67f13f3380727 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-graphql.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=cda3de4c7937bd9d7edbc00c9dab9b89 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-graphql.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=435ac530dd2a64d458bbd7d83879046d 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/berachain/0xgraph-graphql.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=d04f7a343404a8f31afcd37925383c9d 2500w" />
</Frame>

***

## Query for Subgraph Sync Status

To get to know the sync status directly inside the subgraph, a user may run the following query by using `_meta`:

```graphql  theme={null}
{
  _meta {
    block {
      hash
      timestamp
      number
    }
  }
}
```

The result would be similar to the following:

```json  theme={null}
{
  "data": {
    "_meta": {
      "block": {
        "hash": "0x9f2480d4a21fb9743ae35d349fccbc86c0fad084d6a87b53d1f649f1051c6ddb",
        "timestamp": 1700267031,
        "number": 151479342
      }
    }
  }
}
```

***

## Query a Subgraph

Subgraphs expose blockchain data via a GraphQL API, making it easy for anyone familiar with the GraphQL language to get started.

A GraphQL API differs from traditional REST APIs in that it relies on a schema definition to outline the available queries, mutations, and data types that clients can access.

## Benefits of Schema-Driven Approach

This schema-driven approach enables clients to precisely specify the data they need, eliminating the need to over-fetch data. Here's why this is beneficial:

<CardGroup>
  <Card title="Precision" icon="bullseye">
    GraphQL clients can tailor their queries to retrieve only the data they require, enhancing efficiency.
  </Card>

  <Card title="Flexibility" icon="arrows-to-circle">
    Clients can request related data in a single query, reducing the number of API calls needed.
  </Card>

  <Card title="Predictability" icon="chart-line">
    The schema provides clear documentation for available data and operations.
  </Card>
</CardGroup>

## GraphQL Syntax

GraphQL queries are composed using a specific syntax that allows for hierarchical data retrieval. Clients specify the fields they want to retrieve and their relationships within a single query. This approach minimizes unnecessary data retrieval, resulting in more concise and efficient requests.

## Best Practices

When working with the 0xGraph service, it's essential to follow best practices to ensure optimal performance and efficiency. These best practices are outlined in official Graph Protocol documentation.

<Info>
  For detailed instructions on querying 0xGraph using GraphQL and to ensure adherence to best practices, refer to the [official
  documentation](https://thegraph.com/docs/en/querying/querying-best-practices/) provided by the Ormi Labs and Graph Protocol teams. These resources offer
  valuable insights and recommendations to streamline your interaction with blockchain data through GraphQL.
</Info>


# Private Graphql URL
Source: https://docs.ormilabs.com/dedicated-env/berachain/subgraphs/getting-started/private-url

Learn how to create a private GraphQL URL for your subgraph

## Private Graphql URL

When you deploy a new subgraph, a public GraphQL endpoint is provided by default. However, you can also create a private endpoint for your subgraph, which requires an authentication token for requests. This private endpoint ensures that only authorized users or applications can access your subgraph's data, maintaining data security and control.

## Enable Private GraphQL Link

To use the private endpoint, you first need to enable it in your subgraph's detail on the 0xGraph console.

1. Navigate to your project details page.
2. Find the "PRIVATE GRAPHQL LINK" section.
3. Toggle the switch to "Enabled".

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=560e6af6112a63cffb865cbc60afd565" alt="Enable Private URL" width="700" data-og-width="1229" data-og-height="834" data-path="images/how-to/private.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=84eabc519189ef2a3b52f280ff7e2646 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a44106946348f0dcaf322b5b35e66c41 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6dcfd639d6e2d14fdacf34fc469e0afd 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e8470fabfb0845232d16b5434ada8136 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=93dc339e9fdfbd6dcc7ed4ad027c6baf 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=aee1e2143fe2327a40640aacd8e8b906 2500w" />

## Find Your Private URL

Once enabled, your unique private GraphQL URL will be displayed. You can also find this URL listed on the main page of your project environment under the "PRIVATE GRAPHQL LINK" column.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=45d17f6b83f1234c38290ece93132fab" alt="Private URL List" width="700" data-og-width="1881" data-og-height="880" data-path="images/how-to/private2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=170c03e25794a0fa9099ae07c2ce6f67 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a733750201ba10c93bb3d985c5b775de 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=c0b478fca2ec7586f8f12db7bf9434e6 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a0e72f5d6ff87f1768e3688ed1995abb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f478e814674d0454cf0d1eb46704f1c3 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f7fb3ddbec13791ab5948282de354b3e 2500w" />

## Authentication

To query your private GraphQL endpoint, you must include an authentication token in the request header.

1. Obtain your API key from the 0xGraph console API Keys.
2. In your GraphQL client (like GraphiQL or Postman), add an `Authorization` header.
3. Set the header value to `Bearer YOUR_API_KEY`, replacing `YOUR_API_KEY` with the actual key.

Here's how it looks in the GraphiQL interface provided by 0xGraph:

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b36c81515bf5633e8446b1a9bc18a852" alt="Private URL Token" width="700" data-og-width="1261" data-og-height="836" data-path="images/how-to/private3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=62296e918593924606edca6ea9bb0e52 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7b7d3af194a2243c9a63ddd31c209e5c 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=87e773a3ca3156ba9ab3700bb365713d 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a5d877ffa5cc966da46065fa94a2ed90 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e4f121ec83725881815c920ece44b3d1 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=67f6cb202406476251abef74a4f70e3f 2500w" />

By following these steps, you can securely interact with your subgraph using its private GraphQL endpoint.


# Subgraph Webhooks
Source: https://docs.ormilabs.com/dedicated-env/berachain/subgraphs/getting-started/webhook

Learn how to create and manage webhooks for your subgraphs to receive real-time updates.

## Subgraph Webhooks

Subgraph webhooks allow you to receive HTTP POST requests in real-time whenever an entity in your subgraph changes due to an `INSERT`, `UPDATE`, or `DELETE` operation. This is useful for triggering backend processes, sending notifications, or syncing data with external systems.

## How it Works

When a subgraph handler executes an operation like `entity.save()` (resulting in an `INSERT` or `UPDATE`) or an entity is removed (resulting in a `DELETE`), the change is recorded. A real-time watcher detects this update and sends a payload to your configured webhook URL. The payload will indicate the type of operation: `INSERT`, `UPDATE`, or `DELETE`.

## Creating a Webhook

You can create a new webhook through the 0xGraph dashboard.

1. Navigate to the "Webhooks" section of your subgraph.

2. Click on the "New Webhook" button.

3. Fill in the required information in the "Create Webhook" modal:

   * **Name**: A descriptive name for your webhook (e.g., `webhook_demo`).
   * **URL**: The HTTP endpoint where the webhook payloads will be sent.
   * **Entity**: The specific entity you want to track (e.g., `approved`).
   * **Number of retries**: Configure the total number of retries. Defaults to 3, with a maximum of 10.
   * **Retry interval**: Configure the retry interval in seconds. Defaults to 60, with a maximum of 3600.
   * **Retry timeout**: Configure the retry timeout in seconds. Defaults to 30, with a maximum of 60.
   * **"secret" header value**: An optional secret string that will be sent in a designated webhook secret header. This allows your endpoint to verify that the request is authentic.

   <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9234eae31186a5b6f649ed942830ff6c" alt="Create Webhook Modal" data-og-width="1872" width="1872" data-og-height="879" height="879" data-path="images/how-to/webhook.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9f6074a41fc7104edd1f8a831dcf426b 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=70599e318f7d4dbb52bd9b9271f5fb9b 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=12c058b62fbe1aad60ae53b93b4edb0f 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d09122a7d15636238f837d4fb83fb9cb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d4299f143c74dac74aefe4d276549743 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9b8b5cfcba5dbd305b27b026d77ab5d4 2500w" />

4. Click "Create".

## Listing Webhooks

Once created, your webhook will appear in the list of webhooks for your subgraph. You can see its name, the entity it tracks, the target URL, and statistics about successful and failed deliveries.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=1a8a8610f0aa060edd6cec706e366d69" alt="Webhook List" data-og-width="1000" width="1000" data-og-height="818" height="818" data-path="images/how-to/webhook3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=fba9d6def6020d6c02eacc3c4670f763 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ee4af7ca24eeadf9bfab5bde38ab1811 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6e22347e0fe60c0d103c87000e981f06 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=59a7e24f1e30c3da890b3ea603216cc5 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ac5ba543c4c479ce7052f173ee858471 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6887464b8fb3a4b2866c91c8f90a8cb7 2500w" />

## Webhook Payload Structure

The webhook will send a JSON payload to your configured URL. The main payload object contains the following fields:

* `op` (string): The type of operation that triggered the webhook. Possible values are `"INSERT"`, `"UPDATE"`, or `"DELETE"`.
* `data_source` (string): Identifier for the subgraph or indexer being tracked.
* `data` (object): Contains the actual entity data that changed. It has two sub-fields:
  * `old` (object | null): The state of the entity before the change. This will be `null` if the `op` is `"INSERT"`.
  * `new` (object | null): The state of the entity after the change. This will be `null` if the `op` is `"DELETE"`.
* `webhook_name` (string): The name you assigned to your webhook during creation.
* `webhook_id` (string): A unique identifier for the webhook configuration.
* `id` (string): A unique identifier for this specific event notification.
* `delivery_info` (object): Information about the delivery attempt for this webhook. It has two sub-fields:
  * `max_retries` (integer): The maximum number of retry attempts configured for this webhook.
  * `current_retry` (integer): The current retry attempt number for this specific event (0 for the initial attempt).
* `entity` (string): The name of the subgraph entity being tracked.

### Example Payloads:

**`INSERT` operation:**

```json  theme={null}
{
  "op": "INSERT",
  "data_source": "privateURL/v0.0.1",
  "data": {
    "new": {
      "id": "ERC20Approve-0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc-w\\u001c\\u001b\\u0002\\ufffd\\ufffd\\ufffd\\u07Ջ^\\ufffdcO\\ufffd\\ufffd(7C\\u001c\\u001b-\\ufffd\\u0016僞\\ufffdm\\ufffd\\ufffdI+y\\ufffd\\ufffd^\\u0015\\ufffd\\ufffdY\\ufffd",
      "vid": 7271978,
      "owner": "\\\\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc",
      "amount": 1.157920892373162e+77,
      "is_all": false,
      "spender": "\\\\xbde5839ec36db2ac492b79e9e3b75e15fa8a59ec",
      "updated_at": 1747127781,
      "block_range": "[20405156,)"
    },
    "old": null
  },
  "webhook_name": "webhook_demo",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "id": "5b623fd0-b539-400b-bbb3-060d95403a64",
  "delivery_info": {
    "max_retries": 3,
    "current_retry": 0
  },
  "entity": "approved"
}
```

**`UPDATE` operation :**

```json  theme={null}
{
  "data": {
    "new": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,20405060)"
    },
    "old": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,)"
    }
  },
  "data_source": "privateURL/v0.0.1",
  "delivery_info": {
    "current_retry": 0,
    "max_retries": 3
  },
  "entity": "approved",
  "id": "dd2b6013-22e1-4e8e-a665-be5276144a68",
  "op": "UPDATE",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "webhook_name": "webhook_demo"
}
```


# 0xGraph - Reliable Subgraph Indexing
Source: https://docs.ormilabs.com/dedicated-env/berachain/subgraphs/overview



Deploy subgraphs with 99.9%+ availability and fetch smart contract data at 3x the speed. 100% spec-compliant with every subgraph on The Graph's hosted and decentralized networks.

## Overview

Subgraphs are customizable, open-source solutions for indexing and accessing real-time blockchain data through GraphQL APIs.

0xGraph is a zero-hassle subgraph hosting solution that is 100% spec-compliant with every subgraph on The Graph Protocol’s hosted and decentralized networks, minus the lag and downtime.

* Plug and play deployment and subgraph migration from hosted services.
* Deploy subgraphs with the same tooling, UI, and similar CLI as The Graph.
* Query subgraphs without running any nodes or infrastructure.

### Supported Networks

0xGraph currently supports the following networks:

| Name              | Type    | Network Slug        |
| ----------------- | ------- | ------------------- |
| Berachain Mainnet | Mainnet | `berachain-mainnet` |
| Berachain Testnet | Testnet | `berachain-testnet` |

### Available Upon Request

Any other network you need? Please email us: [hello@ormilabs.com](mailto:hello@ormilabs.com)


# Overview
Source: https://docs.ormilabs.com/dedicated-env/dolomite/data-apis/overview

Coming soon



# Create tag
Source: https://docs.ormilabs.com/dedicated-env/dolomite/subgraphs/api-reference/create-tag

POST /public_api/v1/0xgraph/create_tag



# Delete tag
Source: https://docs.ormilabs.com/dedicated-env/dolomite/subgraphs/api-reference/delete-tag

POST /public_api/v1/0xgraph/delete_tag



# Query tag
Source: https://docs.ormilabs.com/dedicated-env/dolomite/subgraphs/api-reference/query-tag

POST /public_api/v1/0xgraph/query_tag



# Remove subgraph
Source: https://docs.ormilabs.com/dedicated-env/dolomite/subgraphs/api-reference/remove-subgraph

POST /public_api/v1/0xgraph/remove_subgraph

<Note>
  ⚠️ CLI deletion is temporarily unsupported. Use the Ormi Dashboard UI to remove subgraphs.
</Note>


# Cheat Sheet
Source: https://docs.ormilabs.com/dedicated-env/dolomite/subgraphs/cheatsheet

Streamlined Guide: Deploying Subgraphs on 0xGraph with The Graph CLI

## Overview

This quick start guide outlines streamlined instructions for deploying Subgraphs using the Command Line Interface (CLI). Developers looking to swiftly incorporate Subgraph capabilities into their projects will find straightforward guidance and pro tips for getting set up fast.

<Info>
  This cheat sheet condenses essential commands, tips, and best practices into
  an indispensable reference for anyone deploying a Subgraph. Developers will
  find this streamlined guide invaluable for swiftly progressing through the
  deployment workflow and resolving frequent pain points. With key information
  consolidated in one place, engineers can deploy Subgraphs more efficiently and
  focus their efforts on building applications powered by real-time,
  customizable blockchain data indexes.
</Info>

## 1. Get started by installing The Graph CLI

Download The Graph CLI via npm

```bash  theme={null}
npm i @graphprotocol/graph-cli
```

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="https://www.npmjs.com/package/@graphprotocol/graph-cli">
  Install The Graph npm package
</Card>

## 2. Generate API key

Create an API key: Visit [0xGraph Dashboard](https://dolomite.0xgraph.xyz/dashboard/api) to generate your API key

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

## 3. Generate types and mappings for your Subgraph

Go to your Subgraph root directory where `subgraph.yaml` file is located

```bash  theme={null}
cd <your_subgraph_project>
```

Run the following command to generate AssemblyScript types for smart contract ABIs and the subgraph schema

```bash  theme={null}
graph codegen
```

## 4. Compile your Subgraph

Run the following command to compile your Subgraph into WASM (WebAssembly)

```bash  theme={null}
graph build
```

## 5. Deploy your Subgraph to 0xGraph

Paste the API key generated in step 2 and run the following command to deploy your Subgraph to 0xGraph

```bash  theme={null}
graph deploy <your_subgraph> --node
https://dolomiteapi.0xgraph.xyz/deploy
--ipfs https://dolomiteapi.0xgraph.xyz/ipfs
--deploy-key <api_key>
```

<Info>
  If prompted to enter the version, use the version of The Graph CLI that you
  downloaded.
</Info>

You can now monitor your Subgraph deployment in the 0xGraph app

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/dolomite/0xgraph-analytics.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7f729733d5f55ace34dbb634de9127b5" alt="Subgraph analytics page" data-og-width="2404" width="2404" data-og-height="1860" height="1860" data-path="images/dolomite/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/dolomite/0xgraph-analytics.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=34d04bcfa77aaa4541f86690ef3e90c7 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/dolomite/0xgraph-analytics.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=178d166f27822e6c7701e180389c0a96 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/dolomite/0xgraph-analytics.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=25492178cc572983a6b654cb59c3d194 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/dolomite/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=47b5b875c60088617cd78882d8d04469 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/dolomite/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=d541fcf67fbf70ef498d71d7293397dd 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/dolomite/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c37c75e584ecc5c00bad4402c78a79c9 2500w" />
</Frame>

## Quick Start in the App

The [0xGraph Web App](https://dolomite.0xgraph.xyz) also offers a concise guide to assist users in deploying their Subgraphs effectively

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-quickstart.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=029e09500a9c991fe1f3e6b5fd1c00e4" alt="Subgraph analytics page" data-og-width="3492" width="3492" data-og-height="1860" height="1860" data-path="images/dolomite/0xgraph-quickstart.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-quickstart.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=ff5251593d66b9d58b11c6459e695f31 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-quickstart.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=60f07294a53bdb5433afe8f5df062f05 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-quickstart.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=708c97b54949d577d259d703fdc985a6 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-quickstart.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=97b1397613b19ba4385f0d4f64144930 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-quickstart.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=855ae4530806eee0a67e968a60a7fc3e 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-quickstart.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=773667caec23e0a498c6a5d3da702663 2500w" />
</Frame>


# Account Creation
Source: https://docs.ormilabs.com/dedicated-env/dolomite/subgraphs/getting-started/account-creation

How to create your 0xGraph account

## Setup Steps

### 1. Create Account

Visit [dolomite.0xgraph.xyz](https://dolomite.0xgraph.xyz) to create your account.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-signup.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=53c834242de318dfe6cd9ced142c3b35" alt="0xGraph App Registration" data-og-width="3436" width="3436" data-og-height="1850" height="1850" data-path="images/dolomite/0xgraph-signup.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-signup.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=cfafce076e011c41991eaf9b0c1e8e8c 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-signup.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=6d7e76da366715dfec7dbc92db2e1707 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-signup.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=f59a4040e358945e743dda7bd2f9ff7c 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-signup.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=5b6d757d44f105a305d233fe5726042b 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-signup.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d7319830acfd2caf8480764b624bd91e 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-signup.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=f7d407364fc622071cf0ab6a0a03d808 2500w" />
</Frame>

### 2. Choose Subscription Plan

Choose a plan that best fits your needs in [Settings page](https://dolomite.0xgraph.xyz/dashboard/settings).

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-pricing.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=6ec8219fefcc61033736e6a62d4b1ab1" alt="0xGraph Subscription Plans" data-og-width="3498" width="3498" data-og-height="1830" height="1830" data-path="images/dolomite/0xgraph-pricing.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-pricing.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=769669f1404d2f882ab6caa016c9d716 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-pricing.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=8f0ef51de079fdc4266fd771514bdef3 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-pricing.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=8c1af203cf3d19d793ed4a9685c1797b 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-pricing.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=c49215652eb18e2cb6579724ffe59efb 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-pricing.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d3b16656f0a51275316b8b13031dce87 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-pricing.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=ea7965add00576918b5129eef571116e 2500w" />

  <figcaption>Choose a subscription plan</figcaption>
</Frame>

### 3. Generate API Key

Go to the [API Keys Page](https://dolomite.0xgraph.xyz/dashboard/api) to create your API key.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-api-key.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=8985bfc8fbd7fa13df8459589c2825ed" alt="0xGraph API Keys" data-og-width="3500" width="3500" data-og-height="1854" height="1854" data-path="images/dolomite/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-api-key.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=f629401def126692da9a1f07202acc4d 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-api-key.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=892480fc417b7d4a335cd38bfd2dba14 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-api-key.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=2758930d26d1ac4ec0c90bf220cfb15d 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=dcebf29ac9e64d707296e925d0eb874d 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=a357adfb78c599e55ce627594d2940dd 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d419436831d4b7d37dffc486abc3b045 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

After clicking the 'Create API Key' button in the top-right corner, your API key will be generated. You can then copy and paste it into your commands as needed.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-generated-api-key.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=efd768cd51cb76c076fc869d96846d04" alt="0xGraph API Keys" data-og-width="3458" width="3458" data-og-height="1844" height="1844" data-path="images/dolomite/0xgraph-generated-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-generated-api-key.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d090e71b5d1077e2d5fe66304b3315b1 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-generated-api-key.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=c565b714f9a39496c648ead82c0d23a9 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-generated-api-key.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=f6551c32faa500cd673788e153effd8d 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-generated-api-key.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=2216140c5c2a707bd1fc766c0f139b92 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-generated-api-key.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=7d0f0f1ce213aff7d66aa18a3905a055 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-generated-api-key.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=60a0e3bf3d4f1c99ad8a9b5d5bf1d41d 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

<Info>
  Warning: Always handle your API keys securely. Do not expose them in
  client-side code or share them publicly. Store them in a secure location, such
  as environment variables, and rotate them regularly to minimize security
  risks. If compromised, regenerate your API key immediately. For public
  repositories, store API keys in a .env file and add .env to .gitignore to
  prevent accidental exposure in your codebase.
</Info>

You are all set and ready to go for deploying a subgraph.


# CLI Usage
Source: https://docs.ormilabs.com/dedicated-env/dolomite/subgraphs/getting-started/cli-usage

A detailed list of all active and relevant commands for The Graph CLI, including their purposes, use cases, and examples.

## `graph init`

**Purpose:**\
Creates a new Subgraph project using an example template or an existing smart contract.

**Use Case:**

* Use this command when starting a new Subgraph project.
* It sets up the necessary folder structure, configuration files `subgraph.yaml`, and example code.
* You can specify a contract address and network to scaffold a Subgraph tailored to a specific smart contract.

**Example:**

```bash  theme={null}
graph init --from-contract <CONTRACT_ADDRESS> --network mainnet
```

## `graph codegen`

**Purpose:**\
Generates AssemblyScript types for smart contract ABIs and the Subgraph schema.

**Use Case:**

* Use this command after making changes to your `schema.graphql` file or when adding/updating smart contract ABIs.
* It creates type-safe classes that make it easier to interact with blockchain data in your mappings.

## `graph build`

**Purpose:**\
Compiles the Subgraph to WebAssembly (WASM), preparing it for deployment.

**Use Case:**

* Run this command after completing your mappings and configuration.
* It ensures your Subgraph is ready for deployment by converting it into the WASM format required by 0xGraph.

## `graph deploy`

**Purpose:**\
Deploys the compiled Subgraph to the 0xGraph hosting service.

**Use Case:**

* After building your Subgraph, use this command to upload and activate it on 0xGraph.
* Specify the deployment target (e.g., staging or production) and the Subgraph name.

**Example:**

```bash  theme={null}
graph deploy <your_subgraph> --node
https://dolomiteapi.0xgraph.xyz/deploy
--ipfs https://dolomiteapi.0xgraph.xyz/ipfs
--deploy-key <your_api_key>
```

## `graph local`

**Purpose:**\
Runs a local test environment (e.g., using Ganache or Hardhat) to test the Subgraph with simulated blockchain data.

**Use Case:**

* Use this command when developing and testing your Subgraph locally.
* It allows you to simulate blockchain events and validate mappings.
* Ideal for testing without deploying to a live environment.

## `graph test`

**Purpose:**\
Downloads and runs the Matchstick Rust binary to execute unit tests for a Subgraph.

**Use Case:**

* Use this command to write and run unit tests for your mappings and ensure that your Subgraph logic works correctly.
* Matchstick is a testing framework built specifically for The Graph.

## `graph add`

**Purpose:**\
Adds a new data source to your Subgraph’s manifest file (subgraph.yaml) and updates relevant files such as schema.graphql, ABIs, and mappings.

**Use Case:**

* Use this command when adding additional smart contracts or data sources to your Subgraph.
* It automates the process of updating your Subgraph configuration and related files.

**Example:**

```bash  theme={null}
graph add <CONTRACT_NAME> --from-contract <CONTRACT_ADDRESS>
```

<Info>
  Ensure you have the latest version of The Graph CLI installed to avoid
  potential issues with deprecated or updated commands.
</Info>


# Deploy a Subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/dolomite/subgraphs/getting-started/deploy-subgraph-graph-cli

Quick start guide for deploying a Subgraph using the Command Line Interface (CLI).

<Info>
  The Graph CLI is an essential tool enabling developers to seamlessly create,
  deploy, and manage subgraphs—providing streamlined blockchain data querying
  and indexing. It gives you superuser access to our enterprise-grade subgraph
  infrastructure. Additionally, we are fully compatible with The Graph's
  tooling, and the CLI works seamlessly out of the box with our platform.
</Info>

## Deployment Network Definitions

For developers who are already familiar with Graph Protocol tooling, below are the network definitions to deploy subgraphs on 0xGraph. These settings can be configured in the subgraph.yaml file:

## Installation

<Steps>
  <Step title="Install CLI Package">
    <CodeGroup>`npm i @graphprotocol/graph-cli `</CodeGroup>
  </Step>
</Steps>

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="_blank">
  Install the graph npm package
</Card>

## Generate API Key

Create an API key: Visit [0xGraph Dashboard](https://dolomite.0xgraph.xyz/dashboard/api) to generate your API key. For a comprehensive tutorial on generating API keys, visit the [Account Creation Page](/dedicated-env/dolomite/subgraphs/getting-started/account-creation).

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

***

## Create your own Subgraph

Details regarding creating your own Subgraph is beyond the scope of this documentation. The Graph's official documentation provides detailed guides and examples for each step of the Subgraph creation process. It also covers advanced topics such as indexing strategies, filtering, and pagination. We recommend referring to their documentation for a comprehensive reference on Subgraph development with The Graph.

## Core Components

A typical Subgraph project has the following components:

<CardGroup cols={2}>
  <Card title="Manifest File" icon="file-lines">
    The `subgraph.yaml` manifest file serves as the root configuration, containing smart contract references, entity mappings, handler functions, and deployment parameters like `startBlock` and `description`.
  </Card>

  {' '}

  <Card title="Schema File" icon="database">
    The `schema.graphql` file defines all the entities and their relationships for
    your Subgraph's GraphQL API, determining what blockchain data will be indexed
    and made queryable.
  </Card>

  <Card title="Mappings File" icon="code">
    Written in [AssemblyScript](https://www.assemblyscript.org/), a TypeScript-like language specifically designed for WebAssembly, the mappings file transforms raw blockchain data into structured entities that match your GraphQL schema through a set of data handling functions.
  </Card>
</CardGroup>

<Note>
  Messari maintains a [well-curated GitHub
  repository](https://github.com/messari/subgraphs) that offers a comprehensive
  collection of example Subgraphs, which serves as a valuable resource for those
  seeking to start their subgraph development journey.
</Note>

***

## Subgraph Compilation

<Steps>
  <Step title="Generate Types and Mappings">
    <Note>
      The codegen step generates code files for indexing and querying data based on your schema and mappings.
    </Note>

    Run in your project root:

    ```bash  theme={null}
    graph codegen
    ```

    Success output:

    ```bash  theme={null}
        Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
        Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
        Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
        Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
        Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
        Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
        Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
      ✔ Apply migrations
      ✔ Load subgraph from subgraph.yaml
        Load contract ABI from abis/factory.json
        Load contract ABI from abis/ERC20.json
        Load contract ABI from abis/ERC20SymbolBytes.json
        Load contract ABI from abis/ERC20NameBytes.json
      ✔ Load contract ABIs
        Generate types for contract ABI: Factory (abis/factory.json)
        Generate types for contract ABI: ERC20 (abis/ERC20.json)
        Generate types for contract ABI: ERC20SymbolBytes (abis/ERC20SymbolBytes.json)
        Generate types for contract ABI: ERC20NameBytes (abis/ERC20NameBytes.json)
        Write types to generated/Factory/Factory.ts
        Write types to generated/Factory/ERC20.ts
        Write types to generated/Factory/ERC20SymbolBytes.ts
        Write types to generated/Factory/ERC20NameBytes.ts
      ✔ Generate types for contract ABIs
        Generate types for data source template Pair
        Write types for templates to generated/templates.ts
      ✔ Generate types for data source templates
        Load data source template ABI from abis/pair.json
        Load data source template ABI from abis/factory.json
      ✔ Load data source template ABIs
        Generate types for data source template ABI: Pair > Pair (abis/pair.json)
        Generate types for data source template ABI: Pair > Factory (abis/factory.json)
        Write types to generated/templates/Pair/Pair.ts
        Write types to generated/templates/Pair/Factory.ts
      ✔ Generate types for data source template ABIs
      ✔ Load GraphQL schema from schema.graphql
        Write types to generated/schema.ts
      ✔ Generate types for GraphQL schema

      Types generated successfully
    ```

    <Accordion title="Codegen Options">
      <Info>
        View all options with `graph codegen --help`:
      </Info>

      ```bash  theme={null}
      USAGE
        $ graph codegen [SUBGRAPH-MANIFEST] [-h] [-o <value>] [--skip-migrations] [-w] [--uncrashable-config <value> -u]

      FLAGS
        -h, --help                    Show CLI help.
        -o, --output-dir=<value>      [default: generated/] Output directory for generated types.
        -u, --uncrashable             Generate Float S
                                      subgraph Uncrashable helper file.
        -w, --watch                   Regenerate types when subgraph files change.
        --skip-migrations             Skip subgraph migrations.
        --uncrashable-config=<value>  Directory for uncrashable config.
      ```
    </Accordion>
  </Step>

  <Step title="Build Your Subgraph">
    After generating types, build your subgraph:

    ```bash  theme={null}
    graph build
    ```

    Success Output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/

    Build completed: build/subgraph.yaml
    ```

    <Accordion title="Build Options">
      <Info>
        View all options with `graph build --help`:
      </Info>

      ```bash  theme={null}
      Builds a subgraph and (optionally) uploads it to IPFS.

        USAGE
          $ graph build [SUBGRAPH-MANIFEST] [-h] [-i <value>] [-o <value>] [-t wasm|wast]
            [--skip-migrations] [-w] [--network <value>] [--network-file <value>]

        FLAGS
          -h, --help                    Show CLI help.
          -i, --ipfs=<value>            Upload build results to an IPFS node.
          -o, --output-dir=<value>      [default: build/] Output directory for build results.
          -t, --output-format=<option>  [default: wasm] Output format for mappings.
                                        <options: wasm|wast>
          -w, --watch                   Regenerate types when subgraph files change.
          --network=<value>             Network configuration to use from the networks config file.
          --network-file=<value>        [default: networks.json] Networks config file path.
          --skip-migrations             Skip subgraph migrations.

      DESCRIPTION
      Builds a subgraph and (optionally) uploads it to IPFS.
      ```
    </Accordion>
  </Step>

  <Step title="Deploy your Subgraph">
    Then deploy your Subgraph:

    ```bash  theme={null}
    graph deploy <your_subgraph> --node
    https://dolomiteapi.0xgraph.xyz/deploy
    --ipfs https://dolomiteapi.0xgraph.xyz/ipfs
    --deploy-key <your_API_key>
    ```

    Success output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/
      Add file to IPFS build/schema.graphql
                    .. Qmckrwbgbx3FjsVH4AU8xP3zgdg3rPnzNo7pmApAmhQkA4
      Add file to IPFS build/Factory/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9
      Add file to IPFS build/Factory/ERC20.json
                    .. QmPfKNZPkVATzL3EHypkcsyKhehR4jkiYEVqSzh2hxWYj1
      Add file to IPFS build/Factory/ERC20SymbolBytes.json
                    .. QmbHnhUFZa6qqqRyubUYhXntox1TCBxqryaBM1iNGqVJzT
      Add file to IPFS build/Factory/ERC20NameBytes.json
                    .. QmQCP6Pdp1MqpwRv2qoPHuUTwZGy7Q3eDHg4w5kzwE9mBj
      Add file to IPFS build/Factory/Factory.wasm
                    .. QmNksN9HGSyMfc4XrjQeHuDKsBQk1xHEKVE2dLwHQQu4kb
      Add file to IPFS build/Pair/pair.json
                    .. QmbPLMADBP8L6LBVP3ZBQ8RgG7ghamD8DvbdUxHAjZrLgm
      Add file to IPFS build/Pair/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9 (already uploaded)
      Add file to IPFS build/templates/Pair/Pair.wasm
                    .. QmSZSUoNinhNshD26iwKyzut6s3w5Lmec3P9szBovfQg8V
    ✔ Upload subgraph to IPFS

    Build completed: QmdXJQUxgrzP8pVotTqiwirJ6NxfmdNdQ6rWQv2rmJpBQp

    Deployed to /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn

    Subgraph endpoints:
    Queries (HTTP):     /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn
    ```
  </Step>
</Steps>

<Card title="View Your Subgraphs" icon="browser">
  Access your deployed Subgraphs through the web-based UI at [dolomite.0xgraph.xyz](http://dolomite.0xgraph.xyz)
</Card>


# Deploy a token transfer subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/dolomite/subgraphs/getting-started/deploy-token-transfer-subgraph

Tutorial on how to deploy an erc20 token transfer subgraph with the Graph CLI



# Monitor Your Subgraph
Source: https://docs.ormilabs.com/dedicated-env/dolomite/subgraphs/getting-started/monitor-subgraph

Learn how to monitor your subgraph syncing progress and logs after deployment

# Monitor your subgraph via the Analytics Page

After deploying your subgraph, you can easily monitor the syncing progress and subgraph logs for up to 48 hours to gain insight and troubleshoot any issues that may come with your subgraph.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-monitor.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=a6c5ef35a7d8103aa4ab41139943411f" alt="Subgraph deployment view" data-og-width="3242" width="3242" data-og-height="710" height="710" data-path="images/dolomite/0xgraph-monitor.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-monitor.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=9a0a112c7eaaa51075a2675fff694b77 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-monitor.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=ced50814bea555880083d0de1aa9f6f7 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-monitor.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=f8c4b58846c0648ab97d6461fd3e3aa0 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-monitor.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=c902464dc6b8b8a3e16c2e34ec99938c 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-monitor.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=f716b6a6a58dcd21367bd6f3ae8a3fef 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-monitor.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=fb3eb73485f6307b1f9908f4c6001d38 2500w" />
</Frame>

You can access your deployed subgraph analytics page by clicking on the subgraph name; afterward, you will be directed to the following analytics page.

<Frame>
  <img src="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/dolomite/0xgraph-analytics.png?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7f729733d5f55ace34dbb634de9127b5" alt="Subgraph analytics page" data-og-width="2404" width="2404" data-og-height="1860" height="1860" data-path="images/dolomite/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/dolomite/0xgraph-analytics.png?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=34d04bcfa77aaa4541f86690ef3e90c7 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/dolomite/0xgraph-analytics.png?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=178d166f27822e6c7701e180389c0a96 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/dolomite/0xgraph-analytics.png?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=25492178cc572983a6b654cb59c3d194 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/dolomite/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=47b5b875c60088617cd78882d8d04469 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/dolomite/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=d541fcf67fbf70ef498d71d7293397dd 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/dolomite/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c37c75e584ecc5c00bad4402c78a79c9 2500w" />
</Frame>


# Perform Query
Source: https://docs.ormilabs.com/dedicated-env/dolomite/subgraphs/getting-started/perform-query

Short description on what this section is about

After deploying your subgraph, you can easily access and query it via GraphQL playground for query. You can open the "GraphQL API" link in your dashboard to access your data.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-api-key.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=8985bfc8fbd7fa13df8459589c2825ed" alt="API Keys" data-og-width="3500" width="3500" data-og-height="1854" height="1854" data-path="images/dolomite/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-api-key.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=f629401def126692da9a1f07202acc4d 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-api-key.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=892480fc417b7d4a335cd38bfd2dba14 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-api-key.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=2758930d26d1ac4ec0c90bf220cfb15d 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=dcebf29ac9e64d707296e925d0eb874d 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=a357adfb78c599e55ce627594d2940dd 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d419436831d4b7d37dffc486abc3b045 2500w" />
</Frame>

For example, you may access the publicly available Dolomite token approval subgraph at `https://dolomiteapi.0xgraph.xyz/subgraphs/name/blocks-berachain-bartio/graphql`

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-graphql.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=e5709161524e72ca0833be98de6ff2ce" alt="GraphQL" data-og-width="1847" width="1847" data-og-height="867" height="867" data-path="images/dolomite/0xgraph-graphql.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-graphql.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=dac9ff9a89ad47310fd8cd07d615872d 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-graphql.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=27e9210bf3503df27810320b60ec95d5 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-graphql.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=656dd4761ab7b562183fe1e42c9dcecb 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-graphql.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=61628ce2ccb57b3e14fce23e0a1c13c6 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-graphql.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=523fcafcf088639b03cf09d7dd7c849b 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/dolomite/0xgraph-graphql.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=b3bc58f449c0d05e512d4109fc01d967 2500w" />
</Frame>

***

## Query for Subgraph Sync Status

To get to know the sync status directly inside the subgraph, a user may run the following query by using `_meta`:

```graphql  theme={null}
{
  _meta {
    block {
      hash
      timestamp
      number
    }
  }
}
```

The result would be similar to the following:

```json  theme={null}
{
  "data": {
    "_meta": {
      "block": {
        "hash": "0x9f2480d4a21fb9743ae35d349fccbc86c0fad084d6a87b53d1f649f1051c6ddb",
        "timestamp": 1700267031,
        "number": 151479342
      }
    }
  }
}
```

***

## Query a Subgraph

Subgraphs expose blockchain data via a GraphQL API, making it easy for anyone familiar with the GraphQL language to get started.

A GraphQL API differs from traditional REST APIs in that it relies on a schema definition to outline the available queries, mutations, and data types that clients can access.

## Benefits of Schema-Driven Approach

This schema-driven approach enables clients to precisely specify the data they need, eliminating the need to over-fetch data. Here's why this is beneficial:

<CardGroup>
  <Card title="Precision" icon="bullseye">
    GraphQL clients can tailor their queries to retrieve only the data they require, enhancing efficiency.
  </Card>

  <Card title="Flexibility" icon="arrows-to-circle">
    Clients can request related data in a single query, reducing the number of API calls needed.
  </Card>

  <Card title="Predictability" icon="chart-line">
    The schema provides clear documentation for available data and operations.
  </Card>
</CardGroup>

## GraphQL Syntax

GraphQL queries are composed using a specific syntax that allows for hierarchical data retrieval. Clients specify the fields they want to retrieve and their relationships within a single query. This approach minimizes unnecessary data retrieval, resulting in more concise and efficient requests.

## Best Practices

When working with the 0xGraph service, it's essential to follow best practices to ensure optimal performance and efficiency. These best practices are outlined in official Graph Protocol documentation.

<Info>
  For detailed instructions on querying 0xGraph using GraphQL and to ensure adherence to best practices, refer to the [official
  documentation](https://thegraph.com/docs/en/querying/querying-best-practices/) provided by the Ormi Labs and Graph Protocol teams. These resources offer
  valuable insights and recommendations to streamline your interaction with blockchain data through GraphQL.
</Info>


# Private Graphql URL
Source: https://docs.ormilabs.com/dedicated-env/dolomite/subgraphs/getting-started/private-url

Learn how to create a private GraphQL URL for your subgraph

## Private Graphql URL

When you deploy a new subgraph, a public GraphQL endpoint is provided by default. However, you can also create a private endpoint for your subgraph, which requires an authentication token for requests. This private endpoint ensures that only authorized users or applications can access your subgraph's data, maintaining data security and control.

## Enable Private GraphQL Link

To use the private endpoint, you first need to enable it in your subgraph's detail on the 0xGraph console.

1. Navigate to your project details page.
2. Find the "PRIVATE GRAPHQL LINK" section.
3. Toggle the switch to "Enabled".

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=560e6af6112a63cffb865cbc60afd565" alt="Enable Private URL" width="700" data-og-width="1229" data-og-height="834" data-path="images/how-to/private.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=84eabc519189ef2a3b52f280ff7e2646 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a44106946348f0dcaf322b5b35e66c41 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6dcfd639d6e2d14fdacf34fc469e0afd 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e8470fabfb0845232d16b5434ada8136 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=93dc339e9fdfbd6dcc7ed4ad027c6baf 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=aee1e2143fe2327a40640aacd8e8b906 2500w" />

## Find Your Private URL

Once enabled, your unique private GraphQL URL will be displayed. You can also find this URL listed on the main page of your project environment under the "PRIVATE GRAPHQL LINK" column.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=45d17f6b83f1234c38290ece93132fab" alt="Private URL List" width="700" data-og-width="1881" data-og-height="880" data-path="images/how-to/private2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=170c03e25794a0fa9099ae07c2ce6f67 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a733750201ba10c93bb3d985c5b775de 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=c0b478fca2ec7586f8f12db7bf9434e6 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a0e72f5d6ff87f1768e3688ed1995abb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f478e814674d0454cf0d1eb46704f1c3 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f7fb3ddbec13791ab5948282de354b3e 2500w" />

## Authentication

To query your private GraphQL endpoint, you must include an authentication token in the request header.

1. Obtain your API key from the 0xGraph console API Keys.
2. In your GraphQL client (like GraphiQL or Postman), add an `Authorization` header.
3. Set the header value to `Bearer YOUR_API_KEY`, replacing `YOUR_API_KEY` with the actual key.

Here's how it looks in the GraphiQL interface provided by 0xGraph:

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b36c81515bf5633e8446b1a9bc18a852" alt="Private URL Token" width="700" data-og-width="1261" data-og-height="836" data-path="images/how-to/private3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=62296e918593924606edca6ea9bb0e52 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7b7d3af194a2243c9a63ddd31c209e5c 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=87e773a3ca3156ba9ab3700bb365713d 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a5d877ffa5cc966da46065fa94a2ed90 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e4f121ec83725881815c920ece44b3d1 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=67f6cb202406476251abef74a4f70e3f 2500w" />

By following these steps, you can securely interact with your subgraph using its private GraphQL endpoint.


# Subgraph Webhooks
Source: https://docs.ormilabs.com/dedicated-env/dolomite/subgraphs/getting-started/webhook

Learn how to create and manage webhooks for your subgraphs to receive real-time updates.

## Subgraph Webhooks

Subgraph webhooks allow you to receive HTTP POST requests in real-time whenever an entity in your subgraph changes due to an `INSERT`, `UPDATE`, or `DELETE` operation. This is useful for triggering backend processes, sending notifications, or syncing data with external systems.

## How it Works

When a subgraph handler executes an operation like `entity.save()` (resulting in an `INSERT` or `UPDATE`) or an entity is removed (resulting in a `DELETE`), the change is recorded. A real-time watcher detects this update and sends a payload to your configured webhook URL. The payload will indicate the type of operation: `INSERT`, `UPDATE`, or `DELETE`.

## Creating a Webhook

You can create a new webhook through the 0xGraph dashboard.

1. Navigate to the "Webhooks" section of your subgraph.

2. Click on the "New Webhook" button.

3. Fill in the required information in the "Create Webhook" modal:

   * **Name**: A descriptive name for your webhook (e.g., `webhook_demo`).
   * **URL**: The HTTP endpoint where the webhook payloads will be sent.
   * **Entity**: The specific entity you want to track (e.g., `approved`).
   * **Number of retries**: Configure the total number of retries. Defaults to 3, with a maximum of 10.
   * **Retry interval**: Configure the retry interval in seconds. Defaults to 60, with a maximum of 3600.
   * **Retry timeout**: Configure the retry timeout in seconds. Defaults to 30, with a maximum of 60.
   * **"secret" header value**: An optional secret string that will be sent in a designated webhook secret header. This allows your endpoint to verify that the request is authentic.

   <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9234eae31186a5b6f649ed942830ff6c" alt="Create Webhook Modal" data-og-width="1872" width="1872" data-og-height="879" height="879" data-path="images/how-to/webhook.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9f6074a41fc7104edd1f8a831dcf426b 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=70599e318f7d4dbb52bd9b9271f5fb9b 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=12c058b62fbe1aad60ae53b93b4edb0f 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d09122a7d15636238f837d4fb83fb9cb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d4299f143c74dac74aefe4d276549743 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9b8b5cfcba5dbd305b27b026d77ab5d4 2500w" />

4. Click "Create".

## Listing Webhooks

Once created, your webhook will appear in the list of webhooks for your subgraph. You can see its name, the entity it tracks, the target URL, and statistics about successful and failed deliveries.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=1a8a8610f0aa060edd6cec706e366d69" alt="Webhook List" data-og-width="1000" width="1000" data-og-height="818" height="818" data-path="images/how-to/webhook3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=fba9d6def6020d6c02eacc3c4670f763 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ee4af7ca24eeadf9bfab5bde38ab1811 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6e22347e0fe60c0d103c87000e981f06 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=59a7e24f1e30c3da890b3ea603216cc5 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ac5ba543c4c479ce7052f173ee858471 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6887464b8fb3a4b2866c91c8f90a8cb7 2500w" />

## Webhook Payload Structure

The webhook will send a JSON payload to your configured URL. The main payload object contains the following fields:

* `op` (string): The type of operation that triggered the webhook. Possible values are `"INSERT"`, `"UPDATE"`, or `"DELETE"`.
* `data_source` (string): Identifier for the subgraph or indexer being tracked.
* `data` (object): Contains the actual entity data that changed. It has two sub-fields:
  * `old` (object | null): The state of the entity before the change. This will be `null` if the `op` is `"INSERT"`.
  * `new` (object | null): The state of the entity after the change. This will be `null` if the `op` is `"DELETE"`.
* `webhook_name` (string): The name you assigned to your webhook during creation.
* `webhook_id` (string): A unique identifier for the webhook configuration.
* `id` (string): A unique identifier for this specific event notification.
* `delivery_info` (object): Information about the delivery attempt for this webhook. It has two sub-fields:
  * `max_retries` (integer): The maximum number of retry attempts configured for this webhook.
  * `current_retry` (integer): The current retry attempt number for this specific event (0 for the initial attempt).
* `entity` (string): The name of the subgraph entity being tracked.

### Example Payloads:

**`INSERT` operation:**

```json  theme={null}
{
  "op": "INSERT",
  "data_source": "privateURL/v0.0.1",
  "data": {
    "new": {
      "id": "ERC20Approve-0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc-w\\u001c\\u001b\\u0002\\ufffd\\ufffd\\ufffd\\u07Ջ^\\ufffdcO\\ufffd\\ufffd(7C\\u001c\\u001b-\\ufffd\\u0016僞\\ufffdm\\ufffd\\ufffdI+y\\ufffd\\ufffd^\\u0015\\ufffd\\ufffdY\\ufffd",
      "vid": 7271978,
      "owner": "\\\\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc",
      "amount": 1.157920892373162e+77,
      "is_all": false,
      "spender": "\\\\xbde5839ec36db2ac492b79e9e3b75e15fa8a59ec",
      "updated_at": 1747127781,
      "block_range": "[20405156,)"
    },
    "old": null
  },
  "webhook_name": "webhook_demo",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "id": "5b623fd0-b539-400b-bbb3-060d95403a64",
  "delivery_info": {
    "max_retries": 3,
    "current_retry": 0
  },
  "entity": "approved"
}
```

**`UPDATE` operation :**

```json  theme={null}
{
  "data": {
    "new": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,20405060)"
    },
    "old": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,)"
    }
  },
  "data_source": "privateURL/v0.0.1",
  "delivery_info": {
    "current_retry": 0,
    "max_retries": 3
  },
  "entity": "approved",
  "id": "dd2b6013-22e1-4e8e-a665-be5276144a68",
  "op": "UPDATE",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "webhook_name": "webhook_demo"
}
```


# 0xGraph - Reliable Subgraph Indexing
Source: https://docs.ormilabs.com/dedicated-env/dolomite/subgraphs/overview



Deploy subgraphs with 99.9%+ availability and fetch smart contract data at 3x the speed. 100% spec-compliant with every subgraph on The Graph's hosted and decentralized networks.

## Overview

Subgraphs are customizable, open-source solutions for indexing and accessing real-time blockchain data through GraphQL APIs.

0xGraph is a zero-hassle subgraph hosting solution that is 100% spec-compliant with every subgraph on The Graph Protocol’s hosted and decentralized networks, minus the lag and downtime.

* Plug and play deployment and subgraph migration from hosted services.
* Deploy subgraphs with the same tooling, UI, and similar CLI as The Graph.
* Query subgraphs without running any nodes or infrastructure.

### Supported Networks

0xGraph currently supports the following networks:

| Name              | Type    | Network Slug        |
| ----------------- | ------- | ------------------- |
| Arbitrum One      | Mainnet | `arbitrum`          |
| Base              | Mainnet | `base`              |
| Berachain Testnet | Testnet | `berachain-testnet` |
| Mantle            | Mainnet | `mantle`            |
| Polygon zkEVM     | Mainnet | `polygon`           |
| Polygon Amoy      | Testnet | `polygon-zkevm`     |
| Xlayer            | Mainnet | `xlayer`            |

### Available Upon Request

Any other network you need? Please email us: [hello@ormilabs.com](mailto:hello@ormilabs.com)


# Overview
Source: https://docs.ormilabs.com/dedicated-env/goat/data-apis/overview

Coming soon



# Create tag
Source: https://docs.ormilabs.com/dedicated-env/goat/subgraphs/api-reference/create-tag

POST /public_api/v1/0xgraph/create_tag



# Delete tag
Source: https://docs.ormilabs.com/dedicated-env/goat/subgraphs/api-reference/delete-tag

POST /public_api/v1/0xgraph/delete_tag



# Query tag
Source: https://docs.ormilabs.com/dedicated-env/goat/subgraphs/api-reference/query-tag

POST /public_api/v1/0xgraph/query_tag



# Remove subgraph
Source: https://docs.ormilabs.com/dedicated-env/goat/subgraphs/api-reference/remove-subgraph

POST /public_api/v1/0xgraph/remove_subgraph

<Note>
  ⚠️ CLI deletion is temporarily unsupported. Use the Ormi Dashboard UI to remove subgraphs.
</Note>


# Cheat Sheet
Source: https://docs.ormilabs.com/dedicated-env/goat/subgraphs/cheatsheet

Streamlined Guide: Deploying Subgraphs on 0xGraph with The Graph CLI

## Overview

This quick start guide outlines streamlined instructions for deploying Subgraphs using the Command Line Interface (CLI). Developers looking to swiftly incorporate Subgraph capabilities into their projects will find straightforward guidance and pro tips for getting set up fast.

<Info>
  This cheat sheet condenses essential commands, tips, and best practices into
  an indispensable reference for anyone deploying a Subgraph. Developers will
  find this streamlined guide invaluable for swiftly progressing through the
  deployment workflow and resolving frequent pain points. With key information
  consolidated in one place, engineers can deploy Subgraphs more efficiently and
  focus their efforts on building applications powered by real-time,
  customizable blockchain data indexes.
</Info>

## 1. Get started by installing The Graph CLI

Download The Graph CLI via npm

```bash  theme={null}
npm i @graphprotocol/graph-cli
```

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="https://www.npmjs.com/package/@graphprotocol/graph-cli">
  Install The Graph npm package
</Card>

## 2. Generate API key

Create an API key: Visit [0xGraph Dashboard](https://ui.goat.cloud.0xgraph.xyz/dashboard/api) to generate your API key

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

## 3. Generate types and mappings for your Subgraph

Go to your Subgraph root directory where `subgraph.yaml` file is located

```bash  theme={null}
cd <your_subgraph_project>
```

Run the following command to generate AssemblyScript types for smart contract ABIs and the subgraph schema

```bash  theme={null}
graph codegen
```

## 4. Compile your Subgraph

Run the following command to compile your Subgraph into WASM (WebAssembly)

```bash  theme={null}
graph build
```

## 5. Deploy your Subgraph to 0xGraph

Paste the API key generated in step 2 and run the following command to deploy your Subgraph to 0xGraph

```bash  theme={null}
graph deploy <your_subgraph> --node
https://api.goat.0xgraph.xyz/deploy
--ipfs https://api.goat.0xgraph.xyz/ipfs
--deploy-key <api_key>
```

<Info>
  If prompted to enter the version, use the version of The Graph CLI that you
  downloaded.
</Info>

You can now monitor your Subgraph deployment in the 0xGraph app

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-analytics.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=06cea82c58bd12f329c8d5b8705de0f9" alt="Subgraph analytics page" data-og-width="2622" width="2622" data-og-height="1854" height="1854" data-path="images/goat/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-analytics.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=521cd1f394ebb6e0f77f13f261fa7348 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-analytics.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=30143c58f288cb06842bb456f2f6d360 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-analytics.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d5d1f92ea94f4e79537d41df255202bf 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=9a133647dc947f731109540ba7f8c794 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=ebd38eda2dac1027a245e7b53117c0be 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=69890154adc643b4b576eda01696ab95 2500w" />
</Frame>

## Quick Start in the App

The [0xGraph Web App](https://ui.goat.cloud.0xgraph.xyz) also offers a concise guide to assist users in deploying their Subgraphs effectively

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-quickstart.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=dd3b2ce39e97c0fe326919c6c27ffb62" alt="Subgraph analytics page" data-og-width="3490" width="3490" data-og-height="1836" height="1836" data-path="images/goat/0xgraph-quickstart.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-quickstart.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=a3ba8f737b205d5d92807e508c32a51b 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-quickstart.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=5948ed1425de615fa83de1635d71f72f 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-quickstart.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=f67cffe1dce7afbe035ada3b73e31de5 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-quickstart.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=2ba527791d6f40fd56f7217315aea7ed 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-quickstart.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=1a2abb5dc4d320db2a83b2ae41754f24 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-quickstart.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=fce173e1b5e9ac91d23b4ceb03e3daf5 2500w" />
</Frame>


# Account Creation
Source: https://docs.ormilabs.com/dedicated-env/goat/subgraphs/getting-started/account-creation

How to create your 0xGraph account

## Setup Steps

### 1. Create Account

Visit [ui.goat.cloud.0xgraph.xyz](https://ui.goat.cloud.0xgraph.xyz) to create your account.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-signup.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=522f173755c8ccb166348992273ba124" alt="Goat App Registration" data-og-width="3448" width="3448" data-og-height="1840" height="1840" data-path="images/goat/0xgraph-signup.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-signup.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=b051422db94bac90e6e1dfe2b77580df 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-signup.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=8f064884f1bc18fbd63cc05370ce2673 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-signup.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=9b778938d6c2863927e23e9ce2ebc84c 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-signup.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=c570a9730ee3bb18b632e99227d1ed14 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-signup.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=df2a4b53d6e439803090a191bd27e730 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-signup.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=5d7786278264c9649f296e03cd584c06 2500w" />
</Frame>

### 2. Choose Subscription Plan

Choose a plan that best fits your needs in [Settings page](https://ui.goat.cloud.0xgraph.xyz/dashboard/settings).

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-pricing.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=a671607a202b2f3371dbdd089dc571e5" alt="Goat Subscription Plans" data-og-width="3474" width="3474" data-og-height="1826" height="1826" data-path="images/goat/0xgraph-pricing.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-pricing.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=7711096f772a35d6474a51584de69a45 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-pricing.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=cbe9cc1f4c0fb240cfd61caf3e791344 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-pricing.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=580145d042c076676585ef5d4f430aaa 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-pricing.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=7bb504cf9eb34b7ddc94f937a7888570 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-pricing.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=3712d43bf12325a0fff2d259637638be 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-pricing.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=6e42d97c18a27284ab63ca1be3eb6f6c 2500w" />

  <figcaption>Choose a subscription plan</figcaption>
</Frame>

### 3. Generate API Key

Go to the [API Keys Page](https://ui.goat.cloud.0xgraph.xyz/dashboard/api) to create your API key.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-api-key.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=6c5d70106eab67070dee00363bedb029" alt="Goat API Keys" data-og-width="3470" width="3470" data-og-height="1850" height="1850" data-path="images/goat/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-api-key.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=6dc9cbed0a2f1306705544dc7ba3adfe 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-api-key.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d1b80f4d8255152b39d11c45ac897f28 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-api-key.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=c773420a83de4383a935322b937fc250 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=310f1ce3509d96b6ad7579c8e269e842 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=079f5575fb55f89d1f2b8058f26c4adb 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=365a30dc5f25548a66fd7441d2246034 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

After clicking the 'Create API Key' button in the top-right corner, your API key will be generated. You can then copy and paste it into your commands as needed.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-generated-api-key.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=3be2e3bac15533d12b7135f14f3791de" alt="Goat API Keys" data-og-width="3486" width="3486" data-og-height="1860" height="1860" data-path="images/goat/0xgraph-generated-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-generated-api-key.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=b80d9ff4b2d6081c60fc5140d48cdf9d 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-generated-api-key.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d13919dbb0221a6c44749406c6715fd1 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-generated-api-key.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d11590e6043447e052b2f9d0e0ff69e2 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-generated-api-key.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=8971a3e76375edd913fa12dfdd16c3f0 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-generated-api-key.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=1aab6367caf567b2909489993f651fc9 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-generated-api-key.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=bcda2d3fdcb539293c8a0fd70b12b2be 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

<Info>
  Warning: Always handle your API keys securely. Do not expose them in
  client-side code or share them publicly. Store them in a secure location, such
  as environment variables, and rotate them regularly to minimize security
  risks. If compromised, regenerate your API key immediately. For public
  repositories, store API keys in a .env file and add .env to .gitignore to
  prevent accidental exposure in your codebase.
</Info>

You are all set and ready to go for deploying a subgraph.


# CLI Usage
Source: https://docs.ormilabs.com/dedicated-env/goat/subgraphs/getting-started/cli-usage

A detailed list of all active and relevant commands for The Graph CLI, including their purposes, use cases, and examples.

## `graph init`

**Purpose:**\
Creates a new Subgraph project using an example template or an existing smart contract.

**Use Case:**

* Use this command when starting a new Subgraph project.
* It sets up the necessary folder structure, configuration files `subgraph.yaml`, and example code.
* You can specify a contract address and network to scaffold a Subgraph tailored to a specific smart contract.

**Example:**

```bash  theme={null}
graph init --from-contract <CONTRACT_ADDRESS> --network mainnet
```

## `graph codegen`

**Purpose:**\
Generates AssemblyScript types for smart contract ABIs and the Subgraph schema.

**Use Case:**

* Use this command after making changes to your `schema.graphql` file or when adding/updating smart contract ABIs.
* It creates type-safe classes that make it easier to interact with blockchain data in your mappings.

## `graph build`

**Purpose:**\
Compiles the Subgraph to WebAssembly (WASM), preparing it for deployment.

**Use Case:**

* Run this command after completing your mappings and configuration.
* It ensures your Subgraph is ready for deployment by converting it into the WASM format required by 0xGraph.

## `graph deploy`

**Purpose:**\
Deploys the compiled Subgraph to the 0xGraph hosting service.

**Use Case:**

* After building your Subgraph, use this command to upload and activate it on 0xGraph.
* Specify the deployment target (e.g., staging or production) and the Subgraph name.

**Example:**

```bash  theme={null}
graph deploy <your_subgraph> --node
https://api.goat.0xgraph.xyz/deploy
--ipfs https://api.goat.0xgraph.xyz/ipfs
--deploy-key <your_api_key>
```

## `graph local`

**Purpose:**\
Runs a local test environment (e.g., using Ganache or Hardhat) to test the Subgraph with simulated blockchain data.

**Use Case:**

* Use this command when developing and testing your Subgraph locally.
* It allows you to simulate blockchain events and validate mappings.
* Ideal for testing without deploying to a live environment.

## `graph test`

**Purpose:**\
Downloads and runs the Matchstick Rust binary to execute unit tests for a Subgraph.

**Use Case:**

* Use this command to write and run unit tests for your mappings and ensure that your Subgraph logic works correctly.
* Matchstick is a testing framework built specifically for The Graph.

## `graph add`

**Purpose:**\
Adds a new data source to your Subgraph’s manifest file (subgraph.yaml) and updates relevant files such as schema.graphql, ABIs, and mappings.

**Use Case:**

* Use this command when adding additional smart contracts or data sources to your Subgraph.
* It automates the process of updating your Subgraph configuration and related files.

**Example:**

```bash  theme={null}
graph add <CONTRACT_NAME> --from-contract <CONTRACT_ADDRESS>
```

<Info>
  Ensure you have the latest version of The Graph CLI installed to avoid
  potential issues with deprecated or updated commands.
</Info>


# Deploy a Subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/goat/subgraphs/getting-started/deploy-subgraph-graph-cli

Quick start guide for deploying a Subgraph using the Command Line Interface (CLI).

<Info>
  The Graph CLI is an essential tool enabling developers to seamlessly create,
  deploy, and manage subgraphs—providing streamlined blockchain data querying
  and indexing. It gives you superuser access to our enterprise-grade subgraph
  infrastructure. Additionally, we are fully compatible with The Graph's
  tooling, and the CLI works seamlessly out of the box with our platform.
</Info>

## Deployment Network Definitions

For developers who are already familiar with Graph Protocol tooling, below are the network definitions to deploy subgraphs on 0xGraph. These settings can be configured in the subgraph.yaml file:

## Installation

<Steps>
  <Step title="Install CLI Package">
    <CodeGroup>`npm i @graphprotocol/graph-cli `</CodeGroup>
  </Step>
</Steps>

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="_blank">
  Install the graph npm package
</Card>

## Generate API Key

Create an API key: Visit [0xGraph Dashboard](https://https://ui.goat.cloud.0xgraph.xyz/dashboard/api) to generate your API key. For a comprehensive tutorial on generating API keys, visit the [Account Creation Page](/dedicated-env/goat/subgraphs/getting-started/account-creation).

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

***

## Create your own Subgraph

Details regarding creating your own Subgraph is beyond the scope of this documentation. The Graph's official documentation provides detailed guides and examples for each step of the Subgraph creation process. It also covers advanced topics such as indexing strategies, filtering, and pagination. We recommend referring to their documentation for a comprehensive reference on Subgraph development with The Graph.

## Core Components

A typical Subgraph project has the following components:

<CardGroup cols={2}>
  <Card title="Manifest File" icon="file-lines">
    The `subgraph.yaml` manifest file serves as the root configuration, containing smart contract references, entity mappings, handler functions, and deployment parameters like `startBlock` and `description`.
  </Card>

  {' '}

  <Card title="Schema File" icon="database">
    The `schema.graphql` file defines all the entities and their relationships for
    your Subgraph's GraphQL API, determining what blockchain data will be indexed
    and made queryable.
  </Card>

  <Card title="Mappings File" icon="code">
    Written in [AssemblyScript](https://www.assemblyscript.org/), a TypeScript-like language specifically designed for WebAssembly, the mappings file transforms raw blockchain data into structured entities that match your GraphQL schema through a set of data handling functions.
  </Card>
</CardGroup>

<Note>
  Messari maintains a [well-curated GitHub
  repository](https://github.com/messari/subgraphs) that offers a comprehensive
  collection of example Subgraphs, which serves as a valuable resource for those
  seeking to start their subgraph development journey.
</Note>

***

## Subgraph Compilation

<Steps>
  <Step title="Generate Types and Mappings">
    <Note>
      The codegen step generates code files for indexing and querying data based on your schema and mappings.
    </Note>

    Run in your project root:

    ```bash  theme={null}
    graph codegen
    ```

    Success output:

    ```bash  theme={null}
        Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
        Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
        Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
        Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
        Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
        Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
        Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
      ✔ Apply migrations
      ✔ Load subgraph from subgraph.yaml
        Load contract ABI from abis/factory.json
        Load contract ABI from abis/ERC20.json
        Load contract ABI from abis/ERC20SymbolBytes.json
        Load contract ABI from abis/ERC20NameBytes.json
      ✔ Load contract ABIs
        Generate types for contract ABI: Factory (abis/factory.json)
        Generate types for contract ABI: ERC20 (abis/ERC20.json)
        Generate types for contract ABI: ERC20SymbolBytes (abis/ERC20SymbolBytes.json)
        Generate types for contract ABI: ERC20NameBytes (abis/ERC20NameBytes.json)
        Write types to generated/Factory/Factory.ts
        Write types to generated/Factory/ERC20.ts
        Write types to generated/Factory/ERC20SymbolBytes.ts
        Write types to generated/Factory/ERC20NameBytes.ts
      ✔ Generate types for contract ABIs
        Generate types for data source template Pair
        Write types for templates to generated/templates.ts
      ✔ Generate types for data source templates
        Load data source template ABI from abis/pair.json
        Load data source template ABI from abis/factory.json
      ✔ Load data source template ABIs
        Generate types for data source template ABI: Pair > Pair (abis/pair.json)
        Generate types for data source template ABI: Pair > Factory (abis/factory.json)
        Write types to generated/templates/Pair/Pair.ts
        Write types to generated/templates/Pair/Factory.ts
      ✔ Generate types for data source template ABIs
      ✔ Load GraphQL schema from schema.graphql
        Write types to generated/schema.ts
      ✔ Generate types for GraphQL schema

      Types generated successfully
    ```

    <Accordion title="Codegen Options">
      <Info>
        View all options with `graph codegen --help`:
      </Info>

      ```bash  theme={null}
      USAGE
        $ graph codegen [SUBGRAPH-MANIFEST] [-h] [-o <value>] [--skip-migrations] [-w] [--uncrashable-config <value> -u]

      FLAGS
        -h, --help                    Show CLI help.
        -o, --output-dir=<value>      [default: generated/] Output directory for generated types.
        -u, --uncrashable             Generate Float S
                                      subgraph Uncrashable helper file.
        -w, --watch                   Regenerate types when subgraph files change.
        --skip-migrations             Skip subgraph migrations.
        --uncrashable-config=<value>  Directory for uncrashable config.
      ```
    </Accordion>
  </Step>

  <Step title="Build Your Subgraph">
    After generating types, build your subgraph:

    ```bash  theme={null}
    graph build
    ```

    Success Output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/

    Build completed: build/subgraph.yaml
    ```

    <Accordion title="Build Options">
      <Info>
        View all options with `graph build --help`:
      </Info>

      ```bash  theme={null}
      Builds a subgraph and (optionally) uploads it to IPFS.

        USAGE
          $ graph build [SUBGRAPH-MANIFEST] [-h] [-i <value>] [-o <value>] [-t wasm|wast]
            [--skip-migrations] [-w] [--network <value>] [--network-file <value>]

        FLAGS
          -h, --help                    Show CLI help.
          -i, --ipfs=<value>            Upload build results to an IPFS node.
          -o, --output-dir=<value>      [default: build/] Output directory for build results.
          -t, --output-format=<option>  [default: wasm] Output format for mappings.
                                        <options: wasm|wast>
          -w, --watch                   Regenerate types when subgraph files change.
          --network=<value>             Network configuration to use from the networks config file.
          --network-file=<value>        [default: networks.json] Networks config file path.
          --skip-migrations             Skip subgraph migrations.

      DESCRIPTION
      Builds a subgraph and (optionally) uploads it to IPFS.

      ```
    </Accordion>
  </Step>

  <Step title="Deploy your Subgraph">
    Then deploy your Subgraph:

    ```bash  theme={null}
    graph deploy <your_subgraph> --node
    https://api.goat.0xgraph.xyz/deploy
    --ipfs https://api.goat.0xgraph.xyz/ipfs
    --deploy-key <your_API_key>
    ```

    Success output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/
      Add file to IPFS build/schema.graphql
                    .. Qmckrwbgbx3FjsVH4AU8xP3zgdg3rPnzNo7pmApAmhQkA4
      Add file to IPFS build/Factory/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9
      Add file to IPFS build/Factory/ERC20.json
                    .. QmPfKNZPkVATzL3EHypkcsyKhehR4jkiYEVqSzh2hxWYj1
      Add file to IPFS build/Factory/ERC20SymbolBytes.json
                    .. QmbHnhUFZa6qqqRyubUYhXntox1TCBxqryaBM1iNGqVJzT
      Add file to IPFS build/Factory/ERC20NameBytes.json
                    .. QmQCP6Pdp1MqpwRv2qoPHuUTwZGy7Q3eDHg4w5kzwE9mBj
      Add file to IPFS build/Factory/Factory.wasm
                    .. QmNksN9HGSyMfc4XrjQeHuDKsBQk1xHEKVE2dLwHQQu4kb
      Add file to IPFS build/Pair/pair.json
                    .. QmbPLMADBP8L6LBVP3ZBQ8RgG7ghamD8DvbdUxHAjZrLgm
      Add file to IPFS build/Pair/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9 (already uploaded)
      Add file to IPFS build/templates/Pair/Pair.wasm
                    .. QmSZSUoNinhNshD26iwKyzut6s3w5Lmec3P9szBovfQg8V
    ✔ Upload subgraph to IPFS

    Build completed: QmdXJQUxgrzP8pVotTqiwirJ6NxfmdNdQ6rWQv2rmJpBQp

    Deployed to /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn

    Subgraph endpoints:
    Queries (HTTP):     /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn
    ```
  </Step>
</Steps>

<Card title="View Your Subgraphs" icon="browser">
  Access your deployed Subgraphs through the web-based UI at [https://ui.goat.cloud.0xgraph.xyz](http://https://ui.goat.cloud.0xgraph.xyz)
</Card>

```
```


# Deploy a token transfer subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/goat/subgraphs/getting-started/deploy-token-transfer-subgraph

Tutorial on how to deploy an erc20 token transfer subgraph with the Graph CLI



# Monitor Your Subgraph
Source: https://docs.ormilabs.com/dedicated-env/goat/subgraphs/getting-started/monitor-subgraph

Learn how to monitor your subgraph syncing progress and logs after deployment

# Monitor your subgraph via the Analytics Page

After deploying your subgraph, you can easily monitor the syncing progress and subgraph logs for up to 48 hours to gain insight and troubleshoot any issues that may come with your subgraph.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-monitor.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=2af7e731630b1d37af666695330c4867" alt="Subgraph deployment view" data-og-width="3476" width="3476" data-og-height="1848" height="1848" data-path="images/goat/0xgraph-monitor.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-monitor.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=ead1e5c64d7f93cee7ea82782b1c7817 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-monitor.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=a50b19eb619e96fbf9ac15e5b9fd4db2 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-monitor.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=bf0d9de0e2b7193fb01e99435fb9f6a9 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-monitor.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=3969386b098c4f6ad57b3e87bbb25876 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-monitor.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=059e08c8094dd2f78dbb2c5f066c0c9e 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-monitor.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=1b5cc55d765bb5241a0d350ad07d5a43 2500w" />
</Frame>

You can access your deployed subgraph analytics page by clicking on the subgraph name; afterward, you will be directed to the following analytics page.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-analytics.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=06cea82c58bd12f329c8d5b8705de0f9" alt="Subgraph analytics page" data-og-width="2622" width="2622" data-og-height="1854" height="1854" data-path="images/goat/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-analytics.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=521cd1f394ebb6e0f77f13f261fa7348 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-analytics.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=30143c58f288cb06842bb456f2f6d360 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-analytics.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d5d1f92ea94f4e79537d41df255202bf 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=9a133647dc947f731109540ba7f8c794 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=ebd38eda2dac1027a245e7b53117c0be 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=69890154adc643b4b576eda01696ab95 2500w" />
</Frame>


# Perform Query
Source: https://docs.ormilabs.com/dedicated-env/goat/subgraphs/getting-started/perform-query

Short description on what this section is about

After deploying your subgraph, you can easily access and query it via GraphQL playground for query. You can open the "GraphQL API" link in your dashboard to access your data.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-graphql-api.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=0e625c5f9ea23c6da997e743f6dc8550" alt="API Keys" data-og-width="3474" width="3474" data-og-height="1850" height="1850" data-path="images/goat/0xgraph-graphql-api.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-graphql-api.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=b4bc1e31f8288edbf424017321046503 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-graphql-api.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=3cabb9dae2600eb68e0f4799f3a54271 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-graphql-api.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=b865e71ecc32255dc0f3f651da2a0c0e 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-graphql-api.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=83e0c28844c2713e0ce5fde049c1f2f0 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-graphql-api.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=340dcc06797352fb30cf7a1f9032262c 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-graphql-api.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=96bdadd419a4fdc20be19f34626bdd4d 2500w" />
</Frame>

For example, you may access the publicly available Goat token approval subgraph at `https://api.goat.cloud.0xgraph.xyz/subgraphs/name/ormi/blocks/graphql`

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-graphql.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=af91d7d4ec5f089937753b6eee262260" alt="GraphQL" data-og-width="1847" width="1847" data-og-height="867" height="867" data-path="images/goat/0xgraph-graphql.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-graphql.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=dff785b2888fe75f5e24dd27b2376fba 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-graphql.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=6f8dd7fcd89a437e75dc9602f038d126 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-graphql.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=6685dea8719fa7eb1415a78f60a6d857 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-graphql.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=9caa25fc4b03e651612fabc61c8cda48 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-graphql.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=c19bfcc40d98155ed3e3fbd6aa5ba29d 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/goat/0xgraph-graphql.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=14639e681eaced00fcdd7460af9ea957 2500w" />
</Frame>

***

## Query for Subgraph Sync Status

To get to know the sync status directly inside the subgraph, a user may run the following query by using `_meta`:

```graphql  theme={null}
{
  _meta {
    block {
      hash
      timestamp
      number
    }
  }
}
```

The result would be similar to the following:

```json  theme={null}
{
  "data": {
    "_meta": {
      "block": {
        "hash": "0x9f2480d4a21fb9743ae35d349fccbc86c0fad084d6a87b53d1f649f1051c6ddb",
        "timestamp": 1700267031,
        "number": 151479342
      }
    }
  }
}
```

***

## Query a Subgraph

Subgraphs expose blockchain data via a GraphQL API, making it easy for anyone familiar with the GraphQL language to get started.

A GraphQL API differs from traditional REST APIs in that it relies on a schema definition to outline the available queries, mutations, and data types that clients can access.

## Benefits of Schema-Driven Approach

This schema-driven approach enables clients to precisely specify the data they need, eliminating the need to over-fetch data. Here's why this is beneficial:

<CardGroup>
  <Card title="Precision" icon="bullseye">
    GraphQL clients can tailor their queries to retrieve only the data they require, enhancing efficiency.
  </Card>

  <Card title="Flexibility" icon="arrows-to-circle">
    Clients can request related data in a single query, reducing the number of API calls needed.
  </Card>

  <Card title="Predictability" icon="chart-line">
    The schema provides clear documentation for available data and operations.
  </Card>
</CardGroup>

## GraphQL Syntax

GraphQL queries are composed using a specific syntax that allows for hierarchical data retrieval. Clients specify the fields they want to retrieve and their relationships within a single query. This approach minimizes unnecessary data retrieval, resulting in more concise and efficient requests.

## Best Practices

When working with the 0xGraph service, it's essential to follow best practices to ensure optimal performance and efficiency. These best practices are outlined in official Graph Protocol documentation.

<Info>
  For detailed instructions on querying 0xGraph using GraphQL and to ensure adherence to best practices, refer to the [official
  documentation](https://thegraph.com/docs/en/querying/querying-best-practices/) provided by the Ormi Labs and Graph Protocol teams. These resources offer
  valuable insights and recommendations to streamline your interaction with blockchain data through GraphQL.
</Info>


# Private Graphql URL
Source: https://docs.ormilabs.com/dedicated-env/goat/subgraphs/getting-started/private-url

Learn how to create a private GraphQL URL for your subgraph

## Private Graphql URL

When you deploy a new subgraph, a public GraphQL endpoint is provided by default. However, you can also create a private endpoint for your subgraph, which requires an authentication token for requests. This private endpoint ensures that only authorized users or applications can access your subgraph's data, maintaining data security and control.

## Enable Private GraphQL Link

To use the private endpoint, you first need to enable it in your subgraph's detail on the 0xGraph console.

1. Navigate to your project details page.
2. Find the "PRIVATE GRAPHQL LINK" section.
3. Toggle the switch to "Enabled".

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=560e6af6112a63cffb865cbc60afd565" alt="Enable Private URL" width="700" data-og-width="1229" data-og-height="834" data-path="images/how-to/private.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=84eabc519189ef2a3b52f280ff7e2646 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a44106946348f0dcaf322b5b35e66c41 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6dcfd639d6e2d14fdacf34fc469e0afd 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e8470fabfb0845232d16b5434ada8136 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=93dc339e9fdfbd6dcc7ed4ad027c6baf 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=aee1e2143fe2327a40640aacd8e8b906 2500w" />

## Find Your Private URL

Once enabled, your unique private GraphQL URL will be displayed. You can also find this URL listed on the main page of your project environment under the "PRIVATE GRAPHQL LINK" column.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=45d17f6b83f1234c38290ece93132fab" alt="Private URL List" width="700" data-og-width="1881" data-og-height="880" data-path="images/how-to/private2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=170c03e25794a0fa9099ae07c2ce6f67 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a733750201ba10c93bb3d985c5b775de 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=c0b478fca2ec7586f8f12db7bf9434e6 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a0e72f5d6ff87f1768e3688ed1995abb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f478e814674d0454cf0d1eb46704f1c3 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f7fb3ddbec13791ab5948282de354b3e 2500w" />

## Authentication

To query your private GraphQL endpoint, you must include an authentication token in the request header.

1. Obtain your API key from the 0xGraph console API Keys.
2. In your GraphQL client (like GraphiQL or Postman), add an `Authorization` header.
3. Set the header value to `Bearer YOUR_API_KEY`, replacing `YOUR_API_KEY` with the actual key.

Here's how it looks in the GraphiQL interface provided by 0xGraph:

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b36c81515bf5633e8446b1a9bc18a852" alt="Private URL Token" width="700" data-og-width="1261" data-og-height="836" data-path="images/how-to/private3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=62296e918593924606edca6ea9bb0e52 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7b7d3af194a2243c9a63ddd31c209e5c 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=87e773a3ca3156ba9ab3700bb365713d 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a5d877ffa5cc966da46065fa94a2ed90 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e4f121ec83725881815c920ece44b3d1 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=67f6cb202406476251abef74a4f70e3f 2500w" />

By following these steps, you can securely interact with your subgraph using its private GraphQL endpoint.


# Subgraph Webhooks
Source: https://docs.ormilabs.com/dedicated-env/goat/subgraphs/getting-started/webhook

Learn how to create and manage webhooks for your subgraphs to receive real-time updates.

## Subgraph Webhooks

Subgraph webhooks allow you to receive HTTP POST requests in real-time whenever an entity in your subgraph changes due to an `INSERT`, `UPDATE`, or `DELETE` operation. This is useful for triggering backend processes, sending notifications, or syncing data with external systems.

## How it Works

When a subgraph handler executes an operation like `entity.save()` (resulting in an `INSERT` or `UPDATE`) or an entity is removed (resulting in a `DELETE`), the change is recorded. A real-time watcher detects this update and sends a payload to your configured webhook URL. The payload will indicate the type of operation: `INSERT`, `UPDATE`, or `DELETE`.

## Creating a Webhook

You can create a new webhook through the 0xGraph dashboard.

1. Navigate to the "Webhooks" section of your subgraph.

2. Click on the "New Webhook" button.

3. Fill in the required information in the "Create Webhook" modal:

   * **Name**: A descriptive name for your webhook (e.g., `webhook_demo`).
   * **URL**: The HTTP endpoint where the webhook payloads will be sent.
   * **Entity**: The specific entity you want to track (e.g., `approved`).
   * **Number of retries**: Configure the total number of retries. Defaults to 3, with a maximum of 10.
   * **Retry interval**: Configure the retry interval in seconds. Defaults to 60, with a maximum of 3600.
   * **Retry timeout**: Configure the retry timeout in seconds. Defaults to 30, with a maximum of 60.
   * **"secret" header value**: An optional secret string that will be sent in a designated webhook secret header. This allows your endpoint to verify that the request is authentic.

   <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9234eae31186a5b6f649ed942830ff6c" alt="Create Webhook Modal" data-og-width="1872" width="1872" data-og-height="879" height="879" data-path="images/how-to/webhook.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9f6074a41fc7104edd1f8a831dcf426b 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=70599e318f7d4dbb52bd9b9271f5fb9b 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=12c058b62fbe1aad60ae53b93b4edb0f 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d09122a7d15636238f837d4fb83fb9cb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d4299f143c74dac74aefe4d276549743 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9b8b5cfcba5dbd305b27b026d77ab5d4 2500w" />

4. Click "Create".

## Listing Webhooks

Once created, your webhook will appear in the list of webhooks for your subgraph. You can see its name, the entity it tracks, the target URL, and statistics about successful and failed deliveries.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=1a8a8610f0aa060edd6cec706e366d69" alt="Webhook List" data-og-width="1000" width="1000" data-og-height="818" height="818" data-path="images/how-to/webhook3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=fba9d6def6020d6c02eacc3c4670f763 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ee4af7ca24eeadf9bfab5bde38ab1811 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6e22347e0fe60c0d103c87000e981f06 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=59a7e24f1e30c3da890b3ea603216cc5 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ac5ba543c4c479ce7052f173ee858471 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6887464b8fb3a4b2866c91c8f90a8cb7 2500w" />

## Webhook Payload Structure

The webhook will send a JSON payload to your configured URL. The main payload object contains the following fields:

* `op` (string): The type of operation that triggered the webhook. Possible values are `"INSERT"`, `"UPDATE"`, or `"DELETE"`.
* `data_source` (string): Identifier for the subgraph or indexer being tracked.
* `data` (object): Contains the actual entity data that changed. It has two sub-fields:
  * `old` (object | null): The state of the entity before the change. This will be `null` if the `op` is `"INSERT"`.
  * `new` (object | null): The state of the entity after the change. This will be `null` if the `op` is `"DELETE"`.
* `webhook_name` (string): The name you assigned to your webhook during creation.
* `webhook_id` (string): A unique identifier for the webhook configuration.
* `id` (string): A unique identifier for this specific event notification.
* `delivery_info` (object): Information about the delivery attempt for this webhook. It has two sub-fields:
  * `max_retries` (integer): The maximum number of retry attempts configured for this webhook.
  * `current_retry` (integer): The current retry attempt number for this specific event (0 for the initial attempt).
* `entity` (string): The name of the subgraph entity being tracked.

### Example Payloads:

**`INSERT` operation:**

```json  theme={null}
{
  "op": "INSERT",
  "data_source": "privateURL/v0.0.1",
  "data": {
    "new": {
      "id": "ERC20Approve-0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc-w\\u001c\\u001b\\u0002\\ufffd\\ufffd\\ufffd\\u07Ջ^\\ufffdcO\\ufffd\\ufffd(7C\\u001c\\u001b-\\ufffd\\u0016僞\\ufffdm\\ufffd\\ufffdI+y\\ufffd\\ufffd^\\u0015\\ufffd\\ufffdY\\ufffd",
      "vid": 7271978,
      "owner": "\\\\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc",
      "amount": 1.157920892373162e+77,
      "is_all": false,
      "spender": "\\\\xbde5839ec36db2ac492b79e9e3b75e15fa8a59ec",
      "updated_at": 1747127781,
      "block_range": "[20405156,)"
    },
    "old": null
  },
  "webhook_name": "webhook_demo",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "id": "5b623fd0-b539-400b-bbb3-060d95403a64",
  "delivery_info": {
    "max_retries": 3,
    "current_retry": 0
  },
  "entity": "approved"
}
```

**`UPDATE` operation :**

```json  theme={null}
{
  "data": {
    "new": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,20405060)"
    },
    "old": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,)"
    }
  },
  "data_source": "privateURL/v0.0.1",
  "delivery_info": {
    "current_retry": 0,
    "max_retries": 3
  },
  "entity": "approved",
  "id": "dd2b6013-22e1-4e8e-a665-be5276144a68",
  "op": "UPDATE",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "webhook_name": "webhook_demo"
}
```


# 0xGraph - Reliable Subgraph Indexing
Source: https://docs.ormilabs.com/dedicated-env/goat/subgraphs/overview



Deploy subgraphs with 99.9%+ availability and fetch smart contract data at 3x the speed. 100% spec-compliant with every subgraph on The Graph's hosted and decentralized networks.

## Overview

Subgraphs are customizable, open-source solutions for indexing and accessing real-time blockchain data through GraphQL APIs.

0xGraph is a zero-hassle subgraph hosting solution that is 100% spec-compliant with every subgraph on The Graph Protocol’s hosted and decentralized networks, minus the lag and downtime.

* Plug and play deployment and subgraph migration from hosted services.
* Deploy subgraphs with the same tooling, UI, and similar CLI as The Graph.
* Query subgraphs without running any nodes or infrastructure.

### Supported Networks

0xGraph currently supports the following networks:

| Name | Type    | Network Slug   |
| ---- | ------- | -------------- |
| Goat | Mainnet | `goat        ` |
| Goat | Testnet | `goat-testnet` |

### Available Upon Request

Any other network you need? Please email us: [hello@ormilabs.com](mailto:hello@ormilabs.com)


# Overview
Source: https://docs.ormilabs.com/dedicated-env/mantle/data-apis/overview

Coming soon



# Create tag
Source: https://docs.ormilabs.com/dedicated-env/mantle/subgraphs/api-reference/create-tag

POST /public_api/v1/0xgraph/create_tag



# Delete tag
Source: https://docs.ormilabs.com/dedicated-env/mantle/subgraphs/api-reference/delete-tag

POST /public_api/v1/0xgraph/delete_tag



# Query tag
Source: https://docs.ormilabs.com/dedicated-env/mantle/subgraphs/api-reference/query-tag

POST /public_api/v1/0xgraph/query_tag



# Remove subgraph
Source: https://docs.ormilabs.com/dedicated-env/mantle/subgraphs/api-reference/remove-subgraph

POST /public_api/v1/0xgraph/remove_subgraph

<Note>
  ⚠️ CLI deletion is temporarily unsupported. Use the Ormi Dashboard UI to remove subgraphs.
</Note>


# Cheat Sheet
Source: https://docs.ormilabs.com/dedicated-env/mantle/subgraphs/cheatsheet

Streamlined Guide: Deploying Subgraphs on 0xGraph with The Graph CLI

## Overview

This quick start guide outlines streamlined instructions for deploying Subgraphs using the Command Line Interface (CLI). Developers looking to swiftly incorporate Subgraph capabilities into their projects will find straightforward guidance and pro tips for getting set up fast.

<Info>
  This cheat sheet condenses essential commands, tips, and best practices into
  an indispensable reference for anyone deploying a Subgraph. Developers will
  find this streamlined guide invaluable for swiftly progressing through the
  deployment workflow and resolving frequent pain points. With key information
  consolidated in one place, engineers can deploy Subgraphs more efficiently and
  focus their efforts on building applications powered by real-time,
  customizable blockchain data indexes.
</Info>

## 1. Get started by installing The Graph CLI

Download The Graph CLI via npm

```bash  theme={null}
npm i @graphprotocol/graph-cli
```

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="https://www.npmjs.com/package/@graphprotocol/graph-cli">
  Install The Graph npm package
</Card>

## 2. Generate API key

Create an API key: Visit [0xGraph Dashboard](https://subgraph.mantle.xyz/dashboard/api) to generate your API key

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

## 3. Generate types and mappings for your Subgraph

Go to your Subgraph root directory where `subgraph.yaml` file is located

```bash  theme={null}
cd <your_subgraph_project>
```

Run the following command to generate AssemblyScript types for smart contract ABIs and the subgraph schema

```bash  theme={null}
graph codegen
```

## 4. Compile your Subgraph

Run the following command to compile your Subgraph into WASM (WebAssembly)

```bash  theme={null}
graph build
```

## 5. Deploy your Subgraph to 0xGraph

Paste the API key generated in step 2 and run the following command to deploy your Subgraph to 0xGraph

```bash  theme={null}
graph deploy <your_subgraph> --node
https://subgraph-api.0xgraph.xyz/deploy
--ipfs https://subgraph-api.0xgraph.xyz/ipfs
--deploy-key <api_key>
```

<Info>
  If prompted to enter the version, use the version of The Graph CLI that you
  downloaded.
</Info>

You can now monitor your Subgraph deployment in the 0xGraph app

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-analytics.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d960220bef3f259a3a0d82df8614e357" alt="Subgraph analytics page" data-og-width="2296" width="2296" data-og-height="1862" height="1862" data-path="images/mantle/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-analytics.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=29ee73cdf5c58e7ae3b60034784186d0 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-analytics.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=e7a6dc636786de6befc4ffb487e67ae0 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-analytics.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=b89f30a607217575bddba541ba02b2ed 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d5d9489cf738842f770ced8026015764 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=be692a4a5070ed8ce80bfb17aa45b91e 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=5002e516579c68852cbf89e6df1a537d 2500w" />
</Frame>

## Quick Start in the App

The [0xGraph Web App](https://subgraph.mantle.xyz) also offers a concise guide to assist users in deploying their Subgraphs effectively

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-quickstart.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=6644cffdde4aa1349809c76275e1a6c0" alt="Subgraph analytics page" data-og-width="3488" width="3488" data-og-height="1850" height="1850" data-path="images/mantle/0xgraph-quickstart.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-quickstart.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=c30b8c4623212b0223bd56ba0240c605 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-quickstart.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=c9fe160c8b71e5b13977fd2f9ab8e41f 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-quickstart.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=a1277a6031face7d25ae5ca41864b11b 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-quickstart.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=3f743de5666138de7cfb91558ac1fb17 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-quickstart.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=2774c534b950ae1f8717c6e5b133d788 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-quickstart.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=6e0c99473cf0869fe75dc45627bf9d1a 2500w" />
</Frame>


# Account Creation
Source: https://docs.ormilabs.com/dedicated-env/mantle/subgraphs/getting-started/account-creation

How to create your 0xGraph account

## Setup Steps

### 1. Create Account

Visit [subgraph.mantle.xyz](https://subgraph.mantle.xyz) to create your account.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-signup.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=a18f4ce468186c0103d3e569eb7d6bdc" alt="0xGraph App Registration" data-og-width="1536" width="1536" data-og-height="966" height="966" data-path="images/mantle/0xgraph-signup.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-signup.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=e9e5dd9123fd7b3fdc295a20d9a414a2 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-signup.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=7355733b84adb0064b0e384a0314666c 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-signup.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=5279b07440a2eb2599cd3efbd6ab52a3 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-signup.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=ddddd4bc67893e46d22b6529235a8426 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-signup.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d3d6e6575d1b336466322313b54eb19d 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-signup.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=52cb9fac54e3ff4d2ed2a0d5da324046 2500w" />
</Frame>

### 2. Choose Subscription Plan

Choose a plan that best fits your needs in [Settings page](https://subgraph.mantle.xyz/dashboard/settings).

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-pricing.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=7d854d5cdc99064ba5832094f2aae03e" alt="0xGraph Subscription Plans" data-og-width="1420" width="1420" data-og-height="634" height="634" data-path="images/mantle/0xgraph-pricing.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-pricing.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=50f54d43cdd37654efeff06566f8b869 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-pricing.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=f00e695d1057982bf0aaf7d94d08c438 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-pricing.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=879de96e77829349f77a7e336700cab7 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-pricing.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=b71b72eae3fbdbfd44b681f5663df5ce 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-pricing.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=95f93f6e1a112ed240709f749ec42af9 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-pricing.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=244909f6b85290ab22ffcd76fad42463 2500w" />

  <figcaption>Choose a subscription plan</figcaption>
</Frame>

### 3. Generate API Key

Go to the [API Keys Page](https://subgraph.mantle.xyz/dashboard/api) to create your API key.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-api-key.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=a5b5cd10813b9b0673f0ff20b43485b0" alt="0xGraph API Keys" data-og-width="1536" width="1536" data-og-height="699" height="699" data-path="images/mantle/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-api-key.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=064846b27a8ce24d900c83a0f0f83ec6 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-api-key.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=2d7050766a81a699eca7700e8c60b8ef 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-api-key.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=8362a5fd96fb55ec0958dc4e4bf73cb2 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=f52b7a774ddd3e11a5400c95f3aa1564 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=cd1b36c4e79cdf899e3c9f58ec1e0551 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=beefc436468c47347d1b2a419df279db 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

After clicking the 'Create API Key' button in the top-right corner, your API key will be generated. You can then copy and paste it into your commands as needed.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-generated-api-key.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=6eb828f527e57a057e222bfca8a07ea5" alt="0xGraph API Keys" data-og-width="3454" width="3454" data-og-height="1836" height="1836" data-path="images/mantle/0xgraph-generated-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-generated-api-key.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=cfd6fea0d68cf121ac69544a8a06ed49 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-generated-api-key.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=c59c74bac257818ffd86d3061f85da68 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-generated-api-key.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=5e7406a4622c5656351cc4ae3d676b78 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-generated-api-key.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=0d55ff776854dda2347c6e3c8f456d67 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-generated-api-key.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=f999b355d0553cf62a17921b7e03a651 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-generated-api-key.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=a2785acdd03165441b104622cae94e3a 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

<Info>
  Warning: Always handle your API keys securely. Do not expose them in
  client-side code or share them publicly. Store them in a secure location, such
  as environment variables, and rotate them regularly to minimize security
  risks. If compromised, regenerate your API key immediately. For public
  repositories, store API keys in a .env file and add .env to .gitignore to
  prevent accidental exposure in your codebase.
</Info>

You are all set and ready to go for deploying a subgraph.


# CLI Usage
Source: https://docs.ormilabs.com/dedicated-env/mantle/subgraphs/getting-started/cli-usage

A detailed list of all active and relevant commands for The Graph CLI, including their purposes, use cases, and examples.

## `graph init`

**Purpose:**\
Creates a new Subgraph project using an example template or an existing smart contract.

**Use Case:**

* Use this command when starting a new Subgraph project.
* It sets up the necessary folder structure, configuration files `subgraph.yaml`, and example code.
* You can specify a contract address and network to scaffold a Subgraph tailored to a specific smart contract.

**Example:**

```bash  theme={null}
graph init --from-contract <CONTRACT_ADDRESS> --network mainnet
```

## `graph codegen`

**Purpose:**\
Generates AssemblyScript types for smart contract ABIs and the Subgraph schema.

**Use Case:**

* Use this command after making changes to your `schema.graphql` file or when adding/updating smart contract ABIs.
* It creates type-safe classes that make it easier to interact with blockchain data in your mappings.

## `graph build`

**Purpose:**\
Compiles the Subgraph to WebAssembly (WASM), preparing it for deployment.

**Use Case:**

* Run this command after completing your mappings and configuration.
* It ensures your Subgraph is ready for deployment by converting it into the WASM format required by 0xGraph.

## `graph deploy`

**Purpose:**\
Deploys the compiled Subgraph to the 0xGraph hosting service.

**Use Case:**

* After building your Subgraph, use this command to upload and activate it on 0xGraph.
* Specify the deployment target (e.g., staging or production) and the Subgraph name.

**Example:**

```bash  theme={null}
graph deploy <your_subgraph> --node
https://subgraph-api.0xgraph.xyz/deploy
--ipfs https://subgraph-api.0xgraph.xyz/ipfs
--deploy-key <your_api_key>
```

## `graph local`

**Purpose:**\
Runs a local test environment (e.g., using Ganache or Hardhat) to test the Subgraph with simulated blockchain data.

**Use Case:**

* Use this command when developing and testing your Subgraph locally.
* It allows you to simulate blockchain events and validate mappings.
* Ideal for testing without deploying to a live environment.

## `graph test`

**Purpose:**\
Downloads and runs the Matchstick Rust binary to execute unit tests for a Subgraph.

**Use Case:**

* Use this command to write and run unit tests for your mappings and ensure that your Subgraph logic works correctly.
* Matchstick is a testing framework built specifically for The Graph.

## `graph add`

**Purpose:**\
Adds a new data source to your Subgraph’s manifest file (subgraph.yaml) and updates relevant files such as schema.graphql, ABIs, and mappings.

**Use Case:**

* Use this command when adding additional smart contracts or data sources to your Subgraph.
* It automates the process of updating your Subgraph configuration and related files.

**Example:**

```bash  theme={null}
graph add <CONTRACT_NAME> --from-contract <CONTRACT_ADDRESS>
```

<Info>
  Ensure you have the latest version of The Graph CLI installed to avoid
  potential issues with deprecated or updated commands.
</Info>


# Deploy a Subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/mantle/subgraphs/getting-started/deploy-subgraph-graph-cli

Quick start guide for deploying a Subgraph using the Command Line Interface (CLI).

<Info>
  The Graph CLI is an essential tool enabling developers to seamlessly create,
  deploy, and manage subgraphs—providing streamlined blockchain data querying
  and indexing. It gives you superuser access to our enterprise-grade subgraph
  infrastructure. Additionally, we are fully compatible with The Graph's
  tooling, and the CLI works seamlessly out of the box with our platform.
</Info>

## Deployment Network Definitions

For developers who are already familiar with Graph Protocol tooling, below are the network definitions to deploy subgraphs on 0xGraph. These settings can be configured in the subgraph.yaml file:

## Installation

<Steps>
  <Step title="Install CLI Package">
    <CodeGroup>`npm i @graphprotocol/graph-cli `</CodeGroup>
  </Step>
</Steps>

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="_blank">
  Install the graph npm package
</Card>

## Generate API Key

Create an API key: Visit [0xGraph Dashboard](https://subgraph.mantle.xyz/dashboard/api) to generate your API key. For a comprehensive tutorial on generating API keys, visit the [Account Creation Page](/dedicated-env/mantle/subgraphs/getting-started/account-creation).

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

***

## Create your own Subgraph

Details regarding creating your own Subgraph is beyond the scope of this documentation. The Graph's official documentation provides detailed guides and examples for each step of the Subgraph creation process. It also covers advanced topics such as indexing strategies, filtering, and pagination. We recommend referring to their documentation for a comprehensive reference on Subgraph development with The Graph.

## Core Components

A typical Subgraph project has the following components:

<CardGroup cols={2}>
  <Card title="Manifest File" icon="file-lines">
    The `subgraph.yaml` manifest file serves as the root configuration, containing smart contract references, entity mappings, handler functions, and deployment parameters like `startBlock` and `description`.
  </Card>

  {' '}

  <Card title="Schema File" icon="database">
    The `schema.graphql` file defines all the entities and their relationships for
    your Subgraph's GraphQL API, determining what blockchain data will be indexed
    and made queryable.
  </Card>

  <Card title="Mappings File" icon="code">
    Written in [AssemblyScript](https://www.assemblyscript.org/), a TypeScript-like language specifically designed for WebAssembly, the mappings file transforms raw blockchain data into structured entities that match your GraphQL schema through a set of data handling functions.
  </Card>
</CardGroup>

<Note>
  Messari maintains a [well-curated GitHub
  repository](https://github.com/messari/subgraphs) that offers a comprehensive
  collection of example Subgraphs, which serves as a valuable resource for those
  seeking to start their subgraph development journey.
</Note>

***

## Subgraph Compilation

<Steps>
  <Step title="Generate Types and Mappings">
    <Note>
      The codegen step generates code files for indexing and querying data based on your schema and mappings.
    </Note>

    Run in your project root:

    ```bash  theme={null}
    graph codegen
    ```

    Success output:

    ```bash  theme={null}
        Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
        Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
        Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
        Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
        Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
        Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
        Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
      ✔ Apply migrations
      ✔ Load subgraph from subgraph.yaml
        Load contract ABI from abis/factory.json
        Load contract ABI from abis/ERC20.json
        Load contract ABI from abis/ERC20SymbolBytes.json
        Load contract ABI from abis/ERC20NameBytes.json
      ✔ Load contract ABIs
        Generate types for contract ABI: Factory (abis/factory.json)
        Generate types for contract ABI: ERC20 (abis/ERC20.json)
        Generate types for contract ABI: ERC20SymbolBytes (abis/ERC20SymbolBytes.json)
        Generate types for contract ABI: ERC20NameBytes (abis/ERC20NameBytes.json)
        Write types to generated/Factory/Factory.ts
        Write types to generated/Factory/ERC20.ts
        Write types to generated/Factory/ERC20SymbolBytes.ts
        Write types to generated/Factory/ERC20NameBytes.ts
      ✔ Generate types for contract ABIs
        Generate types for data source template Pair
        Write types for templates to generated/templates.ts
      ✔ Generate types for data source templates
        Load data source template ABI from abis/pair.json
        Load data source template ABI from abis/factory.json
      ✔ Load data source template ABIs
        Generate types for data source template ABI: Pair > Pair (abis/pair.json)
        Generate types for data source template ABI: Pair > Factory (abis/factory.json)
        Write types to generated/templates/Pair/Pair.ts
        Write types to generated/templates/Pair/Factory.ts
      ✔ Generate types for data source template ABIs
      ✔ Load GraphQL schema from schema.graphql
        Write types to generated/schema.ts
      ✔ Generate types for GraphQL schema

      Types generated successfully
    ```

    <Accordion title="Codegen Options">
      <Info>
        View all options with `graph codegen --help`:
      </Info>

      ```bash  theme={null}
      USAGE
        $ graph codegen [SUBGRAPH-MANIFEST] [-h] [-o <value>] [--skip-migrations] [-w] [--uncrashable-config <value> -u]

      FLAGS
        -h, --help                    Show CLI help.
        -o, --output-dir=<value>      [default: generated/] Output directory for generated types.
        -u, --uncrashable             Generate Float S
                                      subgraph Uncrashable helper file.
        -w, --watch                   Regenerate types when subgraph files change.
        --skip-migrations             Skip subgraph migrations.
        --uncrashable-config=<value>  Directory for uncrashable config.
      ```
    </Accordion>
  </Step>

  <Step title="Build Your Subgraph">
    After generating types, build your subgraph:

    ```bash  theme={null}
    graph build
    ```

    Success Output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/

    Build completed: build/subgraph.yaml
    ```

    <Accordion title="Build Options">
      <Info>
        View all options with `graph build --help`:
      </Info>

      ```bash  theme={null}
      Builds a subgraph and (optionally) uploads it to IPFS.

        USAGE
          $ graph build [SUBGRAPH-MANIFEST] [-h] [-i <value>] [-o <value>] [-t wasm|wast]
            [--skip-migrations] [-w] [--network <value>] [--network-file <value>]

        FLAGS
          -h, --help                    Show CLI help.
          -i, --ipfs=<value>            Upload build results to an IPFS node.
          -o, --output-dir=<value>      [default: build/] Output directory for build results.
          -t, --output-format=<option>  [default: wasm] Output format for mappings.
                                        <options: wasm|wast>
          -w, --watch                   Regenerate types when subgraph files change.
          --network=<value>             Network configuration to use from the networks config file.
          --network-file=<value>        [default: networks.json] Networks config file path.
          --skip-migrations             Skip subgraph migrations.

      DESCRIPTION
      Builds a subgraph and (optionally) uploads it to IPFS.

      ```
    </Accordion>
  </Step>

  <Step title="Deploy your Subgraph">
    Then deploy your Subgraph:

    ```bash  theme={null}
    graph deploy <your_subgraph> --node
    https://subgraph-api.0xgraph.xyz/deploy
    --ipfs https://subgraph-api.0xgraph.xyz/ipfs
    --deploy-key <your_API_key>
    ```

    Success output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/
      Add file to IPFS build/schema.graphql
                    .. Qmckrwbgbx3FjsVH4AU8xP3zgdg3rPnzNo7pmApAmhQkA4
      Add file to IPFS build/Factory/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9
      Add file to IPFS build/Factory/ERC20.json
                    .. QmPfKNZPkVATzL3EHypkcsyKhehR4jkiYEVqSzh2hxWYj1
      Add file to IPFS build/Factory/ERC20SymbolBytes.json
                    .. QmbHnhUFZa6qqqRyubUYhXntox1TCBxqryaBM1iNGqVJzT
      Add file to IPFS build/Factory/ERC20NameBytes.json
                    .. QmQCP6Pdp1MqpwRv2qoPHuUTwZGy7Q3eDHg4w5kzwE9mBj
      Add file to IPFS build/Factory/Factory.wasm
                    .. QmNksN9HGSyMfc4XrjQeHuDKsBQk1xHEKVE2dLwHQQu4kb
      Add file to IPFS build/Pair/pair.json
                    .. QmbPLMADBP8L6LBVP3ZBQ8RgG7ghamD8DvbdUxHAjZrLgm
      Add file to IPFS build/Pair/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9 (already uploaded)
      Add file to IPFS build/templates/Pair/Pair.wasm
                    .. QmSZSUoNinhNshD26iwKyzut6s3w5Lmec3P9szBovfQg8V
    ✔ Upload subgraph to IPFS

    Build completed: QmdXJQUxgrzP8pVotTqiwirJ6NxfmdNdQ6rWQv2rmJpBQp

    Deployed to /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn

    Subgraph endpoints:
    Queries (HTTP):     /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn
    ```
  </Step>
</Steps>

<Card title="View Your Subgraphs" icon="browser">
  Access your deployed Subgraphs through the web-based UI at [subgraph.mantle.xyz](http://subgraph.mantle.xyz)
</Card>

```
```


# Deploy a token transfer subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/mantle/subgraphs/getting-started/deploy-token-transfer-subgraph

Tutorial on how to deploy an erc20 token transfer subgraph with the Graph CLI



# Monitor Your Subgraph
Source: https://docs.ormilabs.com/dedicated-env/mantle/subgraphs/getting-started/monitor-subgraph

Learn how to monitor your subgraph syncing progress and logs after deployment

# Monitor your subgraph via the Analytics Page

After deploying your subgraph, you can easily monitor the syncing progress and subgraph logs for up to 48 hours to gain insight and troubleshoot any issues that may come with your subgraph.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-monitor.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=f176ac9d4f52413c532ee134b0fb88e1" alt="Subgraph deployment view" data-og-width="1536" width="1536" data-og-height="456" height="456" data-path="images/mantle/0xgraph-monitor.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-monitor.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=0e9e454b4d189a9fba617f3e3a13fc07 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-monitor.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=4a4b11232c65ea5d6802704170cd6044 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-monitor.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=4f9335b62c4b134229e2116f50203628 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-monitor.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=7c7c3db2ce382d8a6feb847ecf298e79 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-monitor.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=e3723adb8dee874d49f0f20b178a176f 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-monitor.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=6bea16f4a26159991ee722b8324cfe7c 2500w" />
</Frame>

You can access your deployed subgraph analytics page by clicking on the subgraph name; afterward, you will be directed to the following analytics page.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-analytics.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d960220bef3f259a3a0d82df8614e357" alt="Subgraph analytics page" data-og-width="2296" width="2296" data-og-height="1862" height="1862" data-path="images/mantle/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-analytics.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=29ee73cdf5c58e7ae3b60034784186d0 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-analytics.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=e7a6dc636786de6befc4ffb487e67ae0 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-analytics.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=b89f30a607217575bddba541ba02b2ed 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d5d9489cf738842f770ced8026015764 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=be692a4a5070ed8ce80bfb17aa45b91e 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=5002e516579c68852cbf89e6df1a537d 2500w" />
</Frame>


# Perform Query
Source: https://docs.ormilabs.com/dedicated-env/mantle/subgraphs/getting-started/perform-query

Short description on what this section is about

After deploying your subgraph, you can easily access and query it via GraphQL playground for query. You can open the "GraphQL API" link in your dashboard to access your data.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-graphql-api.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=56cfef4130564e3d42d30c7609e3c99d" alt="API Keys" data-og-width="3448" width="3448" data-og-height="1850" height="1850" data-path="images/mantle/0xgraph-graphql-api.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-graphql-api.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=3f8d81b4cd69cc5d9de2e7eb21f3fee8 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-graphql-api.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=3987997d15b2336fc63d70f58ff49c20 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-graphql-api.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=dd0aa5515d372c428aa2ad64d1f336c9 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-graphql-api.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=00d281f2ab0aeb124d496ede3b0dae23 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-graphql-api.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=58f0e1e5c12e7e9889951a0481f0e13c 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-graphql-api.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=387d580f256e9d4a4b38df0592df50d8 2500w" />
</Frame>

For example, you may access the publicly available Mantle token approval subgraph at `https://subgraph-api.mantle.xyz/subgraphs/name/gamma-cleopatra-mantle/graphql`

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-graphql.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=4b3b2ba71b37f1fa46ee098525155de1" alt="GraphQL" data-og-width="1847" width="1847" data-og-height="867" height="867" data-path="images/mantle/0xgraph-graphql.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-graphql.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=a1ed8a5458941b7bfb297d192f542c3d 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-graphql.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=64a5efef5435bfa06d1f776dcf0156bd 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-graphql.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=81a7f545ddb2fbe03b185994f467dfbd 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-graphql.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=e20f29699f6b0c420c6f169f7706e147 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-graphql.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=3bb80f3e55fb05ffd5c473c3a0b460f1 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/mantle/0xgraph-graphql.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=a3c074ce05449b16c92e7d3e39c25568 2500w" />
</Frame>

***

## Query for Subgraph Sync Status

To get to know the sync status directly inside the subgraph, a user may run the following query by using `_meta`:

```graphql  theme={null}
{
  _meta {
    block {
      hash
      timestamp
      number
    }
  }
}
```

The result would be similar to the following:

```json  theme={null}
{
  "data": {
    "_meta": {
      "block": {
        "hash": "0x9f2480d4a21fb9743ae35d349fccbc86c0fad084d6a87b53d1f649f1051c6ddb",
        "timestamp": 1700267031,
        "number": 151479342
      }
    }
  }
}
```

***

## Query a Subgraph

Subgraphs expose blockchain data via a GraphQL API, making it easy for anyone familiar with the GraphQL language to get started.

A GraphQL API differs from traditional REST APIs in that it relies on a schema definition to outline the available queries, mutations, and data types that clients can access.

## Benefits of Schema-Driven Approach

This schema-driven approach enables clients to precisely specify the data they need, eliminating the need to over-fetch data. Here's why this is beneficial:

<CardGroup>
  <Card title="Precision" icon="bullseye">
    GraphQL clients can tailor their queries to retrieve only the data they require, enhancing efficiency.
  </Card>

  <Card title="Flexibility" icon="arrows-to-circle">
    Clients can request related data in a single query, reducing the number of API calls needed.
  </Card>

  <Card title="Predictability" icon="chart-line">
    The schema provides clear documentation for available data and operations.
  </Card>
</CardGroup>

## GraphQL Syntax

GraphQL queries are composed using a specific syntax that allows for hierarchical data retrieval. Clients specify the fields they want to retrieve and their relationships within a single query. This approach minimizes unnecessary data retrieval, resulting in more concise and efficient requests.

## Best Practices

When working with the 0xGraph service, it's essential to follow best practices to ensure optimal performance and efficiency. These best practices are outlined in official Graph Protocol documentation.

<Info>
  For detailed instructions on querying 0xGraph using GraphQL and to ensure adherence to best practices, refer to the [official
  documentation](https://thegraph.com/docs/en/querying/querying-best-practices/) provided by the Ormi Labs and Graph Protocol teams. These resources offer
  valuable insights and recommendations to streamline your interaction with blockchain data through GraphQL.
</Info>


# Private Graphql URL
Source: https://docs.ormilabs.com/dedicated-env/mantle/subgraphs/getting-started/private-url

Learn how to create a private GraphQL URL for your subgraph

## Private Graphql URL

When you deploy a new subgraph, a public GraphQL endpoint is provided by default. However, you can also create a private endpoint for your subgraph, which requires an authentication token for requests. This private endpoint ensures that only authorized users or applications can access your subgraph's data, maintaining data security and control.

## Enable Private GraphQL Link

To use the private endpoint, you first need to enable it in your subgraph's detail on the 0xGraph console.

1. Navigate to your project details page.
2. Find the "PRIVATE GRAPHQL LINK" section.
3. Toggle the switch to "Enabled".

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=560e6af6112a63cffb865cbc60afd565" alt="Enable Private URL" width="700" data-og-width="1229" data-og-height="834" data-path="images/how-to/private.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=84eabc519189ef2a3b52f280ff7e2646 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a44106946348f0dcaf322b5b35e66c41 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6dcfd639d6e2d14fdacf34fc469e0afd 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e8470fabfb0845232d16b5434ada8136 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=93dc339e9fdfbd6dcc7ed4ad027c6baf 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=aee1e2143fe2327a40640aacd8e8b906 2500w" />

## Find Your Private URL

Once enabled, your unique private GraphQL URL will be displayed. You can also find this URL listed on the main page of your project environment under the "PRIVATE GRAPHQL LINK" column.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=45d17f6b83f1234c38290ece93132fab" alt="Private URL List" width="700" data-og-width="1881" data-og-height="880" data-path="images/how-to/private2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=170c03e25794a0fa9099ae07c2ce6f67 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a733750201ba10c93bb3d985c5b775de 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=c0b478fca2ec7586f8f12db7bf9434e6 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a0e72f5d6ff87f1768e3688ed1995abb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f478e814674d0454cf0d1eb46704f1c3 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f7fb3ddbec13791ab5948282de354b3e 2500w" />

## Authentication

To query your private GraphQL endpoint, you must include an authentication token in the request header.

1. Obtain your API key from the 0xGraph console API Keys.
2. In your GraphQL client (like GraphiQL or Postman), add an `Authorization` header.
3. Set the header value to `Bearer YOUR_API_KEY`, replacing `YOUR_API_KEY` with the actual key.

Here's how it looks in the GraphiQL interface provided by 0xGraph:

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b36c81515bf5633e8446b1a9bc18a852" alt="Private URL Token" width="700" data-og-width="1261" data-og-height="836" data-path="images/how-to/private3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=62296e918593924606edca6ea9bb0e52 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7b7d3af194a2243c9a63ddd31c209e5c 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=87e773a3ca3156ba9ab3700bb365713d 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a5d877ffa5cc966da46065fa94a2ed90 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e4f121ec83725881815c920ece44b3d1 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=67f6cb202406476251abef74a4f70e3f 2500w" />

By following these steps, you can securely interact with your subgraph using its private GraphQL endpoint.


# Subgraph Webhooks
Source: https://docs.ormilabs.com/dedicated-env/mantle/subgraphs/getting-started/webhook

Learn how to create and manage webhooks for your subgraphs to receive real-time updates.

## Subgraph Webhooks

Subgraph webhooks allow you to receive HTTP POST requests in real-time whenever an entity in your subgraph changes due to an `INSERT`, `UPDATE`, or `DELETE` operation. This is useful for triggering backend processes, sending notifications, or syncing data with external systems.

## How it Works

When a subgraph handler executes an operation like `entity.save()` (resulting in an `INSERT` or `UPDATE`) or an entity is removed (resulting in a `DELETE`), the change is recorded. A real-time watcher detects this update and sends a payload to your configured webhook URL. The payload will indicate the type of operation: `INSERT`, `UPDATE`, or `DELETE`.

## Creating a Webhook

You can create a new webhook through the 0xGraph dashboard.

1. Navigate to the "Webhooks" section of your subgraph.

2. Click on the "New Webhook" button.

3. Fill in the required information in the "Create Webhook" modal:

   * **Name**: A descriptive name for your webhook (e.g., `webhook_demo`).
   * **URL**: The HTTP endpoint where the webhook payloads will be sent.
   * **Entity**: The specific entity you want to track (e.g., `approved`).
   * **Number of retries**: Configure the total number of retries. Defaults to 3, with a maximum of 10.
   * **Retry interval**: Configure the retry interval in seconds. Defaults to 60, with a maximum of 3600.
   * **Retry timeout**: Configure the retry timeout in seconds. Defaults to 30, with a maximum of 60.
   * **"secret" header value**: An optional secret string that will be sent in a designated webhook secret header. This allows your endpoint to verify that the request is authentic.

   <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9234eae31186a5b6f649ed942830ff6c" alt="Create Webhook Modal" data-og-width="1872" width="1872" data-og-height="879" height="879" data-path="images/how-to/webhook.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9f6074a41fc7104edd1f8a831dcf426b 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=70599e318f7d4dbb52bd9b9271f5fb9b 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=12c058b62fbe1aad60ae53b93b4edb0f 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d09122a7d15636238f837d4fb83fb9cb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d4299f143c74dac74aefe4d276549743 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9b8b5cfcba5dbd305b27b026d77ab5d4 2500w" />

4. Click "Create".

## Listing Webhooks

Once created, your webhook will appear in the list of webhooks for your subgraph. You can see its name, the entity it tracks, the target URL, and statistics about successful and failed deliveries.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=1a8a8610f0aa060edd6cec706e366d69" alt="Webhook List" data-og-width="1000" width="1000" data-og-height="818" height="818" data-path="images/how-to/webhook3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=fba9d6def6020d6c02eacc3c4670f763 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ee4af7ca24eeadf9bfab5bde38ab1811 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6e22347e0fe60c0d103c87000e981f06 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=59a7e24f1e30c3da890b3ea603216cc5 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ac5ba543c4c479ce7052f173ee858471 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6887464b8fb3a4b2866c91c8f90a8cb7 2500w" />

## Webhook Payload Structure

The webhook will send a JSON payload to your configured URL. The main payload object contains the following fields:

* `op` (string): The type of operation that triggered the webhook. Possible values are `"INSERT"`, `"UPDATE"`, or `"DELETE"`.
* `data_source` (string): Identifier for the subgraph or indexer being tracked.
* `data` (object): Contains the actual entity data that changed. It has two sub-fields:
  * `old` (object | null): The state of the entity before the change. This will be `null` if the `op` is `"INSERT"`.
  * `new` (object | null): The state of the entity after the change. This will be `null` if the `op` is `"DELETE"`.
* `webhook_name` (string): The name you assigned to your webhook during creation.
* `webhook_id` (string): A unique identifier for the webhook configuration.
* `id` (string): A unique identifier for this specific event notification.
* `delivery_info` (object): Information about the delivery attempt for this webhook. It has two sub-fields:
  * `max_retries` (integer): The maximum number of retry attempts configured for this webhook.
  * `current_retry` (integer): The current retry attempt number for this specific event (0 for the initial attempt).
* `entity` (string): The name of the subgraph entity being tracked.

### Example Payloads:

**`INSERT` operation:**

```json  theme={null}
{
  "op": "INSERT",
  "data_source": "privateURL/v0.0.1",
  "data": {
    "new": {
      "id": "ERC20Approve-0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc-w\\u001c\\u001b\\u0002\\ufffd\\ufffd\\ufffd\\u07Ջ^\\ufffdcO\\ufffd\\ufffd(7C\\u001c\\u001b-\\ufffd\\u0016僞\\ufffdm\\ufffd\\ufffdI+y\\ufffd\\ufffd^\\u0015\\ufffd\\ufffdY\\ufffd",
      "vid": 7271978,
      "owner": "\\\\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc",
      "amount": 1.157920892373162e+77,
      "is_all": false,
      "spender": "\\\\xbde5839ec36db2ac492b79e9e3b75e15fa8a59ec",
      "updated_at": 1747127781,
      "block_range": "[20405156,)"
    },
    "old": null
  },
  "webhook_name": "webhook_demo",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "id": "5b623fd0-b539-400b-bbb3-060d95403a64",
  "delivery_info": {
    "max_retries": 3,
    "current_retry": 0
  },
  "entity": "approved"
}
```

**`UPDATE` operation :**

```json  theme={null}
{
  "data": {
    "new": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,20405060)"
    },
    "old": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,)"
    }
  },
  "data_source": "privateURL/v0.0.1",
  "delivery_info": {
    "current_retry": 0,
    "max_retries": 3
  },
  "entity": "approved",
  "id": "dd2b6013-22e1-4e8e-a665-be5276144a68",
  "op": "UPDATE",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "webhook_name": "webhook_demo"
}
```


# 0xGraph - Reliable Subgraph Indexing
Source: https://docs.ormilabs.com/dedicated-env/mantle/subgraphs/overview



Deploy subgraphs with 99.9%+ availability and fetch smart contract data at 3x the speed. 100% spec-compliant with every subgraph on The Graph's hosted and decentralized networks.

## Overview

Subgraphs are customizable, open-source solutions for indexing and accessing real-time blockchain data through GraphQL APIs.

0xGraph is a zero-hassle subgraph hosting solution that is 100% spec-compliant with every subgraph on The Graph Protocol’s hosted and decentralized networks, minus the lag and downtime.

* Plug and play deployment and subgraph migration from hosted services.
* Deploy subgraphs with the same tooling, UI, and similar CLI as The Graph.
* Query subgraphs without running any nodes or infrastructure.

### Supported Networks

0xGraph currently supports the following networks:

| Name           | Type    | Network Slug     |
| -------------- | ------- | ---------------- |
| Mantle         | Mainnet | `mantle`         |
| Mantle Testnet | Testnet | `mantle-testnet` |
| Mantle Speolia | Testnet | `mantle-speolia` |

### Available Upon Request

Any other network you need? Please email us: [hello@ormilabs.com](mailto:hello@ormilabs.com)


# Overview
Source: https://docs.ormilabs.com/dedicated-env/metis/data-apis/overview

Coming soon



# Create tag
Source: https://docs.ormilabs.com/dedicated-env/metis/subgraphs/api-reference/create-tag

POST /public_api/v1/0xgraph/create_tag



# Delete tag
Source: https://docs.ormilabs.com/dedicated-env/metis/subgraphs/api-reference/delete-tag

POST /public_api/v1/0xgraph/delete_tag



# Query tag
Source: https://docs.ormilabs.com/dedicated-env/metis/subgraphs/api-reference/query-tag

POST /public_api/v1/0xgraph/query_tag



# Remove subgraph
Source: https://docs.ormilabs.com/dedicated-env/metis/subgraphs/api-reference/remove-subgraph

POST /public_api/v1/0xgraph/remove_subgraph

<Note>
  ⚠️ CLI deletion is temporarily unsupported. Use the Ormi Dashboard UI to remove subgraphs.
</Note>


# Cheat Sheet
Source: https://docs.ormilabs.com/dedicated-env/metis/subgraphs/cheatsheet

Streamlined Guide: Deploying Subgraphs on 0xGraph with The Graph CLI

## Overview

This quick start guide outlines streamlined instructions for deploying Subgraphs using the Command Line Interface (CLI). Developers looking to swiftly incorporate Subgraph capabilities into their projects will find straightforward guidance and pro tips for getting set up fast.

<Info>
  This cheat sheet condenses essential commands, tips, and best practices into
  an indispensable reference for anyone deploying a Subgraph. Developers will
  find this streamlined guide invaluable for swiftly progressing through the
  deployment workflow and resolving frequent pain points. With key information
  consolidated in one place, engineers can deploy Subgraphs more efficiently and
  focus their efforts on building applications powered by real-time,
  customizable blockchain data indexes.
</Info>

## 1. Get started by installing The Graph CLI

Download The Graph CLI via npm

```bash  theme={null}
npm i @graphprotocol/graph-cli
```

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="https://www.npmjs.com/package/@graphprotocol/graph-cli">
  Install The Graph npm package
</Card>

## 2. Generate API key

Create an API key: Visit [0xGraph Dashboard](https://metis.0xgraph.xyz/dashboard/api) to generate your API key

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

## 3. Generate types and mappings for your Subgraph

Go to your Subgraph root directory where `subgraph.yaml` file is located

```bash  theme={null}
cd <your_subgraph_project>
```

Run the following command to generate AssemblyScript types for smart contract ABIs and the subgraph schema

```bash  theme={null}
graph codegen
```

## 4. Compile your Subgraph

Run the following command to compile your Subgraph into WASM (WebAssembly)

```bash  theme={null}
graph build
```

## 5. Deploy your Subgraph to 0xGraph

Paste the API key generated in step 2 and run the following command to deploy your Subgraph to 0xGraph

```bash  theme={null}
graph deploy <your_subgraph> --node
https://metisapi.0xgraph.xyz/deploy
--ipfs https://metisapi.0xgraph.xyz/ipfs
--deploy-key <api_key>
```

<Info>
  If prompted to enter the version, use the version of The Graph CLI that you
  downloaded.
</Info>

You can now monitor your Subgraph deployment in the 0xGraph app

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-analytics.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=87e16611c23df67f929dd7643132ce4c" alt="Subgraph analytics page" data-og-width="2284" width="2284" data-og-height="1852" height="1852" data-path="images/metis/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-analytics.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=5db1adbb653ec2ab7f204fb0638923d4 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-analytics.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=1e57aba77e43b102897cba85d6b04afb 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-analytics.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=83f6263f888907dd86531fc637cabd90 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=bda308ab6940e5ed0f4e83bbfe74ff91 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=1fc9f8f7ae42b030462b51d438455fb6 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=9d9ef140be536541db02aff4c3450077 2500w" />
</Frame>

## Quick Start in the App

The [0xGraph Web App](https://metis.0xgraph.xyz) also offers a concise guide to assist users in deploying their Subgraphs effectively

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-quickstart.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=00382d7a9e2b5a3ecb962ad0f99b9198" alt="Subgraph analytics page" data-og-width="3454" width="3454" data-og-height="1852" height="1852" data-path="images/metis/0xgraph-quickstart.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-quickstart.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=92dec7651062f8c8d88f8f1a4cf412dc 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-quickstart.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=81e97c2a05e66df425bd3ebec466330a 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-quickstart.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=02abc9028ee9974833733cefa2e9c2f4 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-quickstart.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=544dbaee35cee4377bd451eeec46f780 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-quickstart.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=234431d78f80b2ae64100bc4762cd16f 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-quickstart.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=a71b367511b31e8394052d54bc7c0b5b 2500w" />
</Frame>


# Account Creation
Source: https://docs.ormilabs.com/dedicated-env/metis/subgraphs/getting-started/account-creation

How to create your 0xGraph account

## Setup Steps

### 1. Create Account

Visit [metis.0xgraph.xyz](https://metis.0xgraph.xyz) to create your account.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-signup.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=6045eeb0eef73198b1c792bba88f3695" alt="Metis App Registration" data-og-width="3372" width="3372" data-og-height="1848" height="1848" data-path="images/metis/0xgraph-signup.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-signup.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=45a53e0ccb9cb455fb0f8943b44e3487 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-signup.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=c4413b72e843bf7148c64bf2be53bd68 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-signup.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=96de1ab7cab9be8d7db81de32d2d8c3d 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-signup.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=0eadf0df960833bdee0dd96785413065 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-signup.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=7ecea0b6ae4e6dd5a75a480196f80b89 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-signup.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=450d5c8d1496690614d48e7591fbf70a 2500w" />
</Frame>

### 2. Choose Subscription Plan

Choose a plan that best fits your needs in [Settings page](https://metis.0xgraph.xyz/dashboard/settings).

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-pricing.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=43288c08aef5d3287e6606908ea1e16d" alt="Metis Subscription Plans" data-og-width="1327" width="1327" data-og-height="607" height="607" data-path="images/metis/0xgraph-pricing.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-pricing.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=b3557d4b5f7887a0fa688c22748fa3c4 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-pricing.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=ed1a7e583248592eceb958b4b11481b1 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-pricing.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=36c68c969de4be89cc68e7c2cb52e394 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-pricing.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=41bc8fea43606876fde1f31a5e66f705 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-pricing.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d771459f95199bb38bc711715bc320b2 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-pricing.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=4a1dee73d51d21679b586a640cfe885c 2500w" />

  <figcaption>Choose a subscription plan</figcaption>
</Frame>

### 3. Generate API Key

Go to the [API Keys Page](https://metis.0xgraph.xyz/dashboard/api) to create your API key.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-api-key.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=8809e7255b1cd6941795b56ad02a01e7" alt="Metis API Keys" data-og-width="1536" width="1536" data-og-height="699" height="699" data-path="images/metis/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-api-key.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=8a56d41cba195979538c1175f319ba29 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-api-key.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=27d56069f5f7d61f4799791603de1778 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-api-key.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=2fd182c4a753c30d90463dac0765bc5b 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=3982fd7292236f0dc5a906fd90dd0547 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=7109ca3e3f2b0535275cbe89c0af771b 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=3027c3895f77519eba834da0b2bb22d3 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

After clicking the 'Create API Key' button in the top-right corner, your API key will be generated. You can then copy and paste it into your commands as needed.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-generated-api-key.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=a09d6978ec8ea8751c96ea18ffadcd9e" alt="Metis API Keys" data-og-width="3460" width="3460" data-og-height="1854" height="1854" data-path="images/metis/0xgraph-generated-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-generated-api-key.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=9850fd949d8e70ebca39ef581c117cfe 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-generated-api-key.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=661ccf851aa80d2a3087b143bd955b43 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-generated-api-key.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=6384862ff050b74f5b63fb5848548c93 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-generated-api-key.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=36ff94c2944a915bb8a30148b45e1927 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-generated-api-key.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=0e4c280bb9746c33bcbbff4a1c4fe129 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-generated-api-key.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=f4390f61e5b0b341be9d078805cb58db 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

<Info>
  Warning: Always handle your API keys securely. Do not expose them in
  client-side code or share them publicly. Store them in a secure location, such
  as environment variables, and rotate them regularly to minimize security
  risks. If compromised, regenerate your API key immediately. For public
  repositories, store API keys in a .env file and add .env to .gitignore to
  prevent accidental exposure in your codebase.
</Info>

You are all set and ready to go for deploying a subgraph.


# CLI Usage
Source: https://docs.ormilabs.com/dedicated-env/metis/subgraphs/getting-started/cli-usage

A detailed list of all active and relevant commands for The Graph CLI, including their purposes, use cases, and examples.

## `graph init`

**Purpose:**\
Creates a new Subgraph project using an example template or an existing smart contract.

**Use Case:**

* Use this command when starting a new Subgraph project.
* It sets up the necessary folder structure, configuration files `subgraph.yaml`, and example code.
* You can specify a contract address and network to scaffold a Subgraph tailored to a specific smart contract.

**Example:**

```bash  theme={null}
graph init --from-contract <CONTRACT_ADDRESS> --network mainnet
```

## `graph codegen`

**Purpose:**\
Generates AssemblyScript types for smart contract ABIs and the Subgraph schema.

**Use Case:**

* Use this command after making changes to your `schema.graphql` file or when adding/updating smart contract ABIs.
* It creates type-safe classes that make it easier to interact with blockchain data in your mappings.

## `graph build`

**Purpose:**\
Compiles the Subgraph to WebAssembly (WASM), preparing it for deployment.

**Use Case:**

* Run this command after completing your mappings and configuration.
* It ensures your Subgraph is ready for deployment by converting it into the WASM format required by 0xGraph.

## `graph deploy`

**Purpose:**\
Deploys the compiled Subgraph to the 0xGraph hosting service.

**Use Case:**

* After building your Subgraph, use this command to upload and activate it on 0xGraph.
* Specify the deployment target (e.g., staging or production) and the Subgraph name.

**Example:**

```bash  theme={null}
graph deploy <your_subgraph> --node
https://metisapi.0xgraph.xyz/deploy
--ipfs https://metisapi.0xgraph.xyz/ipfs
--deploy-key <your_api_key>
```

## `graph local`

**Purpose:**\
Runs a local test environment (e.g., using Ganache or Hardhat) to test the Subgraph with simulated blockchain data.

**Use Case:**

* Use this command when developing and testing your Subgraph locally.
* It allows you to simulate blockchain events and validate mappings.
* Ideal for testing without deploying to a live environment.

## `graph test`

**Purpose:**\
Downloads and runs the Matchstick Rust binary to execute unit tests for a Subgraph.

**Use Case:**

* Use this command to write and run unit tests for your mappings and ensure that your Subgraph logic works correctly.
* Matchstick is a testing framework built specifically for The Graph.

## `graph add`

**Purpose:**\
Adds a new data source to your Subgraph’s manifest file (subgraph.yaml) and updates relevant files such as schema.graphql, ABIs, and mappings.

**Use Case:**

* Use this command when adding additional smart contracts or data sources to your Subgraph.
* It automates the process of updating your Subgraph configuration and related files.

**Example:**

```bash  theme={null}
graph add <CONTRACT_NAME> --from-contract <CONTRACT_ADDRESS>
```

<Info>
  Ensure you have the latest version of The Graph CLI installed to avoid
  potential issues with deprecated or updated commands.
</Info>


# Deploy a Subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/metis/subgraphs/getting-started/deploy-subgraph-graph-cli

Quick start guide for deploying a Subgraph using the Command Line Interface (CLI).

<Info>
  The Graph CLI is an essential tool enabling developers to seamlessly create,
  deploy, and manage subgraphs—providing streamlined blockchain data querying
  and indexing. It gives you superuser access to our enterprise-grade subgraph
  infrastructure. Additionally, we are fully compatible with The Graph's
  tooling, and the CLI works seamlessly out of the box with our platform.
</Info>

## Deployment Network Definitions

For developers who are already familiar with Graph Protocol tooling, below are the network definitions to deploy subgraphs on 0xGraph. These settings can be configured in the subgraph.yaml file:

## Installation

<Steps>
  <Step title="Install CLI Package">
    <CodeGroup>`npm i @graphprotocol/graph-cli `</CodeGroup>
  </Step>
</Steps>

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="_blank">
  Install the graph npm package
</Card>

## Generate API Key

Create an API key: Visit [0xGraph Dashboard](https://metis.0xgraph.xyz/dashboard/api) to generate your API key. For a comprehensive tutorial on generating API keys, visit the [Account Creation Page](/dedicated-env/metis/subgraphs/getting-started/account-creation).

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

***

## Create your own Subgraph

Details regarding creating your own Subgraph is beyond the scope of this documentation. The Graph's official documentation provides detailed guides and examples for each step of the Subgraph creation process. It also covers advanced topics such as indexing strategies, filtering, and pagination. We recommend referring to their documentation for a comprehensive reference on Subgraph development with The Graph.

## Core Components

A typical Subgraph project has the following components:

<CardGroup cols={2}>
  <Card title="Manifest File" icon="file-lines">
    The `subgraph.yaml` manifest file serves as the root configuration, containing smart contract references, entity mappings, handler functions, and deployment parameters like `startBlock` and `description`.
  </Card>

  {' '}

  <Card title="Schema File" icon="database">
    The `schema.graphql` file defines all the entities and their relationships for
    your Subgraph's GraphQL API, determining what blockchain data will be indexed
    and made queryable.
  </Card>

  <Card title="Mappings File" icon="code">
    Written in [AssemblyScript](https://www.assemblyscript.org/), a TypeScript-like language specifically designed for WebAssembly, the mappings file transforms raw blockchain data into structured entities that match your GraphQL schema through a set of data handling functions.
  </Card>
</CardGroup>

<Note>
  Messari maintains a [well-curated GitHub
  repository](https://github.com/messari/subgraphs) that offers a comprehensive
  collection of example Subgraphs, which serves as a valuable resource for those
  seeking to start their subgraph development journey.
</Note>

***

## Subgraph Compilation

<Steps>
  <Step title="Generate Types and Mappings">
    <Note>
      The codegen step generates code files for indexing and querying data based on your schema and mappings.
    </Note>

    Run in your project root:

    ```bash  theme={null}
    graph codegen
    ```

    Success output:

    ```bash  theme={null}
        Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
        Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
        Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
        Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
        Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
        Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
        Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
      ✔ Apply migrations
      ✔ Load subgraph from subgraph.yaml
        Load contract ABI from abis/factory.json
        Load contract ABI from abis/ERC20.json
        Load contract ABI from abis/ERC20SymbolBytes.json
        Load contract ABI from abis/ERC20NameBytes.json
      ✔ Load contract ABIs
        Generate types for contract ABI: Factory (abis/factory.json)
        Generate types for contract ABI: ERC20 (abis/ERC20.json)
        Generate types for contract ABI: ERC20SymbolBytes (abis/ERC20SymbolBytes.json)
        Generate types for contract ABI: ERC20NameBytes (abis/ERC20NameBytes.json)
        Write types to generated/Factory/Factory.ts
        Write types to generated/Factory/ERC20.ts
        Write types to generated/Factory/ERC20SymbolBytes.ts
        Write types to generated/Factory/ERC20NameBytes.ts
      ✔ Generate types for contract ABIs
        Generate types for data source template Pair
        Write types for templates to generated/templates.ts
      ✔ Generate types for data source templates
        Load data source template ABI from abis/pair.json
        Load data source template ABI from abis/factory.json
      ✔ Load data source template ABIs
        Generate types for data source template ABI: Pair > Pair (abis/pair.json)
        Generate types for data source template ABI: Pair > Factory (abis/factory.json)
        Write types to generated/templates/Pair/Pair.ts
        Write types to generated/templates/Pair/Factory.ts
      ✔ Generate types for data source template ABIs
      ✔ Load GraphQL schema from schema.graphql
        Write types to generated/schema.ts
      ✔ Generate types for GraphQL schema

      Types generated successfully
    ```

    <Accordion title="Codegen Options">
      <Info>
        View all options with `graph codegen --help`:
      </Info>

      ```bash  theme={null}
      USAGE
        $ graph codegen [SUBGRAPH-MANIFEST] [-h] [-o <value>] [--skip-migrations] [-w] [--uncrashable-config <value> -u]

      FLAGS
        -h, --help                    Show CLI help.
        -o, --output-dir=<value>      [default: generated/] Output directory for generated types.
        -u, --uncrashable             Generate Float S
                                      subgraph Uncrashable helper file.
        -w, --watch                   Regenerate types when subgraph files change.
        --skip-migrations             Skip subgraph migrations.
        --uncrashable-config=<value>  Directory for uncrashable config.
      ```
    </Accordion>
  </Step>

  <Step title="Build Your Subgraph">
    After generating types, build your subgraph:

    ```bash  theme={null}
    graph build
    ```

    Success Output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/

    Build completed: build/subgraph.yaml
    ```

    <Accordion title="Build Options">
      <Info>
        View all options with `graph build --help`:
      </Info>

      ```bash  theme={null}
      Builds a subgraph and (optionally) uploads it to IPFS.

        USAGE
          $ graph build [SUBGRAPH-MANIFEST] [-h] [-i <value>] [-o <value>] [-t wasm|wast]
            [--skip-migrations] [-w] [--network <value>] [--network-file <value>]

        FLAGS
          -h, --help                    Show CLI help.
          -i, --ipfs=<value>            Upload build results to an IPFS node.
          -o, --output-dir=<value>      [default: build/] Output directory for build results.
          -t, --output-format=<option>  [default: wasm] Output format for mappings.
                                        <options: wasm|wast>
          -w, --watch                   Regenerate types when subgraph files change.
          --network=<value>             Network configuration to use from the networks config file.
          --network-file=<value>        [default: networks.json] Networks config file path.
          --skip-migrations             Skip subgraph migrations.

      DESCRIPTION
      Builds a subgraph and (optionally) uploads it to IPFS.

      ```
    </Accordion>
  </Step>

  <Step title="Deploy your Subgraph">
    Then deploy your Subgraph:

    ```bash  theme={null}
    graph deploy <your_subgraph> --node
    https://metisapi.0xgraph.xyz/deploy
    --ipfs https://metisapi.0xgraph.xyz/ipfs
    --deploy-key <your_API_key>
    ```

    Success output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/
      Add file to IPFS build/schema.graphql
                    .. Qmckrwbgbx3FjsVH4AU8xP3zgdg3rPnzNo7pmApAmhQkA4
      Add file to IPFS build/Factory/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9
      Add file to IPFS build/Factory/ERC20.json
                    .. QmPfKNZPkVATzL3EHypkcsyKhehR4jkiYEVqSzh2hxWYj1
      Add file to IPFS build/Factory/ERC20SymbolBytes.json
                    .. QmbHnhUFZa6qqqRyubUYhXntox1TCBxqryaBM1iNGqVJzT
      Add file to IPFS build/Factory/ERC20NameBytes.json
                    .. QmQCP6Pdp1MqpwRv2qoPHuUTwZGy7Q3eDHg4w5kzwE9mBj
      Add file to IPFS build/Factory/Factory.wasm
                    .. QmNksN9HGSyMfc4XrjQeHuDKsBQk1xHEKVE2dLwHQQu4kb
      Add file to IPFS build/Pair/pair.json
                    .. QmbPLMADBP8L6LBVP3ZBQ8RgG7ghamD8DvbdUxHAjZrLgm
      Add file to IPFS build/Pair/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9 (already uploaded)
      Add file to IPFS build/templates/Pair/Pair.wasm
                    .. QmSZSUoNinhNshD26iwKyzut6s3w5Lmec3P9szBovfQg8V
    ✔ Upload subgraph to IPFS

    Build completed: QmdXJQUxgrzP8pVotTqiwirJ6NxfmdNdQ6rWQv2rmJpBQp

    Deployed to /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn

    Subgraph endpoints:
    Queries (HTTP):     /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn
    ```
  </Step>
</Steps>

<Card title="View Your Subgraphs" icon="browser">
  Access your deployed Subgraphs through the web-based UI at [metis.0xgraph.xyz](http://metis.0xgraph.xyz)
</Card>

```
```


# Deploy a token transfer subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/metis/subgraphs/getting-started/deploy-token-transfer-subgraph

Tutorial on how to deploy an erc20 token transfer subgraph with the Graph CLI



# Monitor Your Subgraph
Source: https://docs.ormilabs.com/dedicated-env/metis/subgraphs/getting-started/monitor-subgraph

Learn how to monitor your subgraph syncing progress and logs after deployment

# Monitor your subgraph via the Analytics Page

After deploying your subgraph, you can easily monitor the syncing progress and subgraph logs for up to 48 hours to gain insight and troubleshoot any issues that may come with your subgraph.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-monitor.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=771dccd73e1f168b9cc31d257f5ffb46" alt="Subgraph deployment view" data-og-width="3458" width="3458" data-og-height="1850" height="1850" data-path="images/metis/0xgraph-monitor.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-monitor.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=066930e7f9fe6429261e0624f9cfd76d 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-monitor.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=0b8937e48b0c27a9ac9ca1a78519cb13 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-monitor.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=8dcb7e317964f338e8e959bd517d5306 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-monitor.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=d9aa3254952f702bade79b70ec6633ed 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-monitor.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=4996a9e1f50a614fd162461feaa8470e 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-monitor.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=7a16803d7b215efca7dadcac881f4b44 2500w" />
</Frame>

You can access your deployed subgraph analytics page by clicking on the subgraph name; afterward, you will be directed to the following analytics page.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-analytics.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=87e16611c23df67f929dd7643132ce4c" alt="Subgraph analytics page" data-og-width="2284" width="2284" data-og-height="1852" height="1852" data-path="images/metis/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-analytics.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=5db1adbb653ec2ab7f204fb0638923d4 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-analytics.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=1e57aba77e43b102897cba85d6b04afb 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-analytics.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=83f6263f888907dd86531fc637cabd90 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=bda308ab6940e5ed0f4e83bbfe74ff91 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=1fc9f8f7ae42b030462b51d438455fb6 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=9d9ef140be536541db02aff4c3450077 2500w" />
</Frame>


# Perform Query
Source: https://docs.ormilabs.com/dedicated-env/metis/subgraphs/getting-started/perform-query

Short description on what this section is about

After deploying your subgraph, you can easily access and query it via GraphQL playground for query. You can open the "GraphQL API" link in your dashboard to access your data.

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-graphql-api.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=e11045decc8e8acb3c488a1d6695bf99" alt="API Keys" data-og-width="1489" width="1489" data-og-height="504" height="504" data-path="images/metis/0xgraph-graphql-api.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-graphql-api.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=5e07035c3866a4a04252b75890a28525 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-graphql-api.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=98304a27fb6bb0bbec22846e01f151cd 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-graphql-api.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=0e85494c3ecea6909b239f1a571b793e 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-graphql-api.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=f6c80eed5b951340d769af9d7c752079 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-graphql-api.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=c2b51d2f4c22f3a0d645fe47578a7de0 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-graphql-api.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=3d0c124ac49507d465d39471d65f0725 2500w" />
</Frame>

For example, you may access the publicly available Mantle token approval subgraph at `https://metisapi.0xgraph.xyz/subgraphs/name/test_org/token-approval/graphql`

<Frame>
  <img src="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-graphql.png?fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=429c03b0dee8287191765a935b30d486" alt="GraphQL" data-og-width="1847" width="1847" data-og-height="867" height="867" data-path="images/metis/0xgraph-graphql.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-graphql.png?w=280&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=0adb638e9347421a499d5401c8c860dd 280w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-graphql.png?w=560&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=b4a7f4bcf5f4dbc1a629b89643c48c57 560w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-graphql.png?w=840&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=34f34d92d285476acc16c609db9cb699 840w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-graphql.png?w=1100&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=586f1520890c4b04bb6b17a8fa07b6a7 1100w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-graphql.png?w=1650&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=63e5babf147fab4531c0fad6eb81c428 1650w, https://mintcdn.com/ormilabs/j8jlYGf8fuhxRlxb/images/metis/0xgraph-graphql.png?w=2500&fit=max&auto=format&n=j8jlYGf8fuhxRlxb&q=85&s=65875912f7f63ba3f01519215512d01c 2500w" />
</Frame>

***

## Query for Subgraph Sync Status

To get to know the sync status directly inside the subgraph, a user may run the following query by using `_meta`:

```graphql  theme={null}
{
  _meta {
    block {
      hash
      timestamp
      number
    }
  }
}
```

The result would be similar to the following:

```json  theme={null}
{
  "data": {
    "_meta": {
      "block": {
        "hash": "0x9f2480d4a21fb9743ae35d349fccbc86c0fad084d6a87b53d1f649f1051c6ddb",
        "timestamp": 1700267031,
        "number": 151479342
      }
    }
  }
}
```

***

## Query a Subgraph

Subgraphs expose blockchain data via a GraphQL API, making it easy for anyone familiar with the GraphQL language to get started.

A GraphQL API differs from traditional REST APIs in that it relies on a schema definition to outline the available queries, mutations, and data types that clients can access.

## Benefits of Schema-Driven Approach

This schema-driven approach enables clients to precisely specify the data they need, eliminating the need to over-fetch data. Here's why this is beneficial:

<CardGroup>
  <Card title="Precision" icon="bullseye">
    GraphQL clients can tailor their queries to retrieve only the data they require, enhancing efficiency.
  </Card>

  <Card title="Flexibility" icon="arrows-to-circle">
    Clients can request related data in a single query, reducing the number of API calls needed.
  </Card>

  <Card title="Predictability" icon="chart-line">
    The schema provides clear documentation for available data and operations.
  </Card>
</CardGroup>

## GraphQL Syntax

GraphQL queries are composed using a specific syntax that allows for hierarchical data retrieval. Clients specify the fields they want to retrieve and their relationships within a single query. This approach minimizes unnecessary data retrieval, resulting in more concise and efficient requests.

## Best Practices

When working with the 0xGraph service, it's essential to follow best practices to ensure optimal performance and efficiency. These best practices are outlined in official Graph Protocol documentation.

<Info>
  For detailed instructions on querying 0xGraph using GraphQL and to ensure adherence to best practices, refer to the [official
  documentation](https://thegraph.com/docs/en/querying/querying-best-practices/) provided by the Ormi Labs and Graph Protocol teams. These resources offer
  valuable insights and recommendations to streamline your interaction with blockchain data through GraphQL.
</Info>


# Private Graphql URL
Source: https://docs.ormilabs.com/dedicated-env/metis/subgraphs/getting-started/private-url

Learn how to create a private GraphQL URL for your subgraph

## Private Graphql URL

When you deploy a new subgraph, a public GraphQL endpoint is provided by default. However, you can also create a private endpoint for your subgraph, which requires an authentication token for requests. This private endpoint ensures that only authorized users or applications can access your subgraph's data, maintaining data security and control.

## Enable Private GraphQL Link

To use the private endpoint, you first need to enable it in your subgraph's detail on the 0xGraph console.

1. Navigate to your project details page.
2. Find the "PRIVATE GRAPHQL LINK" section.
3. Toggle the switch to "Enabled".

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=560e6af6112a63cffb865cbc60afd565" alt="Enable Private URL" width="700" data-og-width="1229" data-og-height="834" data-path="images/how-to/private.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=84eabc519189ef2a3b52f280ff7e2646 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a44106946348f0dcaf322b5b35e66c41 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6dcfd639d6e2d14fdacf34fc469e0afd 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e8470fabfb0845232d16b5434ada8136 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=93dc339e9fdfbd6dcc7ed4ad027c6baf 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=aee1e2143fe2327a40640aacd8e8b906 2500w" />

## Find Your Private URL

Once enabled, your unique private GraphQL URL will be displayed. You can also find this URL listed on the main page of your project environment under the "PRIVATE GRAPHQL LINK" column.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=45d17f6b83f1234c38290ece93132fab" alt="Private URL List" width="700" data-og-width="1881" data-og-height="880" data-path="images/how-to/private2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=170c03e25794a0fa9099ae07c2ce6f67 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a733750201ba10c93bb3d985c5b775de 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=c0b478fca2ec7586f8f12db7bf9434e6 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a0e72f5d6ff87f1768e3688ed1995abb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f478e814674d0454cf0d1eb46704f1c3 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f7fb3ddbec13791ab5948282de354b3e 2500w" />

## Authentication

To query your private GraphQL endpoint, you must include an authentication token in the request header.

1. Obtain your API key from the 0xGraph console API Keys.
2. In your GraphQL client (like GraphiQL or Postman), add an `Authorization` header.
3. Set the header value to `Bearer YOUR_API_KEY`, replacing `YOUR_API_KEY` with the actual key.

Here's how it looks in the GraphiQL interface provided by 0xGraph:

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b36c81515bf5633e8446b1a9bc18a852" alt="Private URL Token" width="700" data-og-width="1261" data-og-height="836" data-path="images/how-to/private3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=62296e918593924606edca6ea9bb0e52 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7b7d3af194a2243c9a63ddd31c209e5c 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=87e773a3ca3156ba9ab3700bb365713d 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a5d877ffa5cc966da46065fa94a2ed90 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e4f121ec83725881815c920ece44b3d1 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=67f6cb202406476251abef74a4f70e3f 2500w" />

By following these steps, you can securely interact with your subgraph using its private GraphQL endpoint.


# Subgraph Webhooks
Source: https://docs.ormilabs.com/dedicated-env/metis/subgraphs/getting-started/webhook

Learn how to create and manage webhooks for your subgraphs to receive real-time updates.

## Subgraph Webhooks

Subgraph webhooks allow you to receive HTTP POST requests in real-time whenever an entity in your subgraph changes due to an `INSERT`, `UPDATE`, or `DELETE` operation. This is useful for triggering backend processes, sending notifications, or syncing data with external systems.

## How it Works

When a subgraph handler executes an operation like `entity.save()` (resulting in an `INSERT` or `UPDATE`) or an entity is removed (resulting in a `DELETE`), the change is recorded. A real-time watcher detects this update and sends a payload to your configured webhook URL. The payload will indicate the type of operation: `INSERT`, `UPDATE`, or `DELETE`.

## Creating a Webhook

You can create a new webhook through the 0xGraph dashboard.

1. Navigate to the "Webhooks" section of your subgraph.

2. Click on the "New Webhook" button.

3. Fill in the required information in the "Create Webhook" modal:

   * **Name**: A descriptive name for your webhook (e.g., `webhook_demo`).
   * **URL**: The HTTP endpoint where the webhook payloads will be sent.
   * **Entity**: The specific entity you want to track (e.g., `approved`).
   * **Number of retries**: Configure the total number of retries. Defaults to 3, with a maximum of 10.
   * **Retry interval**: Configure the retry interval in seconds. Defaults to 60, with a maximum of 3600.
   * **Retry timeout**: Configure the retry timeout in seconds. Defaults to 30, with a maximum of 60.
   * **"secret" header value**: An optional secret string that will be sent in a designated webhook secret header. This allows your endpoint to verify that the request is authentic.

   <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9234eae31186a5b6f649ed942830ff6c" alt="Create Webhook Modal" data-og-width="1872" width="1872" data-og-height="879" height="879" data-path="images/how-to/webhook.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9f6074a41fc7104edd1f8a831dcf426b 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=70599e318f7d4dbb52bd9b9271f5fb9b 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=12c058b62fbe1aad60ae53b93b4edb0f 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d09122a7d15636238f837d4fb83fb9cb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d4299f143c74dac74aefe4d276549743 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9b8b5cfcba5dbd305b27b026d77ab5d4 2500w" />

4. Click "Create".

## Listing Webhooks

Once created, your webhook will appear in the list of webhooks for your subgraph. You can see its name, the entity it tracks, the target URL, and statistics about successful and failed deliveries.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=1a8a8610f0aa060edd6cec706e366d69" alt="Webhook List" data-og-width="1000" width="1000" data-og-height="818" height="818" data-path="images/how-to/webhook3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=fba9d6def6020d6c02eacc3c4670f763 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ee4af7ca24eeadf9bfab5bde38ab1811 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6e22347e0fe60c0d103c87000e981f06 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=59a7e24f1e30c3da890b3ea603216cc5 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ac5ba543c4c479ce7052f173ee858471 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6887464b8fb3a4b2866c91c8f90a8cb7 2500w" />

## Webhook Payload Structure

The webhook will send a JSON payload to your configured URL. The main payload object contains the following fields:

* `op` (string): The type of operation that triggered the webhook. Possible values are `"INSERT"`, `"UPDATE"`, or `"DELETE"`.
* `data_source` (string): Identifier for the subgraph or indexer being tracked.
* `data` (object): Contains the actual entity data that changed. It has two sub-fields:
  * `old` (object | null): The state of the entity before the change. This will be `null` if the `op` is `"INSERT"`.
  * `new` (object | null): The state of the entity after the change. This will be `null` if the `op` is `"DELETE"`.
* `webhook_name` (string): The name you assigned to your webhook during creation.
* `webhook_id` (string): A unique identifier for the webhook configuration.
* `id` (string): A unique identifier for this specific event notification.
* `delivery_info` (object): Information about the delivery attempt for this webhook. It has two sub-fields:
  * `max_retries` (integer): The maximum number of retry attempts configured for this webhook.
  * `current_retry` (integer): The current retry attempt number for this specific event (0 for the initial attempt).
* `entity` (string): The name of the subgraph entity being tracked.

### Example Payloads:

**`INSERT` operation:**

```json  theme={null}
{
  "op": "INSERT",
  "data_source": "privateURL/v0.0.1",
  "data": {
    "new": {
      "id": "ERC20Approve-0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc-w\\u001c\\u001b\\u0002\\ufffd\\ufffd\\ufffd\\u07Ջ^\\ufffdcO\\ufffd\\ufffd(7C\\u001c\\u001b-\\ufffd\\u0016僞\\ufffdm\\ufffd\\ufffdI+y\\ufffd\\ufffd^\\u0015\\ufffd\\ufffdY\\ufffd",
      "vid": 7271978,
      "owner": "\\\\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc",
      "amount": 1.157920892373162e+77,
      "is_all": false,
      "spender": "\\\\xbde5839ec36db2ac492b79e9e3b75e15fa8a59ec",
      "updated_at": 1747127781,
      "block_range": "[20405156,)"
    },
    "old": null
  },
  "webhook_name": "webhook_demo",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "id": "5b623fd0-b539-400b-bbb3-060d95403a64",
  "delivery_info": {
    "max_retries": 3,
    "current_retry": 0
  },
  "entity": "approved"
}
```

**`UPDATE` operation :**

```json  theme={null}
{
  "data": {
    "new": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,20405060)"
    },
    "old": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,)"
    }
  },
  "data_source": "privateURL/v0.0.1",
  "delivery_info": {
    "current_retry": 0,
    "max_retries": 3
  },
  "entity": "approved",
  "id": "dd2b6013-22e1-4e8e-a665-be5276144a68",
  "op": "UPDATE",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "webhook_name": "webhook_demo"
}
```


# 0xGraph - Reliable Subgraph Indexing
Source: https://docs.ormilabs.com/dedicated-env/metis/subgraphs/overview



Deploy subgraphs with 99.9%+ availability and fetch smart contract data at 3x the speed. 100% spec-compliant with every subgraph on The Graph's hosted and decentralized networks.

## Overview

Subgraphs are customizable, open-source solutions for indexing and accessing real-time blockchain data through GraphQL APIs.

0xGraph is a zero-hassle subgraph hosting solution that is 100% spec-compliant with every subgraph on The Graph Protocol’s hosted and decentralized networks, minus the lag and downtime.

* Plug and play deployment and subgraph migration from hosted services.
* Deploy subgraphs with the same tooling, UI, and similar CLI as The Graph.
* Query subgraphs without running any nodes or infrastructure.

### Supported Networks

0xGraph currently supports the following networks:

| Name                 | Type    | Network Slug    |
| -------------------- | ------- | --------------- |
| Metis                | Mainnet | `metis`         |
| Metis Andromeda      | Mainnet | `andromeda`     |
| Metis Goerli Testnet | Testnet | `metis-goerli`  |
| Metis Sepolia        | Testnet | `metis-sepolia` |

### Available Upon Request

Any other network you need? Please email us: [hello@ormilabs.com](mailto:hello@ormilabs.com)


# Overview
Source: https://docs.ormilabs.com/dedicated-env/noks/data-apis/overview

Coming soon



# Create tag
Source: https://docs.ormilabs.com/dedicated-env/noks/subgraphs/api-reference/create-tag

POST /public_api/v1/0xgraph/create_tag



# Delete tag
Source: https://docs.ormilabs.com/dedicated-env/noks/subgraphs/api-reference/delete-tag

POST /public_api/v1/0xgraph/delete_tag



# Query tag
Source: https://docs.ormilabs.com/dedicated-env/noks/subgraphs/api-reference/query-tag

POST /public_api/v1/0xgraph/query_tag



# Remove subgraph
Source: https://docs.ormilabs.com/dedicated-env/noks/subgraphs/api-reference/remove-subgraph

POST /public_api/v1/0xgraph/remove_subgraph

<Note>
  ⚠️ CLI deletion is temporarily unsupported. Use the Ormi Dashboard UI to remove subgraphs.
</Note>


# Cheat Sheet
Source: https://docs.ormilabs.com/dedicated-env/noks/subgraphs/cheatsheet

Streamlined Guide: Deploying Subgraphs on 0xGraph with The Graph CLI

## Overview

This quick start guide outlines streamlined instructions for deploying Subgraphs using the Command Line Interface (CLI). Developers looking to swiftly incorporate Subgraph capabilities into their projects will find straightforward guidance and pro tips for getting set up fast.

<Info>
  This cheat sheet condenses essential commands, tips, and best practices into
  an indispensable reference for anyone deploying a Subgraph. Developers will
  find this streamlined guide invaluable for swiftly progressing through the
  deployment workflow and resolving frequent pain points. With key information
  consolidated in one place, engineers can deploy Subgraphs more efficiently and
  focus their efforts on building applications powered by real-time,
  customizable blockchain data indexes.
</Info>

## 1. Get started by installing The Graph CLI

Download The Graph CLI via npm

```bash  theme={null}
npm i @graphprotocol/graph-cli
```

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="https://www.npmjs.com/package/@graphprotocol/graph-cli">
  Install The Graph npm package
</Card>

## 2. Generate API key

Create an API key: Visit [0xGraph Dashboard](https://noks.0xgraph.xyz/dashboard/api) to generate your API key

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

## 3. Generate types and mappings for your Subgraph

Go to your Subgraph root directory where `subgraph.yaml` file is located

```bash  theme={null}
cd <your_subgraph_project>
```

Run the following command to generate AssemblyScript types for smart contract ABIs and the subgraph schema

```bash  theme={null}
graph codegen
```

## 4. Compile your Subgraph

Run the following command to compile your Subgraph into WASM (WebAssembly)

```bash  theme={null}
graph build
```

## 5. Deploy your Subgraph to 0xGraph

Paste the API key generated in step 2 and run the following command to deploy your Subgraph to 0xGraph

```bash  theme={null}
graph deploy <your_subgraph> --node
https://noksapi.0xgraph.xyz/deploy
--ipfs https://noksapi.0xgraph.xyz/ipfs
--deploy-key <api_key>
```

<Info>
  If prompted to enter the version, use the version of The Graph CLI that you
  downloaded.
</Info>

You can now monitor your Subgraph deployment in the 0xGraph app

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-analytics.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=7cb92668ea3a389010b0847871a81d26" alt="Subgraph analytics page" data-og-width="2154" width="2154" data-og-height="1762" height="1762" data-path="images/noks/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-analytics.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=0177332f0121aef1fe140fa3c10a9517 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-analytics.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=d21d78e71b4d6d3e95122a1cd9a65b81 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-analytics.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=2249f9a66e1593c5de68518fc8359c28 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=fdf7558867df1f15fcd44c5e80fdb0f7 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=abd0e34b1c5c23b80dc468a77b324aa2 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=013d6ad29a0963549cbf86d2fe647eac 2500w" />
</Frame>

## Quick Start in the App

The [0xGraph Web App](https://noks.0xgraph.xyz) also offers a concise guide to assist users in deploying their Subgraphs effectively

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-quickstart.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=86b79bafa6e95d084fcff28c5a77c24c" alt="Subgraph analytics page" data-og-width="3402" width="3402" data-og-height="1826" height="1826" data-path="images/noks/0xgraph-quickstart.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-quickstart.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=4eabc556762c6ce4cd7cfbdd883efa6a 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-quickstart.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=f7931ff8888cd83d6e440ccd2447979c 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-quickstart.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=8259e4bfd85a8b464bc2c350885958fb 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-quickstart.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=9987916acddf5905ed771c21f3f9a933 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-quickstart.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=088f7c6ee9be5600a798afecca62313a 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-quickstart.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=699802c4ab12c2d34fd0f76732695957 2500w" />
</Frame>


# Account Creation
Source: https://docs.ormilabs.com/dedicated-env/noks/subgraphs/getting-started/account-creation

How to create your 0xGraph account

## Setup Steps

### 1. Create Account

Visit [noks.0xgraph.xyz](https://noks.0xgraph.xyz) to create your account.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-signup.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=cb27096ba518297716e519dfd0b95f46" alt="Noks App Registration" data-og-width="3350" width="3350" data-og-height="1846" height="1846" data-path="images/noks/0xgraph-signup.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-signup.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=07ce9db709bca0526fb01b1311fc3770 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-signup.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=bfbeeca589d9dec71d257130fd714efa 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-signup.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=073944ef6413129499a0dae5f79e23d3 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-signup.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=8542c988c7ced82594c3b8ea5ab4c389 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-signup.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=c782502736170c06876cf9ec657afa83 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-signup.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=f4f798d058affa9cba9c145ea17d561f 2500w" />
</Frame>

### 2. Choose Subscription Plan

Choose a plan that best fits your needs in [Settings page](https://noks.0xgraph.xyz/dashboard/settings).

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-pricing.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=b4d065823d6897ae0f40175b8508cb91" alt="Noks Subscription Plans" data-og-width="3460" width="3460" data-og-height="1832" height="1832" data-path="images/noks/0xgraph-pricing.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-pricing.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=2ed40c995ea22a476bc5c8b7ee539d18 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-pricing.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=df61ebcd2d4890ac230500b8c9806e60 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-pricing.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=17631e21992c24b6acf74c29e5a3348b 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-pricing.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=1726ee574c22406de769369ea6555183 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-pricing.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=0e391fc90bc7c293e7af9b6492650a32 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-pricing.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=d3cf201c141199be828f330bf9144513 2500w" />

  <figcaption>Choose a subscription plan</figcaption>
</Frame>

### 3. Generate API Key

Go to the [API Keys Page](https://noks.0xgraph.xyz/dashboard/api) to create your API key.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-api-key.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=68a430db5546964ed01da4743e060a21" alt="Noks API Keys" data-og-width="3446" width="3446" data-og-height="1842" height="1842" data-path="images/noks/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-api-key.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=e6b72bf251551f2145e43723ee34c71a 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-api-key.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=02e2700998afb265e098ccd14e5bb75b 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-api-key.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=76b96d720bc86cd91d8f9f79543c04a8 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=87200c1f51ebedbb8ec253aea1003620 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=02002d16ddbde18e005c11cb77baabcb 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=b89e3b3103398445aa03dc69448a501b 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

After clicking the 'Create API Key' button in the top-right corner, your API key will be generated. You can then copy and paste it into your commands as needed.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-generated-api-key.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=0031b1100e41bd6deae4be471ab9c62f" alt="Noks API Keys" data-og-width="3464" width="3464" data-og-height="1846" height="1846" data-path="images/noks/0xgraph-generated-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-generated-api-key.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=b70dafcdf16623832714e42af483f952 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-generated-api-key.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=db902abf9242e7557ebbcd91b61cbffc 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-generated-api-key.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=89ba2cb951bacd9b5abbe78f8c404eb1 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-generated-api-key.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=4d210c4a4e92aa525b7fbcde21b967ef 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-generated-api-key.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=4fd4a1281ca6e0edf74988a8e3739f3c 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-generated-api-key.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=ea80b68a68a2528a4d748ab260a718ad 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

<Info>
  Warning: Always handle your API keys securely. Do not expose them in
  client-side code or share them publicly. Store them in a secure location, such
  as environment variables, and rotate them regularly to minimize security
  risks. If compromised, regenerate your API key immediately. For public
  repositories, store API keys in a .env file and add .env to .gitignore to
  prevent accidental exposure in your codebase.
</Info>

You are all set and ready to go for deploying a subgraph.


# CLI Usage
Source: https://docs.ormilabs.com/dedicated-env/noks/subgraphs/getting-started/cli-usage

A detailed list of all active and relevant commands for The Graph CLI, including their purposes, use cases, and examples.

## `graph init`

**Purpose:**\
Creates a new Subgraph project using an example template or an existing smart contract.

**Use Case:**

* Use this command when starting a new Subgraph project.
* It sets up the necessary folder structure, configuration files `subgraph.yaml`, and example code.
* You can specify a contract address and network to scaffold a Subgraph tailored to a specific smart contract.

**Example:**

```bash  theme={null}
graph init --from-contract <CONTRACT_ADDRESS> --network mainnet
```

## `graph codegen`

**Purpose:**\
Generates AssemblyScript types for smart contract ABIs and the Subgraph schema.

**Use Case:**

* Use this command after making changes to your `schema.graphql` file or when adding/updating smart contract ABIs.
* It creates type-safe classes that make it easier to interact with blockchain data in your mappings.

## `graph build`

**Purpose:**\
Compiles the Subgraph to WebAssembly (WASM), preparing it for deployment.

**Use Case:**

* Run this command after completing your mappings and configuration.
* It ensures your Subgraph is ready for deployment by converting it into the WASM format required by 0xGraph.

## `graph deploy`

**Purpose:**\
Deploys the compiled Subgraph to the 0xGraph hosting service.

**Use Case:**

* After building your Subgraph, use this command to upload and activate it on 0xGraph.
* Specify the deployment target (e.g., staging or production) and the Subgraph name.

**Example:**

```bash  theme={null}
graph deploy <your_subgraph> --node
https://noksapi.0xgraph.xyz/deploy
--ipfs https://noksapi.0xgraph.xyz/ipfs
--deploy-key <your_api_key>
```

## `graph local`

**Purpose:**\
Runs a local test environment (e.g., using Ganache or Hardhat) to test the Subgraph with simulated blockchain data.

**Use Case:**

* Use this command when developing and testing your Subgraph locally.
* It allows you to simulate blockchain events and validate mappings.
* Ideal for testing without deploying to a live environment.

## `graph test`

**Purpose:**\
Downloads and runs the Matchstick Rust binary to execute unit tests for a Subgraph.

**Use Case:**

* Use this command to write and run unit tests for your mappings and ensure that your Subgraph logic works correctly.
* Matchstick is a testing framework built specifically for The Graph.

## `graph add`

**Purpose:**\
Adds a new data source to your Subgraph’s manifest file (subgraph.yaml) and updates relevant files such as schema.graphql, ABIs, and mappings.

**Use Case:**

* Use this command when adding additional smart contracts or data sources to your Subgraph.
* It automates the process of updating your Subgraph configuration and related files.

**Example:**

```bash  theme={null}
graph add <CONTRACT_NAME> --from-contract <CONTRACT_ADDRESS>
```

<Info>
  Ensure you have the latest version of The Graph CLI installed to avoid
  potential issues with deprecated or updated commands.
</Info>


# Deploy a Subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/noks/subgraphs/getting-started/deploy-subgraph-graph-cli

Quick start guide for deploying a Subgraph using the Command Line Interface (CLI).

<Info>
  The Graph CLI is an essential tool enabling developers to seamlessly create,
  deploy, and manage subgraphs—providing streamlined blockchain data querying
  and indexing. It gives you superuser access to our enterprise-grade subgraph
  infrastructure. Additionally, we are fully compatible with The Graph's
  tooling, and the CLI works seamlessly out of the box with our platform.
</Info>

## Deployment Network Definitions

For developers who are already familiar with Graph Protocol tooling, below are the network definitions to deploy subgraphs on 0xGraph. These settings can be configured in the subgraph.yaml file:

## Installation

<Steps>
  <Step title="Install CLI Package">
    <CodeGroup>`npm i @graphprotocol/graph-cli `</CodeGroup>
  </Step>
</Steps>

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="_blank">
  Install the graph npm package
</Card>

## Generate API Key

Create an API key: Visit [0xGraph Dashboard](https://noks.0xgraph.xyz/dashboard/api) to generate your API key. For a comprehensive tutorial on generating API keys, visit the [Account Creation Page](/dedicated-env/noks/subgraphs/getting-started/account-creation).

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

***

## Create your own Subgraph

Details regarding creating your own Subgraph is beyond the scope of this documentation. The Graph's official documentation provides detailed guides and examples for each step of the Subgraph creation process. It also covers advanced topics such as indexing strategies, filtering, and pagination. We recommend referring to their documentation for a comprehensive reference on Subgraph development with The Graph.

## Core Components

A typical Subgraph project has the following components:

<CardGroup cols={2}>
  <Card title="Manifest File" icon="file-lines">
    The `subgraph.yaml` manifest file serves as the root configuration, containing smart contract references, entity mappings, handler functions, and deployment parameters like `startBlock` and `description`.
  </Card>

  {' '}

  <Card title="Schema File" icon="database">
    The `schema.graphql` file defines all the entities and their relationships for
    your Subgraph's GraphQL API, determining what blockchain data will be indexed
    and made queryable.
  </Card>

  <Card title="Mappings File" icon="code">
    Written in [AssemblyScript](https://www.assemblyscript.org/), a TypeScript-like language specifically designed for WebAssembly, the mappings file transforms raw blockchain data into structured entities that match your GraphQL schema through a set of data handling functions.
  </Card>
</CardGroup>

<Note>
  Messari maintains a [well-curated GitHub
  repository](https://github.com/messari/subgraphs) that offers a comprehensive
  collection of example Subgraphs, which serves as a valuable resource for those
  seeking to start their subgraph development journey.
</Note>

***

## Subgraph Compilation

<Steps>
  <Step title="Generate Types and Mappings">
    <Note>
      The codegen step generates code files for indexing and querying data based on your schema and mappings.
    </Note>

    Run in your project root:

    ```bash  theme={null}
    graph codegen
    ```

    Success output:

    ```bash  theme={null}
        Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
        Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
        Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
        Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
        Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
        Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
        Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
      ✔ Apply migrations
      ✔ Load subgraph from subgraph.yaml
        Load contract ABI from abis/factory.json
        Load contract ABI from abis/ERC20.json
        Load contract ABI from abis/ERC20SymbolBytes.json
        Load contract ABI from abis/ERC20NameBytes.json
      ✔ Load contract ABIs
        Generate types for contract ABI: Factory (abis/factory.json)
        Generate types for contract ABI: ERC20 (abis/ERC20.json)
        Generate types for contract ABI: ERC20SymbolBytes (abis/ERC20SymbolBytes.json)
        Generate types for contract ABI: ERC20NameBytes (abis/ERC20NameBytes.json)
        Write types to generated/Factory/Factory.ts
        Write types to generated/Factory/ERC20.ts
        Write types to generated/Factory/ERC20SymbolBytes.ts
        Write types to generated/Factory/ERC20NameBytes.ts
      ✔ Generate types for contract ABIs
        Generate types for data source template Pair
        Write types for templates to generated/templates.ts
      ✔ Generate types for data source templates
        Load data source template ABI from abis/pair.json
        Load data source template ABI from abis/factory.json
      ✔ Load data source template ABIs
        Generate types for data source template ABI: Pair > Pair (abis/pair.json)
        Generate types for data source template ABI: Pair > Factory (abis/factory.json)
        Write types to generated/templates/Pair/Pair.ts
        Write types to generated/templates/Pair/Factory.ts
      ✔ Generate types for data source template ABIs
      ✔ Load GraphQL schema from schema.graphql
        Write types to generated/schema.ts
      ✔ Generate types for GraphQL schema

      Types generated successfully
    ```

    <Accordion title="Codegen Options">
      <Info>
        View all options with `graph codegen --help`:
      </Info>

      ```bash  theme={null}
      USAGE
        $ graph codegen [SUBGRAPH-MANIFEST] [-h] [-o <value>] [--skip-migrations] [-w] [--uncrashable-config <value> -u]

      FLAGS
        -h, --help                    Show CLI help.
        -o, --output-dir=<value>      [default: generated/] Output directory for generated types.
        -u, --uncrashable             Generate Float S
                                      subgraph Uncrashable helper file.
        -w, --watch                   Regenerate types when subgraph files change.
        --skip-migrations             Skip subgraph migrations.
        --uncrashable-config=<value>  Directory for uncrashable config.
      ```
    </Accordion>
  </Step>

  <Step title="Build Your Subgraph">
    After generating types, build your subgraph:

    ```bash  theme={null}
    graph build
    ```

    Success Output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/

    Build completed: build/subgraph.yaml
    ```

    <Accordion title="Build Options">
      <Info>
        View all options with `graph build --help`:
      </Info>

      ```bash  theme={null}
      Builds a subgraph and (optionally) uploads it to IPFS.

        USAGE
          $ graph build [SUBGRAPH-MANIFEST] [-h] [-i <value>] [-o <value>] [-t wasm|wast]
            [--skip-migrations] [-w] [--network <value>] [--network-file <value>]

        FLAGS
          -h, --help                    Show CLI help.
          -i, --ipfs=<value>            Upload build results to an IPFS node.
          -o, --output-dir=<value>      [default: build/] Output directory for build results.
          -t, --output-format=<option>  [default: wasm] Output format for mappings.
                                        <options: wasm|wast>
          -w, --watch                   Regenerate types when subgraph files change.
          --network=<value>             Network configuration to use from the networks config file.
          --network-file=<value>        [default: networks.json] Networks config file path.
          --skip-migrations             Skip subgraph migrations.

      DESCRIPTION
      Builds a subgraph and (optionally) uploads it to IPFS.

      ```
    </Accordion>
  </Step>

  <Step title="Deploy your Subgraph">
    Then deploy your Subgraph:

    ```bash  theme={null}
    graph deploy <your_subgraph> --node
    https://noksapi.0xgraph.xyz/deploy
    --ipfs https://noksapi.0xgraph.xyz/ipfs
    --deploy-key <your_API_key>
    ```

    Success output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/
      Add file to IPFS build/schema.graphql
                    .. Qmckrwbgbx3FjsVH4AU8xP3zgdg3rPnzNo7pmApAmhQkA4
      Add file to IPFS build/Factory/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9
      Add file to IPFS build/Factory/ERC20.json
                    .. QmPfKNZPkVATzL3EHypkcsyKhehR4jkiYEVqSzh2hxWYj1
      Add file to IPFS build/Factory/ERC20SymbolBytes.json
                    .. QmbHnhUFZa6qqqRyubUYhXntox1TCBxqryaBM1iNGqVJzT
      Add file to IPFS build/Factory/ERC20NameBytes.json
                    .. QmQCP6Pdp1MqpwRv2qoPHuUTwZGy7Q3eDHg4w5kzwE9mBj
      Add file to IPFS build/Factory/Factory.wasm
                    .. QmNksN9HGSyMfc4XrjQeHuDKsBQk1xHEKVE2dLwHQQu4kb
      Add file to IPFS build/Pair/pair.json
                    .. QmbPLMADBP8L6LBVP3ZBQ8RgG7ghamD8DvbdUxHAjZrLgm
      Add file to IPFS build/Pair/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9 (already uploaded)
      Add file to IPFS build/templates/Pair/Pair.wasm
                    .. QmSZSUoNinhNshD26iwKyzut6s3w5Lmec3P9szBovfQg8V
    ✔ Upload subgraph to IPFS

    Build completed: QmdXJQUxgrzP8pVotTqiwirJ6NxfmdNdQ6rWQv2rmJpBQp

    Deployed to /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn

    Subgraph endpoints:
    Queries (HTTP):     /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn
    ```
  </Step>
</Steps>

<Card title="View Your Subgraphs" icon="browser">
  Access your deployed Subgraphs through the web-based UI at [noks.0xgraph.xyz](http://noks.0xgraph.xyz)
</Card>

```
```


# Deploy a token transfer subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/noks/subgraphs/getting-started/deploy-token-transfer-subgraph

Tutorial on how to deploy an erc20 token transfer subgraph with the Graph CLI



# Monitor Your Subgraph
Source: https://docs.ormilabs.com/dedicated-env/noks/subgraphs/getting-started/monitor-subgraph

Learn how to monitor your subgraph syncing progress and logs after deployment

# Monitor your subgraph via the Analytics Page

After deploying your subgraph, you can easily monitor the syncing progress and subgraph logs for up to 48 hours to gain insight and troubleshoot any issues that may come with your subgraph.

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph2.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=116c3dc4f54bfc97376cf2c1ec70ad14" alt="Subgraph deployment view" data-og-width="2063" width="2063" data-og-height="1098" height="1098" data-path="images/how-to/monitor-subgraph2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph2.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=0615b1f8f1cdd2a7f7f4cb984588b8f7 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph2.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=61208bd794bc0a7dc913c890850134f5 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph2.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=7d61c87ac8cf7c56c0bb61cac73e6275 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph2.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=549432011973422cab9260fe8b0dc3eb 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph2.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=b892064043e7b083125e9b3ac714c3bd 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph2.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=0a7ec9e1df9e5b70f81f8204e157e362 2500w" />
</Frame>

You can access your deployed subgraph analytics page by clicking on the subgraph name; afterward, you will be directed to the following analytics page.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-analytics.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=7cb92668ea3a389010b0847871a81d26" alt="Subgraph analytics page" data-og-width="2154" width="2154" data-og-height="1762" height="1762" data-path="images/noks/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-analytics.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=0177332f0121aef1fe140fa3c10a9517 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-analytics.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=d21d78e71b4d6d3e95122a1cd9a65b81 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-analytics.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=2249f9a66e1593c5de68518fc8359c28 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=fdf7558867df1f15fcd44c5e80fdb0f7 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=abd0e34b1c5c23b80dc468a77b324aa2 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=013d6ad29a0963549cbf86d2fe647eac 2500w" />
</Frame>


# Perform Query
Source: https://docs.ormilabs.com/dedicated-env/noks/subgraphs/getting-started/perform-query

Short description on what this section is about

After deploying your subgraph, you can easily access and query it via GraphQL playground for query. You can open the "GraphQL API" link in your dashboard to access your data.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-api-key.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=68a430db5546964ed01da4743e060a21" alt="API Keys" data-og-width="3446" width="3446" data-og-height="1842" height="1842" data-path="images/noks/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-api-key.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=e6b72bf251551f2145e43723ee34c71a 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-api-key.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=02e2700998afb265e098ccd14e5bb75b 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-api-key.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=76b96d720bc86cd91d8f9f79543c04a8 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=87200c1f51ebedbb8ec253aea1003620 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=02002d16ddbde18e005c11cb77baabcb 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=b89e3b3103398445aa03dc69448a501b 2500w" />
</Frame>

For example, you may access the publicly available Noks token approval subgraph at `https://noksapi.0xgraph.xyz/subgraphs/name/base_V1/graphql`

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-graphql.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=31fdbf9caca3540f24ecb2179585085c" alt="GraphQL" data-og-width="1847" width="1847" data-og-height="867" height="867" data-path="images/noks/0xgraph-graphql.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-graphql.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=1d537e79a38f2f711a22adb1387becbc 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-graphql.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=49e53b8ed3be350516e74fbf457db627 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-graphql.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=3a659c90b52d34d55fdfcb0a335e512a 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-graphql.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=e3eddf1fe63614f613b663f3839edbf6 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-graphql.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=ebd6a2033fb0c34f51c002f11696029d 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/noks/0xgraph-graphql.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=041837cf2615404bb28613d92b031b37 2500w" />
</Frame>

***

## Query for Subgraph Sync Status

To get to know the sync status directly inside the subgraph, a user may run the following query by using `_meta`:

```graphql  theme={null}
{
  _meta {
    block {
      hash
      timestamp
      number
    }
  }
}
```

The result would be similar to the following:

```json  theme={null}
{
  "data": {
    "_meta": {
      "block": {
        "hash": "0x9f2480d4a21fb9743ae35d349fccbc86c0fad084d6a87b53d1f649f1051c6ddb",
        "timestamp": 1700267031,
        "number": 151479342
      }
    }
  }
}
```

***

## Query a Subgraph

Subgraphs expose blockchain data via a GraphQL API, making it easy for anyone familiar with the GraphQL language to get started.

A GraphQL API differs from traditional REST APIs in that it relies on a schema definition to outline the available queries, mutations, and data types that clients can access.

## Benefits of Schema-Driven Approach

This schema-driven approach enables clients to precisely specify the data they need, eliminating the need to over-fetch data. Here's why this is beneficial:

<CardGroup>
  <Card title="Precision" icon="bullseye">
    GraphQL clients can tailor their queries to retrieve only the data they require, enhancing efficiency.
  </Card>

  <Card title="Flexibility" icon="arrows-to-circle">
    Clients can request related data in a single query, reducing the number of API calls needed.
  </Card>

  <Card title="Predictability" icon="chart-line">
    The schema provides clear documentation for available data and operations.
  </Card>
</CardGroup>

## GraphQL Syntax

GraphQL queries are composed using a specific syntax that allows for hierarchical data retrieval. Clients specify the fields they want to retrieve and their relationships within a single query. This approach minimizes unnecessary data retrieval, resulting in more concise and efficient requests.

## Best Practices

When working with the 0xGraph service, it's essential to follow best practices to ensure optimal performance and efficiency. These best practices are outlined in official Graph Protocol documentation.

<Info>
  For detailed instructions on querying 0xGraph using GraphQL and to ensure adherence to best practices, refer to the [official
  documentation](https://thegraph.com/docs/en/querying/querying-best-practices/) provided by the Ormi Labs and Graph Protocol teams. These resources offer
  valuable insights and recommendations to streamline your interaction with blockchain data through GraphQL.
</Info>


# Private Graphql URL
Source: https://docs.ormilabs.com/dedicated-env/noks/subgraphs/getting-started/private-url

Learn how to create a private GraphQL URL for your subgraph

## Private Graphql URL

When you deploy a new subgraph, a public GraphQL endpoint is provided by default. However, you can also create a private endpoint for your subgraph, which requires an authentication token for requests. This private endpoint ensures that only authorized users or applications can access your subgraph's data, maintaining data security and control.

## Enable Private GraphQL Link

To use the private endpoint, you first need to enable it in your subgraph's detail on the 0xGraph console.

1. Navigate to your project details page.
2. Find the "PRIVATE GRAPHQL LINK" section.
3. Toggle the switch to "Enabled".

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=560e6af6112a63cffb865cbc60afd565" alt="Enable Private URL" width="700" data-og-width="1229" data-og-height="834" data-path="images/how-to/private.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=84eabc519189ef2a3b52f280ff7e2646 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a44106946348f0dcaf322b5b35e66c41 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6dcfd639d6e2d14fdacf34fc469e0afd 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e8470fabfb0845232d16b5434ada8136 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=93dc339e9fdfbd6dcc7ed4ad027c6baf 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=aee1e2143fe2327a40640aacd8e8b906 2500w" />

## Find Your Private URL

Once enabled, your unique private GraphQL URL will be displayed. You can also find this URL listed on the main page of your project environment under the "PRIVATE GRAPHQL LINK" column.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=45d17f6b83f1234c38290ece93132fab" alt="Private URL List" width="700" data-og-width="1881" data-og-height="880" data-path="images/how-to/private2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=170c03e25794a0fa9099ae07c2ce6f67 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a733750201ba10c93bb3d985c5b775de 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=c0b478fca2ec7586f8f12db7bf9434e6 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a0e72f5d6ff87f1768e3688ed1995abb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f478e814674d0454cf0d1eb46704f1c3 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f7fb3ddbec13791ab5948282de354b3e 2500w" />

## Authentication

To query your private GraphQL endpoint, you must include an authentication token in the request header.

1. Obtain your API key from the 0xGraph console API Keys.
2. In your GraphQL client (like GraphiQL or Postman), add an `Authorization` header.
3. Set the header value to `Bearer YOUR_API_KEY`, replacing `YOUR_API_KEY` with the actual key.

Here's how it looks in the GraphiQL interface provided by 0xGraph:

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b36c81515bf5633e8446b1a9bc18a852" alt="Private URL Token" width="700" data-og-width="1261" data-og-height="836" data-path="images/how-to/private3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=62296e918593924606edca6ea9bb0e52 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7b7d3af194a2243c9a63ddd31c209e5c 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=87e773a3ca3156ba9ab3700bb365713d 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a5d877ffa5cc966da46065fa94a2ed90 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e4f121ec83725881815c920ece44b3d1 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=67f6cb202406476251abef74a4f70e3f 2500w" />

By following these steps, you can securely interact with your subgraph using its private GraphQL endpoint.


# Subgraph Webhooks
Source: https://docs.ormilabs.com/dedicated-env/noks/subgraphs/getting-started/webhook

Learn how to create and manage webhooks for your subgraphs to receive real-time updates.

## Subgraph Webhooks

Subgraph webhooks allow you to receive HTTP POST requests in real-time whenever an entity in your subgraph changes due to an `INSERT`, `UPDATE`, or `DELETE` operation. This is useful for triggering backend processes, sending notifications, or syncing data with external systems.

## How it Works

When a subgraph handler executes an operation like `entity.save()` (resulting in an `INSERT` or `UPDATE`) or an entity is removed (resulting in a `DELETE`), the change is recorded. A real-time watcher detects this update and sends a payload to your configured webhook URL. The payload will indicate the type of operation: `INSERT`, `UPDATE`, or `DELETE`.

## Creating a Webhook

You can create a new webhook through the 0xGraph dashboard.

1. Navigate to the "Webhooks" section of your subgraph.

2. Click on the "New Webhook" button.

3. Fill in the required information in the "Create Webhook" modal:

   * **Name**: A descriptive name for your webhook (e.g., `webhook_demo`).
   * **URL**: The HTTP endpoint where the webhook payloads will be sent.
   * **Entity**: The specific entity you want to track (e.g., `approved`).
   * **Number of retries**: Configure the total number of retries. Defaults to 3, with a maximum of 10.
   * **Retry interval**: Configure the retry interval in seconds. Defaults to 60, with a maximum of 3600.
   * **Retry timeout**: Configure the retry timeout in seconds. Defaults to 30, with a maximum of 60.
   * **"secret" header value**: An optional secret string that will be sent in a designated webhook secret header. This allows your endpoint to verify that the request is authentic.

   <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9234eae31186a5b6f649ed942830ff6c" alt="Create Webhook Modal" data-og-width="1872" width="1872" data-og-height="879" height="879" data-path="images/how-to/webhook.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9f6074a41fc7104edd1f8a831dcf426b 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=70599e318f7d4dbb52bd9b9271f5fb9b 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=12c058b62fbe1aad60ae53b93b4edb0f 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d09122a7d15636238f837d4fb83fb9cb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d4299f143c74dac74aefe4d276549743 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9b8b5cfcba5dbd305b27b026d77ab5d4 2500w" />

4. Click "Create".

## Listing Webhooks

Once created, your webhook will appear in the list of webhooks for your subgraph. You can see its name, the entity it tracks, the target URL, and statistics about successful and failed deliveries.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=1a8a8610f0aa060edd6cec706e366d69" alt="Webhook List" data-og-width="1000" width="1000" data-og-height="818" height="818" data-path="images/how-to/webhook3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=fba9d6def6020d6c02eacc3c4670f763 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ee4af7ca24eeadf9bfab5bde38ab1811 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6e22347e0fe60c0d103c87000e981f06 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=59a7e24f1e30c3da890b3ea603216cc5 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ac5ba543c4c479ce7052f173ee858471 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6887464b8fb3a4b2866c91c8f90a8cb7 2500w" />

## Webhook Payload Structure

The webhook will send a JSON payload to your configured URL. The main payload object contains the following fields:

* `op` (string): The type of operation that triggered the webhook. Possible values are `"INSERT"`, `"UPDATE"`, or `"DELETE"`.
* `data_source` (string): Identifier for the subgraph or indexer being tracked.
* `data` (object): Contains the actual entity data that changed. It has two sub-fields:
  * `old` (object | null): The state of the entity before the change. This will be `null` if the `op` is `"INSERT"`.
  * `new` (object | null): The state of the entity after the change. This will be `null` if the `op` is `"DELETE"`.
* `webhook_name` (string): The name you assigned to your webhook during creation.
* `webhook_id` (string): A unique identifier for the webhook configuration.
* `id` (string): A unique identifier for this specific event notification.
* `delivery_info` (object): Information about the delivery attempt for this webhook. It has two sub-fields:
  * `max_retries` (integer): The maximum number of retry attempts configured for this webhook.
  * `current_retry` (integer): The current retry attempt number for this specific event (0 for the initial attempt).
* `entity` (string): The name of the subgraph entity being tracked.

### Example Payloads:

**`INSERT` operation:**

```json  theme={null}
{
  "op": "INSERT",
  "data_source": "privateURL/v0.0.1",
  "data": {
    "new": {
      "id": "ERC20Approve-0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc-w\\u001c\\u001b\\u0002\\ufffd\\ufffd\\ufffd\\u07Ջ^\\ufffdcO\\ufffd\\ufffd(7C\\u001c\\u001b-\\ufffd\\u0016僞\\ufffdm\\ufffd\\ufffdI+y\\ufffd\\ufffd^\\u0015\\ufffd\\ufffdY\\ufffd",
      "vid": 7271978,
      "owner": "\\\\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc",
      "amount": 1.157920892373162e+77,
      "is_all": false,
      "spender": "\\\\xbde5839ec36db2ac492b79e9e3b75e15fa8a59ec",
      "updated_at": 1747127781,
      "block_range": "[20405156,)"
    },
    "old": null
  },
  "webhook_name": "webhook_demo",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "id": "5b623fd0-b539-400b-bbb3-060d95403a64",
  "delivery_info": {
    "max_retries": 3,
    "current_retry": 0
  },
  "entity": "approved"
}
```

**`UPDATE` operation :**

```json  theme={null}
{
  "data": {
    "new": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,20405060)"
    },
    "old": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,)"
    }
  },
  "data_source": "privateURL/v0.0.1",
  "delivery_info": {
    "current_retry": 0,
    "max_retries": 3
  },
  "entity": "approved",
  "id": "dd2b6013-22e1-4e8e-a665-be5276144a68",
  "op": "UPDATE",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "webhook_name": "webhook_demo"
}
```


# 0xGraph - Reliable Subgraph Indexing
Source: https://docs.ormilabs.com/dedicated-env/noks/subgraphs/overview



Deploy subgraphs with 99.9%+ availability and fetch smart contract data at 3x the speed. 100% spec-compliant with every subgraph on The Graph's hosted and decentralized networks.

## Overview

Subgraphs are customizable, open-source solutions for indexing and accessing real-time blockchain data through GraphQL APIs.

0xGraph is a zero-hassle subgraph hosting solution that is 100% spec-compliant with every subgraph on The Graph Protocol’s hosted and decentralized networks, minus the lag and downtime.

* Plug and play deployment and subgraph migration from hosted services.
* Deploy subgraphs with the same tooling, UI, and similar CLI as The Graph.
* Query subgraphs without running any nodes or infrastructure.

### Supported Networks

0xGraph currently supports the following networks:

| Name     | Type    | Network Slug |
| -------- | ------- | ------------ |
| Base     | Mainnet | `base`       |
| Ethereum | Mainnet | `mainnet`    |

### Available Upon Request

Any other network you need? Please email us: [hello@ormilabs.com](mailto:hello@ormilabs.com)


# Dedicated environment
Source: https://docs.ormilabs.com/dedicated-env/overview

Dedicated environments are custom-built infrastructure designed to index the fastest chains.

## Supported Networks

Ormi currently supports the following networks for subgraph hosting, and data API.

<CardGroup cols={2}>
  <Card title="Apechain" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=a9571396cc76c68d8a93a2a2e05b8e82" href="https://apechain.0xgraph.xyz" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/apechain-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=22149a81839206b445adde58fba72a2b 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=ab48183701879eed55a7a2aea4bed7c3 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=0acfc63a6e4ea6055dcea7a0bbe13b19 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=cbc537fd1ca2faad235449e4bfc1cc6d 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7499d9bd6e9b5770566b16a17fb9245c 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/apechain-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=1aecb07172defcb70732a70939640f04 2500w">
    Apechain Subgraph
  </Card>

  <Card title="Berachain" img="https://mintcdn.com/ormilabs/DTzE6j6gfV7nffuS/images/chain-logos/berachain-icon-padding.svg?fit=max&auto=format&n=DTzE6j6gfV7nffuS&q=85&s=8e8dacc6e050daa6a6499fcc5f439dff" href="https://berachain.0xgraph.xyz" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/berachain-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/DTzE6j6gfV7nffuS/images/chain-logos/berachain-icon-padding.svg?w=280&fit=max&auto=format&n=DTzE6j6gfV7nffuS&q=85&s=7578cf16b93ac98b23deb81193c3789c 280w, https://mintcdn.com/ormilabs/DTzE6j6gfV7nffuS/images/chain-logos/berachain-icon-padding.svg?w=560&fit=max&auto=format&n=DTzE6j6gfV7nffuS&q=85&s=9b7b58271ef8084a4cb3c9dd9e62b135 560w, https://mintcdn.com/ormilabs/DTzE6j6gfV7nffuS/images/chain-logos/berachain-icon-padding.svg?w=840&fit=max&auto=format&n=DTzE6j6gfV7nffuS&q=85&s=7159ffa22890c9c06594b8542afba948 840w, https://mintcdn.com/ormilabs/DTzE6j6gfV7nffuS/images/chain-logos/berachain-icon-padding.svg?w=1100&fit=max&auto=format&n=DTzE6j6gfV7nffuS&q=85&s=1ada4aeabd63feaf42709f4f203971e9 1100w, https://mintcdn.com/ormilabs/DTzE6j6gfV7nffuS/images/chain-logos/berachain-icon-padding.svg?w=1650&fit=max&auto=format&n=DTzE6j6gfV7nffuS&q=85&s=1c92f8439edabb42dcf8663119f74965 1650w, https://mintcdn.com/ormilabs/DTzE6j6gfV7nffuS/images/chain-logos/berachain-icon-padding.svg?w=2500&fit=max&auto=format&n=DTzE6j6gfV7nffuS&q=85&s=5b38b23f83a5ae703259d28c594ad7c1 2500w">
    Berachain Subgraph
  </Card>

  <div>
    <div className="block dark:hidden">
      <Card title="Dolomite" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/dolomite-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3baef4de0be86a889245bc6fd19b26be" href="https://dolomite.0xgraph.xyz" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/dolomite-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/dolomite-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=4cd40924e037ee900292431a7c152c58 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/dolomite-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=074efca17157fa2c625de79e7f660a0f 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/dolomite-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=56ce6f2f56c7e1d7a7c1019be84085c0 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/dolomite-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3c5f401265c87f2c0afc42736f2c346c 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/dolomite-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=bb059c17de3878c808ce8845160e06fb 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/dolomite-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=aa7df70ba7e73d503ee65324a17f5c18 2500w">
        Dolomite Subgraph
      </Card>
    </div>

    <div className="hidden dark:block dark-mode-invert">
      <Card title="Dolomite" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/dolomite-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3baef4de0be86a889245bc6fd19b26be" href="https://dolomite.0xgraph.xyz" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/dolomite-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/dolomite-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=4cd40924e037ee900292431a7c152c58 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/dolomite-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=074efca17157fa2c625de79e7f660a0f 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/dolomite-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=56ce6f2f56c7e1d7a7c1019be84085c0 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/dolomite-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3c5f401265c87f2c0afc42736f2c346c 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/dolomite-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=bb059c17de3878c808ce8845160e06fb 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/dolomite-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=aa7df70ba7e73d503ee65324a17f5c18 2500w">
        Dolomite Subgraph
      </Card>
    </div>
  </div>

  <Card title="Goat" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/goat-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=9a99ce2e73a1559d69738f341be016b4" href="https://subgraph.goat.network" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/goat-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/goat-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=1180fe820b0ace757daeefa3c8592281 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/goat-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=dd9d4f7abcf6d362f86b494f65b6ce76 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/goat-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3b3b4da8d206b49100c18e5e04abe708 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/goat-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=8bfe1882ab1636224363a055c773141a 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/goat-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=05793cc8c0ec3d7a60776709e23adfee 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/goat-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=f1b561dd44bcaa70a309b8c1ef548870 2500w">
    Goat Subgraph
  </Card>

  <div>
    <div className="block dark:hidden">
      <Card title="Mantle" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/mantle-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c8559fa492e53c7121c0ac158f6c538e" href="https://subgraph.mantle.xyz" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/mantle-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/mantle-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c3ae0e1009b9b1d5b8ac7b46d342c2aa 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/mantle-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=2f12d286e846437c5895879361c1c45a 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/mantle-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c3497c286a706200af4627086c5b42b7 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/mantle-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=eb124e5ecebf08e7b380ab03f3f497dc 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/mantle-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=0ca24737126a2819a76563404c206c42 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/mantle-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=94595be1e8edf8ab2492052554a15f28 2500w">
        Mantle Subgraph
      </Card>
    </div>

    <div className="hidden dark:block dark-mode-invert">
      <Card title="Mantle" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/mantle-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c8559fa492e53c7121c0ac158f6c538e" href="https://subgraph.mantle.xyz" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/mantle-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/mantle-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c3ae0e1009b9b1d5b8ac7b46d342c2aa 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/mantle-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=2f12d286e846437c5895879361c1c45a 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/mantle-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c3497c286a706200af4627086c5b42b7 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/mantle-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=eb124e5ecebf08e7b380ab03f3f497dc 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/mantle-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=0ca24737126a2819a76563404c206c42 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/mantle-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=94595be1e8edf8ab2492052554a15f28 2500w">
        Mantle Subgraph
      </Card>
    </div>
  </div>

  <Card title="Metis" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/metis-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c056c7fa946b355d10c17af692a48de8" href="https://metis.0xgraph.xyz" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/metis-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/metis-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=f11ebd148574477ef1531555a4011d7f 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/metis-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=dc5b03f1ffdd4fc7846a05420eeee0d2 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/metis-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=8badfcad80743b54322de6d8fd3b8337 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/metis-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=0524c474aa4e3ac39d166a37ce70bfa4 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/metis-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3881cbb2d566a07119a7e373f58783fd 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/metis-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=d3cf53a47ed56025130bbfb13930df70 2500w">
    Metis Subgraph
  </Card>

  <div>
    <div className="block dark:hidden">
      <Card title="Noks" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/noks-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3013437ae9981ecef283d694a3b2d002" href="https://noks.0xgraph.xyz" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/noks-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/noks-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=e98af6fafe7f1bb000d4108a14488700 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/noks-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c58d1d06878f67b15773348d0765cdf2 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/noks-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=faa88e8a0711973adef74b6fa28eb2af 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/noks-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=fcfd5e247fe4862cc3da65cc54b7ba23 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/noks-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=b82d00f497c78e7c271e2575ab81855a 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/noks-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=4b6eda8c8670b16658da509f3424a827 2500w">
        Noks Subgraph
      </Card>
    </div>

    <div className="hidden dark:block dark-mode-invert">
      <Card title="Noks" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/noks-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3013437ae9981ecef283d694a3b2d002" href="https://noks.0xgraph.xyz" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/noks-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/noks-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=e98af6fafe7f1bb000d4108a14488700 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/noks-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c58d1d06878f67b15773348d0765cdf2 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/noks-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=faa88e8a0711973adef74b6fa28eb2af 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/noks-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=fcfd5e247fe4862cc3da65cc54b7ba23 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/noks-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=b82d00f497c78e7c271e2575ab81855a 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/noks-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=4b6eda8c8670b16658da509f3424a827 2500w">
        Noks Subgraph
      </Card>
    </div>
  </div>

  <Card title="Somnia" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=5772d9dbc682fe6ff18b2ac648a7e67f" href="https://somnia.0xgraph.xyz" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/somnia-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=534f7cdc1fb4e8684a04372862ffc061 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=8d0e3d7430cc6998608c96bec5d0c24d 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3159fd10ccea4bd5c1f0a36534250da4 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=73ebd87083c045ee655cc3534d8ea6da 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=5949c154fe60603955cf50a8d6f6ce85 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=ee42111f782ca7b86b9750f5ffa1b9bc 2500w">
    Somnia Subgraph
  </Card>

  <Card title="Telos" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/telos-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=c66a89e26f60c9511d88a08e0e8a84e9" href="https://telos.0xgraph.xyz" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/telos-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/telos-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=93234f6fdd7b2e34bc17705d5b95dbad 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/telos-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=a333d5b28fe1dbdd55dacc63dbd669c0 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/telos-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=46e363eac46c1956419bdac7fd3f27b3 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/telos-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=7c53a6951a719b4ac114d8fd69579a2b 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/telos-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=21060fffebccfae764e6d05badd7a606 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/telos-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=972142b0686412b3b583eaf6c11e4524 2500w">
    Telos Subgraph
  </Card>
</CardGroup>

## Need a custom environment?

Please [schedule a call](https://calendly.com/ormilabs) with our sales team to discuss your requirements and get a quote.

## Need another chain?

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="https://forms.fillout.com/t/66AyD9bdZvus"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ebadba019a911b27f922ea79588b939d" alt="ecosystem icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/boxes.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d13c22a16e1077c57a96e4eea973eb85 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=fc8ccea3fe21d83c7391877396575949 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=1c91a2a34350eed8e9f6018ca47919a0 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8cd2cb4551e3d0655fb8e73da106826e 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4b534dcd403e58e53cf1b2ff6dd5160b 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ee44bdce4df96eaa59c74d5c426a19dc 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">For ecosystems</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Partner with Ormi to power your ecosystem with subgraphs and APIs that are real-time, reliable, and fully white-labeled. Give your developers enterprise-grade data under your own brand.
      </p>
    </div>
  </a>

  <a
    href="https://forms.fillout.com/t/2U1EKfDebbus"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7abf3ee5e020a6c691989d0333b1bf3f" alt="builder icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/laptop.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=162396f09b219713bf2ba0bfdb68228d 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=611c4abf9ce174932c3c122eef2b3729 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ceb463055475f5fdc8a77379c03bee1f 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=aee69538cc9b9a846316fdcb58300876 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=c091bafac5ce7476fbc10c00a314f7bb 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=bf47d74856b0891e7ae019fb1404cd54 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">For builders</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Request support for any chain, and we'll spin up real-time subgraphs and APIs with enterprise grade reliability. No throttling, or stale data – just the data you need to build high-throughput applications.
      </p>
    </div>
  </a>
</div>


# Get ERC-1155 balance
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/balances/get-erc-1155-balance

get /somnia/v1/address/{walletAddress}/balance/erc1155
Lists ERC-1155 token balances of a wallet address.



# Get ERC-20 balance
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/balances/get-erc-20-balance

get /somnia/v1/address/{walletAddress}/balance/erc20
Lists ERC-20 token balances of a wallet address.



# Get ERC-721 balance
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/balances/get-erc-721-balance

get /somnia/v1/address/{walletAddress}/balance/erc721
Lists ERC-721 token balances of a wallet address.



# Get historical balance
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/balances/get-historical-balance

get /somnia/v1/address/{walletAddress}/balance/historical
Fetch the historical native, fungible (ERC-20), and non-fungible (ERC-721 & ERC-1155) tokens held by an address at a given block height or date.




# Get native token balance
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/balances/get-native-token-balance

get /somnia/v1/address/{walletAddress}/balance/native
Get the native token balance for an address.




# Get token balance portfolio for address
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/balances/get-token-balance-portfolio-for-address

get /somnia/v1/address/{walletAddress}/balance/portfolio
Render a daily portfolio balance for an address broken down by the token. The timeframe is user-configurable, defaults to 30 days.



# Get block heights
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/blocks/get-block-heights

get /somnia/v1/blocks/{startDate}/{endDate}
Get all block heights within a particular date range.



# Get block transactions
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/blocks/get-block-transactions

get /somnia/v1/block/{blockNumber}/transactions
Get transactions that occurred in a given block.



# Get one block
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/blocks/get-one-block

get /somnia/v1/block/{blockHeight}
Get the details of an individual block.



# null
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/events/get-transaction-logs

get /somnia/v1/events/



# Get NFT tokens by address
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/nfts/get-nft-tokens-by-address

get /somnia/v1/nft/collections/{address}/tokens
Lists non-fungible tokens for a particular contract address.



# Get NFT tokens by id for address
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/nfts/get-nft-tokens-by-id-for-address

get /somnia/v1/nft/collections/{address}/tokens/{tokenID}
Get token details for a specific token of an NFT contract.



# Get NFT traits by collection
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/nfts/get-nft-traits-by-collection

get /somnia/v1/nft/collections/{address}/traits
Get a list of traits for a particular NFT address



# Get token holders
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/tokens/get-token-holders

get /somnia/v1/tokens/{tokenAddress}/holders
Get a list of all the token holders for a specified ERC-20, ERC-721 or ERC-1155 token.



# Get bulk transactions
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/transactions/get-bulk-transactions

get /somnia/v1/bulk/transactions/{walletAddress}/{timeBucket}
Lists bulk transaction data for a wallet address in a 15-minute time bucket interval.



# Get earliest wallet transactions
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/transactions/get-earliest-wallet-transactions

get /somnia/v1/earliest/{walletAddress}/transactions
Lists the earliest transactions involving an address.



# Get latest transactions
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/transactions/get-latest-transactions

get /somnia/v1/transactions
Lists the latest transactions.



# Get native transactions for address
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/transactions/get-native-transactions-for-address

get /somnia/v1/address/{walletAddress}/transactions/native
Lists native transactions for an address. Filterable by block range.



# Get one transaction
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/transactions/get-one-transaction

get /somnia/v1/transaction/{txHash}
Get a single transaction by transaction hash.



# Get recent wallet transactions
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/transactions/get-recent-wallet-transactions

get /somnia/v1/recent/{walletAddress}/transactions
Lists the most recent transactions involving an address.



# Get transactions for address
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/transactions/get-transactions-for-address

get /somnia/v1/address/{walletAddress}/transactions
Get paginated transactions involving an address.



# Get wallet transactions summary
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/transactions/get-wallet-transactions-summary

get /somnia/v1/address/{walletAddress}/transactions/summary
Get the earliest and latest transactions, and the transaction cound involving a wallet.



# Get ERC-1155 transfers
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/transfers/get-erc-1155-transfers

get /somnia/v1/address/{walletAddress}/transfers/erc1155
Lists ERC-1155 transfers for an address. Filterable by block range and contract address.



# Get ERC-20 transfers
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/transfers/get-erc-20-transfers

get /somnia/v1/address/{walletAddress}/transfers/erc20
Lists ERC-20 transfers for an address. Filterable by block range and contract address.



# Get ERC-721 transfers
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/api-reference/transfers/get-erc-721-transfers

get /somnia/v1/address/{walletAddress}/transfers/erc721
Lists ERC-20 transfers for an address. Filterable by block range and contract address.



# Account Creation
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/getting-started/account-creation

How to create an account and access for Somnia Data APIs

## Setup Steps

### 1. Create Account

Visit [the application dashboard](https://somnia.0xgraph.xyz) to create your account.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-signup.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=fa152815463aff23d82e148d2f2adb8b" alt="Somnia Registration" data-og-width="3400" width="3400" data-og-height="1780" height="1780" data-path="images/somnia/0xgraph-signup.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-signup.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=a272100ac63f32e1e0fc50af1fe32be4 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-signup.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=ffa65036ed4ca5e9fd2e0ffc285a6d1e 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-signup.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=173c4a88520f6030817b707a61da2c4d 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-signup.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=6473bb8a2ceb6b4b4c61253103e45ed7 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-signup.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=94fa2d0180f892e00d0842a32fc7bf32 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-signup.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=476c690cabdaf3fcacc008c50fde08e5 2500w" />
</Frame>

### 2. Choose Subscription Plan

The current access for data APIs is **free**, but rate limited. In the future, user will be required to navigate to the [Pricing page](https://somnia.0xgraph.xyz/dashboard/price) to select a plan that matches your needs.

If you'd like to remove rate limits or are looking for custom APIs, please select **Enterprise** and connect with our team.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-pricing.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=cbc5eafaca7221e19f60944b51d8bc45" alt="0xGraph Subscription Plans" data-og-width="3468" width="3468" data-og-height="1810" height="1810" data-path="images/somnia/0xgraph-pricing.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-pricing.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=a0b420615890408a8a79a6a45d43a603 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-pricing.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=0367c6e8d94ae554afa3aed68616ef86 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-pricing.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=eca6347de33c6bc8d75873ec6aa07f1d 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-pricing.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=a688f6d50fa2766c33e9863ec5945144 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-pricing.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=af58301821314b607ee0c6b849d63574 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-pricing.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=a70b2064233bfdb54014c0155f042b07 2500w" />

  <figcaption>Choose a subscription plan</figcaption>
</Frame>

### 3. Generate API Key

An API key is required to access the Somnia Data APIs endpoints. This API key is currently shared among all of Ormi's data solutions.

Go to the [API Keys Page](https://somnia.0xgraph.xyz/dashboard/api) to create your API key.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-api-key.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=b32283b245f9d591c860c05e57208476" alt="0xGraph API Keys" data-og-width="3488" width="3488" data-og-height="1846" height="1846" data-path="images/somnia/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-api-key.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=ea7e27e70ce32a8f3b9ff50e089012c4 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-api-key.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=1010fd79a845f1aecb9b2fe8eda5ecc1 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-api-key.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=b73f51cf777470b9b602312d972d5b38 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=dbeb319c24b289c564d1de5795eff490 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=5be2993d183bda6945843cf48ee6d7f1 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=c70eef758dbd21165cf0cbbb2b1d4ce5 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

After clicking the 'Create API Key' button in the top-right corner, your API key will be generated.
You can then copy and paste it for querying Somnia Data APIs endpoints.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-generated-api-key.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=3965977d6a01dec9169303e3c92b57bc" alt="0xGraph API Keys" data-og-width="3430" width="3430" data-og-height="1832" height="1832" data-path="images/somnia/0xgraph-generated-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-generated-api-key.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=4843c55d48f641a6b6f2b912d04c07fb 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-generated-api-key.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=45eb62f946bff06e03c8c07d1412d703 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-generated-api-key.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=2d441927ca1c837a92f405a20b4f92ad 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-generated-api-key.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=c998f74c34285ba939d44609993fb4dc 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-generated-api-key.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=6219d5c2575e91f09f8a5d8445b08b37 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-generated-api-key.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=5396092912848640d78d0f2f7703227b 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

<Info>
  Warning: Always handle your API keys securely. Do not expose them in client-side code or share them publicly. Store
  them in a secure location, such as environment variables, and rotate them regularly to minimize security risks. If
  compromised, regenerate your API key immediately. For public repositories, store API keys in a .env file and add .env
  to .gitignore to prevent accidental exposure in your codebase.
</Info>

You are all set and ready to query Somnia Data APIs endpoints here:

<Card title="Access Now" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=5772d9dbc682fe6ff18b2ac648a7e67f" href="/dedicated-env/somnia/data-apis/api-reference/balances/get-erc-20-balance" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/somnia-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=534f7cdc1fb4e8684a04372862ffc061 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=8d0e3d7430cc6998608c96bec5d0c24d 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3159fd10ccea4bd5c1f0a36534250da4 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=73ebd87083c045ee655cc3534d8ea6da 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=5949c154fe60603955cf50a8d6f6ce85 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=ee42111f782ca7b86b9750f5ffa1b9bc 2500w">
  Access Data APIs Now for Free
</Card>


# Monitor Your Data APIs
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/getting-started/monitoring

How to monitor your data APIs performance and usage

This feature is coming soon.


# Perform Query
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/getting-started/perform-query

How to perform a query on a REST endpoint to retrieve onchain data

In this guide, we will walk you through the steps to perform a query on a REST endpoint to retrieve onchain data.

## Prerequisites

Before you begin, ensure you have the following:

* An API key
* A REST client (e.g., Postman, curl)

## Steps to Perform a Query

1. **Identify the endpoint URL**: The base URL for the API is `https://data-api.cloud.ormi.dev/somnia`.
2. **Add the endpoint path**: Append the specific endpoint path to the base URL, e.g., `v1/address/{walletAddress}/balance`.
3. **Include query parameters**: Add any necessary query parameters to the URL, e.g., `?param1=value1&param2=value2`.
4. **Set up headers**: Include the required headers, such as `Authorization` with your API key.
5. **Make the request**: Use your REST client to send a GET request to the constructed URL.

You may find all our API definitions in the [API Reference](/dedicated-env/somnia/data-apis/api-reference/balances/get-erc-20-balance) or access them below:

<Card title="Access Now" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=5772d9dbc682fe6ff18b2ac648a7e67f" href="/dedicated-env/somnia/data-apis/api-reference/balances/get-erc-20-balance" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/somnia-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=534f7cdc1fb4e8684a04372862ffc061 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=8d0e3d7430cc6998608c96bec5d0c24d 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3159fd10ccea4bd5c1f0a36534250da4 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=73ebd87083c045ee655cc3534d8ea6da 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=5949c154fe60603955cf50a8d6f6ce85 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=ee42111f782ca7b86b9750f5ffa1b9bc 2500w">
  Access Data APIs Now for Free
</Card>

***

## Example - Performing a Query to Fetch ERC20 Transfers

Here is an example of a query to retrieve the token balance of a wallet address on the Ethereum mainnet:

1. Identify the endpoint URL by navigating to the [API Reference](/dedicated-env/somnia/data-apis/api-reference/balances/get-erc-20-balance).

   <Frame>
     <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/erc20-transfers.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=9db5da0773febafdb17bbf8ba6c67e68" alt="Retrieve ERC20 transfers" data-og-width="2665" width="2665" data-og-height="2255" height="2255" data-path="images/0xAPI/erc20-transfers.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/erc20-transfers.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=4b34f7765aef693ec85e1cbc40aa01e0 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/erc20-transfers.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=2630ca60882a05b87991e30f8a418ffd 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/erc20-transfers.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=61b2ea90cda3bb98a96692c6a1f0ecbe 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/erc20-transfers.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=dbe912bce71d5f42c1aab6d6193d9e9c 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/erc20-transfers.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=57519d164fca5eea3704ada80a9e189d 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/erc20-transfers.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=60831e62754f75726e5113afaf15622a 2500w" />

     <figcaption>Retrieve ERC20 transfers</figcaption>
   </Frame>

2. Copy and paste the required endpoint path and query parameters into the editor, then click "Send" to make the request.

   <Frame>
     <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/perform-query.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=2d4a69182934e441a80bc9dda15aa18f" alt="Perform Query" data-og-width="2012" width="2012" data-og-height="2118" height="2118" data-path="images/0xAPI/perform-query.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/perform-query.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=97297acd0f0691970ca84935b0a89dc3 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/perform-query.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=11c707c93913501298527dee231a93ef 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/perform-query.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=6859140789d3080bb316250b60982eae 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/perform-query.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=71c559585204ad25b027dea070c5ea2b 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/perform-query.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=0ee41d9afb4249f614fcc29d68322d21 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/perform-query.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=9cc808c8ed5f1c4ca52f7b312d6f0666 2500w" />

     <figcaption>Perform query</figcaption>
   </Frame>

3. You may use any third-party tool such as curl or Postman to directly query the endpoint.

   <Frame>
     <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/curl.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=95c934286705686378f668f76729fb57" alt="Using Curl" data-og-width="1402" width="1402" data-og-height="292" height="292" data-path="images/0xAPI/curl.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/curl.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=fc09712a9e8c98fa31d6257e59851e51 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/curl.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=b0e6fdc67757083407d496be1a5e7e33 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/curl.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=eba6c1fd4c279b2894288693d968c29c 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/curl.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=4abb4ab4d52e9d9027f990c6835d28d1 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/curl.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=a1b957a5bfb6925c9c851063bd3a7477 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/curl.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=c22495a4dbc38f06611f3f1efbde2b53 2500w" />

     <figcaption>Using curl for query</figcaption>
   </Frame>

4. The API Reference page also provides handy code snippets for various programming languages to help you get started.
   <Frame>
     <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/languages.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=bd78192435a35ae9f2f98c4a7f591d58" alt="Using Other Programming Languages" data-og-width="1408" width="1408" data-og-height="1106" height="1106" data-path="images/0xAPI/languages.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/languages.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=0a2c41fc61612dee53c5f26ecfd9184c 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/languages.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=ff80f4e37480d205cef7fd325998eeb1 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/languages.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=71af9c680cfeb2937f1c5a79a0522958 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/languages.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=24c71b5e1f6ebc2cc1858faa831949f3 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/languages.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=ba599682a887ec3765969a85f9104ed3 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xAPI/languages.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=f6b4d7bef911e94ec7790939423ab6e9 2500w" />

     <figcaption>Using other programming languages</figcaption>
   </Frame>


# Overview
Source: https://docs.ormilabs.com/dedicated-env/somnia/data-apis/overview

The one-stop REST API solutions for standard and structured blockchain data access.

0xAPI provides a comprehensive suite of data APIs and development tools designed to simplify Web3 integration for Somnia Network.

<Card title="Access Now" img="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=5772d9dbc682fe6ff18b2ac648a7e67f" href="/dedicated-env/somnia/data-apis/api-reference/balances/get-erc-20-balance" data-og-width="328" width="328" data-og-height="119" height="119" data-path="images/chain-logos/somnia-icon-padding.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=280&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=534f7cdc1fb4e8684a04372862ffc061 280w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=560&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=8d0e3d7430cc6998608c96bec5d0c24d 560w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=840&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=3159fd10ccea4bd5c1f0a36534250da4 840w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=1100&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=73ebd87083c045ee655cc3534d8ea6da 1100w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=1650&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=5949c154fe60603955cf50a8d6f6ce85 1650w, https://mintcdn.com/ormilabs/BLe_GGMAArQ1xyMR/images/chain-logos/somnia-icon-padding.svg?w=2500&fit=max&auto=format&n=BLe_GGMAArQ1xyMR&q=85&s=ee42111f782ca7b86b9750f5ffa1b9bc 2500w">
  Access Data APIs Now for Free
</Card>

Built on the enterprise-grade, highly available Ormi data layer, these Somnia Data APIs deliver structured on-chain data at the edge through robust interfaces, SDKs, and real-time streaming. Key features include:

* Token balance retrieval
* Access to historical transaction data
* Decoded event log insights
* Detailed traces with internal transactions, state changes, and input data (for foundational chains)

0xAPI provides developers with powerful tools to simplify and enhance web3 application development. Whether you're building wallets, NFT marketplaces, DeFi platforms, or blockchain explorers, these APIs offer comprehensive access to blockchain data across multiple chains. From tracking token balances and historical transactions to managing NFTs and enabling cross-chain functionality, Ormi APIs streamline the integration of critical features. With a focus on flexibility, security, and real-world utility, this toolkit empowers developers to create innovative solutions for a decentralized future.

## Summary of the Data APIs:

0xAPI enables developers to quickly and easily access structured onchain data. This means consistent response schemas that are blockchain agnostic. Available APIs and corresponding use cases include:

### Wallet API

**Features:** Retrieve all token balances (ERC20, ERC721, ERC1155, and native tokens), token transfers, and both current and historical token prices.\
**Use Cases:** Ideal for wallets, portfolio management tools, token gating systems, and airdrop snapshot functionality.

### Transactions API

**Features:** Comprehensive access to all historical transactions with easily interpretable log events, including gas usage and spending summaries.\
**Use Cases:** Perfect for accounting and tax solutions, as well as generating custom in-app transaction receipts.

### NFT API

**Features:** Access to media assets, metadata, sales data, ownership details, trait and attribute filters, and thumbnail previews.\
**Use Cases:** Designed for NFT galleries, marketplaces, real-world asset (RWA) tracking, and token gating mechanisms.

### Cross-Chain API

**Features:** Simplified APIs for retrieving wallet activity across multiple chains in a single call, including cross-chain transaction and balance data.\
**Use Cases:** Streamlined app onboarding and consolidated wallet activity feeds.

### Blockchain API

**Features:** Provides block details, log events by contract address or topic hash, gas price data, token price insights, and holder statistics.\
**Use Cases:** Tailored for building custom blockchain explorers.

### Security API (Coming Soon)

**Features:** Detailed insights into NFT and ERC20 token allowances, including value-at-risk calculations.\
**Use Cases:** Supports wallet revoke features and advanced security applications.


# Create tag
Source: https://docs.ormilabs.com/dedicated-env/somnia/subgraphs/api-reference/create-tag

POST /public_api/v1/0xgraph/create_tag



# Delete tag
Source: https://docs.ormilabs.com/dedicated-env/somnia/subgraphs/api-reference/delete-tag

POST /public_api/v1/0xgraph/delete_tag



# Query tag
Source: https://docs.ormilabs.com/dedicated-env/somnia/subgraphs/api-reference/query-tag

POST /public_api/v1/0xgraph/query_tag



# Remove subgraph
Source: https://docs.ormilabs.com/dedicated-env/somnia/subgraphs/api-reference/remove-subgraph

POST /public_api/v1/0xgraph/remove_subgraph

<Note>
  ⚠️ CLI deletion is temporarily unsupported. Use the Ormi Dashboard UI to remove subgraphs.
</Note>


# Cheat Sheet
Source: https://docs.ormilabs.com/dedicated-env/somnia/subgraphs/cheatsheet

Streamlined Guide: Deploying Subgraphs on 0xGraph with The Graph CLI

## Overview

This quick start guide outlines streamlined instructions for deploying Subgraphs using the Command Line Interface (CLI). Developers looking to swiftly incorporate Subgraph capabilities into their projects will find straightforward guidance and pro tips for getting set up fast.

<Info>
  This cheat sheet condenses essential commands, tips, and best practices into
  an indispensable reference for anyone deploying a Subgraph. Developers will
  find this streamlined guide invaluable for swiftly progressing through the
  deployment workflow and resolving frequent pain points. With key information
  consolidated in one place, engineers can deploy Subgraphs more efficiently and
  focus their efforts on building applications powered by real-time,
  customizable blockchain data indexes.
</Info>

## 1. Get started by installing The Graph CLI

Download The Graph CLI via npm

```bash  theme={null}
npm i @graphprotocol/graph-cli
```

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="https://www.npmjs.com/package/@graphprotocol/graph-cli">
  Install The Graph npm package
</Card>

## 2. Generate API key

Create an API key: Visit [0xGraph Dashboard](https://somnia.0xgraph.xyz/dashboard/api) to generate your API key

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

## 3. Generate types and mappings for your Subgraph

Go to your Subgraph root directory where `subgraph.yaml` file is located

```bash  theme={null}
cd <your_subgraph_project>
```

Run the following command to generate AssemblyScript types for smart contract ABIs and the subgraph schema

```bash  theme={null}
graph codegen
```

## 4. Compile your Subgraph

Run the following command to compile your Subgraph into WASM (WebAssembly)

```bash  theme={null}
graph build
```

## 5. Deploy your Subgraph to 0xGraph

Paste the API key generated in step 2 and run the following command to deploy your Subgraph to 0xGraph

```bash  theme={null}
graph deploy <your_subgraph> --node
https://api.subgraph.somnia.network/deploy
--ipfs https://api.subgraph.somnia.network/ipfs
--deploy-key <api_key>
```

<Info>
  If prompted to enter the version, use the version of The Graph CLI that you
  downloaded.
</Info>

You can now monitor your Subgraph deployment in the 0xGraph app

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-analytics.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=a8e56d4f59b89c4e0915616c49d38bbd" alt="Subgraph analytics page" data-og-width="3278" width="3278" data-og-height="1834" height="1834" data-path="images/somnia/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-analytics.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=34a15e1ee4db81e68671139134921232 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-analytics.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=856e564ae9b2d6ae6883ae049e2cbffb 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-analytics.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=6f659bdaa5d35b481ea6792f8c001516 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=6da9b30871385c84e8da820f65152cd6 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=3ef5e3a59c58bd348e6a5423c68d805d 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=dca1cfefe26e5c8b569a32af379a01a7 2500w" />
</Frame>

## Quick Start in the App

The [0xGraph Web App](https://somnia.0xgraph.xyz) also offers a concise guide to assist users in deploying their Subgraphs effectively

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-quickstart.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=1428c84a3aa691d30368a1e66115e39e" alt="Subgraph analytics page" data-og-width="1000" width="1000" data-og-height="516" height="516" data-path="images/somnia/0xgraph-quickstart.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-quickstart.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=feb2f15b21e3575f2ee77cc324548f13 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-quickstart.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=aba6f5afdf73497c19d0470e7fb1a82a 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-quickstart.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=3ee58ee8ea73e97ad9d66fef2a8bde6d 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-quickstart.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=c0cb8e1f69f08e1432917e1e9df0b4ed 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-quickstart.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=223ed4779dce59c4d226ef7ea7daf484 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-quickstart.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=4433d52c57a5d4b1e9ee4cb6189ca8d5 2500w" />
</Frame>


# Account Creation
Source: https://docs.ormilabs.com/dedicated-env/somnia/subgraphs/getting-started/account-creation

How to create your 0xGraph account

## Setup Steps

### 1. Create Account

Visit [somnia.0xgraph.xyz](https://somnia.0xgraph.xyz) to create your account.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-signup.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=fa152815463aff23d82e148d2f2adb8b" alt="Somnia App Registration" data-og-width="3400" width="3400" data-og-height="1780" height="1780" data-path="images/somnia/0xgraph-signup.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-signup.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=a272100ac63f32e1e0fc50af1fe32be4 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-signup.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=ffa65036ed4ca5e9fd2e0ffc285a6d1e 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-signup.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=173c4a88520f6030817b707a61da2c4d 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-signup.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=6473bb8a2ceb6b4b4c61253103e45ed7 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-signup.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=94fa2d0180f892e00d0842a32fc7bf32 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-signup.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=476c690cabdaf3fcacc008c50fde08e5 2500w" />
</Frame>

### 2. Choose Subscription Plan

Choose a plan that best fits your needs in [Settings page](https://somnia.0xgraph.xyz/dashboard/settings).

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-pricing.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=cbc5eafaca7221e19f60944b51d8bc45" alt="Somnia Subscription Plans" data-og-width="3468" width="3468" data-og-height="1810" height="1810" data-path="images/somnia/0xgraph-pricing.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-pricing.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=a0b420615890408a8a79a6a45d43a603 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-pricing.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=0367c6e8d94ae554afa3aed68616ef86 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-pricing.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=eca6347de33c6bc8d75873ec6aa07f1d 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-pricing.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=a688f6d50fa2766c33e9863ec5945144 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-pricing.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=af58301821314b607ee0c6b849d63574 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-pricing.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=a70b2064233bfdb54014c0155f042b07 2500w" />

  <figcaption>Choose a subscription plan</figcaption>
</Frame>

### 3. Generate API Key

Go to the [API Keys Page](https://somnia.0xgraph.xyz/dashboard/api) to create your API key.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-api-key.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=b32283b245f9d591c860c05e57208476" alt="Somnia API Keys" data-og-width="3488" width="3488" data-og-height="1846" height="1846" data-path="images/somnia/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-api-key.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=ea7e27e70ce32a8f3b9ff50e089012c4 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-api-key.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=1010fd79a845f1aecb9b2fe8eda5ecc1 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-api-key.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=b73f51cf777470b9b602312d972d5b38 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=dbeb319c24b289c564d1de5795eff490 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=5be2993d183bda6945843cf48ee6d7f1 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=c70eef758dbd21165cf0cbbb2b1d4ce5 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

After clicking the 'Create API Key' button in the top-right corner, your API key will be generated. You can then copy and paste it into your commands as needed.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-generated-api-key.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=3965977d6a01dec9169303e3c92b57bc" alt="Somnia API Keys" data-og-width="3430" width="3430" data-og-height="1832" height="1832" data-path="images/somnia/0xgraph-generated-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-generated-api-key.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=4843c55d48f641a6b6f2b912d04c07fb 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-generated-api-key.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=45eb62f946bff06e03c8c07d1412d703 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-generated-api-key.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=2d441927ca1c837a92f405a20b4f92ad 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-generated-api-key.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=c998f74c34285ba939d44609993fb4dc 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-generated-api-key.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=6219d5c2575e91f09f8a5d8445b08b37 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-generated-api-key.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=5396092912848640d78d0f2f7703227b 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

<Info>
  Warning: Always handle your API keys securely. Do not expose them in
  client-side code or share them publicly. Store them in a secure location, such
  as environment variables, and rotate them regularly to minimize security
  risks. If compromised, regenerate your API key immediately. For public
  repositories, store API keys in a .env file and add .env to .gitignore to
  prevent accidental exposure in your codebase.
</Info>

You are all set and ready to go for deploying a subgraph.


# CLI Usage
Source: https://docs.ormilabs.com/dedicated-env/somnia/subgraphs/getting-started/cli-usage

A detailed list of all active and relevant commands for The Graph CLI, including their purposes, use cases, and examples.

## `graph init`

**Purpose:**\
Creates a new Subgraph project using an example template or an existing smart contract.

**Use Case:**

* Use this command when starting a new Subgraph project.
* It sets up the necessary folder structure, configuration files `subgraph.yaml`, and example code.
* You can specify a contract address and network to scaffold a Subgraph tailored to a specific smart contract.

**Example:**

```bash  theme={null}
graph init --from-contract <CONTRACT_ADDRESS> --network mainnet
```

## `graph codegen`

**Purpose:**\
Generates AssemblyScript types for smart contract ABIs and the Subgraph schema.

**Use Case:**

* Use this command after making changes to your `schema.graphql` file or when adding/updating smart contract ABIs.
* It creates type-safe classes that make it easier to interact with blockchain data in your mappings.

## `graph build`

**Purpose:**\
Compiles the Subgraph to WebAssembly (WASM), preparing it for deployment.

**Use Case:**

* Run this command after completing your mappings and configuration.
* It ensures your Subgraph is ready for deployment by converting it into the WASM format required by 0xGraph.

## `graph deploy`

**Purpose:**\
Deploys the compiled Subgraph to the 0xGraph hosting service.

**Use Case:**

* After building your Subgraph, use this command to upload and activate it on 0xGraph.
* Specify the deployment target (e.g., staging or production) and the Subgraph name.

**Example:**

```bash  theme={null}
graph deploy <your_subgraph> --node
https://api.subgraph.somnia.network/deploy
--ipfs https://api.subgraph.somnia.network/ipfs
--deploy-key <your_api_key>
```

## `graph local`

**Purpose:**\
Runs a local test environment (e.g., using Ganache or Hardhat) to test the Subgraph with simulated blockchain data.

**Use Case:**

* Use this command when developing and testing your Subgraph locally.
* It allows you to simulate blockchain events and validate mappings.
* Ideal for testing without deploying to a live environment.

## `graph test`

**Purpose:**\
Downloads and runs the Matchstick Rust binary to execute unit tests for a Subgraph.

**Use Case:**

* Use this command to write and run unit tests for your mappings and ensure that your Subgraph logic works correctly.
* Matchstick is a testing framework built specifically for The Graph.

## `graph add`

**Purpose:**\
Adds a new data source to your Subgraph’s manifest file (subgraph.yaml) and updates relevant files such as schema.graphql, ABIs, and mappings.

**Use Case:**

* Use this command when adding additional smart contracts or data sources to your Subgraph.
* It automates the process of updating your Subgraph configuration and related files.

**Example:**

```bash  theme={null}
graph add <CONTRACT_NAME> --from-contract <CONTRACT_ADDRESS>
```

<Info>
  Ensure you have the latest version of The Graph CLI installed to avoid
  potential issues with deprecated or updated commands.
</Info>


# Deploy a Subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/somnia/subgraphs/getting-started/deploy-subgraph-graph-cli

Quick start guide for deploying a Subgraph using the Command Line Interface (CLI).

<Info>
  The Graph CLI is an essential tool enabling developers to seamlessly create,
  deploy, and manage subgraphs—providing streamlined blockchain data querying
  and indexing. It gives you superuser access to our enterprise-grade subgraph
  infrastructure. Additionally, we are fully compatible with The Graph's
  tooling, and the CLI works seamlessly out of the box with our platform.
</Info>

## Deployment Network Definitions

For developers who are already familiar with Graph Protocol tooling, below are the network definitions to deploy subgraphs on 0xGraph. These settings can be configured in the subgraph.yaml file:

## Installation

<Steps>
  <Step title="Install CLI Package">
    <CodeGroup>`npm i @graphprotocol/graph-cli `</CodeGroup>
  </Step>
</Steps>

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="_blank">
  Install the graph npm package
</Card>

## Generate API Key

Create an API key: Visit [0xGraph Dashboard](https://somnia.0xgraph.xyz/dashboard/api) to generate your API key. For a comprehensive tutorial on generating API keys, visit the [Account Creation Page](/dedicated-env/somnia/subgraphs/getting-started/account-creation).

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

***

## Create your own Subgraph

Details regarding creating your own Subgraph is beyond the scope of this documentation. The Graph's official documentation provides detailed guides and examples for each step of the Subgraph creation process. It also covers advanced topics such as indexing strategies, filtering, and pagination. We recommend referring to their documentation for a comprehensive reference on Subgraph development with The Graph.

## Core Components

A typical Subgraph project has the following components:

<CardGroup cols={2}>
  <Card title="Manifest File" icon="file-lines">
    The `subgraph.yaml` manifest file serves as the root configuration, containing smart contract references, entity mappings, handler functions, and deployment parameters like `startBlock` and `description`.
  </Card>

  {' '}

  <Card title="Schema File" icon="database">
    The `schema.graphql` file defines all the entities and their relationships for
    your Subgraph's GraphQL API, determining what blockchain data will be indexed
    and made queryable.
  </Card>

  <Card title="Mappings File" icon="code">
    Written in [AssemblyScript](https://www.assemblyscript.org/), a TypeScript-like language specifically designed for WebAssembly, the mappings file transforms raw blockchain data into structured entities that match your GraphQL schema through a set of data handling functions.
  </Card>
</CardGroup>

<Note>
  Messari maintains a [well-curated GitHub
  repository](https://github.com/messari/subgraphs) that offers a comprehensive
  collection of example Subgraphs, which serves as a valuable resource for those
  seeking to start their subgraph development journey.
</Note>

***

## Subgraph Compilation

<Steps>
  <Step title="Generate Types and Mappings">
    <Note>
      The codegen step generates code files for indexing and querying data based on your schema and mappings.
    </Note>

    Run in your project root:

    ```bash  theme={null}
    graph codegen
    ```

    Success output:

    ```bash  theme={null}
        Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
        Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
        Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
        Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
        Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
        Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
        Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
      ✔ Apply migrations
      ✔ Load subgraph from subgraph.yaml
        Load contract ABI from abis/factory.json
        Load contract ABI from abis/ERC20.json
        Load contract ABI from abis/ERC20SymbolBytes.json
        Load contract ABI from abis/ERC20NameBytes.json
      ✔ Load contract ABIs
        Generate types for contract ABI: Factory (abis/factory.json)
        Generate types for contract ABI: ERC20 (abis/ERC20.json)
        Generate types for contract ABI: ERC20SymbolBytes (abis/ERC20SymbolBytes.json)
        Generate types for contract ABI: ERC20NameBytes (abis/ERC20NameBytes.json)
        Write types to generated/Factory/Factory.ts
        Write types to generated/Factory/ERC20.ts
        Write types to generated/Factory/ERC20SymbolBytes.ts
        Write types to generated/Factory/ERC20NameBytes.ts
      ✔ Generate types for contract ABIs
        Generate types for data source template Pair
        Write types for templates to generated/templates.ts
      ✔ Generate types for data source templates
        Load data source template ABI from abis/pair.json
        Load data source template ABI from abis/factory.json
      ✔ Load data source template ABIs
        Generate types for data source template ABI: Pair > Pair (abis/pair.json)
        Generate types for data source template ABI: Pair > Factory (abis/factory.json)
        Write types to generated/templates/Pair/Pair.ts
        Write types to generated/templates/Pair/Factory.ts
      ✔ Generate types for data source template ABIs
      ✔ Load GraphQL schema from schema.graphql
        Write types to generated/schema.ts
      ✔ Generate types for GraphQL schema

      Types generated successfully
    ```

    <Accordion title="Codegen Options">
      <Info>
        View all options with `graph codegen --help`:
      </Info>

      ```bash  theme={null}
      USAGE
        $ graph codegen [SUBGRAPH-MANIFEST] [-h] [-o <value>] [--skip-migrations] [-w] [--uncrashable-config <value> -u]

      FLAGS
        -h, --help                    Show CLI help.
        -o, --output-dir=<value>      [default: generated/] Output directory for generated types.
        -u, --uncrashable             Generate Float S
                                      subgraph Uncrashable helper file.
        -w, --watch                   Regenerate types when subgraph files change.
        --skip-migrations             Skip subgraph migrations.
        --uncrashable-config=<value>  Directory for uncrashable config.
      ```
    </Accordion>
  </Step>

  <Step title="Build Your Subgraph">
    After generating types, build your subgraph:

    ```bash  theme={null}
    graph build
    ```

    Success Output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/

    Build completed: build/subgraph.yaml
    ```

    <Accordion title="Build Options">
      <Info>
        View all options with `graph build --help`:
      </Info>

      ```bash  theme={null}
      Builds a subgraph and (optionally) uploads it to IPFS.

        USAGE
          $ graph build [SUBGRAPH-MANIFEST] [-h] [-i <value>] [-o <value>] [-t wasm|wast]
            [--skip-migrations] [-w] [--network <value>] [--network-file <value>]

        FLAGS
          -h, --help                    Show CLI help.
          -i, --ipfs=<value>            Upload build results to an IPFS node.
          -o, --output-dir=<value>      [default: build/] Output directory for build results.
          -t, --output-format=<option>  [default: wasm] Output format for mappings.
                                        <options: wasm|wast>
          -w, --watch                   Regenerate types when subgraph files change.
          --network=<value>             Network configuration to use from the networks config file.
          --network-file=<value>        [default: networks.json] Networks config file path.
          --skip-migrations             Skip subgraph migrations.

      DESCRIPTION
      Builds a subgraph and (optionally) uploads it to IPFS.

      ```
    </Accordion>
  </Step>

  <Step title="Deploy your Subgraph">
    Then deploy your Subgraph:

    ```bash  theme={null}
    graph deploy <your_subgraph> --node
    https://api.subgraph.somnia.network/deploy
    --ipfs https://api.subgraph.somnia.network/ipfs
    --deploy-key <your_API_key>
    ```

    Success output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/
      Add file to IPFS build/schema.graphql
                    .. Qmckrwbgbx3FjsVH4AU8xP3zgdg3rPnzNo7pmApAmhQkA4
      Add file to IPFS build/Factory/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9
      Add file to IPFS build/Factory/ERC20.json
                    .. QmPfKNZPkVATzL3EHypkcsyKhehR4jkiYEVqSzh2hxWYj1
      Add file to IPFS build/Factory/ERC20SymbolBytes.json
                    .. QmbHnhUFZa6qqqRyubUYhXntox1TCBxqryaBM1iNGqVJzT
      Add file to IPFS build/Factory/ERC20NameBytes.json
                    .. QmQCP6Pdp1MqpwRv2qoPHuUTwZGy7Q3eDHg4w5kzwE9mBj
      Add file to IPFS build/Factory/Factory.wasm
                    .. QmNksN9HGSyMfc4XrjQeHuDKsBQk1xHEKVE2dLwHQQu4kb
      Add file to IPFS build/Pair/pair.json
                    .. QmbPLMADBP8L6LBVP3ZBQ8RgG7ghamD8DvbdUxHAjZrLgm
      Add file to IPFS build/Pair/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9 (already uploaded)
      Add file to IPFS build/templates/Pair/Pair.wasm
                    .. QmSZSUoNinhNshD26iwKyzut6s3w5Lmec3P9szBovfQg8V
    ✔ Upload subgraph to IPFS

    Build completed: QmdXJQUxgrzP8pVotTqiwirJ6NxfmdNdQ6rWQv2rmJpBQp

    Deployed to /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn

    Subgraph endpoints:
    Queries (HTTP):     /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn
    ```
  </Step>
</Steps>

<Card title="View Your Subgraphs" icon="browser">
  Access your deployed Subgraphs through the web-based UI at [somnia.0xgraph.xyz](http://somnia.0xgraph.xyz)
</Card>

```
```


# Deploy a token transfer subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/somnia/subgraphs/getting-started/deploy-token-transfer-subgraph

Tutorial on how to deploy an erc20 token transfer subgraph with the Graph CLI



# Monitor Your Subgraph
Source: https://docs.ormilabs.com/dedicated-env/somnia/subgraphs/getting-started/monitor-subgraph

Learn how to monitor your subgraph syncing progress and logs after deployment

# Monitor your subgraph via the Analytics Page

After deploying your subgraph, you can easily monitor the syncing progress and subgraph logs for up to 48 hours to gain insight and troubleshoot any issues that may come with your subgraph.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-monitor.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=1402a7460ad83e597fbcbe07839ae311" alt="Subgraph deployment view" data-og-width="3302" width="3302" data-og-height="914" height="914" data-path="images/somnia/0xgraph-monitor.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-monitor.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=a1120284cb4eea7f1e6ab6b447f6778a 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-monitor.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=51671e5716e15b156eca956ef016dacf 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-monitor.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=854b9b3156c4d74c734c928342c45e27 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-monitor.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=860c361722246d9f9063566968948fed 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-monitor.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=72ea01df6064ad1bb99f02e2e680abd6 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-monitor.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=5ddf479213f5c6545b2e1a80945ca64f 2500w" />
</Frame>

You can access your deployed subgraph analytics page by clicking on the subgraph name; afterward, you will be directed to the following analytics page.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-analytics.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=a8e56d4f59b89c4e0915616c49d38bbd" alt="Subgraph analytics page" data-og-width="3278" width="3278" data-og-height="1834" height="1834" data-path="images/somnia/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-analytics.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=34a15e1ee4db81e68671139134921232 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-analytics.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=856e564ae9b2d6ae6883ae049e2cbffb 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-analytics.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=6f659bdaa5d35b481ea6792f8c001516 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=6da9b30871385c84e8da820f65152cd6 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=3ef5e3a59c58bd348e6a5423c68d805d 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=dca1cfefe26e5c8b569a32af379a01a7 2500w" />
</Frame>


# Perform Query
Source: https://docs.ormilabs.com/dedicated-env/somnia/subgraphs/getting-started/perform-query

Short description on what this section is about

After deploying your subgraph, you can easily access and query it via GraphQL playground for query. You can open the "GraphQL API" link in your dashboard to access your data.

For example, you may access the publicly available Somnia token approval subgraph at `https://api.subgraph.somnia.network/subgraphs/name/token-transfer/graphql`

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-graphql.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=e5d989f904cc8c4806c97f1b54110d82" alt="GraphQL" data-og-width="1847" width="1847" data-og-height="867" height="867" data-path="images/somnia/0xgraph-graphql.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-graphql.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=0de2dbd739b36a4e2212787d7ed269bc 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-graphql.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=604bcdb20b60e4ec08a5f878b5c05b93 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-graphql.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=00480f4ff2a5d06a9940fa780d52170e 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-graphql.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=38ac077fb9f8864ed8032c0c04e62f23 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-graphql.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=258f65ff4f4645968c4f94c4ebbbc83f 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/somnia/0xgraph-graphql.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=67ccb3e2c9b5c612107994c2fdc766b6 2500w" />
</Frame>

***

## Query for Subgraph Sync Status

To get to know the sync status directly inside the subgraph, a user may run the following query by using `_meta`:

```graphql  theme={null}
{
  _meta {
    block {
      hash
      timestamp
      number
    }
  }
}
```

The result would be similar to the following:

```json  theme={null}
{
  "data": {
    "_meta": {
      "block": {
        "hash": "0x9f2480d4a21fb9743ae35d349fccbc86c0fad084d6a87b53d1f649f1051c6ddb",
        "timestamp": 1700267031,
        "number": 151479342
      }
    }
  }
}
```

***

## Query a Subgraph

Subgraphs expose blockchain data via a GraphQL API, making it easy for anyone familiar with the GraphQL language to get started.

A GraphQL API differs from traditional REST APIs in that it relies on a schema definition to outline the available queries, mutations, and data types that clients can access.

## Benefits of Schema-Driven Approach

This schema-driven approach enables clients to precisely specify the data they need, eliminating the need to over-fetch data. Here's why this is beneficial:

<CardGroup>
  <Card title="Precision" icon="bullseye">
    GraphQL clients can tailor their queries to retrieve only the data they require, enhancing efficiency.
  </Card>

  <Card title="Flexibility" icon="arrows-to-circle">
    Clients can request related data in a single query, reducing the number of API calls needed.
  </Card>

  <Card title="Predictability" icon="chart-line">
    The schema provides clear documentation for available data and operations.
  </Card>
</CardGroup>

## GraphQL Syntax

GraphQL queries are composed using a specific syntax that allows for hierarchical data retrieval. Clients specify the fields they want to retrieve and their relationships within a single query. This approach minimizes unnecessary data retrieval, resulting in more concise and efficient requests.

## Best Practices

When working with the 0xGraph service, it's essential to follow best practices to ensure optimal performance and efficiency. These best practices are outlined in official Graph Protocol documentation.

<Info>
  For detailed instructions on querying 0xGraph using GraphQL and to ensure adherence to best practices, refer to the [official
  documentation](https://thegraph.com/docs/en/querying/querying-best-practices/) provided by the Ormi Labs and Graph Protocol teams. These resources offer
  valuable insights and recommendations to streamline your interaction with blockchain data through GraphQL.
</Info>


# Private Graphql URL
Source: https://docs.ormilabs.com/dedicated-env/somnia/subgraphs/getting-started/private-url

Learn how to create a private GraphQL URL for your subgraph

## Private Graphql URL

When you deploy a new subgraph, a public GraphQL endpoint is provided by default. However, you can also create a private endpoint for your subgraph, which requires an authentication token for requests. This private endpoint ensures that only authorized users or applications can access your subgraph's data, maintaining data security and control.

## Enable Private GraphQL Link

To use the private endpoint, you first need to enable it in your subgraph's detail on the 0xGraph console.

1. Navigate to your project details page.
2. Find the "PRIVATE GRAPHQL LINK" section.
3. Toggle the switch to "Enabled".

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=560e6af6112a63cffb865cbc60afd565" alt="Enable Private URL" width="700" data-og-width="1229" data-og-height="834" data-path="images/how-to/private.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=84eabc519189ef2a3b52f280ff7e2646 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a44106946348f0dcaf322b5b35e66c41 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6dcfd639d6e2d14fdacf34fc469e0afd 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e8470fabfb0845232d16b5434ada8136 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=93dc339e9fdfbd6dcc7ed4ad027c6baf 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=aee1e2143fe2327a40640aacd8e8b906 2500w" />

## Find Your Private URL

Once enabled, your unique private GraphQL URL will be displayed. You can also find this URL listed on the main page of your project environment under the "PRIVATE GRAPHQL LINK" column.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=45d17f6b83f1234c38290ece93132fab" alt="Private URL List" width="700" data-og-width="1881" data-og-height="880" data-path="images/how-to/private2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=170c03e25794a0fa9099ae07c2ce6f67 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a733750201ba10c93bb3d985c5b775de 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=c0b478fca2ec7586f8f12db7bf9434e6 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a0e72f5d6ff87f1768e3688ed1995abb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f478e814674d0454cf0d1eb46704f1c3 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f7fb3ddbec13791ab5948282de354b3e 2500w" />

## Authentication

To query your private GraphQL endpoint, you must include an authentication token in the request header.

1. Obtain your API key from the 0xGraph console API Keys.
2. In your GraphQL client (like GraphiQL or Postman), add an `Authorization` header.
3. Set the header value to `Bearer YOUR_API_KEY`, replacing `YOUR_API_KEY` with the actual key.

Here's how it looks in the GraphiQL interface provided by 0xGraph:

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b36c81515bf5633e8446b1a9bc18a852" alt="Private URL Token" width="700" data-og-width="1261" data-og-height="836" data-path="images/how-to/private3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=62296e918593924606edca6ea9bb0e52 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7b7d3af194a2243c9a63ddd31c209e5c 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=87e773a3ca3156ba9ab3700bb365713d 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a5d877ffa5cc966da46065fa94a2ed90 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e4f121ec83725881815c920ece44b3d1 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=67f6cb202406476251abef74a4f70e3f 2500w" />

By following these steps, you can securely interact with your subgraph using its private GraphQL endpoint.


# Subgraph Webhooks
Source: https://docs.ormilabs.com/dedicated-env/somnia/subgraphs/getting-started/webhook

Learn how to create and manage webhooks for your subgraphs to receive real-time updates.

## Subgraph Webhooks

Subgraph webhooks allow you to receive HTTP POST requests in real-time whenever an entity in your subgraph changes due to an `INSERT`, `UPDATE`, or `DELETE` operation. This is useful for triggering backend processes, sending notifications, or syncing data with external systems.

## How it Works

When a subgraph handler executes an operation like `entity.save()` (resulting in an `INSERT` or `UPDATE`) or an entity is removed (resulting in a `DELETE`), the change is recorded. A real-time watcher detects this update and sends a payload to your configured webhook URL. The payload will indicate the type of operation: `INSERT`, `UPDATE`, or `DELETE`.

## Creating a Webhook

You can create a new webhook through the 0xGraph dashboard.

1. Navigate to the "Webhooks" section of your subgraph.

2. Click on the "New Webhook" button.

3. Fill in the required information in the "Create Webhook" modal:

   * **Name**: A descriptive name for your webhook (e.g., `webhook_demo`).
   * **URL**: The HTTP endpoint where the webhook payloads will be sent.
   * **Entity**: The specific entity you want to track (e.g., `approved`).
   * **Number of retries**: Configure the total number of retries. Defaults to 3, with a maximum of 10.
   * **Retry interval**: Configure the retry interval in seconds. Defaults to 60, with a maximum of 3600.
   * **Retry timeout**: Configure the retry timeout in seconds. Defaults to 30, with a maximum of 60.
   * **"secret" header value**: An optional secret string that will be sent in a designated webhook secret header. This allows your endpoint to verify that the request is authentic.

   <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9234eae31186a5b6f649ed942830ff6c" alt="Create Webhook Modal" data-og-width="1872" width="1872" data-og-height="879" height="879" data-path="images/how-to/webhook.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9f6074a41fc7104edd1f8a831dcf426b 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=70599e318f7d4dbb52bd9b9271f5fb9b 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=12c058b62fbe1aad60ae53b93b4edb0f 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d09122a7d15636238f837d4fb83fb9cb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d4299f143c74dac74aefe4d276549743 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9b8b5cfcba5dbd305b27b026d77ab5d4 2500w" />

4. Click "Create".

## Listing Webhooks

Once created, your webhook will appear in the list of webhooks for your subgraph. You can see its name, the entity it tracks, the target URL, and statistics about successful and failed deliveries.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=1a8a8610f0aa060edd6cec706e366d69" alt="Webhook List" data-og-width="1000" width="1000" data-og-height="818" height="818" data-path="images/how-to/webhook3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=fba9d6def6020d6c02eacc3c4670f763 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ee4af7ca24eeadf9bfab5bde38ab1811 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6e22347e0fe60c0d103c87000e981f06 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=59a7e24f1e30c3da890b3ea603216cc5 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ac5ba543c4c479ce7052f173ee858471 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6887464b8fb3a4b2866c91c8f90a8cb7 2500w" />

## Webhook Payload Structure

The webhook will send a JSON payload to your configured URL. The main payload object contains the following fields:

* `op` (string): The type of operation that triggered the webhook. Possible values are `"INSERT"`, `"UPDATE"`, or `"DELETE"`.
* `data_source` (string): Identifier for the subgraph or indexer being tracked.
* `data` (object): Contains the actual entity data that changed. It has two sub-fields:
  * `old` (object | null): The state of the entity before the change. This will be `null` if the `op` is `"INSERT"`.
  * `new` (object | null): The state of the entity after the change. This will be `null` if the `op` is `"DELETE"`.
* `webhook_name` (string): The name you assigned to your webhook during creation.
* `webhook_id` (string): A unique identifier for the webhook configuration.
* `id` (string): A unique identifier for this specific event notification.
* `delivery_info` (object): Information about the delivery attempt for this webhook. It has two sub-fields:
  * `max_retries` (integer): The maximum number of retry attempts configured for this webhook.
  * `current_retry` (integer): The current retry attempt number for this specific event (0 for the initial attempt).
* `entity` (string): The name of the subgraph entity being tracked.

### Example Payloads:

**`INSERT` operation:**

```json  theme={null}
{
  "op": "INSERT",
  "data_source": "privateURL/v0.0.1",
  "data": {
    "new": {
      "id": "ERC20Approve-0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc-w\\u001c\\u001b\\u0002\\ufffd\\ufffd\\ufffd\\u07Ջ^\\ufffdcO\\ufffd\\ufffd(7C\\u001c\\u001b-\\ufffd\\u0016僞\\ufffdm\\ufffd\\ufffdI+y\\ufffd\\ufffd^\\u0015\\ufffd\\ufffdY\\ufffd",
      "vid": 7271978,
      "owner": "\\\\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc",
      "amount": 1.157920892373162e+77,
      "is_all": false,
      "spender": "\\\\xbde5839ec36db2ac492b79e9e3b75e15fa8a59ec",
      "updated_at": 1747127781,
      "block_range": "[20405156,)"
    },
    "old": null
  },
  "webhook_name": "webhook_demo",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "id": "5b623fd0-b539-400b-bbb3-060d95403a64",
  "delivery_info": {
    "max_retries": 3,
    "current_retry": 0
  },
  "entity": "approved"
}
```

**`UPDATE` operation :**

```json  theme={null}
{
  "data": {
    "new": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,20405060)"
    },
    "old": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,)"
    }
  },
  "data_source": "privateURL/v0.0.1",
  "delivery_info": {
    "current_retry": 0,
    "max_retries": 3
  },
  "entity": "approved",
  "id": "dd2b6013-22e1-4e8e-a665-be5276144a68",
  "op": "UPDATE",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "webhook_name": "webhook_demo"
}
```


# 0xGraph - Reliable Subgraph Indexing
Source: https://docs.ormilabs.com/dedicated-env/somnia/subgraphs/overview



Deploy subgraphs with 99.9%+ availability and fetch smart contract data at 3x the speed. 100% spec-compliant with every subgraph on The Graph's hosted and decentralized networks.

## Overview

Subgraphs are customizable, open-source solutions for indexing and accessing real-time blockchain data through GraphQL APIs.

0xGraph is a zero-hassle subgraph hosting solution that is 100% spec-compliant with every subgraph on The Graph Protocol’s hosted and decentralized networks, minus the lag and downtime.

* Plug and play deployment and subgraph migration from hosted services.
* Deploy subgraphs with the same tooling, UI, and similar CLI as The Graph.
* Query subgraphs without running any nodes or infrastructure.

### Supported Networks

0xGraph currently supports the following networks:

| Name           | Type    | Network Slug     |
| -------------- | ------- | ---------------- |
| Somnia Testnet | Testnet | `somnia-testnet` |

### Available Upon Request

Any other network you need? Please email us: [hello@ormilabs.com](mailto:hello@ormilabs.com)


# Overview
Source: https://docs.ormilabs.com/dedicated-env/telos/data-apis/overview

Coming soon



# Create tag
Source: https://docs.ormilabs.com/dedicated-env/telos/subgraphs/api-reference/create-tag

POST /public_api/v1/0xgraph/create_tag



# Delete tag
Source: https://docs.ormilabs.com/dedicated-env/telos/subgraphs/api-reference/delete-tag

POST /public_api/v1/0xgraph/delete_tag



# Query tag
Source: https://docs.ormilabs.com/dedicated-env/telos/subgraphs/api-reference/query-tag

POST /public_api/v1/0xgraph/query_tag



# Remove subgraph
Source: https://docs.ormilabs.com/dedicated-env/telos/subgraphs/api-reference/remove-subgraph

POST /public_api/v1/0xgraph/remove_subgraph

<Note>
  ⚠️ CLI deletion is temporarily unsupported. Use the Ormi Dashboard UI to remove subgraphs.
</Note>


# Cheat Sheet
Source: https://docs.ormilabs.com/dedicated-env/telos/subgraphs/cheatsheet

Streamlined Guide: Deploying Subgraphs on 0xGraph with The Graph CLI

## Overview

This quick start guide outlines streamlined instructions for deploying Subgraphs using the Command Line Interface (CLI). Developers looking to swiftly incorporate Subgraph capabilities into their projects will find straightforward guidance and pro tips for getting set up fast.

<Info>
  This cheat sheet condenses essential commands, tips, and best practices into
  an indispensable reference for anyone deploying a Subgraph. Developers will
  find this streamlined guide invaluable for swiftly progressing through the
  deployment workflow and resolving frequent pain points. With key information
  consolidated in one place, engineers can deploy Subgraphs more efficiently and
  focus their efforts on building applications powered by real-time,
  customizable blockchain data indexes.
</Info>

## 1. Get started by installing The Graph CLI

Download The Graph CLI via npm

```bash  theme={null}
npm i @graphprotocol/graph-cli
```

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="https://www.npmjs.com/package/@graphprotocol/graph-cli">
  Install The Graph npm package
</Card>

## 2. Generate API key

Create an API key: Visit [0xGraph Dashboard](https://telos.0xgraph.xyz/dashboard/api) to generate your API key

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

## 3. Generate types and mappings for your Subgraph

Go to your Subgraph root directory where `subgraph.yaml` file is located

```bash  theme={null}
cd <your_subgraph_project>
```

Run the following command to generate AssemblyScript types for smart contract ABIs and the subgraph schema

```bash  theme={null}
graph codegen
```

## 4. Compile your Subgraph

Run the following command to compile your Subgraph into WASM (WebAssembly)

```bash  theme={null}
graph build
```

## 5. Deploy your Subgraph to 0xGraph

Paste the API key generated in step 2 and run the following command to deploy your Subgraph to 0xGraph

```bash  theme={null}
graph deploy <your_subgraph> --node
https://telosapi.0xgraph.xyz/deploy
--ipfs https://telosapi.0xgraph.xyz/ipfs
--deploy-key <api_key>
```

<Info>
  If prompted to enter the version, use the version of The Graph CLI that you
  downloaded.
</Info>

You can now monitor your Subgraph deployment in the 0xGraph app

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-analytics.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=61a6dc09453a862b4ab563314f7f5c95" alt="Subgraph analytics page" data-og-width="2520" width="2520" data-og-height="1848" height="1848" data-path="images/telos/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-analytics.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=5a5a2c0f4e029b4039fd1b37fdb287f6 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-analytics.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=adb7dca8bc31bac0d2325070153e72a2 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-analytics.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=2c62ffa5a51638a49ce4f7ab2ad84e8f 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=ef02e5a332c3a3a26d5f39b814709eb6 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=263b83cfdfa18c29cb96ed94c76071b9 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=4b32fe3774c7ee8e57c8f550abb20a01 2500w" />
</Frame>

## Quick Start in the App

The [0xGraph Web App](https://telos.0xgraph.xyz) also offers a concise guide to assist users in deploying their Subgraphs effectively

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-quickstart.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=7f93b605d69fae5ffa05a50469d00f1a" alt="Subgraph analytics page" data-og-width="3486" width="3486" data-og-height="1842" height="1842" data-path="images/telos/0xgraph-quickstart.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-quickstart.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=b5dede93d17f1eecbdf0a41a2c67b1e0 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-quickstart.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=9ec78d3bb415bd7d3d97770676598d86 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-quickstart.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=df406974bccf707108a2fac0a51e6ce8 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-quickstart.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=e7a050fb02d8411fe9d59046d693e835 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-quickstart.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=58716936372157895030be3dbf1fb60b 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-quickstart.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=252fdd543df24a6570f05f56870b393c 2500w" />
</Frame>


# Account Creation
Source: https://docs.ormilabs.com/dedicated-env/telos/subgraphs/getting-started/account-creation

How to create your 0xGraph account

## Setup Steps

### 1. Create Account

Visit [telos.0xgraph.xyz](https://telos.0xgraph.xyz) to create your account.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-signup.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=20165c9c1ecaea8cd32da9d7576f6069" alt="0xGraph App Registration" data-og-width="3346" width="3346" data-og-height="1850" height="1850" data-path="images/telos/0xgraph-signup.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-signup.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=3ae434564f4064bdcaa24189328d3f84 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-signup.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=fbac0c8663243f46e23ca681bc12503f 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-signup.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=a522f66f7088196f4c30ec83c7c183f8 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-signup.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=e65a6abc37020f7b18e5d302b950085f 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-signup.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=2fc9add7ceee451b07c30eedd8b49bd6 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-signup.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=ecf2e3287f0a9d2bd974edab15fa800f 2500w" />
</Frame>

### 2. Choose Subscription Plan

Choose a plan that best fits your needs in [Settings page](https://telos.0xgraph.xyz/dashboard/settings).

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-pricing.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=ff3194845c957ea35157b924964d619d" alt="0xGraph Subscription Plans" data-og-width="1536" width="1536" data-og-height="813" height="813" data-path="images/telos/0xgraph-pricing.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-pricing.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=3dd05c7694de71794e050a5c46ab409c 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-pricing.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=cd8925161b8c07fd61a043f1cd97ef64 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-pricing.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=73addf052e59cc74f2f21a9e34628a25 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-pricing.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=dfc39ae16ca85770a08d8ba4fa815da4 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-pricing.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=b00ca1c8d2b13b8f6479ba041d591b95 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-pricing.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=3744815bd8dceb46bca8c341cd04f183 2500w" />

  <figcaption>Choose a subscription plan</figcaption>
</Frame>

### 3. Generate API Key

Go to the [API Keys Page](https://telos.0xgraph.xyz/dashboard/api) to create your API key.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-api-key.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=89427337b5875ee5f09e5826590228b9" alt="0xGraph API Keys" data-og-width="3468" width="3468" data-og-height="1842" height="1842" data-path="images/telos/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-api-key.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=19683ea719ecb4282e9c53f8bea04c4c 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-api-key.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=3660e2da5c32bc9bdb716ccfff2dc32b 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-api-key.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=a64efa638fcc14962a39980924a1e2ef 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=81fc0f739813e520c17595707e1c4d68 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=dd5e8745fe93662255d36c98d797e565 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=1065d0c11518ae5cd1faf361b72d38e2 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

After clicking the 'Create API Key' button in the top-right corner, your API key will be generated. You can then copy and paste it into your commands as needed.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-generated-api-key.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=0cbbb9e9b2fd8e50538a49d0d3162439" alt="0xGraph API Keys" data-og-width="3446" width="3446" data-og-height="1840" height="1840" data-path="images/telos/0xgraph-generated-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-generated-api-key.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=8fdc8601f6790e44ce8301a19a84b35e 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-generated-api-key.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=821f043473ab97f6a24ad0a44eb6500b 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-generated-api-key.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=28dff5ea1ef15553f0709ede54ab5b9f 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-generated-api-key.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=28b64575001b9ba351d74f6ee0d65baa 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-generated-api-key.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=199c5dafd6051a7b85f893483d156b90 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-generated-api-key.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=e97c8efe870a4f66ecc049dc7b663610 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

<Info>
  Warning: Always handle your API keys securely. Do not expose them in
  client-side code or share them publicly. Store them in a secure location, such
  as environment variables, and rotate them regularly to minimize security
  risks. If compromised, regenerate your API key immediately. For public
  repositories, store API keys in a .env file and add .env to .gitignore to
  prevent accidental exposure in your codebase.
</Info>

You are all set and ready to go for deploying a subgraph.


# CLI Usage
Source: https://docs.ormilabs.com/dedicated-env/telos/subgraphs/getting-started/cli-usage

A detailed list of all active and relevant commands for The Graph CLI, including their purposes, use cases, and examples.

## `graph init`

**Purpose:**\
Creates a new Subgraph project using an example template or an existing smart contract.

**Use Case:**

* Use this command when starting a new Subgraph project.
* It sets up the necessary folder structure, configuration files `subgraph.yaml`, and example code.
* You can specify a contract address and network to scaffold a Subgraph tailored to a specific smart contract.

**Example:**

```bash  theme={null}
graph init --from-contract <CONTRACT_ADDRESS> --network mainnet
```

## `graph codegen`

**Purpose:**\
Generates AssemblyScript types for smart contract ABIs and the Subgraph schema.

**Use Case:**

* Use this command after making changes to your `schema.graphql` file or when adding/updating smart contract ABIs.
* It creates type-safe classes that make it easier to interact with blockchain data in your mappings.

## `graph build`

**Purpose:**\
Compiles the Subgraph to WebAssembly (WASM), preparing it for deployment.

**Use Case:**

* Run this command after completing your mappings and configuration.
* It ensures your Subgraph is ready for deployment by converting it into the WASM format required by 0xGraph.

## `graph deploy`

**Purpose:**\
Deploys the compiled Subgraph to the 0xGraph hosting service.

**Use Case:**

* After building your Subgraph, use this command to upload and activate it on 0xGraph.
* Specify the deployment target (e.g., staging or production) and the Subgraph name.

**Example:**

```bash  theme={null}
graph deploy <your_subgraph> --node
https://telosapi.0xgraph.xyz/deploy
--ipfs https://telosapi.0xgraph.xyz/ipfs
--deploy-key <your_api_key>
```

## `graph local`

**Purpose:**\
Runs a local test environment (e.g., using Ganache or Hardhat) to test the Subgraph with simulated blockchain data.

**Use Case:**

* Use this command when developing and testing your Subgraph locally.
* It allows you to simulate blockchain events and validate mappings.
* Ideal for testing without deploying to a live environment.

## `graph test`

**Purpose:**\
Downloads and runs the Matchstick Rust binary to execute unit tests for a Subgraph.

**Use Case:**

* Use this command to write and run unit tests for your mappings and ensure that your Subgraph logic works correctly.
* Matchstick is a testing framework built specifically for The Graph.

## `graph add`

**Purpose:**\
Adds a new data source to your Subgraph’s manifest file (subgraph.yaml) and updates relevant files such as schema.graphql, ABIs, and mappings.

**Use Case:**

* Use this command when adding additional smart contracts or data sources to your Subgraph.
* It automates the process of updating your Subgraph configuration and related files.

**Example:**

```bash  theme={null}
graph add <CONTRACT_NAME> --from-contract <CONTRACT_ADDRESS>
```

<Info>
  Ensure you have the latest version of The Graph CLI installed to avoid
  potential issues with deprecated or updated commands.
</Info>


# Deploy a Subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/telos/subgraphs/getting-started/deploy-subgraph-graph-cli

Quick start guide for deploying a Subgraph using the Command Line Interface (CLI).

<Info>
  The Graph CLI is an essential tool enabling developers to seamlessly create,
  deploy, and manage subgraphs—providing streamlined blockchain data querying
  and indexing. It gives you superuser access to our enterprise-grade subgraph
  infrastructure. Additionally, we are fully compatible with The Graph's
  tooling, and the CLI works seamlessly out of the box with our platform.
</Info>

## Deployment Network Definitions

For developers who are already familiar with Graph Protocol tooling, below are the network definitions to deploy subgraphs on 0xGraph. These settings can be configured in the subgraph.yaml file:

## Installation

<Steps>
  <Step title="Install CLI Package">
    <CodeGroup>`npm i @graphprotocol/graph-cli `</CodeGroup>
  </Step>
</Steps>

<Card title="NPM CLI Package" icon="npm" href="https://www.npmjs.com/package/@graphprotocol/graph-cli" target="_blank">
  Install the graph npm package
</Card>

## Generate API Key

Create an API key: Visit [0xGraph Dashboard](https://telos.0xgraph.xyz/dashboard/api) to generate your API key. For a comprehensive tutorial on generating API keys, visit the [Account Creation Page](/dedicated-env/telos/subgraphs/getting-started/account-creation).

<Info>
  You need to specify the 0xGraph deployment endpoint. Your API key should only
  be used for the 0xGraph deployment endpoint.
</Info>

***

## Create your own Subgraph

Details regarding creating your own Subgraph is beyond the scope of this documentation. The Graph's official documentation provides detailed guides and examples for each step of the Subgraph creation process. It also covers advanced topics such as indexing strategies, filtering, and pagination. We recommend referring to their documentation for a comprehensive reference on Subgraph development with The Graph.

## Core Components

A typical Subgraph project has the following components:

<CardGroup cols={2}>
  <Card title="Manifest File" icon="file-lines">
    The `subgraph.yaml` manifest file serves as the root configuration, containing smart contract references, entity mappings, handler functions, and deployment parameters like `startBlock` and `description`.
  </Card>

  {' '}

  <Card title="Schema File" icon="database">
    The `schema.graphql` file defines all the entities and their relationships for
    your Subgraph's GraphQL API, determining what blockchain data will be indexed
    and made queryable.
  </Card>

  <Card title="Mappings File" icon="code">
    Written in [AssemblyScript](https://www.assemblyscript.org/), a TypeScript-like language specifically designed for WebAssembly, the mappings file transforms raw blockchain data into structured entities that match your GraphQL schema through a set of data handling functions.
  </Card>
</CardGroup>

<Note>
  Messari maintains a [well-curated GitHub
  repository](https://github.com/messari/subgraphs) that offers a comprehensive
  collection of example Subgraphs, which serves as a valuable resource for those
  seeking to start their subgraph development journey.
</Note>

***

## Subgraph Compilation

<Steps>
  <Step title="Generate Types and Mappings">
    <Note>
      The codegen step generates code files for indexing and querying data based on your schema and mappings.
    </Note>

    Run in your project root:

    ```bash  theme={null}
    graph codegen
    ```

    Success output:

    ```bash  theme={null}
        Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
        Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
        Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
        Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
        Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
        Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
        Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
      ✔ Apply migrations
      ✔ Load subgraph from subgraph.yaml
        Load contract ABI from abis/factory.json
        Load contract ABI from abis/ERC20.json
        Load contract ABI from abis/ERC20SymbolBytes.json
        Load contract ABI from abis/ERC20NameBytes.json
      ✔ Load contract ABIs
        Generate types for contract ABI: Factory (abis/factory.json)
        Generate types for contract ABI: ERC20 (abis/ERC20.json)
        Generate types for contract ABI: ERC20SymbolBytes (abis/ERC20SymbolBytes.json)
        Generate types for contract ABI: ERC20NameBytes (abis/ERC20NameBytes.json)
        Write types to generated/Factory/Factory.ts
        Write types to generated/Factory/ERC20.ts
        Write types to generated/Factory/ERC20SymbolBytes.ts
        Write types to generated/Factory/ERC20NameBytes.ts
      ✔ Generate types for contract ABIs
        Generate types for data source template Pair
        Write types for templates to generated/templates.ts
      ✔ Generate types for data source templates
        Load data source template ABI from abis/pair.json
        Load data source template ABI from abis/factory.json
      ✔ Load data source template ABIs
        Generate types for data source template ABI: Pair > Pair (abis/pair.json)
        Generate types for data source template ABI: Pair > Factory (abis/factory.json)
        Write types to generated/templates/Pair/Pair.ts
        Write types to generated/templates/Pair/Factory.ts
      ✔ Generate types for data source template ABIs
      ✔ Load GraphQL schema from schema.graphql
        Write types to generated/schema.ts
      ✔ Generate types for GraphQL schema

      Types generated successfully
    ```

    <Accordion title="Codegen Options">
      <Info>
        View all options with `graph codegen --help`:
      </Info>

      ```bash  theme={null}
      USAGE
        $ graph codegen [SUBGRAPH-MANIFEST] [-h] [-o <value>] [--skip-migrations] [-w] [--uncrashable-config <value> -u]

      FLAGS
        -h, --help                    Show CLI help.
        -o, --output-dir=<value>      [default: generated/] Output directory for generated types.
        -u, --uncrashable             Generate Float S
                                      subgraph Uncrashable helper file.
        -w, --watch                   Regenerate types when subgraph files change.
        --skip-migrations             Skip subgraph migrations.
        --uncrashable-config=<value>  Directory for uncrashable config.
      ```
    </Accordion>
  </Step>

  <Step title="Build Your Subgraph">
    After generating types, build your subgraph:

    ```bash  theme={null}
    graph build
    ```

    Success Output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/

    Build completed: build/subgraph.yaml
    ```

    <Accordion title="Build Options">
      <Info>
        View all options with `graph build --help`:
      </Info>

      ```bash  theme={null}
      Builds a subgraph and (optionally) uploads it to IPFS.

        USAGE
          $ graph build [SUBGRAPH-MANIFEST] [-h] [-i <value>] [-o <value>] [-t wasm|wast]
            [--skip-migrations] [-w] [--network <value>] [--network-file <value>]

        FLAGS
          -h, --help                    Show CLI help.
          -i, --ipfs=<value>            Upload build results to an IPFS node.
          -o, --output-dir=<value>      [default: build/] Output directory for build results.
          -t, --output-format=<option>  [default: wasm] Output format for mappings.
                                        <options: wasm|wast>
          -w, --watch                   Regenerate types when subgraph files change.
          --network=<value>             Network configuration to use from the networks config file.
          --network-file=<value>        [default: networks.json] Networks config file path.
          --skip-migrations             Skip subgraph migrations.

      DESCRIPTION
      Builds a subgraph and (optionally) uploads it to IPFS.

      ```
    </Accordion>
  </Step>

  <Step title="Deploy your Subgraph">
    Then deploy your Subgraph:

    ```bash  theme={null}
    graph deploy <your_subgraph> --node
    https://telosapi.0xgraph.xyz/deploy
    --ipfs https://telosapi.0xgraph.xyz/ipfs
    --deploy-key <your_API_key>
    ```

    Success output:

    ```bash  theme={null}
      Skip migration: Bump mapping apiVersion from 0.0.1 to 0.0.2
      Skip migration: Bump mapping apiVersion from 0.0.2 to 0.0.3
      Skip migration: Bump mapping apiVersion from 0.0.3 to 0.0.4
      Skip migration: Bump mapping apiVersion from 0.0.4 to 0.0.5
      Skip migration: Bump mapping apiVersion from 0.0.5 to 0.0.6
      Skip migration: Bump manifest specVersion from 0.0.1 to 0.0.2
      Skip migration: Bump manifest specVersion from 0.0.2 to 0.0.4
    ✔ Apply migrations
    ✔ Load subgraph from subgraph.yaml
      Compile data source: Factory => build/Factory/Factory.wasm
      Compile data source template: Pair => build/templates/Pair/Pair.wasm
    ✔ Compile subgraph
      Copy schema file build/schema.graphql
      Write subgraph file build/Factory/factory.json
      Write subgraph file build/Factory/ERC20.json
      Write subgraph file build/Factory/ERC20SymbolBytes.json
      Write subgraph file build/Factory/ERC20NameBytes.json
      Write subgraph file build/Pair/pair.json
      Write subgraph file build/Pair/factory.json
      Write subgraph manifest build/subgraph.yaml
    ✔ Write compiled subgraph to build/
      Add file to IPFS build/schema.graphql
                    .. Qmckrwbgbx3FjsVH4AU8xP3zgdg3rPnzNo7pmApAmhQkA4
      Add file to IPFS build/Factory/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9
      Add file to IPFS build/Factory/ERC20.json
                    .. QmPfKNZPkVATzL3EHypkcsyKhehR4jkiYEVqSzh2hxWYj1
      Add file to IPFS build/Factory/ERC20SymbolBytes.json
                    .. QmbHnhUFZa6qqqRyubUYhXntox1TCBxqryaBM1iNGqVJzT
      Add file to IPFS build/Factory/ERC20NameBytes.json
                    .. QmQCP6Pdp1MqpwRv2qoPHuUTwZGy7Q3eDHg4w5kzwE9mBj
      Add file to IPFS build/Factory/Factory.wasm
                    .. QmNksN9HGSyMfc4XrjQeHuDKsBQk1xHEKVE2dLwHQQu4kb
      Add file to IPFS build/Pair/pair.json
                    .. QmbPLMADBP8L6LBVP3ZBQ8RgG7ghamD8DvbdUxHAjZrLgm
      Add file to IPFS build/Pair/factory.json
                    .. QmZ55G1yYFzde8Vcq4cpLfNgPSEibpLi9aYCqS1jEvCKQ9 (already uploaded)
      Add file to IPFS build/templates/Pair/Pair.wasm
                    .. QmSZSUoNinhNshD26iwKyzut6s3w5Lmec3P9szBovfQg8V
    ✔ Upload subgraph to IPFS

    Build completed: QmdXJQUxgrzP8pVotTqiwirJ6NxfmdNdQ6rWQv2rmJpBQp

    Deployed to /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn

    Subgraph endpoints:
    Queries (HTTP):     /api/public/1b347b54-0d7f-4008-9a62-60fdcaffec9c/subgraphs/v2-subgraph/v0.89.0/gn
    ```
  </Step>
</Steps>

<Card title="View Your Subgraphs" icon="browser">
  Access your deployed Subgraphs through the web-based UI at [telos.0xgraph.xyz](http://telos.0xgraph.xyz)
</Card>

```
```


# Deploy a token transfer subgraph with the Graph Cli
Source: https://docs.ormilabs.com/dedicated-env/telos/subgraphs/getting-started/deploy-token-transfer-subgraph

Tutorial on how to deploy an erc20 token transfer subgraph with the Graph CLI



# Monitor Your Subgraph
Source: https://docs.ormilabs.com/dedicated-env/telos/subgraphs/getting-started/monitor-subgraph

Learn how to monitor your subgraph syncing progress and logs after deployment

# Monitor your subgraph via the Analytics Page

After deploying your subgraph, you can easily monitor the syncing progress and subgraph logs for up to 48 hours to gain insight and troubleshoot any issues that may come with your subgraph.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-monitor.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=ad3c76d3dafd12aaf9656e38cbeac024" alt="Subgraph deployment view" data-og-width="3438" width="3438" data-og-height="1848" height="1848" data-path="images/telos/0xgraph-monitor.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-monitor.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=1b66c93f502654cc2eb25fde521a7833 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-monitor.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=0789fe485298514a27a0a1afe83d777e 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-monitor.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=e1a169183057ccd3b4b02d6e1ad5f5b3 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-monitor.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=9be69e25014fc369f4c604833a8ff3f2 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-monitor.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=cd0dcee6d3150bbae98c943412955acd 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-monitor.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=f6c9ee784d8dc3f151a4550866c0c739 2500w" />
</Frame>

You can access your deployed subgraph analytics page by clicking on the subgraph name; afterward, you will be directed to the following analytics page.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-analytics.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=61a6dc09453a862b4ab563314f7f5c95" alt="Subgraph analytics page" data-og-width="2520" width="2520" data-og-height="1848" height="1848" data-path="images/telos/0xgraph-analytics.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-analytics.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=5a5a2c0f4e029b4039fd1b37fdb287f6 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-analytics.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=adb7dca8bc31bac0d2325070153e72a2 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-analytics.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=2c62ffa5a51638a49ce4f7ab2ad84e8f 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-analytics.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=ef02e5a332c3a3a26d5f39b814709eb6 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-analytics.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=263b83cfdfa18c29cb96ed94c76071b9 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-analytics.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=4b32fe3774c7ee8e57c8f550abb20a01 2500w" />
</Frame>


# Perform Query
Source: https://docs.ormilabs.com/dedicated-env/telos/subgraphs/getting-started/perform-query

Short description on what this section is about

After deploying your subgraph, you can easily access and query it via GraphQL playground for query. You can open the "GraphQL API" link in your dashboard to access your data.

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-graphql-api.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=e5e6b5a5df447b094f1458dd553d5b76" alt="API Keys" data-og-width="3462" width="3462" data-og-height="1840" height="1840" data-path="images/telos/0xgraph-graphql-api.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-graphql-api.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=78537017bbeebaefa5a253fbf0492f74 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-graphql-api.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=bef738654470c4dffea43f3e115a59d7 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-graphql-api.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=1fc2b8e876a1fbeaba71e093dac5637a 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-graphql-api.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=05d7b00252763d4642f933211ff7c6f5 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-graphql-api.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=c87d3ca213f233a2439d44e25e96e0f3 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-graphql-api.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=a1ab19d49dad27ed72c912a7d3ac868d 2500w" />
</Frame>

For example, you may access the publicly available Telos token approval subgraph at `https://telosapi.0xgraph.xyz/subgraphs/name/test_org/token-approval/graphql`

<Frame>
  <img src="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-graphql.png?fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=fbc193ae0253835894b47bd930d04ae7" alt="GraphQL" data-og-width="1847" width="1847" data-og-height="867" height="867" data-path="images/telos/0xgraph-graphql.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-graphql.png?w=280&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=ce94957638046cd728e4589bd28513a0 280w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-graphql.png?w=560&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=b36df5dd60f278a3a673e80b4bf531e1 560w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-graphql.png?w=840&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=810e360dcb15a190aa8383de23a33ada 840w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-graphql.png?w=1100&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=61664339a03a3a0d55b308d6acc1ad2e 1100w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-graphql.png?w=1650&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=1b4f739e93b269a8a295236210e8dc1c 1650w, https://mintcdn.com/ormilabs/JlJYa16BgTj1OqXG/images/telos/0xgraph-graphql.png?w=2500&fit=max&auto=format&n=JlJYa16BgTj1OqXG&q=85&s=e276ced47507ef73a251186501fb3107 2500w" />
</Frame>

***

## Query for Subgraph Sync Status

To get to know the sync status directly inside the subgraph, a user may run the following query by using `_meta`:

```graphql  theme={null}
{
  _meta {
    block {
      hash
      timestamp
      number
    }
  }
}
```

The result would be similar to the following:

```json  theme={null}
{
  "data": {
    "_meta": {
      "block": {
        "hash": "0x9f2480d4a21fb9743ae35d349fccbc86c0fad084d6a87b53d1f649f1051c6ddb",
        "timestamp": 1700267031,
        "number": 151479342
      }
    }
  }
}
```

***

## Query a Subgraph

Subgraphs expose blockchain data via a GraphQL API, making it easy for anyone familiar with the GraphQL language to get started.

A GraphQL API differs from traditional REST APIs in that it relies on a schema definition to outline the available queries, mutations, and data types that clients can access.

## Benefits of Schema-Driven Approach

This schema-driven approach enables clients to precisely specify the data they need, eliminating the need to over-fetch data. Here's why this is beneficial:

<CardGroup>
  <Card title="Precision" icon="bullseye">
    GraphQL clients can tailor their queries to retrieve only the data they require, enhancing efficiency.
  </Card>

  <Card title="Flexibility" icon="arrows-to-circle">
    Clients can request related data in a single query, reducing the number of API calls needed.
  </Card>

  <Card title="Predictability" icon="chart-line">
    The schema provides clear documentation for available data and operations.
  </Card>
</CardGroup>

## GraphQL Syntax

GraphQL queries are composed using a specific syntax that allows for hierarchical data retrieval. Clients specify the fields they want to retrieve and their relationships within a single query. This approach minimizes unnecessary data retrieval, resulting in more concise and efficient requests.

## Best Practices

When working with the 0xGraph service, it's essential to follow best practices to ensure optimal performance and efficiency. These best practices are outlined in official Graph Protocol documentation.

<Info>
  For detailed instructions on querying 0xGraph using GraphQL and to ensure adherence to best practices, refer to the [official
  documentation](https://thegraph.com/docs/en/querying/querying-best-practices/) provided by the Ormi Labs and Graph Protocol teams. These resources offer
  valuable insights and recommendations to streamline your interaction with blockchain data through GraphQL.
</Info>


# Private Graphql URL
Source: https://docs.ormilabs.com/dedicated-env/telos/subgraphs/getting-started/private-url

Learn how to create a private GraphQL URL for your subgraph

## Private Graphql URL

When you deploy a new subgraph, a public GraphQL endpoint is provided by default. However, you can also create a private endpoint for your subgraph, which requires an authentication token for requests. This private endpoint ensures that only authorized users or applications can access your subgraph's data, maintaining data security and control.

## Enable Private GraphQL Link

To use the private endpoint, you first need to enable it in your subgraph's detail on the 0xGraph console.

1. Navigate to your project details page.
2. Find the "PRIVATE GRAPHQL LINK" section.
3. Toggle the switch to "Enabled".

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=560e6af6112a63cffb865cbc60afd565" alt="Enable Private URL" width="700" data-og-width="1229" data-og-height="834" data-path="images/how-to/private.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=84eabc519189ef2a3b52f280ff7e2646 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a44106946348f0dcaf322b5b35e66c41 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6dcfd639d6e2d14fdacf34fc469e0afd 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e8470fabfb0845232d16b5434ada8136 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=93dc339e9fdfbd6dcc7ed4ad027c6baf 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=aee1e2143fe2327a40640aacd8e8b906 2500w" />

## Find Your Private URL

Once enabled, your unique private GraphQL URL will be displayed. You can also find this URL listed on the main page of your project environment under the "PRIVATE GRAPHQL LINK" column.

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=45d17f6b83f1234c38290ece93132fab" alt="Private URL List" width="700" data-og-width="1881" data-og-height="880" data-path="images/how-to/private2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=170c03e25794a0fa9099ae07c2ce6f67 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a733750201ba10c93bb3d985c5b775de 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=c0b478fca2ec7586f8f12db7bf9434e6 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a0e72f5d6ff87f1768e3688ed1995abb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f478e814674d0454cf0d1eb46704f1c3 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f7fb3ddbec13791ab5948282de354b3e 2500w" />

## Authentication

To query your private GraphQL endpoint, you must include an authentication token in the request header.

1. Obtain your API key from the 0xGraph console API Keys.
2. In your GraphQL client (like GraphiQL or Postman), add an `Authorization` header.
3. Set the header value to `Bearer YOUR_API_KEY`, replacing `YOUR_API_KEY` with the actual key.

Here's how it looks in the GraphiQL interface provided by 0xGraph:

<img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b36c81515bf5633e8446b1a9bc18a852" alt="Private URL Token" width="700" data-og-width="1261" data-og-height="836" data-path="images/how-to/private3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=62296e918593924606edca6ea9bb0e52 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7b7d3af194a2243c9a63ddd31c209e5c 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=87e773a3ca3156ba9ab3700bb365713d 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a5d877ffa5cc966da46065fa94a2ed90 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e4f121ec83725881815c920ece44b3d1 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=67f6cb202406476251abef74a4f70e3f 2500w" />

By following these steps, you can securely interact with your subgraph using its private GraphQL endpoint.


# 0xGraph - Reliable Subgraph Indexing
Source: https://docs.ormilabs.com/dedicated-env/telos/subgraphs/overview



Deploy subgraphs with 99.9%+ availability and fetch smart contract data at 3x the speed. 100% spec-compliant with every subgraph on The Graph's hosted and decentralized networks.

## Overview

Subgraphs are customizable, open-source solutions for indexing and accessing real-time blockchain data through GraphQL APIs.

0xGraph is a zero-hassle subgraph hosting solution that is 100% spec-compliant with every subgraph on The Graph Protocol’s hosted and decentralized networks, minus the lag and downtime.

* Plug and play deployment and subgraph migration from hosted services.
* Deploy subgraphs with the same tooling, UI, and similar CLI as The Graph.
* Query subgraphs without running any nodes or infrastructure.

### Supported Networks

0xGraph currently supports the following networks:

| Name          | Type    | Network Slug    |
| ------------- | ------- | --------------- |
| Telos         | Mainnet | `telos`         |
| Telos Testnet | Testnet | `telos-testnet` |

### Available Upon Request

Any other network you need? Please email us: [hello@ormilabs.com](mailto:hello@ormilabs.com)


# How to perform grafting
Source: https://docs.ormilabs.com/subgraphs/advanced-guides/grafting

Learn how to build and deploy new subgraphs by grafting existing subgraphs.

For larger subgraphs or when continuously deploying smart contracts as part of a project, developers often encounter challenges when indexing a subgraph from its inception, which can lead to resource inefficiency and time consumption.

## Overview

For more experienced developers, there is the option to utilize the Grafting feature. Grafting involves reusing data from a compatible existing subgraph and initiating indexing from a custom-defined later block. This approach can prove beneficial for:

* Testing new features within the underlying smart contract or subgraph entity
* Quickly addressing simple mapping errors during development
* Temporarily restoring functionality of an existing subgraph that has encountered issues

## Schema Compatibility

The new grafted subgraph does not have to have an identical GraphQL schema as the old base subgraph. It only needs to be compatible with it. Acceptable schema deviations include:

* Adding or removing entity types
* Removing attributes from entity types
* Adding nullable attributes to entity types
* Turning non-nullable attributes into nullable attributes
* Adding values to enums
* Adding or removing interfaces
* Changing for which entity types an interface is implemented

## Additional Resources

The Official Graph Documentation offers in-depth tutorials and documentation on how Grafting can be performed on a subgraph:

* [Grafting onto existing subgraphs](https://thegraph.com/docs/en/developing/creating-a-subgraph/#grafting-onto-existing-subgraphs)
* [Important notes on grafting when upgrading to the network](https://thegraph.com/docs/en/cookbook/grafting/#important-note-on-grafting-when-upgrading-to-the-network)


# How to build a subgraph from scratch
Source: https://docs.ormilabs.com/subgraphs/deploy-a-subgraph/build-subgraph

Index and query blockchain data in real-time via Subgraphs

<Note>
  If you plan to update or redeploy your subgraph in the future, create and use a tag before you start querying the endpoint.

  [Tags](/subgraphs/manage-and-monitor/tags) let you hot-swap new deployments under the same URL later without changing your front-end code.
</Note>

## Prerequisite

* [Graph CLI installed](https://www.npmjs.com/package/@graphprotocol/graph-cli?ref=blog.ormilabs.com)
* [node.js installed](https://nodejs.org/en)
* [Git installed](https://git-scm.com/downloads)

### Getting started

1. Log in to [Ormi](https://app.ormilabs.com/) and go to your dashboard.
2. From the dashboard, create an API key.

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=8c6505e0c7da85e6dee269b981fd4988" alt="0xGraph graph init" data-og-width="1894" width="1894" data-og-height="884" height="884" data-path="images/how-to/build-subgraph.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=88e1370b249db007d238e125860e2f08 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=02d27de21fdd3cec0799d8a1087d8df9 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=0ce8cf5b66d781bd76d2ba2a56f34949 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=c7938e3289111b5d70abed6c028b34d4 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=9897757ab160fc44505cf8f89ef755cb 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=6ed4927a22a06951ddbef711e76d0ee9 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

**Note**: Keep this page open, we’ll need the API key later to deploy a subgraph.

## Install Graph CLI

On your local machine, run the following in your terminal:

```
npm install -g @graphprotocol/graph-cli
```

## Create a directory for your subgraph

```
mkdir katana-blocks
cd katana-blocks
```

We’ll call the folder katana-blocks in this example.

## Initialize Node project

Run bash in the directory folder

```
npm init -y
```

## Install dependencies

```
npm install --save-dev @graphprotocol/graph-ts
npm install --save-dev assemblyscript
```

## Create the required files

You will need:

* subgraph.yaml
* schema.graphql
* mappings/blocks.ts
* abis/Dummy.json

### subgraph.yaml

```
specVersion: 0.0.5
description: Blocks indexer for Katana
schema:
  file: ./schema.graphql

dataSources:
  # We declare a contract data source so we can attach a blockHandler.
  # The "Dummy" ABI is unused but required by the manifest when kind=ethereum/contract.
  - kind: ethereum/contract
    name: KatanaBlocks
    network: katana
    source:
      address: "0x0000000000000000000000000000000000000000"  # not used
      abi: Dummy
      startBlock: 1
    mapping:
      kind: ethereum/events
      apiVersion: 0.0.7
      language: wasm/assemblyscript
      entities:
        - Block
      abis:
        - name: Dummy
          file: ./abis/Dummy.json
      # This is the key: run our handler every block
      blockHandlers:
        - handler: handleBlock
      file: ./mappings/blocks.ts
```

Note: `Dummy.json` is required because every data source must include at least one ABI, even if unused. Just put `[]` inside it.

### schema.graphql

```
type Block @entity(immutable: true) {
  id: ID!            # we will use the block number as the ID
  number: BigInt!
  timestamp: BigInt!
  hash: Bytes!
  parentHash: Bytes!
}
```

### Mapping files in typescript

```
import { Block as BlockEntity } from "../generated/schema";
import { ethereum } from "@graphprotocol/graph-ts";

export function handleBlock(block: ethereum.Block): void {
  // Use block number as the stable ID
  let id = block.number.toString();

  let entity = new BlockEntity(id);
  entity.number = block.number;
  entity.timestamp = block.timestamp;
  entity.hash = block.hash;
  entity.parentHash = block.parentHash;
  entity.save();
}
```

## Directory layout

```
katana-blocks/
├─ abis/
│  └─ Dummy.json          
├─ mappings/
│  └─ blocks.ts
├─ schema.graphql
└─ subgraph.yaml
```

You’ll also see `node_modules/` after installing dependencies - that’s expected.

## Build the subgraph

Generate types:

```
graph codegen
```

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph2.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=a1baddd77f993524e7901dc598a17b4a" alt="0xGraph graph init" data-og-width="1058" width="1058" data-og-height="437" height="437" data-path="images/how-to/build-subgraph2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph2.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=188ca2fed8f632df66ea4b7d1f8f037e 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph2.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=1d29a0b6ae54454f0dc3ecf0a0dbed02 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph2.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=99b8869b6b02806838b8ff94162f40ca 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph2.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=8e37a2f353b103ee1e8fee25f0999413 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph2.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=c8fdd807f6fd4f5c5c4f9c1f3e75e670 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph2.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=33630090a8f5e8069fc2d8fe83ab3af3 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

Now run:

```
graph build
```

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph3.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=62f0d933d7626246f6465f34e2df6b5d" alt="0xGraph graph init" data-og-width="857" width="857" data-og-height="402" height="402" data-path="images/how-to/build-subgraph3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph3.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=34557efd32f13134c354af00d4378cb1 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph3.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=3bf9142432ec020c709afbc86c465b89 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph3.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=2852cf3fe46e0767596a2868d7e86829 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph3.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=2bf99c62617ebfac558fe760e33e0723 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph3.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=cfbaf789de13dfb07643651eec98d74c 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph3.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=4152b1da42d3732c897f96ac291df055 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## Deploy the Subgraph to Ormi 0xGraph

Return to your [API key](https://app.ormilabs.com/dashboard/api) from the dashboard.

Replace `graph-name` and `API key` with your actual values

```
graph deploy <graph-name> --node  https://subgraph.api.ormilabs.com/deploy --ipfs https://subgraph.api.ormilabs.com/ipfs --deploy-key <API key>
```

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph4.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=938e574af9fa5879c3e76098cd42ff19" alt="0xGraph graph init" data-og-width="1260" width="1260" data-og-height="594" height="594" data-path="images/how-to/build-subgraph4.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph4.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=337e45222758a1e04e895db1e2f2d8a8 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph4.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=a4fee84db9f21c5aab515fd640197ef7 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph4.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=19d32eabb083f00a67d954e069fa7409 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph4.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=61642cd1d8acd4913a1c51fb8f1f1df0 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph4.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=7de0c0f4d02278c345b735e9af85770e 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph4.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=81ae8cf41f38d2f8ab9c89da1786e8b9 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## Track sync status

You can check syncing in the dashboard by going to the Subgraphs tab:

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph5.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=e345147402c3684ca10aae65bfeecdf9" alt="0xGraph graph init" data-og-width="1911" width="1911" data-og-height="889" height="889" data-path="images/how-to/build-subgraph5.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph5.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=f1cc7e289b9524350b9d2bd66896485b 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph5.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=6d58a37841f1da78616fc121df39c460 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph5.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=4575cea6cef9b560cafa5d5ba177af3f 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph5.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=09d0b6706e9da9d3066edba395f6f80a 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph5.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=b0643bbf0515d6ccc78797d4095cad12 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph5.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=bcb24b1b1ad43e1b89ff1ae6d51b6264 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## Query Katana blocks

Click on the button where the red arrow is pointing.

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph6.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=eb1bb529905cfa3587b9e526c802c00c" alt="0xGraph graph init" data-og-width="1886" width="1886" data-og-height="826" height="826" data-path="images/how-to/build-subgraph6.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph6.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=44511544c9451a217be080fbef8136b1 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph6.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=57a76665f7e1d671a910b076d0cbbdba 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph6.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=b737b1915f171fb1d567379c7889ea20 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph6.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=52f0b5f6ede92fe48ace087b6f654ef0 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph6.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=d889db899958a20302d372a0a2e206f8 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph6.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=0e178cc673b03634bc19639122eae8c6 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

Once synced, click the GraphQL endpoint link in the dashboard.

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph7.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=d8d60c65233f339e69bdb43008dab566" alt="0xGraph graph init" data-og-width="1850" width="1850" data-og-height="850" height="850" data-path="images/how-to/build-subgraph7.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph7.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=1f9791872cc4732f6c5457f12bf1a377 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph7.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=95c3aaa0119dcbadbfc4f50da3cf61f1 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph7.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=11a6194effc9b58e1a0b881a87433b15 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph7.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=c11cd02ec10511e4abc21a0b4f850653 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph7.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=0f2053a0e6805ee26428154f0d4b8bae 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph7.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=9b8b0757a474829b4bc435b3ebddab35 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

### Sample query

Run this query to fetch the latest 5 blocks

```
{
  blocks(first: 5) {
    id
    number
    timestamp
    parentHash
  }
}
```

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph8.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=068d4937aa9234c5342aa3472a11bc7a" alt="0xGraph graph init" data-og-width="1887" width="1887" data-og-height="888" height="888" data-path="images/how-to/build-subgraph8.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph8.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=02b51d11b43c2e46fd266006b65b1b24 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph8.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=2c8cd0cecddcf13f0d4091073f0f65a6 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph8.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=3d5cf0f3716911695f1ded65f4bcf896 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph8.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=0a13ae5d534cc148da2826cad28b1506 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph8.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=c69722a24c30cfdec8a79d4681ded586 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/build-subgraph8.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=bf81f800ff104359b32db310c15dcc6d 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## Done!

You now have a live subgraph indexing Katana blocks through [Ormi’s 0xGraph](https://app.ormilabs.com/).

## Next steps

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/subgraphs/query-data/querying-a-subgraph"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=db8e90d965f8893a197d1503caa565c6" alt="query subgraph icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/scan.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=3bb8dd7040c8c654e5e0d31212f85083 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5b8e0aa2a08d2129f65c93d0cd4c91ce 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=9691a16bda2d6de153d88cfc1699fb07 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f44f2bd60236d15d1f4e354a13154a95 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8d30ab3b344e1a90cc49c88fa194de89 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=81bf8db31d0fa7547f04990c2270c77e 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">How to query a subgraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Learn how to run GraphQL queries to fetch smart contract data from deployed subgraphs.
      </p>
    </div>
  </a>

  <a
    href="/subgraphs/manage-and-monitor/monitor-subgraph"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4cf2a42cfacb997491af3e7f0a1b62a5" alt="monitor subgraph icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/monitor-check.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5340d3e35fb1c2049aaf68011c8139ea 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=79b1274535708f0e545a84fcc2412e74 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ecbee7660dab6a51c7cc3e34eb7ce107 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=6612e4bc9d8560d513a26667f615c06f 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=1ee744abf2f3af7fa06941258fa71ed7 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7b4b932e990106ee32d50a455ed09459 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">How to monitor your subgraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Learn how to monitor your subgraph syncing progress and logs after deployment.
      </p>
    </div>
  </a>
</div>


# How to deploy a USDC subgraph with The Graph CLI
Source: https://docs.ormilabs.com/subgraphs/deploy-a-subgraph/deploy-subgraphs-via-cli

This tutorial will gude you through creating and deploying a USDC (ERC-20) subgraph with The Graph CLI.

<Note>
  If you plan to update or redeploy your subgraph in the future, create and use a tag before you start querying the endpoint.
  [Tags](/subgraphs/manage-and-monitor/tags) let you hot-swap new deployments under the same URL later without changing your front-end code.
</Note>

## What you'll need

* An [Ormi Labs account](https://app.ormilabs.com/)
* [Graph CLI installed](https://www.npmjs.com/package/@graphprotocol/graph-cli) `npm install -g @graphprotocol/graph-cli`
* [node.js installed](https://nodejs.org/en)
* [Git installed](https://git-scm.com/downloads/win)
* The USDC contract on Ethereum mainnet: 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48

**Tip**: USDC launched on Ethereum in Sept 2018; you can confirm addresses per chain in Circle’s docs if you ever target other networks.

## Getting started

1. Go to the [Ormi App](https://app.ormilabs.com) and login.
2. From the dashboard, create an API key for deployments.

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=ac4ade1e29e7be09629130b131f3dd1b" alt="0xGraph API Keys" data-og-width="1878" width="1878" data-og-height="784" height="784" data-path="images/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=9a7ce75c4a23f097f9c37aa2bb9bc23c 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=2d08282114911e455dfd5530d3ade80b 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=f10e634bc4879559c80c6512fbac4925 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=0abb78bac049e0f3c2c71b4a0f608ae6 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=bf2ee85dba964b271417f70f8aebf435 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=156187b64fa5fcb67843bc3a5082d638 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

Keep this page open, we’ll need the API key to deploy a subgraph.

## Running the subgraph CLI

Open your terminal and run The Graph CLI init flow:

```
graph init usdc-subgraph
```

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-init-1.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=b78bf8ed5e0dc57701872d827a8c4004" alt="0xGraph graph init" data-og-width="1262" width="1262" data-og-height="478" height="478" data-path="images/how-to/cli-graph-init-1.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-init-1.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=b5282add914c8eedebe23b002a35009d 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-init-1.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=a3ddcf6495f587f8cd34c53fa941efb5 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-init-1.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=f0584822846a5ea35d0299e9ed8f34cb 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-init-1.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=f8a60241f92cc3c256fcdab203c58397 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-init-1.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=7bed97a6905bac302f8deb335104099a 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-init-1.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=5a25d00a8466e7dd1b6b48836fd7c301 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

When prompted:

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-init-2.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=c8c6df75bf431aafbb0ce21281b46baa" alt="0xGraph graph init" data-og-width="1243" width="1243" data-og-height="390" height="390" data-path="images/how-to/cli-graph-init-2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-init-2.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=823e45ddf426044f3bffb19444924bd5 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-init-2.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=7d038973b24722d5b4dcb6f0663528d3 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-init-2.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=102fe353acad5765a3cce679563a16ba 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-init-2.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=8a9cbe1fb906b52b893a378e7d742257 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-init-2.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=52acf9e948dcbc71968f1f35d075cb6b 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-init-2.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=f808f3ca87b07d5b129feb5476d01eaf 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

1. **Network**: Ethereum Mainnet
2. **Source**: Smart contract: Ethereum
3. **Subgraph slug**: `create your own name`
4. **Contract address**: 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48
5. **Contract name**: `create your own name`
6. **Start block**: (optional but recommended)

## Setting up the subgraph

```
cd <subgraph name>
```

```
graph codegen
```

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-codegen.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=65159f24638237bbe0a073566644e252" alt="0xGraph graph init" data-og-width="1258" width="1258" data-og-height="501" height="501" data-path="images/how-to/cli-graph-codegen.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-codegen.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=3129a36e3707f0ff8a67f4f0c4e85b99 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-codegen.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=6e52a0000672035f95bca4d5521d2174 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-codegen.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=ae60c839db9af3786717988a9f8ba526 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-codegen.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=50a27eadc676f8f16f9158db62b1218d 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-codegen.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=7c6af166a68cafe204c032cb876a2bb4 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-codegen.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=c03fa6d90a40f9ea712d29f935773e1c 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

```
graph build
```

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-build.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=b3f3fa2ea0b0043ea0a1abbc397a622f" alt="0xGraph graph init" data-og-width="1244" width="1244" data-og-height="388" height="388" data-path="images/how-to/cli-graph-build.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-build.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=2068f75a0d3a240a02b0ec2675009b40 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-build.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=60502875a98577b6a1bc6bbaad5774f5 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-build.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=3304bf406fb7d26e1a90360c2ad5306c 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-build.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=a796578b52f7d0fbe63633fc3e97a43e 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-build.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=f74b5392fac4932e2147af7a2a4da453 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-build.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=53ee4eb9e253e6c9866be9838f9fe159 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## Deploy the subgraph to 0xGraph

Return to your [API page](https://app.ormilabs.com/dashboard/api) and copy the information to paste it in the `API key` section below.

```
graph deploy <graph-name> --node  https://subgraph.api.ormilabs.com/deploy --ipfs https://subgraph.api.ormilabs.com/ipfs --deploy-key <API key>
```

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-deploy.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=c9bd9481d0ac4b67ef7e9c29525be48a" alt="0xGraph graph init" data-og-width="1243" width="1243" data-og-height="673" height="673" data-path="images/how-to/cli-graph-deploy.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-deploy.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=3111fb1e3e41ee19358b8a7363af0368 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-deploy.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=0c68d24d90e927ebfb9afff02cdd4864 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-deploy.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=1058961902f0a786bbdcf6a23a47a682 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-deploy.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=575f8cf72f19bfee86acb1d88fb49927 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-deploy.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=eab683db2d9c1f92dc764974989f4703 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-deploy.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=cc1a6d249738a7eb0dd04ab1d0f859b0 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## Track sync status

You can check syncing in the dashboard by going to the Subgraphs tab:

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-sync.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=059494b6496d79326a1852fc1eb690ee" alt="0xGraph graph init" data-og-width="2545" width="2545" data-og-height="1000" height="1000" data-path="images/how-to/cli-graph-sync.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-sync.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=a7c0613c6f9fd2d9c23f4e2792adf1c6 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-sync.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=71ae7c1663595d493a96348cf265e71b 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-sync.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=37ba5532f2683c15f0d6e104e9b99207 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-sync.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=a0f4a3f3f8d59f6405f88173291388cd 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-sync.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=ff73651b062a77a70613a9b58d9a5451 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-sync.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=380d37f469bfedaf3d573a143b3b2374 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## Find the GraphQL link

Click the URL button and a graphql link will pop up. Click the graphql link.

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-graphql.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=71e95b5652b6cb8909015373fa6773a8" alt="0xGraph graph init" data-og-width="2268" width="2268" data-og-height="1141" height="1141" data-path="images/how-to/cli-graph-graphql.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-graphql.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=2366fc17ee00b3fc5ba62377428530ea 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-graphql.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=0286d210bc06db8ebb1a13759ad81e54 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-graphql.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=26a06694733f5a8596877645d09c2be5 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-graphql.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=81eeb67d8307622a0ec3c31d7310b5ab 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-graphql.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=06acdab8cb02d66494a36d3b2d20ad9b 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graph-graphql.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=333e2f303024b0b8666f74975bdedb07 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## Query your USDC subgraph

```
query LatestTransfers {
  transfers(first: 5, orderBy: blockTimestamp, orderDirection: desc) {
    id
    from
    to
    blockTimestamp
  }
}
```

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graphql-query.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=27b586ae3ebe87dd133425527051e592" alt="0xGraph graph init" data-og-width="1886" width="1886" data-og-height="907" height="907" data-path="images/how-to/cli-graphql-query.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graphql-query.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=7fcf9a71dc35126320c7e2219c218318 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graphql-query.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=15059080bbd5f105269f4fbc42c6ca83 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graphql-query.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=8450366a4cac4aad2e5623e64d77f470 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graphql-query.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=c5b0a6ae6e8e8e87e861c27395f9f0ed 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graphql-query.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=fe1be33ba0d9cebcbc912cf614d89afe 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/cli-graphql-query.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=e0320b7e5fd8e132f94dc57065e0acf9 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## You're all set up!

## Next steps

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/subgraphs/query-data/querying-a-subgraph"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=db8e90d965f8893a197d1503caa565c6" alt="query subgraph icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/scan.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=3bb8dd7040c8c654e5e0d31212f85083 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5b8e0aa2a08d2129f65c93d0cd4c91ce 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=9691a16bda2d6de153d88cfc1699fb07 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f44f2bd60236d15d1f4e354a13154a95 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8d30ab3b344e1a90cc49c88fa194de89 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=81bf8db31d0fa7547f04990c2270c77e 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">How to query a subgraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Learn how to run GraphQL queries to fetch smart contract data from deployed subgraphs.
      </p>
    </div>
  </a>

  {" "}

  <a
    href="/subgraphs/manage-and-monitor/monitor-subgraph"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "flex",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: "200px",
    display: "flex",
    flexDirection: "column",
    width: "100%",
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: "#3E744D" }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4cf2a42cfacb997491af3e7f0a1b62a5" alt="monitor subgraph icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/monitor-check.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5340d3e35fb1c2049aaf68011c8139ea 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=79b1274535708f0e545a84fcc2412e74 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ecbee7660dab6a51c7cc3e34eb7ce107 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=6612e4bc9d8560d513a26667f615c06f 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=1ee744abf2f3af7fa06941258fa71ed7 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7b4b932e990106ee32d50a455ed09459 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          How to monitor your subgraph
        </div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">Learn how to monitor your subgraph syncing progress and logs after deployment.</p>
    </div>
  </a>
</div>


# How to deploy a no-code subgraph in 5 minutes
Source: https://docs.ormilabs.com/subgraphs/deploy-a-subgraph/deploy-with-contract

All you need is the smart contract address

<Note>
  If you plan to update or redeploy your subgraph in the future, create and use a tag before you start querying the endpoint.

  [Tags](/subgraphs/manage-and-monitor/tags) let you hot-swap new deployments under the same URL later without changing your front-end code.
</Note>

## Getting started

1. In the Ormi dashboard, click 0xGraph
2. Expand the **Migrate from contract address** section

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7b1c464c55ece20d1a18fe98b1e4d307" alt="0xGraph graph init" data-og-width="1916" width="1916" data-og-height="900" height="900" data-path="images/how-to/no-code-screen.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d87475bede5baef2dfb89df2d525f703 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=0ed9f3b9d8f63ce64cdbaefb37d1ace4 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=748afac9807f98643d9a17dc714a52d4 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=3ddeea2797ea4c10932c24210514418b 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=0a84044b36f6e3215596f3960b67adea 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7dcd1830279851c172f42bd4c63aa40d 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

**Note**: If you already deployed a subgraph, click on **Deploy Subgraph** for the window to pop up.

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-new.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=bdbdf739e085558ad7d67a161f55f88e" alt="0xGraph graph init" data-og-width="1907" width="1907" data-og-height="899" height="899" data-path="images/how-to/no-code-new.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-new.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b4d7599804c7a82eee8ac8de037deb74 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-new.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b54d0acee99ed9007cc93b67b9ee118a 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-new.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=3652bdfec0a182ab4db46b832425cf02 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-new.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=fc3e2bec8c3d5fad3f6cc3ab71f27d06 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-new.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=1044595603b25ecc3b901d56c87276a2 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-new.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d7cb05ab0475c55f74dddb616d1f01f5 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

For this example, we’ll use VaultBridge’s Bridged USDC:

* **Contract address**: 0x203A662b0BD271A6ed5a60EdFbd04bFce608FD36
* **Network**: Katana
* **Name**: katana-vbusdc
* **Version**: v.1

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen2.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=86b96b825250dc7b77ce67579c46ac59" alt="0xGraph graph init" data-og-width="1890" width="1890" data-og-height="873" height="873" data-path="images/how-to/no-code-screen2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen2.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=1081ca9dd21574a4463ab5b40b8d2568 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen2.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=5cdea9c056f9b1ec2cb816d3853b4657 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen2.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ae936c31d7cdfe5f509491ebb1ed73a1 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen2.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f4d1bcefaec3ab43d98be8624da6736e 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen2.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e7d0975ab0d7e69be417b5eff8a26a6b 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen2.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=c95505567e38721a2fafd29ecba5ac5b 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

**Note**: If the ABI cannot be auto-fetched, you may need to upload it manually.

For vbUSD, you will need to fetch the implementation contracts’ ABI, so head over to [Katanascan](https://katanascan.com/token/0x203a662b0bd271a6ed5a60edfbd04bfce608fd36) and search for the vbUSD contract.

## Fetching a contract's ABI

### Click on the **Contract** tab

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/no-code-abi.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=2603a34c39e79ce698b8640a71703c3c" alt="0xGraph graph init" data-og-width="1544" width="1544" data-og-height="912" height="912" data-path="images/how-to/no-code-abi.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/no-code-abi.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=882e0e02459cc4c163a8be47208cc379 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/no-code-abi.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=90a8beb898097c93077bf520b7705f5f 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/no-code-abi.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=283c6e890b0284d47514edff48ce6415 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/no-code-abi.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=29ee7d05d911ebe18808be3029f86d20 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/no-code-abi.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=57dfeeaad55c42e7012edc667a7794f2 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/no-code-abi.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=996ccf5c6ad205ef5644ce645e61488a 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

### Click **Read or Write as Proxy** Tab

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi2.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a6920f086cf7739b991f8eebfa8a01c1" alt="0xGraph graph init" data-og-width="1499" width="1499" data-og-height="748" height="748" data-path="images/how-to/no-code-abi2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi2.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=fcec543b21db9bf123ab748c0a92d7ac 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi2.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9a4b0e568b322840a67d2fe45134a027 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi2.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7ec4906936415a746d26299bdf09035d 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi2.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ebe6ff23d90e1f41e8ff1aa1f85651a2 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi2.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=65461ceb01f6c9fa1613abec07fe44ac 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi2.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=16ced92fc5500ce1c2cc2222859d4498 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

**Implementation contract address**: 0x5e875267f65537768435C3C6C81cd313a570B422

### Click on the implementation contract and press the contract tab

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d40244621c695f1a56e8d952fe3815d6" alt="0xGraph graph init" data-og-width="1461" width="1461" data-og-height="478" height="478" data-path="images/how-to/no-code-abi3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=50c1247c424e24ec00fa807f4ea62088 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f914d4adaec24840e3b758b8bf1a1b59 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e3d5ebe49f7d0bbbe2e199e400cac0d6 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=624f8a30addc9ce90d4b60dc2f0cecc9 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=eece1871ea87056aa65a0a129dc41689 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=cfdaf8a287f5fddf1463c6971beba58d 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

### Scroll down to the bottom, and copy the Contract ABI.

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi4.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=49e761837de2e955a4733654bfc0d042" alt="0xGraph graph init" data-og-width="1558" width="1558" data-og-height="820" height="820" data-path="images/how-to/no-code-abi4.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi4.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=edb7c70dd6406b55ea8098f52dfa2bcb 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi4.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=790e09a401089b0a22147ae6f36ee5a6 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi4.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b49a6c6617139d65ed38f03d4eae07ca 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi4.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ad4978a46ba4d2d24c0e801e0647ea17 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi4.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=33d464447d393bcd13e4ba5d57f5556d 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi4.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=abfd0777da76cb81d54ab5aa50df6509 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

### Paste the Contract ABI into this section and press submit

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi5.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e3dfae522367f22cbc7938cf6133b1dd" alt="0xGraph graph init" data-og-width="1599" width="1599" data-og-height="796" height="796" data-path="images/how-to/no-code-abi5.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi5.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f4016eb556fa5114ec095a7317a200e2 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi5.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=c45f87fb41fe4bfa556b705c6bab9e43 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi5.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=81954fd90f5b105aa30bde27139a5119 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi5.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e83e8b2435913d31cbb323ca153bde9a 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi5.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=391589f6507a498b52536577d357797c 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-abi5.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=2e6dce83793607c6a0d761d3a32d84e4 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

Once submitted, the system will process your request. When it finishes loading, you’ll be taken to the next screen.

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=1c8a6ead637b052f575d4eeaa395583a" alt="0xGraph graph init" data-og-width="1888" width="1888" data-og-height="880" height="880" data-path="images/how-to/no-code-screen3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f7dc2952473827a117208276b622b531 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=632b8cbbd9761c8b7e432a9839dc56b0 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=2d985445d15d8cb052360a3fad3e56de 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=dda90f774351a4f87802d66323981c39 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=59944588cc2a7b97f7a7fed4bd5d5f54 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/no-code-screen3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=29fd6bb82d2d0ea8990cff247e2ce750 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

When your subgraph finishes syncing, you can start querying immediately by clicking the graphql link.

## Next steps

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/subgraphs/query-data/querying-a-subgraph"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round">
            <path d="M3 7V5a2 2 0 0 1 2-2h2" />

            <path d="M17 3h2a2 2 0 0 1 2 2v2" />

            <path d="M21 17v2a2 2 0 0 1-2 2h-2" />

            <path d="M7 21H5a2 2 0 0 1-2-2v-2" />
          </svg>
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">How to query a subgraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Learn how to run GraphQL queries to fetch smart contract data from deployed subgraphs.
      </p>
    </div>
  </a>

  <a
    href="/subgraphs/manage-and-monitor/monitor-subgraph"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round">
            <path d="m9 10 2 2 4-4" />

            <rect width="20" height="14" x="2" y="3" rx="2" />

            <path d="M12 17v4" />

            <path d="M8 21h8" />
          </svg>
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">How to monitor your subgraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Learn how to monitor your subgraph syncing progress and logs after deployment.
      </p>
    </div>
  </a>
</div>


# How to migrate your subgraph in 3 minutes
Source: https://docs.ormilabs.com/subgraphs/deploy-a-subgraph/migrate-subgraphs

Import an existing subgraph by entering its deployment ID.

<Note>
  If you plan to update or redeploy your subgraph in the future, create and use a tag before you start querying the endpoint.

  [Tags](/subgraphs/manage-and-monitor/tags) let you hot-swap new deployments under the same URL later without changing your front-end code.
</Note>

## Getting started

1. In the Ormi dashboard, click 0xGraph
2. Expand the **Migrate from another provider** section

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=e3586951202bb2d89233186952598057" alt="0xGraph graph init" data-og-width="1858" width="1858" data-og-height="878" height="878" data-path="images/how-to/migrate-subgraph.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=115469288323b28693bfa595dbf91e77 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=dccded2b62adba77eade37a4caa993d7 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=d5609c3fb554f177f9ffac55f3bc7b25 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=f41258f8f3b94262a7679442dd494428 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=451d5109188aea675767dfe88bf9f18d 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=7f6e7b68cb3250713ae29e894f3730e8 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

**Note**: If you already deployed a subgraph, click on **Deploy Subgraph** for the window to pop up.

**Keep this tab open.** We'll come back to this part in a bit.

## How to find the deployment ID using [The Graph Explorer](https://thegraph.com/explorer)

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph2.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=07dd8d80563747ffb435050d62e1c48c" alt="0xGraph graph init" data-og-width="1507" width="1507" data-og-height="902" height="902" data-path="images/how-to/migrate-subgraph2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph2.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=c42ca2ae0e1544c25758613e48bf83e4 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph2.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=6da0f56cd3d5e49e05008e487e48d907 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph2.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=526b9634e3aeefa81deabdd2b4066372 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph2.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=d3c6967a621ddbaf5bf502516ec3986d 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph2.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=5bada31f7e03b82a582f62b331068e78 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph2.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=66f9bf1eca238e9a3a3395fb389f59ef 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

### Find the subgraph you want to migrate and copy the deployment ID

In this guide, we'll be migrating **Uniswap v4 on Base Chain from TheGraph**.

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph3.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=de0d8eb5539d8fe859ee5292d7d274f0" alt="0xGraph graph init" data-og-width="1405" width="1405" data-og-height="1246" height="1246" data-path="images/how-to/migrate-subgraph3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph3.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=1e433b694a98a31dc026a91703cb95f6 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph3.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=b3c6172b288777ffba446717628be55d 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph3.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=75ac0e34b0501883c2582a5cedf53324 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph3.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=77d70c509b3437f1450e5eb4b4da2ff0 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph3.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=5d20c4b9a7cf84dc4745989bfa270e4a 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph3.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=c9d1aef0b586568758507ee7f4234ac3 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## Head back to the 0xGraph page

Complete the required fields in the **Migrate from another provider** section

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph4.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=cee77544fb2a0d1a03fda6a63bbe3d2b" alt="0xGraph graph init" data-og-width="620" width="620" data-og-height="661" height="661" data-path="images/how-to/migrate-subgraph4.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph4.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=ed77332c13a1126abe26918f8e82a17a 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph4.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=8f676b42f6ce7c1fae06477ae3468f1c 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph4.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=ad0696dd12ee114861b95d82678ccbe5 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph4.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=911b0981ff335c6152376bd9e902e8f4 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph4.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=499265a1d5470c3efcac13eeae7ca8b6 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph4.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=362c984af86e1cbd459dcf0c26b35bf3 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

1. **Deployment ID**: QQmS1ehFzXTD9eA1f1EgjZvdyAj2EHtVNMrEN91H3pLuHMy
2. **Network**: Base
3. **Name**: base-uniswap-v4
4. **Version**: v.1

After entering these details, you’ll be redirected to the 0xGraph dashboard, where your subgraph will start syncing automatically.

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph5.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=66512bf2680e465fad482101623c231f" alt="0xGraph graph init" data-og-width="1996" width="1996" data-og-height="976" height="976" data-path="images/how-to/migrate-subgraph5.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph5.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=6cd72458e08309fdd2d76a8cfaa9c638 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph5.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=0bbeb113a5186a3605e1cc273523c00c 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph5.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=eda7750e579f27755eeda0b7afb1507e 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph5.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=8cef1d003a35d1dc5fc6ee1cfb3596c3 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph5.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=8625015f17b9441459345e8e35c44e0b 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/migrate-subgraph5.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=409f4321d740f9d8f3d98ad5c2b27df1 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

That’s it! Once your subgraph syncs, you’ll be able to query data directly through Ormi’s 0xGraph.

## Next steps

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/subgraphs/query-data/querying-a-subgraph"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=db8e90d965f8893a197d1503caa565c6" alt="query subgraph icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/scan.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=3bb8dd7040c8c654e5e0d31212f85083 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5b8e0aa2a08d2129f65c93d0cd4c91ce 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=9691a16bda2d6de153d88cfc1699fb07 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f44f2bd60236d15d1f4e354a13154a95 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8d30ab3b344e1a90cc49c88fa194de89 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=81bf8db31d0fa7547f04990c2270c77e 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">How to query a subgraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Learn how to run GraphQL queries to fetch smart contract data from deployed subgraphs.
      </p>
    </div>
  </a>

  <a
    href="/subgraphs/manage-and-monitor/monitor-subgraph"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4cf2a42cfacb997491af3e7f0a1b62a5" alt="monitor subgraph icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/monitor-check.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5340d3e35fb1c2049aaf68011c8139ea 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=79b1274535708f0e545a84fcc2412e74 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ecbee7660dab6a51c7cc3e34eb7ce107 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=6612e4bc9d8560d513a26667f615c06f 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=1ee744abf2f3af7fa06941258fa71ed7 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7b4b932e990106ee32d50a455ed09459 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">How to monitor your subgraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Learn how to monitor your subgraph syncing progress and logs after deployment.
      </p>
    </div>
  </a>
</div>


# How to deploy a community subgraph
Source: https://docs.ormilabs.com/subgraphs/deploy-a-subgraph/use-template-subgraphs

Community subgraphs are pre-built, fully indexed subgraphs you can deploy in minutes and start querying right away.

<div
  style={{
margin: '0',
padding: '1rem 1.25rem',
overflow: 'hidden',
borderRadius: '1rem',
display: 'flex',
gap: '0.75rem',
border: '1px solid rgba(113, 113, 122, 0.2)',
backgroundColor: 'rgba(244, 244, 245, 0.5)'
}}
>
  <div style={{ marginTop: '0.125rem', width: '1rem' }}>
    <svg
      viewBox="0 0 20 20"
      fill="currentColor"
      xmlns="http://www.w3.org/2000/svg"
      style={{ 
    width: '1.25rem', 
    height: '1.25rem', 
    color: 'rgba(113, 113, 122, 0.6)' 
  }}
    >
      <path d="M8 0C3.58125 0 0 3.58125 0 8C0 12.4187 3.58125 16 8 16C12.4187 16 16 12.4187 16 8C16 3.58125 12.4187 0 8 0ZM8 14.5C4.41563 14.5 1.5 11.5841 1.5 8C1.5 4.41594 4.41563 1.5 8 1.5C11.5844 1.5 14.5 4.41594 14.5 8C14.5 11.5841 11.5844 14.5 8 14.5ZM9.25 10.5H8.75V7.75C8.75 7.3375 8.41563 7 8 7H7C6.5875 7 6.25 7.3375 6.25 7.75C6.25 8.1625 6.5875 8.5 7 8.5H7.25V10.5H6.75C6.3375 10.5 6 10.8375 6 11.25C6 11.6625 6.3375 12 6.75 12H9.25C9.66406 12 10 11.6641 10 11.25C10 10.8359 9.66563 10.5 9.25 10.5ZM8 6C8.55219 6 9 5.55219 9 5C9 4.44781 8.55219 4 8 4C7.44781 4 7 4.44687 7 5C7 5.55313 7.44687 6 8 6Z" />
    </svg>
  </div>

  <div style={{ fontSize: '0.875rem', minWidth: '0', width: '100%' }}>
    <h3 style={{ fontWeight: '600', margin: '0 0 0.5rem 0' }}>No account? No problem.</h3>
    <p style={{ margin: '0' }}>Deploy or query community subgraphs instantly. [Sign up](http://app.ormilabs.com/) for a free developer account - no credit card needed. </p>
  </div>
</div>

## **Step 1**: Login to the [Ormi App](https://app.ormilabs.com/) and click Explore

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=00b38abe70fe05222a56eeb64adcaddd" alt="0xGraph Community Subgraphs" data-og-width="2535" width="2535" data-og-height="1265" height="1265" data-path="images/0xgraph-explore.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=36f7506788fbbc81960b6d5262b21c87 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=aed2f3b0e1c5f1530574d4f6f371e9bf 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=8a848fd181e69edef1066cab0c3638b0 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=7b0ffcd7e9e2d80057c9f403a6e81b61 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=f3a03f52df1496e23b6f02c10405a0d1 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=a99db4056b673d00a1c551c5af11b6a2 2500w" />
</Frame>

## **Step 2**: Choose a Subgraph and press Deploy

We'll deploy a community subgraph on Arbitrum-one as an example.

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore-deploy.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=300ea9cb1168350ee6d07f3381a17f93" alt="0xGraph deploy Community Subgraphs" data-og-width="2527" width="2527" data-og-height="1261" height="1261" data-path="images/0xgraph-explore-deploy.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore-deploy.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=a256a4ca9366bc5f0f5dc9cd9d360f43 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore-deploy.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=2a254974ae93c5ead13021de2efb7948 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore-deploy.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=4dd7e8eeed86c5582cceb4151238e605 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore-deploy.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=5859a42cabb24d6f52eccacfb19bc617 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore-deploy.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=193ab4f31a5fefadf716f2adcda6587a 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore-deploy.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=1faaba12bbe5414ce2917f0b3eb93b8e 2500w" />
</Frame>

You'll be taken to the 0xGraph page right after you click deploy.

## **Step 3**: Go to the [API key page](https://app.ormilabs.com/dashboard/api) to generate an API key

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=ac4ade1e29e7be09629130b131f3dd1b" alt="0xGraph API Keys" data-og-width="1878" width="1878" data-og-height="784" height="784" data-path="images/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=9a7ce75c4a23f097f9c37aa2bb9bc23c 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=2d08282114911e455dfd5530d3ade80b 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=f10e634bc4879559c80c6512fbac4925 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=0abb78bac049e0f3c2c71b4a0f608ae6 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=bf2ee85dba964b271417f70f8aebf435 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=156187b64fa5fcb67843bc3a5082d638 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

Click on 'Create API Key' to generate an API key.

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=27378c8be18ab8c673ad359d766c74b9" alt="0xGraph API Keys" data-og-width="1905" width="1905" data-og-height="850" height="850" data-path="images/0xgraph-generated-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=3b84276a591ade543b0235093dab3ba2 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=ec35293209dda94aeda54b1210c84d36 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=7236ffe8e39e0459a54908d7ef2c6bcd 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=d6f81496480361d508cb5bcb87197969 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=d2d0046a932f52af19be8d53090f8902 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=0e5e3a1fc56de44929e488f2f40e4147 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## **Step 4**: Head back to the 0xGraph page

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore-0xgraph.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=8bb3915667b2f0d4eaa7ca3830608b3f" alt="0xGraph dashboard" data-og-width="2522" width="2522" data-og-height="1181" height="1181" data-path="images/0xgraph-explore-0xgraph.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore-0xgraph.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=8355dc5bbc18b776507d80271579c8c7 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore-0xgraph.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=e42619533f79bb470269372dc87a3b89 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore-0xgraph.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=842a6d1ed9b9dd06941cb889608cb07c 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore-0xgraph.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=402391a6bf9a6c3560f1722ad2df5551 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore-0xgraph.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=3aa45268634c2c3c8f61dfa953433726 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-explore-0xgraph.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=dfd7a112b5761fa784434917c021d256 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## **Step 5**: Press the URL button to see GraphQL link

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-popup.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=7ab1d26600bc7e857f3df5ba676a147d" alt="0xGraph graphql link" data-og-width="1805" width="1805" data-og-height="875" height="875" data-path="images/0xgraph-popup.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-popup.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=738359c5dbba747cad588d5b29445c62 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-popup.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=c587800c9b2d2bbaa165664699b90311 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-popup.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=ae2cea39affcfeaa58218b7a7a5db62c 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-popup.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=61561a01253b154b6dfb0a0e8b3dca5e 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-popup.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=537f2781fa7b2b657e952e7489b3eb8f 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-popup.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=0367168e7ed00c720f8f369528b36942 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

Now you've deployed a community subgraph and can query it via the GraphQL link!

## Next steps

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/subgraphs/query-data/querying-a-subgraph"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=db8e90d965f8893a197d1503caa565c6" alt="query subgraph icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/scan.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=3bb8dd7040c8c654e5e0d31212f85083 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5b8e0aa2a08d2129f65c93d0cd4c91ce 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=9691a16bda2d6de153d88cfc1699fb07 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f44f2bd60236d15d1f4e354a13154a95 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8d30ab3b344e1a90cc49c88fa194de89 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=81bf8db31d0fa7547f04990c2270c77e 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">How to query a subgraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Learn how to run GraphQL queries to fetch smart contract data from deployed subgraphs.
      </p>
    </div>
  </a>

  <a
    href="/subgraphs/manage-and-monitor/monitor-subgraph"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4cf2a42cfacb997491af3e7f0a1b62a5" alt="monitor subgraph icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/monitor-check.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5340d3e35fb1c2049aaf68011c8139ea 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=79b1274535708f0e545a84fcc2412e74 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ecbee7660dab6a51c7cc3e34eb7ce107 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=6612e4bc9d8560d513a26667f615c06f 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=1ee744abf2f3af7fa06941258fa71ed7 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7b4b932e990106ee32d50a455ed09459 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">How to monitor your subgraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Learn how to monitor your subgraph syncing progress and logs after deployment.
      </p>
    </div>
  </a>
</div>


# 0xGraph feature overview
Source: https://docs.ormilabs.com/subgraphs/features

Explore 0xGraph features and capabilites.

<div data-page="features-no-toc">
  ## Core capabilities

  | **Feature**                    | **Description**                                                                                                                                                                                                                                            |
  | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | **No-code subgraph**           | Deploy a subgraph instantly by providing a smart contract address. 0xGraph automatically generates the ABI, or you can upload your own for custom configuration. Ideal for teams who want to skip setup and start indexing right away.                     |
  | **No-code migration**          | Bring over any existing subgraph from The Graph or other providers using just the deployment ID. Fully compatible with existing manifests, mappings, and schemas - no re-writes required.                                                                  |
  | **Subgraph templates**         | Launch production-ready subgraphs in seconds. Choose from 50+ community templates that are fully synced and queryable immediately - perfect for popular protocols and datasets.                                                                            |
  | **Monitoring & observability** | Track subgraph health and performance in real time. View status (Syncing, Live, Paused, or Error), analyze metrics like latency, block height, and indexing speed, and inspect logs to debug mappings or schema issues.                                    |
  | **API versioning with tags**   | Manage multiple deployments under one stable endpoint. Tags let you hot-swap subgraph versions (e.g., from staging to prod) without downtime or front-end changes - ideal for seamless version upgrades.                                                   |
  | **Private endpoints**          | Secure your subgraph with API key authentication. Enable a private GraphQL URL to restrict access to trusted users, protect sensitive data, and monitor authenticated usage in production environments.                                                    |
  | **Webhooks**                   | Receive real-time POST updates whenever entities are inserted, updated, or deleted. Use webhooks to trigger backend workflows, sync databases, or integrate subgraph events directly into your apps.                                                       |
  | **Dedicated Environment**      | Ormi's **Dedicated Environment** is a high performant subgraph environment with dedicated compute, storage, and bandwidth. It is designed for fast chains and highly-demanding protocols.                                                                  |
  | **Custom Environment**         | Ormi's **Custom Environment** is a fully private and customizable environment. It gives institutions and infrastructure partners a high availability hosted environment with dedicated resources, full access control, and guaranteed operational privacy. |
</div>

## Resources

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="https://app.ormilabs.com/dashboard/0xgraph"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'block',
  height: '100%'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    padding: '1.25rem 1.5rem',
    height: '100%',
    display: 'flex',
    flexDirection: 'column'
  }}
    >
      <div style={{ display: 'flex', alignItems: 'center', marginBottom: '0.5rem' }}>
        <div style={{ color: '#3E744D', marginRight: '0.75rem' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/gauge.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=34e05ec9d97e3debd6457992aa262cf1" alt="access now icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/gauge.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/gauge.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=6d3c7aa14240a45075e373d6e0d23a3c 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/gauge.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=84b4ad6de4549ce045410f9176291307 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/gauge.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ed77e560e48dc70fbe4fbd7e0fefac2b 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/gauge.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7d22924e2ce778aa02e23c100009f77a 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/gauge.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=12bab3968027831122861bbb894e912b 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/gauge.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=9778fe5ff45fe18a74f353810cb702fb 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Access 0xGraph now
        </div>
      </div>

      <p className="text-gray-600 text-sm" style={{ margin: 0, lineHeight: '1.4' }}>
        Use 0xGraph to index and query real-time smart contract data across 70+ chains - start for free.
      </p>
    </div>
  </a>

  <a
    href="/subgraphs/quickstart"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'block',
  height: '100%'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    padding: '1.25rem 1.5rem',
    height: '100%',
    display: 'flex',
    flexDirection: 'column'
  }}
    >
      <div style={{ display: 'flex', alignItems: 'center', marginBottom: '0.5rem' }}>
        <div style={{ color: '#3E744D', marginRight: '0.75rem' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=cca7b26ac73e65453815fbe85b6c6d01" alt="quickstart icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/quickstart.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=499bcd7a2f5b526ff905dd5e83885798 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=57aa39e42ca0bf768ce458874ad42321 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8062bcadbdaa365483ea6e545d413bb4 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7f3546557b416294e5b6f71c1949d230 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4dad90676bccde6863759fb27ad456c7 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7960022f64f10a2b868b24c3bbdc1791 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Quickstart
        </div>
      </div>

      <p className="text-gray-600 text-sm" style={{ margin: 0, lineHeight: '1.4' }}>
        See the different ways to create, deploy, and query a subgraph in minutes.
      </p>
    </div>
  </a>
</div>


# How to monitor your subgraph
Source: https://docs.ormilabs.com/subgraphs/manage-and-monitor/monitor-subgraph

Learn how to monitor your subgraph syncing progress and logs after deployment.

## Start here

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=85aadd85ea313403b14ac485da51a2f0" alt="0xGraph graph init" data-og-width="1895" width="1895" data-og-height="883" height="883" data-path="images/how-to/monitor-subgraph.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=552b22ec77077b73bc64a404f779275a 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=16ec1ba6d0e2f74d6e4dfe0bb90ef022 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=5b04d5c7251640579515958e27305eab 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=869682c6d12af9a072eac29bbda65646 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=3349bbcd9af36278c8376d31a517d7a2 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=b53fe634ff8e73f2512553e166dab8be 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

1. Go to the [Ormi app](https://app.ormilabs.com/dashboard/0xgraph).
2. Select the subgraph you want to monitor.
3. Click on the `>_` icon  of the subgraph card to open the detailed view.

## Syncing status

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph3.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=c6a09f2d28699069a352374136a1932a" alt="0xGraph graph init" data-og-width="1431" width="1431" data-og-height="745" height="745" data-path="images/how-to/monitor-subgraph3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph3.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=f61d32be725e25ef50509d6c1999b53a 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph3.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=7b4562881e801475bbeef5d6df67581f 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph3.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=de373e5c19f8b06fc67509cffe6f43a0 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph3.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=363edbaefceecdc0cd8f9c4d09e5763c 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph3.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=0c08bf177fb62bbe2ad2454ee6b5bf6d 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph3.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=8539b1a6ff21161de4321960e0ce0d42 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

When you deploy a subgraph on 0xGraph, its state is tracked in the mainframe.

A subgraph can be in one of the following states:

* `Syncing` - The subgraph is currently indexing blocks and catching up to the chain head.
* `Live` - The subgraph is fully synced and serving queries in real time.
* `Pause` - Indexing is temporarily stopped. Queries may still return existing data. The pause function is a manual toggle and the subgraph owner can pause the subgraph at any time.
* `Error` - The subgraph encountered a problem during indexing. Check logs for details.

## View analytics

<Frame>
  <img src="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph2.png?fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=116c3dc4f54bfc97376cf2c1ec70ad14" alt="0xGraph graph init" data-og-width="2063" width="2063" data-og-height="1098" height="1098" data-path="images/how-to/monitor-subgraph2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph2.png?w=280&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=0615b1f8f1cdd2a7f7f4cb984588b8f7 280w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph2.png?w=560&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=61208bd794bc0a7dc913c890850134f5 560w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph2.png?w=840&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=7d61c87ac8cf7c56c0bb61cac73e6275 840w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph2.png?w=1100&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=549432011973422cab9260fe8b0dc3eb 1100w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph2.png?w=1650&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=b892064043e7b083125e9b3ac714c3bd 1650w, https://mintcdn.com/ormilabs/vcU9W8gg4MUmMgRt/images/how-to/monitor-subgraph2.png?w=2500&fit=max&auto=format&n=vcU9W8gg4MUmMgRt&q=85&s=0a7ec9e1df9e5b70f81f8204e157e362 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

The Analytics tab provides key performance metrics at a glance. You can adjust the interval **(hourly, daily)** to analyze trends.

* **Count** - number of processed requests.
* **Latency** - Average response time in milliseconds.
* **Response data size** - Average size of responses returned.
* **Block head count** - The current block height the subgraph has synced to.
* **Entity count** - Total number of entities stored.
* **Indexing speed**  - Rate of block / entity ingestion over time.

## Monitoring logs

The logs provides a detailed runtime information for you subgraph. Logs are essential for debugging, monitoring performance, and identifying issues in your mappings or indexing process.

You can filter logs by **minimum log level** and **time range** to narrow down what you're looking for or use the **search function** to look up specific events, txn hashes, or handlers.

Minimum log levels are defined as:

* `Debug` - Detailed technical logs for development and troubleshooting. Best for diagnosing specific issues in mappings or schema.
* `Info` - Standard operational logs showing normal indexing activity. Use to confirm your subgraph is progressing as expected.
* `Warn` - Alerts for unusual behavior that doesn’t stop syncing but may affect performance or data accuracy. Check the underlying log details to confirm if action is needed.
* `Error` - Critical issues that stop or block indexing. Always investigate the logs directly to identify the cause and resolve the failure.

## Tips for monitoring

* **Track syncing progress**: Compare the subgraph's block head with the chain's latest block. Large gaps may indicate indexing lag.
* **Watch for errors**: Check logs regularly for failed handlers, out-of-gas errors, or schema mismatches.
* **Monitor performance**: Use latency and indexing speed metrics to anticipate scaling needs.

## Subgraph maintennce

Keep in mind that errors don’t always come from infrastructure issues - subgraphs themselves require ongoing maintenance. Protocol upgrades, new contract deployments, or schema changes may cause your subgraph to break or return incomplete data if not updated.

Regularly review your subgraph mappings and schema, and plan to maintain them as the underlying protocol evolves.


# How to setup a private GraphQL URL
Source: https://docs.ormilabs.com/subgraphs/manage-and-monitor/private-endpoints

Enable a private GraphQL endpoint to secure your subgraph data with API key authentication.

## What is a private GraphQL URL?

By default, every deployed subgraph includes a **public GraphQL endpoint**.

You can also enable a **private endpoint**, which requires an authentication token for every request.

### Private endpoints are ideal for:

* Restrict data access to trusted users or applications.
* Protect sensitive onchain data in production.
* Manage usage via authenticated API keys.

## How to enable a private GraphQL link

### Step 1: Navigate to the [0xGraph console](https://app.ormilabs.com/dashboard/0xgraph) and press the `>_` icon

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=45d17f6b83f1234c38290ece93132fab" alt="0xGraph graph init" data-og-width="1881" width="1881" data-og-height="880" height="880" data-path="images/how-to/private2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=170c03e25794a0fa9099ae07c2ce6f67 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a733750201ba10c93bb3d985c5b775de 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=c0b478fca2ec7586f8f12db7bf9434e6 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a0e72f5d6ff87f1768e3688ed1995abb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f478e814674d0454cf0d1eb46704f1c3 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private2.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f7fb3ddbec13791ab5948282de354b3e 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

### Step 2: Click on the "Tags" tab

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=560e6af6112a63cffb865cbc60afd565" alt="0xGraph graph init" data-og-width="1229" width="1229" data-og-height="834" height="834" data-path="images/how-to/private.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=84eabc519189ef2a3b52f280ff7e2646 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a44106946348f0dcaf322b5b35e66c41 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6dcfd639d6e2d14fdacf34fc469e0afd 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e8470fabfb0845232d16b5434ada8136 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=93dc339e9fdfbd6dcc7ed4ad027c6baf 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=aee1e2143fe2327a40640aacd8e8b906 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

### Step 3: Enable private GraphQL link

Tick the **Enabled** checkbox

## Find your private URL

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b36c81515bf5633e8446b1a9bc18a852" alt="0xGraph graph init" data-og-width="1261" width="1261" data-og-height="836" height="836" data-path="images/how-to/private3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=62296e918593924606edca6ea9bb0e52 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7b7d3af194a2243c9a63ddd31c209e5c 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=87e773a3ca3156ba9ab3700bb365713d 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a5d877ffa5cc966da46065fa94a2ed90 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e4f121ec83725881815c920ece44b3d1 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=67f6cb202406476251abef74a4f70e3f 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

Once enabled, your unique private GraphQL URL can be accesed from the 0xGraph console.

## Authenticate your requests

Private endpoints require an API key in the request header for authentication.

### Step 1: Generate an [API key](/subgraphs/quickstart/generate-an-api-key).

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private5.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=47d4177b1c69834587e905571fe931d0" alt="0xGraph graph init" data-og-width="1885" width="1885" data-og-height="878" height="878" data-path="images/how-to/private5.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private5.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7b1575c960614a965d1ad33283e04d41 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private5.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=4e21c6a23dc9fb8dce5646bea59f99b6 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private5.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9699d88dfacd1633733597bd3f610eca 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private5.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=36ab2f7b182780fa2d0a1731b7030aff 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private5.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=add19356b1e16001e1afbb31282331a5 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private5.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7505c33642ee9e2ab0a00c230da2a83c 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

### Step 2: Add the API key into the `Authorization` header in the GraphQL client.

```
{ "Authorization": "Bearer GVOQH8CE7XL0WTOXXXXXXXXXX" }
```

Set the header value to `Bearer GVOQH8CE7XL0WTOXXXXXXXXXX`, replacing `GVOQH8CE7XL0WTOXXXXXXXXXX` with the API key you just generated.

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private4.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=5cf935e468420423f9a1b90d92ce266d" alt="0xGraph graph init" data-og-width="1884" width="1884" data-og-height="903" height="903" data-path="images/how-to/private4.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private4.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e83745b0a8d862f84414dc5ef7f92832 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private4.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=2240e0ec6519628573dd1618c7d29d3a 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private4.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d9309c91933cfc4cd59822cf96faecc0 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private4.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=0cab16c58fd184c5721968bdff2812c4 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private4.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d64e2f433ef2adcf5dcba7f90ae706ac 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/private4.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6ad694d1cb16e89bc2d4e404a5dda643 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

By following these steps, you can securely interact with your subgraph using its private GraphQL endpoint.


# How to manage API endpoints with tags
Source: https://docs.ormilabs.com/subgraphs/manage-and-monitor/tags

Tags let you **hot-swap subgraph deployments** without changing your front-end URL.

## What are tags?

* Tags let you **version and manage your subgraph endpoints** without changing your URL.
* They act as pointers that direct your GraphQL endpoint to a specific subgraph deployment.

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9873aaefcdaaa7806aaad5a6de084a63" alt="0xGraph graph init" data-og-width="1900" width="1900" data-og-height="881" height="881" data-path="images/how-to/tag.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=caedd1daef9ffdfb5c68e0105097adac 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=836015dd4085dbe58f7b4198d359e682 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e5574dafc5db04140845a8fe3f04ee25 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=562fb825e162cb7e693bcaa5066fd62c 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=2241df24cb9858b003de26a07af02cce 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d1beedfb0a7e1283711bfe382ee8bea8 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

When you deploy a subgraph, a tag is automatically created using this format:

`subgraph-name` + `version`

For example: `mainnet-usdc/v0.0.1`

This tag is composed of:

* **Name** - The subgraph name (`mainnet-usdc`)
* **Version** - The deployed version (`v0.0.1`)

<Note>
  Tags always point to a specific subgraph deployment. When you deploy a subgraph, a tag is created automatically based on the **name** and **version**.
</Note>

## How tags work

* Tags let you **update or replace a subgraph deployment** without breaking your existing endpoint.

* This allows you to test, sync, and deploy new versions **without downtime or front-end changes**.

### Example workflow

1. You deploy `mainnet-usdc v0.0.1` and tag it as `prod`, giving you this endpoint:

```
/mainnet-usdc/prod
```

2. You deploy an updated version of `mainnet-usdc v0.0.1` for testing and call it:

* **Name**: `mainnet-usdc`
* **Version**: `v2.0`

3. Once it's synced and ready, you reassign the `prod` tag to the `mainnet-usdc v2.0` subgraph.

Your application keeps querying the same endpoint (`/mainnet-usdc/prod`), but now it serves data from the new version without downtime or code changes.

<Note>
  Tags can only be reassigned between deployments that **share the same subgraph name**.   If you change the name, the tag will no longer apply.
</Note>

## When to use tags

* **Product stability**: Swap new versions in real-time without downtime.
* **Testing environments**: Route traffic between subgraphs used in `staging`, and `prod`.
* **Version management**: Keep a single stable URL across multiple subgraph updates.

<Note>
  Tags are ideal when you need continuous data delivery while testing or upgrading. They’re not needed for one-off or experimental subgraphs.
</Note>

## How to create tags

### Step 1: Access 0xGraph and press the `>_` icon

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag2.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e1ad9289750568faa64883e21ff05397" alt="0xGraph graph init" data-og-width="1907" width="1907" data-og-height="871" height="871" data-path="images/how-to/tag2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag2.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=395dc88e2a1f2bbfe1be9f9854c78c0c 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag2.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=cbf6a21f72035c6a9194653405c087b2 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag2.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=07d9da5d56cc5aaaef62a1be5cb9401d 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag2.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=91ea920a7fb14007ca4984b053245677 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag2.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=0d8bd82835f66e06bc78959fd2790934 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag2.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=606d3526ded09c826be00a6f31ad04d9 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

### Step 2: Click on the **Tags** tab

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=1b888af1240cdc9c7d59febf00669d7f" alt="0xGraph graph init" data-og-width="1885" width="1885" data-og-height="835" height="835" data-path="images/how-to/tag3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=2264db0f9bbfcbacece40e75b6fda3f7 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=15131b572ba0c9a2b435ef03f7033fb1 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e5cdf945054d93a437646d7c7a041346 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f5becd0c5b6703880f7adad74b5a7f88 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=4f2a09f8d578b1d85bf2f5aff3fc8227 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ba6e09fe7c430c254843d5dc6c359e81 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

### Step 3: Generate a tag

We created a new tag called `testing`

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag4.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=bf9865fa2603abbcabbde835290c4846" alt="0xGraph graph init" data-og-width="1520" width="1520" data-og-height="828" height="828" data-path="images/how-to/tag4.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag4.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=4dcf29d8b06e7317b4f3e49457b4316d 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag4.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9a0a2ae3c0a492ef71faa4eca5a15592 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag4.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=3864dc2a8f1ab778daa29c87ffc20819 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag4.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d33a74a41e39715d91c2f63b3b0e7782 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag4.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ce61e306ef556811b366161e98c99e66 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag4.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7a79242ef24abfea1399eeb2732af6c2 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

<Note>
  Prefer managing tags programmatically?\
  See the [**API Reference**](/api-reference/0xGraph/tags/create-tag) for full details on creating, deleting, and querying tags directly through the API.
</Note>

### Step 4: Query using the tag

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag5.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b4017d92bbb708fc54e64b61dbc77ed1" alt="0xGraph graph init" data-og-width="1350" width="1350" data-og-height="719" height="719" data-path="images/how-to/tag5.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag5.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=1e35389d0ab82e6787b5280f455a6d6c 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag5.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e6c6745fb286f5672fad5674928ec2d5 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag5.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=4a6b54b51d8f7b63ba3941cd0ab162d3 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag5.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=2366f016c46bee6ee2028d7f1ff6b16a 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag5.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=741454dc24f283d94d7fc6c0fdd36379 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/tag5.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=498be2084ff9a1208a8793ff08a4e777 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>


# How to create and manage subgraph webhooks
Source: https://docs.ormilabs.com/subgraphs/manage-and-monitor/webhooks

Subgraph webhooks send POST requests in real time when entities are inserted, updated, or deleted, so you can react instantly to on-chain data changes.

## What are webhooks?

Webhooks let your backend receive **real-time updates** whenever data changes in your subgraph, for example, when an entity is **inserted, updated, or deleted**.

This is useful for:

* Triggering external workflows.
* Syncing your database with on-chain data.
* Integrating subgraph evenets into other systems or services.

## How it works

Whenever a subgraph handler runs `entity.save()`, or removes an entity, the change is recorded. A real-time watcher detects the event and sends an **HTTP POST** request to your configured webhook endpoint.

### Payload includes:

* **Operation type**: `INSERT`, `UPDATE`, or `DELETE`
* **Entity name**: the affected entity (ex. `approved`, `user`, `pool`)
* **Entity data**: The new or updated values
* **Timestamp** and **block number**

## Creating a Webhook

You can create a new webhook through the 0xGraph dashboard.

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9234eae31186a5b6f649ed942830ff6c" alt="0xGraph graph init" data-og-width="1872" width="1872" data-og-height="879" height="879" data-path="images/how-to/webhook.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9f6074a41fc7104edd1f8a831dcf426b 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=70599e318f7d4dbb52bd9b9271f5fb9b 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=12c058b62fbe1aad60ae53b93b4edb0f 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d09122a7d15636238f837d4fb83fb9cb 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d4299f143c74dac74aefe4d276549743 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=9b8b5cfcba5dbd305b27b026d77ab5d4 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

1. Navigate to the **Webhooks** tab of your subgraph.
2. Click on the **Add Webhook** button.

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=1a8a8610f0aa060edd6cec706e366d69" alt="0xGraph graph init" data-og-width="1000" width="1000" data-og-height="818" height="818" data-path="images/how-to/webhook3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=fba9d6def6020d6c02eacc3c4670f763 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ee4af7ca24eeadf9bfab5bde38ab1811 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6e22347e0fe60c0d103c87000e981f06 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=59a7e24f1e30c3da890b3ea603216cc5 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ac5ba543c4c479ce7052f173ee858471 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6887464b8fb3a4b2866c91c8f90a8cb7 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

### Parameters of each field

* **Name**: A descriptive name for your webhook (e.g., `webhook_demo`).
* **URL**: The HTTP endpoint where the webhook payloads will be sent.
* **Entity**: The specific entity you want to track (ex., `approved`).
* **Number of retries**: Configure the total number of retries. Defaults to 3, with a maximum of 10.
* **Retry interval**: Configure the retry interval in seconds. Defaults to 60, with a maximum of 3600.
* **Retry timeout**: Configure the retry timeout in seconds. Defaults to 30, with a maximum of 60.
* **"secret" header value**: An optional secret string that will be sent in a designated webhook secret header. This allows your endpoint to verify that the request is authentic.

3. Fill in the required fields in the **Create Webhook** pop-up.
4. Click **Create.**

## Viewing and managing webhooks

All created webhooks appear in your subgraph’s **Webhooks** list.

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook4.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d79659957279a343b9a734fcda04999f" alt="0xGraph graph init" data-og-width="1361" width="1361" data-og-height="814" height="814" data-path="images/how-to/webhook4.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook4.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=7fd9d94f1094b7fa99cdfa4a60a4da1e 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook4.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ed88640927a5cfeb0dedde8fa87c2d60 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook4.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b15714229bdb9491840e805026be5d1d 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook4.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=486c977499c78b30f0343687bff31dd5 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook4.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=4768c7dab0521cf78ee32ecd17e41ff7 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/webhook4.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=8111303238cb8a4eea31475620af3df8 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

For each webhook, you can view:

* The tracked entity and target URL.
* Last delivery time.
* Number of successful and failed deliveries.
* Retry and error statistics.

## Webhook payload structure

The webhook will send a JSON payload to your configured URL. The main payload object contains the following fields:

* `op` (string): The type of operation that triggered the webhook. Possible values are `"INSERT"`, `"UPDATE"`, or `"DELETE"`.
* `data_source` (string): Identifier for the subgraph or indexer being tracked.
* `data` (object): Contains the actual entity data that changed. It has two sub-fields:
  * `old` (object | null): The state of the entity before the change. This will be `null` if the `op` is `"INSERT"`.
  * `new` (object | null): The state of the entity after the change. This will be `null` if the `op` is `"DELETE"`.
* `webhook_name` (string): The name you assigned to your webhook during creation.
* `webhook_id` (string): A unique identifier for the webhook configuration.
* `id` (string): A unique identifier for this specific event notification.
* `delivery_info` (object): Information about the delivery attempt for this webhook. It has two sub-fields:
  * `max_retries` (integer): The maximum number of retry attempts configured for this webhook.
  * `current_retry` (integer): The current retry attempt number for this specific event (0 for the initial attempt).
* `entity` (string): The name of the subgraph entity being tracked.

### Example Payloads:

**`INSERT` operation:**

```json  theme={null}
{
  "op": "INSERT",
  "data_source": "privateURL/v0.0.1",
  "data": {
    "new": {
      "id": "ERC20Approve-0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc-w\\u001c\\u001b\\u0002\\ufffd\\ufffd\\ufffd\\u07Ջ^\\ufffdcO\\ufffd\\ufffd(7C\\u001c\\u001b-\\ufffd\\u0016僞\\ufffdm\\ufffd\\ufffdI+y\\ufffd\\ufffd^\\u0015\\ufffd\\ufffdY\\ufffd",
      "vid": 7271978,
      "owner": "\\\\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc",
      "amount": 1.157920892373162e+77,
      "is_all": false,
      "spender": "\\\\xbde5839ec36db2ac492b79e9e3b75e15fa8a59ec",
      "updated_at": 1747127781,
      "block_range": "[20405156,)"
    },
    "old": null
  },
  "webhook_name": "webhook_demo",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "id": "5b623fd0-b539-400b-bbb3-060d95403a64",
  "delivery_info": {
    "max_retries": 3,
    "current_retry": 0
  },
  "entity": "approved"
}
```

**`UPDATE` operation :**

```json  theme={null}
{
  "data": {
    "new": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,20405060)"
    },
    "old": {
      "id": "ERC20Approve-0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000-w  Ջ^cO(7C -w Ջ^cO(7C ",
      "vid": 7271844,
      "owner": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "token": "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
      "amount": 115792089237316195423570985008687907853269984665640561215151422165121803858650,
      "is_all": false,
      "spender": "\x771cab02cfc4ebd58b5e9b634fe7f82837431cc6",
      "updated_at": 1747126465,
      "block_range": "[20405057,)"
    }
  },
  "data_source": "privateURL/v0.0.1",
  "delivery_info": {
    "current_retry": 0,
    "max_retries": 3
  },
  "entity": "approved",
  "id": "dd2b6013-22e1-4e8e-a665-be5276144a68",
  "op": "UPDATE",
  "webhook_id": "fcdce3c3-b288-4bb1-a7df-0d5acd8cd447",
  "webhook_name": "webhook_demo"
}
```


# How to migrate your subgraph from Alchemy to Ormi in 30 seconds
Source: https://docs.ormilabs.com/subgraphs/migrate-alchemy-subgraphs



> Alchemy is sunsetting its Subgraph service.
> Ormi offers a seamless migration path. No CLI setup, or code changes. You can move everything to Ormi in seconds using your existing Deployment ID.

## Why choose Ormi?

* Zero-friction migration: deploy in seconds using your existing Deployment ID.
* High-throughput performance: built to handle **up to 4,000+ RPS and 99.9% uptime**.
* Real-time indexing: always synced to the tip of the chain.
* 90% of existing Ormi clients came over from Goldsky to Ormi for better performance.

<iframe width="560" height="315" src="https://www.youtube.com/embed/bBC_kD6N1QA" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowFullScreen />

## Getting started

<Note>
  If you plan to update or redeploy your subgraph in the future, create and use a tag before you start querying the endpoint.

  [Tags](/subgraphs/manage-and-monitor/tags) let you hot-swap new deployments under the same URL later without changing your front-end code.
</Note>

1. Go to your Alchemy Subgraphs dashboard
2. Click on the subgraph that you want to migrate

<Frame>
  <img src="https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration.png?fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=40dc98404dec54521be14229ed9cf44a" alt="0xGraph graph init" data-og-width="1788" width="1788" data-og-height="883" height="883" data-path="images/0xgraph/alchemy-migration.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration.png?w=280&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=9138936bd0f4f3219c6fcd436258674e 280w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration.png?w=560&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=152f35c83a1b9c8582e6c91ca02a969b 560w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration.png?w=840&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=f8251f8565f5fda4852e3cbeabd4dff3 840w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration.png?w=1100&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=deb2cc7b4332c99993485e8600163da4 1100w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration.png?w=1650&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=041ba1c6f569d4f09de3595d7d7344b6 1650w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration.png?w=2500&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=9a03ec2ba1c8fa8a28a5870e8074aad6 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## Copy the deployment ID

<Frame>
  <img src="https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration2.png?fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=3791c87b1d385af91a9b6e9b1237e0c9" alt="0xGraph graph init" data-og-width="1821" width="1821" data-og-height="908" height="908" data-path="images/0xgraph/alchemy-migration2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration2.png?w=280&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=c4bdf44a917412a61d17e706fa7f4c58 280w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration2.png?w=560&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=1d698278fe88377cd0fa0d782a728202 560w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration2.png?w=840&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=96c305f06872c499df44a4f4a53fa113 840w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration2.png?w=1100&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=a962db17c0334f166de959ac37b15385 1100w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration2.png?w=1650&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=bf500344d99f65f63226f5f180251042 1650w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration2.png?w=2500&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=e9be1ddb02c769190b2b31cae7027c69 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## Retrieving the IPFS Hash (for custom Alchemy IPFS deployments)

Some Alchemy subgraphs were stored on an IPFS node that cannot be accessed through standard public gateways.

If your migration fails when using the standard IPFS URL, you can retrieve the IPFS hash by querying your Alchemy subgraph endpoint:

```
query {
  _meta {
    deployment
  }
}
```

<Note>
  This lookup may not work for every Alchemy deployment because of how their IPFS layer handled metadata. If you run into issues, contact us on [Telegram](https://t.me/ormi_community) or through our [contact form](https://ormilabs.com/contact-us) and we can help.
</Note>

## Head back to the 0xGraph page

Press the **Deploy Subgraph** button

<Frame>
  <img src="https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration3.png?fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=1cda9b075b8cc0dd888b30f760c0a797" alt="0xGraph graph init" data-og-width="1896" width="1896" data-og-height="911" height="911" data-path="images/0xgraph/alchemy-migration3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration3.png?w=280&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=fd0acdc4cb9fa6135ed4dc9e01eff530 280w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration3.png?w=560&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=b5e57c2f142f06062a0a67dc05738dd8 560w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration3.png?w=840&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=02530f3affb07c9226848d3edf6f88d7 840w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration3.png?w=1100&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=853365c612ae691bf3308f2ddad76c29 1100w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration3.png?w=1650&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=c89e7390282577e7df0848710d8639cf 1650w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration3.png?w=2500&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=d5a7e4ce30485ef4a86cd23c255e9bc3 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

Complete the required fields in the **Migrate from another provider** section

<Frame>
  <img src="https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration4.png?fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=318341aaf12f737ad39b7e45eb40428c" alt="0xGraph graph init" data-og-width="570" width="570" data-og-height="606" height="606" data-path="images/0xgraph/alchemy-migration4.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration4.png?w=280&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=b6c47474fb8eb70fc056776666a269b6 280w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration4.png?w=560&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=70d37ddd0a7008722a49d49f0e53b5b6 560w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration4.png?w=840&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=bc19207466d5bbdecccfadf58d4d1f82 840w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration4.png?w=1100&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=1b1ed27830cdb2d4b872b71d09dff067 1100w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration4.png?w=1650&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=bd1ccd0c8e75614261ed6ce910f2b42a 1650w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration4.png?w=2500&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=dd13b0364e3ad6c2afbc5d65c81e3832 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

1. **Deployment ID**: QmemRNjvy3fxcz15HFSj7kWQ8H2RLEufzV3tZtYqbrj7Wd
2. **Network**: Monad Testnet
3. **Name**: monad-blocks
4. **Version**: v0.0.1

After entering these details, you’ll be redirected to the 0xGraph dashboard, where your subgraph will start syncing automatically.

<Frame>
  <img src="https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration5.png?fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=1f745bcdad5ac10e2e0ae5867376750c" alt="0xGraph graph init" data-og-width="1875" width="1875" data-og-height="831" height="831" data-path="images/0xgraph/alchemy-migration5.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration5.png?w=280&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=cbf26894755e942f89b1f060360df11a 280w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration5.png?w=560&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=fc82cd43e87d5bcf2e16fee14203550c 560w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration5.png?w=840&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=4a58bd078448c1dd1862ef6491ac1db9 840w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration5.png?w=1100&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=cdca31e6d4521a9451cb5c56588ea7f4 1100w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration5.png?w=1650&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=c7d119463e31630477a91753dbb91bdf 1650w, https://mintcdn.com/ormilabs/h4YxPeb-6SKo2rZZ/images/0xgraph/alchemy-migration5.png?w=2500&fit=max&auto=format&n=h4YxPeb-6SKo2rZZ&q=85&s=ce9e3d4ad27ec9029eecfbba1f828f1c 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

That’s it! Once your subgraph syncs, you’ll be able to query data directly through Ormi’s 0xGraph.

## Endpoint differences

| **Alchemy**                                                                          | **Ormi**                                                                                    |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- |
| `https://subgraph.satsuma-prod.com/<query_key>/<project_prefix>/<subgraph_name>/api` | `https://api.subgraph.ormilabs.com/api/public/query_deployment?subgraph_id=<deployment_id>` |

## Post-migration checklist

1. Open your subgraph in the Ormi dashboard
2. Check sync status and logs to make sure it's indexing
3. Test GraphQL queries using the GraphQL link
4. Use tags if you plan on updating your subgraph

## Need help?

For assistance with large or complex migrations, our team is here to help.

* **[Contact us](https://ormilabs.com/contact-us)**
* **[Join our telegram](https://t.me/ormi_community)**
* **[Book a call with us](https://calendly.com/ormilabs)**

## Next steps

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/subgraphs/query-data/querying-a-subgraph"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=db8e90d965f8893a197d1503caa565c6" alt="query subgraph icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/scan.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=3bb8dd7040c8c654e5e0d31212f85083 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5b8e0aa2a08d2129f65c93d0cd4c91ce 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=9691a16bda2d6de153d88cfc1699fb07 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f44f2bd60236d15d1f4e354a13154a95 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8d30ab3b344e1a90cc49c88fa194de89 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=81bf8db31d0fa7547f04990c2270c77e 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">How to query a subgraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Learn how to run GraphQL queries to fetch smart contract data from deployed subgraphs.
      </p>
    </div>
  </a>

  <a
    href="/subgraphs/manage-and-monitor/monitor-subgraph"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4cf2a42cfacb997491af3e7f0a1b62a5" alt="monitor subgraph icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/monitor-check.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5340d3e35fb1c2049aaf68011c8139ea 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=79b1274535708f0e545a84fcc2412e74 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ecbee7660dab6a51c7cc3e34eb7ce107 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=6612e4bc9d8560d513a26667f615c06f 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=1ee744abf2f3af7fa06941258fa71ed7 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/monitor-check.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7b4b932e990106ee32d50a455ed09459 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">How to monitor your subgraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Learn how to monitor your subgraph syncing progress and logs after deployment.
      </p>
    </div>
  </a>
</div>


# Intro to Ormi 0xGraph (Subgraphs)
Source: https://docs.ormilabs.com/subgraphs/overview

Index and query smart contract data in real-time via Subgraphs

## What is Ormi 0xGraph

0xGraph is a next-gen subgraph indexer, **fully compatible with The Graph** and **built for real-time, high-throughput apps**. Ormi's secret sauce lies in its vertically integrated stack which includes:

* A custom hybrid architecture which combines **bare-metal speed** and **cloud flexibility** for **elastic scaling** to stay at the tip of chain.
* Redundancy at every layer, from compute to query execution. If the cloud goes down, our global-bare metal network instantly kicks-in.
* Optimized indexing (5x faster) and query layer enabling sub-second (\< 30ms) queries at 1,000+ RPS (up to 4,000+ RPS) , with zero throttling, and full chain sync from day one.

***

## New to subgraphs?

If you're new to subgraphs, start here to learn the essentials.

<div
  className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/subgraphs/quickstart/creating-an-account"
    style={{ 
  textDecoration: 'none', 
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    maxWidth: '380px',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/square-arrow-out-up-right.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f10b7884460ad076225c3bbfaded1c48" alt="create account icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/square-arrow-out-up-right.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/square-arrow-out-up-right.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d033eb948b0e0e301df67f4023a5946b 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/square-arrow-out-up-right.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=c2144d1c6cc1e1a62bddff0b303eadc0 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/square-arrow-out-up-right.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=65665783a64de5e81f459a1a1cf0ff71 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/square-arrow-out-up-right.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=de5c4a63258e60aceb876eebd5cf4cc0 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/square-arrow-out-up-right.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=1e9b1d9730d03ff286c21421031beb6c 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/square-arrow-out-up-right.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=85d276e121cb14be104c5de23bac69c3 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Create account</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Create an account to deploy and query subgraphs with real-time data.
      </p>
    </div>
  </a>

  <a
    href="/subgraphs/deploy-a-subgraph/use-template-subgraphs"
    style={{ 
  textDecoration: 'none', 
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    maxWidth: '380px',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/copy.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7f675691001e255ed637d86d05d963ec" alt="use template icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/copy.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/copy.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=a6fcff59ee6ff5a57e3b6e2b9b1722d4 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/copy.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=bc2bed170035be9f024f4c142bb3b02b 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/copy.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=3e7fd0dfba28663903b914e49e8f61a2 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/copy.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=aa255e624fcd1780aae185a18a3ef472 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/copy.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=260caf80f6408fff3f8fe990b0c2d40d 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/copy.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f9f9deb28e015bf2ed2439e36e1fd9af 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Use templates</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Deploy a community subgraph in seconds and begin querying immediately.
      </p>
    </div>
  </a>

  <a
    href="/subgraphs/query-data/querying-a-subgraph"
    style={{ 
  textDecoration: 'none', 
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    maxWidth: '380px',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=db8e90d965f8893a197d1503caa565c6" alt="query subgraph icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/scan.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=3bb8dd7040c8c654e5e0d31212f85083 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5b8e0aa2a08d2129f65c93d0cd4c91ce 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=9691a16bda2d6de153d88cfc1699fb07 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f44f2bd60236d15d1f4e354a13154a95 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8d30ab3b344e1a90cc49c88fa194de89 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/scan.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=81bf8db31d0fa7547f04990c2270c77e 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Query a subgraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Run GraphQL queries to fetch real-time onchain data from deployed subgraphs.
      </p>
    </div>
  </a>
</div>

***

## Start indexing and querying with Ormi

Start here if you're already familiar with subgraphs and want to get started.

<div
  className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/subgraphs/quickstart"
    style={{ 
  textDecoration: 'none', 
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    maxWidth: '380px',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=cca7b26ac73e65453815fbe85b6c6d01" alt="quickstart icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/quickstart.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=499bcd7a2f5b526ff905dd5e83885798 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=57aa39e42ca0bf768ce458874ad42321 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8062bcadbdaa365483ea6e545d413bb4 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7f3546557b416294e5b6f71c1949d230 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4dad90676bccde6863759fb27ad456c7 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7960022f64f10a2b868b24c3bbdc1791 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Quickstart</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Create an account to deploy and query subgraphs with real-time data.
      </p>
    </div>
  </a>

  <a
    href="/subgraphs/deploy-a-subgraph/migrate-subgraphs"
    style={{ 
  textDecoration: 'none', 
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    maxWidth: '380px',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/send-to-back.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5071593618cd84386c5b384fbce5f5f9" alt="migrate subgraphs icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/send-to-back.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/send-to-back.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=056c879eeb8e142fc3277b7655e58a7d 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/send-to-back.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=1dd3d942766496f912af796bf3eea6c7 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/send-to-back.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=89c0f35a36ce8ec80d367217bb9fc17a 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/send-to-back.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8f15aae4399002e15dad2de02d6d3961 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/send-to-back.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=a7647835432d607964a60b7b013d13b8 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/send-to-back.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=e349d497c2c93fcb1ab657c7362b1f47 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Migrate subgraphs</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Deploy a community subgraph in seconds and begin querying immediately.
      </p>
    </div>
  </a>

  <a
    href="/supported-chains/subgraphs"
    style={{ 
  textDecoration: 'none', 
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    maxWidth: '380px',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=763219942a929fb35f1e728ffbcca310" alt="supported chain icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/link.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d2eb9296c3fc41d23b4a3cf2dee8c1e7 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=451350aeeed6a9b4d4366b7ae6d63dcd 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8f9ea18cdf4deeee05e3c44db0cf432d 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7f838361856d778ae65ddc91ca5609cc 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=34b862e55631e82b514e2db6302c5dfc 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5dde712015493301b0829c0b1565020f 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Supported chains</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        See the full list of supported chains and networks on Ormi 0xGraph.
      </p>
    </div>
  </a>
</div>

***

## Need another chain?

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="https://forms.fillout.com/t/66AyD9bdZvus"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ebadba019a911b27f922ea79588b939d" alt="ecosystem icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/boxes.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d13c22a16e1077c57a96e4eea973eb85 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=fc8ccea3fe21d83c7391877396575949 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=1c91a2a34350eed8e9f6018ca47919a0 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8cd2cb4551e3d0655fb8e73da106826e 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4b534dcd403e58e53cf1b2ff6dd5160b 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ee44bdce4df96eaa59c74d5c426a19dc 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">For ecosystems</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Partner with Ormi to power your ecosystem with subgraphs and APIs that are real-time, reliable, and fully white-labeled. Give your developers enterprise-grade data under your own brand.
      </p>
    </div>
  </a>

  <a
    href="https://forms.fillout.com/t/2U1EKfDebbus"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7abf3ee5e020a6c691989d0333b1bf3f" alt="builder icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/laptop.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=162396f09b219713bf2ba0bfdb68228d 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=611c4abf9ce174932c3c122eef2b3729 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ceb463055475f5fdc8a77379c03bee1f 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=aee69538cc9b9a846316fdcb58300876 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=c091bafac5ce7476fbc10c00a314f7bb 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=bf47d74856b0891e7ae019fb1404cd54 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">For builders</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Request support for any chain, and we'll spin up real-time subgraphs and APIs with enterprise grade reliability. No throttling, or stale data – just the data you need to build high-throughput applications.
      </p>
    </div>
  </a>
</div>


# How to query a Uniswap v4 subgraph with Ormi 0xGraph
Source: https://docs.ormilabs.com/subgraphs/query-data/querying-a-subgraph

Subgraphs provides fast, reliable, and structured access to onchain data - without the need to run your own indexing infrastructure.

<div
  style={{
margin: '0',
padding: '1rem 1.25rem',
overflow: 'hidden',
borderRadius: '1rem',
display: 'flex',
gap: '0.75rem',
border: '1px solid rgba(113, 113, 122, 0.2)',
backgroundColor: 'rgba(244, 244, 245, 0.5)'
}}
>
  <div style={{ marginTop: '0.125rem', width: '1rem' }}>
    <svg
      viewBox="0 0 20 20"
      fill="currentColor"
      xmlns="http://www.w3.org/2000/svg"
      style={{ 
    width: '1.25rem', 
    height: '1.25rem', 
    color: 'rgba(113, 113, 122, 0.6)' 
  }}
    >
      <path d="M8 0C3.58125 0 0 3.58125 0 8C0 12.4187 3.58125 16 8 16C12.4187 16 16 12.4187 16 8C16 3.58125 12.4187 0 8 0ZM8 14.5C4.41563 14.5 1.5 11.5841 1.5 8C1.5 4.41594 4.41563 1.5 8 1.5C11.5844 1.5 14.5 4.41594 14.5 8C14.5 11.5841 11.5844 14.5 8 14.5ZM9.25 10.5H8.75V7.75C8.75 7.3375 8.41563 7 8 7H7C6.5875 7 6.25 7.3375 6.25 7.75C6.25 8.1625 6.5875 8.5 7 8.5H7.25V10.5H6.75C6.3375 10.5 6 10.8375 6 11.25C6 11.6625 6.3375 12 6.75 12H9.25C9.66406 12 10 11.6641 10 11.25C10 10.8359 9.66563 10.5 9.25 10.5ZM8 6C8.55219 6 9 5.55219 9 5C9 4.44781 8.55219 4 8 4C7.44781 4 7 4.44687 7 5C7 5.55313 7.44687 6 8 6Z" />
    </svg>
  </div>

  <div style={{ fontSize: '0.875rem', minWidth: '0', width: '100%' }}>
    <h3 style={{ fontWeight: '600', margin: '0 0 0.5rem 0' }}>Start querying Uniswap v4 instantly</h3>
    <p style={{ margin: '0' }}>Uniswap v4 data on Base is already indexed and ready to use on Ormi. With a free developer account, you can start querying protocol data right away - no setup, no credit card required. [Start free.](http://app.ormilabs.com/)</p>
  </div>
</div>

## Go to the 0xGraph page and click on the URL icon

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=382d999f1c440c34e797f57dba87e8df" alt="0xGraph graph init" data-og-width="1540" width="1540" data-og-height="840" height="840" data-path="images/how-to/subgraph-query.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=54773c5106c3f173973992d9f0805afc 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=c5a5993144e34a18a358f999feab9571 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ad46999bb8b8ee9cea021dafc3ce9568 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e8d59304629271ba9ed27eec9b4c0ba1 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=4b11dbfe385bb6e5909151896bc10a53 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6d6c957d57a3a4e37738a2cd1b192c5a 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## Open GraphiQL Explorer

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query2.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e6be210c428276aa4299b843c33ccd57" alt="0xGraph graph init" data-og-width="1894" width="1894" data-og-height="907" height="907" data-path="images/how-to/subgraph-query2.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query2.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=c9260e34380bd76f9df6477c3259665b 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query2.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=5f5cf0dbb1137d6b80ff6755dd6966eb 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query2.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=81a5931f9337f3fba45a1710dbbb6d0c 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query2.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=741c894d79bba679e55321024fe6c4d0 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query2.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=93ff571d13a889d4cd06f26c2e6e8436 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query2.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=468fbef2697f417757e6f39635865467 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## Introspect the schema

After opening the Explorer, you'll be able to see available entites, for example pool, swap, poolDayData, etc.

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query3.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=281531b32e4358ad7fb203352bde039f" alt="0xGraph graph init" data-og-width="1908" width="1908" data-og-height="1257" height="1257" data-path="images/how-to/subgraph-query3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query3.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=50899432d9f8f65d1fa959a1210fb29a 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query3.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=87fe388fdc007012dd74ecb7b0adb4f1 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query3.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=3b3426380f4cee507a8cd1ff1019c2e2 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query3.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=d59c214f4d5f5f92b26e24345e0112c7 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query3.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=f701139e2254181cac142641fa16b04b 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query3.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=b64f837848c3081a7f4cfcb466bcda19 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## Core entities and what they mean

* `uniswapDayDatas` - protocol-wide daily snapshot
* `poolManager`- Uniswap's global accounting contract. Holds network-wide stats like total volume, fees and pool counts.
* `pools` / `pool` - A liquidity pool which tracks liquidity, swaps, ticks, etc.
* `poolDayDatas` - Daily snapshots for one pool.
* `tokenDayDatas` - Daily snapshot for a token across all pools.
* `swaps` - Individual trade events like buyer/seller, amounts, timestamp.
* `positions` - Liqiuidty provider positions.

## Creating your own query using Explorer

<Frame>
  <img src="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query4.png?fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=6bd6a85caa491f50d55839663181b17e" alt="0xGraph graph init" data-og-width="1878" width="1878" data-og-height="899" height="899" data-path="images/how-to/subgraph-query4.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query4.png?w=280&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=785c33e8237d85d2b5a2261999ea6d3e 280w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query4.png?w=560&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=907a45407cebb08788c833661c38838a 560w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query4.png?w=840&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=cadd73eac6fa9181e2f4ac04ce01dbc4 840w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query4.png?w=1100&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=a50b82613206866ef6ab221e2aa1b047 1100w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query4.png?w=1650&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=ded25fafcaf63fee897d2a860ecfcbbd 1650w, https://mintcdn.com/ormilabs/XdTpJ0jGUKw4Ynly/images/how-to/subgraph-query4.png?w=2500&fit=max&auto=format&n=XdTpJ0jGUKw4Ynly&q=85&s=e51a2c791e5e5652c4c7ea05970019d7 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

1. Select the entities and fields you want to query.
2. Press run
3. Get output

In this example, I ran:

### Input

```
query {
  uniswapDayDatas {
    id
    date
    volumeETH
    volumeUSD
    volumeUSDUntracked
    feesUSD
    txCount
    tvlUSD
  }
}
```

### Output

```
{
  "data": {
    "uniswapDayDatas": [
      {
        "id": "20110",
        "date": 1737504000,
        "volumeETH": "0",
        "volumeUSD": "0",
        "volumeUSDUntracked": "0",
        "feesUSD": "0",
        "txCount": "1",
        "tvlUSD": "0"
      },
      {
        "id": "20111",
        "date": 1737590400,
        "volumeETH": "0.03825796132944227393357183151400676",
        "volumeUSD": "137.4168486184123701729440534967298",
        "volumeUSDUntracked": "0",
        "feesUSD": "0.2895005352096755986878110059489288",
        "txCount": "78",
        "tvlUSD": "277.7215175412274270560062480579528"
      },
```

## Querying for pool-level daily stats

### Input

```
{
  poolManager(id: "0x498581ff718922c3f8e6a244956af099b2652b2b") {
    poolCount
    txCount
    totalVolumeUSD
    totalVolumeETH
  }
}
```

* `poolCount` - how many pools exist
* `txCount` - total txns / swaps recorded
* `totalVolumeUSD/ETH` - cumulative trading volume since launch

### Output

```
{
  "data": {
    "poolManager": {
      "poolCount": "6404",
      "txCount": "2660638",
      "totalVolumeUSD": "118888687.8347001359469929298875743",
      "totalVolumeETH": "51610.64004064559902428529500862623"
    }
  }
}
```

## You can now start querying!


# Quickstart
Source: https://docs.ormilabs.com/subgraphs/quickstart

Deploy and query your first subgraph with Ormi in minutes.

<div
  style={{
margin: '0',
padding: '1rem 1.25rem',
overflow: 'hidden',
borderRadius: '1rem',
display: 'flex',
gap: '0.75rem',
border: '1px solid rgba(113, 113, 122, 0.2)',
backgroundColor: 'rgba(244, 244, 245, 0.5)'
}}
>
  <div style={{ marginTop: '0.125rem', width: '1rem' }}>
    <svg
      viewBox="0 0 20 20"
      fill="currentColor"
      xmlns="http://www.w3.org/2000/svg"
      style={{ 
    width: '1.25rem', 
    height: '1.25rem', 
    color: 'rgba(113, 113, 122, 0.6)' 
  }}
    >
      <path d="M8 0C3.58125 0 0 3.58125 0 8C0 12.4187 3.58125 16 8 16C12.4187 16 16 12.4187 16 8C16 3.58125 12.4187 0 8 0ZM8 14.5C4.41563 14.5 1.5 11.5841 1.5 8C1.5 4.41594 4.41563 1.5 8 1.5C11.5844 1.5 14.5 4.41594 14.5 8C14.5 11.5841 11.5844 14.5 8 14.5ZM9.25 10.5H8.75V7.75C8.75 7.3375 8.41563 7 8 7H7C6.5875 7 6.25 7.3375 6.25 7.75C6.25 8.1625 6.5875 8.5 7 8.5H7.25V10.5H6.75C6.3375 10.5 6 10.8375 6 11.25C6 11.6625 6.3375 12 6.75 12H9.25C9.66406 12 10 11.6641 10 11.25C10 10.8359 9.66563 10.5 9.25 10.5ZM8 6C8.55219 6 9 5.55219 9 5C9 4.44781 8.55219 4 8 4C7.44781 4 7 4.44687 7 5C7 5.55313 7.44687 6 8 6Z" />
    </svg>
  </div>

  <div style={{ fontSize: '0.875rem', minWidth: '0', width: '100%' }}>
    <h3 style={{ fontWeight: '600', margin: '0 0 0.5rem 0' }}>No account yet?</h3>
    <p style={{ margin: '0' }}> [Create an account](http://app.ormilabs.com) - free dev plan, no card required. </p>
  </div>
</div>

## Choose your path

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/subgraphs/deploy-a-subgraph/use-template-subgraphs"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <span style={{
            display: 'inline-block',
            width: 'fit-content',
            padding: '0.25rem 0.75rem',
            borderRadius: '0.375rem',
            fontSize: '0.75rem',
            fontWeight: '600',
            backgroundColor: 'transparent',
            border: '1.5px solid #00BFFF',
            color: '#00BFFF',
            marginBottom: '0.75rem'
          }}>FASTEST</span>

      <div className="flex items-center mb-4">
        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Deploy from a template</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Start instantly with a prebuilt community subgraph and query live data in seconds.
      </p>
    </div>
  </a>

  <a
    href="/subgraphs/deploy-a-subgraph/deploy-with-contract"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <span style={{
            display: 'inline-block',
            width: 'fit-content',
            padding: '0.25rem 0.75rem',
            borderRadius: '0.375rem',
            fontSize: '0.75rem',
            fontWeight: '600',
            backgroundColor: 'transparent',
            border: '1.5px solid #34D399',
            color: '#34D399',
            marginBottom: '0.75rem'
          }}>NO-CODE</span>

      <div className="flex items-center mb-4">
        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Deploy with a contract address</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Enter a contract address and Ormi will auto-generate your subgraph configuration.
      </p>
    </div>
  </a>
</div>

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/subgraphs/deploy-a-subgraph/migrate-subgraphs"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <span style={{
            display: 'inline-block',
            width: 'fit-content',
            padding: '0.25rem 0.75rem',
            borderRadius: '0.375rem',
            fontSize: '0.75rem',
            fontWeight: '600',
            backgroundColor: 'transparent',
            border: '1.5px solid #f59E0B',
            color: '#f59E0B',
            marginBottom: '0.75rem'
          }}>NO-CODE MIGRATION</span>

      <div className="flex items-center mb-4">
        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Migrate with a deployment ID</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Import an existing subgraph from The Graph or another provider in just a few clicks.
      </p>
    </div>
  </a>

  <a
    href="/subgraphs/deploy-a-subgraph/build-subgraph"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <span style={{
            display: 'inline-block',
            width: 'fit-content',
            padding: '0.25rem 0.75rem',
            borderRadius: '0.375rem',
            fontSize: '0.75rem',
            fontWeight: '600',
            backgroundColor: 'transparent',
            border: '1.5px solid #6366F1',
            color: '#6366F1',
            marginBottom: '0.75rem'
          }}>ADVANCED</span>

      <div className="flex items-center mb-4">
        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Build a subgraph from scratch</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Manually define your schema, mappings, and manifest for full customization.
      </p>
    </div>
  </a>
</div>

## Don't know where to start?

<div
  className="not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto'
}}
>
  <a
    href="/subgraphs/overview#new-to-subgraphs%3F"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'block'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    padding: '1.25rem 1.5rem'
  }}
    >
      <div style={{ display: 'flex', alignItems: 'center', marginBottom: '0.5rem' }}>
        <div style={{ color: '#3E744D', marginRight: '0.75rem' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-right.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=04ba7de117969d7f90b5cc26181658d0" alt="start here icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/chevrons-right.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-right.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d7ea2337d1323a9e461b8efc5bd2b976 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-right.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=98a6ea25cb73832faf14f4f90784e78f 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-right.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f6333b2dfae66b4c281f89e2a46ef081 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-right.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=2494c7f1bffea5b8f42b8e09f54cab3a 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-right.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=131c2b42a209b161c2fa3273fa6d876c 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-right.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=c007b7fb798abd349d04dbc096b0cf65 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Start here
        </div>
      </div>

      <p className="text-gray-600 text-sm" style={{ margin: 0, lineHeight: '1.4' }}>
        New to subgraphs? Learn the basics of indexing and querying before you deploy your first one.
      </p>
    </div>
  </a>
</div>


# Creating an Ormi account
Source: https://docs.ormilabs.com/subgraphs/quickstart/creating-an-account

How to create your 0xGraph account in 1 minute

## **Step 1**: Head to the [Ormi App](https://app.ormilabs.com) to create an account

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-signup.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=bec33610b329a4114e00cee79fbf6639" alt="0xGraph App registration" data-og-width="1884" width="1884" data-og-height="894" height="894" data-path="images/0xgraph-signup.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-signup.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=c4eae8ad840903220162446bbd137361 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-signup.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=be338737f99080c19ea963e0603d0dc6 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-signup.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=eb3adfdb5ddf3976df58e128d54d2917 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-signup.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=98b3d7429b9a46435568cda811c2ca94 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-signup.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=63c695483dd68875bc4af0fe3a7775a6 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-signup.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=0f73c21cdc1cf224b4d20d75011a7506 2500w" />
</Frame>

## **Step 2**: Choose how you want to get started

Once you created an account, you can start working with subgraphs in different ways depending on your needs and experience level.

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-how-to-start.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=87c741002fb1ea9a0ab999bc43e79e56" alt="0xGraph Get started" data-og-width="1499" width="1499" data-og-height="956" height="956" data-path="images/0xgraph-how-to-start.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-how-to-start.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=246124cb603cb99ef9d3d4de94b608cc 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-how-to-start.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=d8f9dfe915a608b4ba788554dd1f8706 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-how-to-start.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=1efe22516c0b2083729e1b8e5f3c8e78 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-how-to-start.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=4bbbc4b37cd61a653791b3f08a60a23a 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-how-to-start.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=affbea46ebb5bf09a8334facfb04b09f 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-how-to-start.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=c7ed3f5c3d4fcc5ffb0dd9e94d5df015 2500w" />

  <figcaption>Choose how to start</figcaption>
</Frame>

Ormi supports mutiple deployment methods, from beginner friendly to advance:

* **Basic**: [Explore existing subgraphs shared by the community.](/subgraphs/deploy-a-subgraph/use-template-subgraphs)
* **Basic**: [Deploy a no-code subgraph using a smart contract address.](/subgraphs/deploy-a-subgraph/deploy-with-contract)
* **Basic**: [Migrate an existing subgraph using a deployment ID](/subgraphs/deploy-a-subgraph/migrate-subgraphs)
* **Intermediate**: [Deploy via The Graph CLI](/subgraphs/deploy-a-subgraph/deploy-subgraphs-via-cli)
* **Advanced**: [Build from scratch with your own manifest, schema, and mappings](/subgraphs/deploy-a-subgraph/build-subgraph)

## Next steps

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/subgraphs/quickstart/generate-an-api-key"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/key-round.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=2f535800d839afccfcbab75bd3d1d65c" alt="api key icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/key-round.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/key-round.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=6f0aadc8a87093d9d604e11108e23332 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/key-round.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=2ccf98b880c72f731de66bbb70650bb6 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/key-round.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5f9c5dcf9b9fd91d8baa156a53db5000 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/key-round.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=c89742f7b92e535265f89beeca895f16 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/key-round.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=791e37ef89d468e2126033ce09ee9464 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/key-round.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=cc4c3a0eceabf3e0219b298d8e2fb5e3 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">Create an API key</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Generate an API key to start querying your subgraph.
      </p>
    </div>
  </a>

  <a
    href="/subgraphs/overview#new-to-subgraphs%3F"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'block'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    padding: '1.25rem 1.5rem'
  }}
    >
      <div style={{ display: 'flex', alignItems: 'center', marginBottom: '0.5rem' }}>
        <div style={{ color: '#3E744D', marginRight: '0.75rem' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-right.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=04ba7de117969d7f90b5cc26181658d0" alt="start here icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/chevrons-right.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-right.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d7ea2337d1323a9e461b8efc5bd2b976 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-right.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=98a6ea25cb73832faf14f4f90784e78f 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-right.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f6333b2dfae66b4c281f89e2a46ef081 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-right.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=2494c7f1bffea5b8f42b8e09f54cab3a 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-right.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=131c2b42a209b161c2fa3273fa6d876c 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/chevrons-right.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=c007b7fb798abd349d04dbc096b0cf65 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Start here
        </div>
      </div>

      <p className="text-gray-600 text-sm" style={{ margin: 0, lineHeight: '1.4' }}>
        New to subgraphs? Learn the basics of indexing and querying before you deploy your first one.
      </p>
    </div>
  </a>
</div>


# How to generate an API key
Source: https://docs.ormilabs.com/subgraphs/quickstart/generate-an-api-key



## **Step 1**: Go to the [API key page](https://app.ormilabs.com/dashboard/api) to generate an API key

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=ac4ade1e29e7be09629130b131f3dd1b" alt="0xGraph API Keys" data-og-width="1878" width="1878" data-og-height="784" height="784" data-path="images/0xgraph-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=9a7ce75c4a23f097f9c37aa2bb9bc23c 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=2d08282114911e455dfd5530d3ade80b 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=f10e634bc4879559c80c6512fbac4925 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=0abb78bac049e0f3c2c71b4a0f608ae6 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=bf2ee85dba964b271417f70f8aebf435 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-api-key.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=156187b64fa5fcb67843bc3a5082d638 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

## **Step 2**: Click on 'Create API Key' to generate an API key.

<Frame>
  <img src="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=27378c8be18ab8c673ad359d766c74b9" alt="0xGraph API Keys" data-og-width="1905" width="1905" data-og-height="850" height="850" data-path="images/0xgraph-generated-api-key.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=280&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=3b84276a591ade543b0235093dab3ba2 280w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=560&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=ec35293209dda94aeda54b1210c84d36 560w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=840&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=7236ffe8e39e0459a54908d7ef2c6bcd 840w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=1100&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=d6f81496480361d508cb5bcb87197969 1100w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=1650&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=d2d0046a932f52af19be8d53090f8902 1650w, https://mintcdn.com/ormilabs/QF_fmnEzWAEcNv02/images/0xgraph-generated-api-key.png?w=2500&fit=max&auto=format&n=QF_fmnEzWAEcNv02&q=85&s=0e5e3a1fc56de44929e488f2f40e4147 2500w" />

  <figcaption>API Keys</figcaption>
</Frame>

After generating an API key, you can then copy and paste it into your commands as needed.

<Info>
  Warning: Always handle your API keys securely. Do not expose them in client-side code or share them publicly. Store them in a secure location, such as
  environment variables, and rotate them regularly to minimize security risks. If compromised, regenerate your API key immediately. For public repositories,
  store API keys in a .env file and add .env to .gitignore to prevent accidental exposure in your codebase.
</Info>

## Next steps

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/subgraphs/overview#new-to-subgraphs%3F"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'block',
  height: '100%'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    padding: '1.25rem 1.5rem',
    height: '100%',
    display: 'flex',
    flexDirection: 'column'
  }}
    >
      <div style={{ display: 'flex', alignItems: 'center', marginBottom: '0.5rem' }}>
        <div style={{ color: '#3E744D', marginRight: '0.75rem' }}>
          <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round">
            <path d="m6 17 5-5-5-5" />

            <path d="m13 17 5-5-5-5" />
          </svg>
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Start here
        </div>
      </div>

      <p className="text-gray-600 text-sm" style={{ margin: 0, lineHeight: '1.4' }}>
        New to subgraphs? Learn the basics of indexing and querying before you deploy your first one.
      </p>
    </div>
  </a>

  <a
    href="/subgraphs/quickstart"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'block',
  height: '100%'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    padding: '1.25rem 1.5rem',
    height: '100%',
    display: 'flex',
    flexDirection: 'column'
  }}
    >
      <div style={{ display: 'flex', alignItems: 'center', marginBottom: '0.5rem' }}>
        <div style={{ color: '#3E744D', marginRight: '0.75rem' }}>
          <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round">
            <path d="M5 5a2 2 0 0 1 3.008-1.728l11.997 6.998a2 2 0 0 1 .003 3.458l-12 7A2 2 0 0 1 5 19z" />
          </svg>
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Quickstart
        </div>
      </div>

      <p className="text-gray-600 text-sm" style={{ margin: 0, lineHeight: '1.4' }}>
        Deploy and query your first subgraph with Ormi in minutes.
      </p>
    </div>
  </a>
</div>


# Supported chains on 0xAPI
Source: https://docs.ormilabs.com/supported-chains/data-api

Ormi supports EVM and non-EVM chains across L1s, L2s, and L3s.

| Name                | Type    | Network Slug          |
| ------------------- | ------- | --------------------- |
| Arbitrum            | Mainnet | `arbitrum-one`        |
| Arbitrum Sepolia    | Testnet | `arbitrum-sepolia`    |
| Base                | Mainnet | `base`                |
| Base Sepolia        | Testnet | `base-sepolia`        |
| Berachain           | Mainnet | `berachain`           |
| Berachain Testnet   | Testnet | `berachain-testnet`   |
| Binance             | Mainnet | `bsc`                 |
| Blast               | Mainnet | `blast`               |
| Botanix             | Mainnet | `botanix`             |
| Botanix Testnet     | Testnet | `botanix-testnet`     |
| Cronos              | Mainnet | `cronos`              |
| Cronos Testnet      | Testnet | `cronos-testnet`      |
| Ethereum            | Mainnet | `mainnet`             |
| Ethereum Sepolia    | Testnet | `sepolia`             |
| Form Testnet        | Testnet | `form-testnet`        |
| Gnosis              | Mainnet | `gnosis`              |
| Hyperevm            | Mainnet | `hyperevm`            |
| Injective           | Testnet | `injective-testnet`   |
| Katana              | Mainnet | `katana`              |
| Katana Tatara       | Testnet | `katana-tatara`       |
| Linea               | Mainnet | `linea`               |
| Manta               | Mainnet | `manta`               |
| Mantle              | Mainnet | `mantle`              |
| Metis               | Mainnet | `andromeda`           |
| Megaeth Testnet     | Testnet | `megaeth-testnet`     |
| Mode                | Mainnet | `mode`                |
| Mode Sepolia        | Testnet | `mode-sepolia`        |
| Monad Testnet       | Testnet | `monad-testnet`       |
| Optimism            | Mainnet | `optimism`            |
| Plasma              | Mainnet | `plasma`              |
| Polygon             | Mainnet | `polygon`             |
| Polygon Amoy        | Testnet | `polygon-amoy`        |
| Soneium             | Mainnet | `soneium`             |
| Sonic               | Mainnet | `sonic`               |
| Sonic Blaze Testnet | Testnet | `sonic-blaze-testnet` |
| Taiko               | Mainnet | `taiko`               |
| Unichain            | Mainnet | `unichain`            |

## Ecosystem partners

<div
  className="not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto'
}}
>
  <a
    href="/dedicated-env/overview"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'block'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    padding: '1.25rem 1.5rem'
  }}
    >
      <div style={{ display: 'flex', alignItems: 'center', marginBottom: '0.5rem' }}>
        <div style={{ color: '#3E744D', marginRight: '0.75rem' }}>
          <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round">
            <rect width="20" height="8" x="2" y="2" rx="2" ry="2" />

            <rect width="20" height="8" x="2" y="14" rx="2" ry="2" />

            <line x1="6" x2="6.01" y1="6" y2="6" />

            <line x1="6" x2="6.01" y1="18" y2="18" />
          </svg>
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Chains running on our custom infrastructure
        </div>
      </div>

      <p className="text-gray-600 text-sm" style={{ margin: 0, lineHeight: '1.4' }}>
        Explore chain ecosystems hosted on Ormi's dedicated infrastructure for high availability, faster indexing, and real-time data performance.
      </p>
    </div>
  </a>
</div>

## Need another chain?

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="https://forms.fillout.com/t/66AyD9bdZvus"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ebadba019a911b27f922ea79588b939d" alt="ecosystem icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/boxes.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d13c22a16e1077c57a96e4eea973eb85 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=fc8ccea3fe21d83c7391877396575949 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=1c91a2a34350eed8e9f6018ca47919a0 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8cd2cb4551e3d0655fb8e73da106826e 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4b534dcd403e58e53cf1b2ff6dd5160b 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ee44bdce4df96eaa59c74d5c426a19dc 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">For ecosystems</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Partner with Ormi to power your ecosystem with subgraphs and APIs that are real-time, reliable, and fully white-labeled. Give your developers enterprise-grade data under your own brand.
      </p>
    </div>
  </a>

  <a
    href="https://forms.fillout.com/t/2U1EKfDebbus"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7abf3ee5e020a6c691989d0333b1bf3f" alt="builder icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/laptop.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=162396f09b219713bf2ba0bfdb68228d 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=611c4abf9ce174932c3c122eef2b3729 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ceb463055475f5fdc8a77379c03bee1f 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=aee69538cc9b9a846316fdcb58300876 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=c091bafac5ce7476fbc10c00a314f7bb 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=bf47d74856b0891e7ae019fb1404cd54 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">For builders</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Request support for any chain, and we'll spin up real-time subgraphs and APIs with enterprise grade reliability. No throttling, or stale data – just the data you need to build high-throughput applications.
      </p>
    </div>
  </a>
</div>


# Supported chains
Source: https://docs.ormilabs.com/supported-chains/overview

Supported blockchain networks

## By product

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="/supported-chains/subgraphs"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round">
            <path d="M19.5 7a24 24 0 0 1 0 10" />

            <path d="M4.5 7a24 24 0 0 0 0 10" />

            <path d="M7 19.5a24 24 0 0 0 10 0" />

            <path d="M7 4.5a24 24 0 0 1 10 0" />

            <rect x="17" y="17" width="5" height="5" rx="1" />

            <rect x="17" y="2" width="5" height="5" rx="1" />

            <rect x="2" y="17" width="5" height="5" rx="1" />

            <rect x="2" y="2" width="5" height="5" rx="1" />
          </svg>
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">0xGraph</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Browse all supported mainnets and testnets across EVM, L2s, and non-EVM chains. Currently supporting over 70 chains.
      </p>
    </div>
  </a>

  <a
    href="/supported-chains/data-api"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round">
            <path d="M8 3H7a2 2 0 0 0-2 2v5a2 2 0 0 1-2 2 2 2 0 0 1 2 2v5c0 1.1.9 2 2 2h1" />

            <path d="M16 21h1a2 2 0 0 0 2-2v-5c0-1.1.9-2 2-2a2 2 0 0 1-2-2V5a2 2 0 0 0-2-2h-1" />
          </svg>
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">0xAPI</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Browse all supported mainnets and testnets across EVM, L2s, and non-EVM chains. Currently supporting over 100 chains.
      </p>
    </div>
  </a>
</div>

## Dedicated environment

<div
  className="not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto'
}}
>
  <a
    href="/dedicated-env/overview"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'block'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    padding: '1.25rem 1.5rem'
  }}
    >
      <div style={{ display: 'flex', alignItems: 'center', marginBottom: '0.5rem' }}>
        <div style={{ color: '#3E744D', marginRight: '0.75rem' }}>
          <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round">
            <rect width="20" height="8" x="2" y="2" rx="2" ry="2" />

            <rect width="20" height="8" x="2" y="14" rx="2" ry="2" />

            <line x1="6" x2="6.01" y1="6" y2="6" />

            <line x1="6" x2="6.01" y1="18" y2="18" />
          </svg>
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Chains running on our custom infrastructure
        </div>
      </div>

      <p className="text-gray-600 text-sm" style={{ margin: 0, lineHeight: '1.4' }}>
        Explore chain ecosystems hosted on Ormi's dedicated infrastructure for high availability, faster indexing, and real-time data performance.
      </p>
    </div>
  </a>
</div>


# Supported chains on 0xGraph
Source: https://docs.ormilabs.com/supported-chains/subgraphs

Ormi supports EVM and non-EVM chains across L1s, L2s, and L3s.

| Name                | Type    | Network Slug          |
| ------------------- | ------- | --------------------- |
| Arbitrum            | Mainnet | `arbitrum-one`        |
| Arbitrum Sepolia    | Testnet | `arbitrum-sepolia`    |
| Avalanche           | Mainnet | `avalanche`           |
| Avalanche Fuji      | Testnet | `avalanche-fuji`      |
| Base                | Mainnet | `base`                |
| Base Sepolia        | Testnet | `base-sepolia`        |
| Berachain           | Mainnet | `berachain`           |
| Berachain Testnet   | Testnet | `berachain-testnet`   |
| Binance             | Mainnet | `bsc`                 |
| Blast               | Mainnet | `blast`               |
| Botanix             | Mainnet | `botanix`             |
| Botanix Testnet     | Testnet | `botanix-testnet`     |
| Cronos              | Mainnet | `cronos`              |
| Cronos Testnet      | Testnet | `cronos-testnet`      |
| Ethereum            | Mainnet | `mainnet`             |
| Ethereum Sepolia    | Testnet | `sepolia`             |
| Form Testnet        | Testnet | `form-testnet`        |
| Gnosis              | Mainnet | `gnosis`              |
| Hyperevm            | Mainnet | `hyperevm`            |
| Injective           | Mainnet | `injective-mainnet`   |
| Injective           | Testnet | `injective-testnet`   |
| Katana              | Mainnet | `katana`              |
| Katana Tatara       | Testnet | `katana-tatara`       |
| Kite AI             | Testnet | `kiteai-testnet`      |
| Linea               | Mainnet | `linea`               |
| Manta               | Mainnet | `manta`               |
| Mantle              | Mainnet | `mantle`              |
| Metis               | Mainnet | `andromeda`           |
| MegaETH Timothy     | Testnet | `megaeth-timothy`     |
| Mode                | Mainnet | `mode`                |
| Mode Sepolia        | Testnet | `mode-sepolia`        |
| Monad               | Mainnet | `monad`               |
| Monad Testnet       | Testnet | `monad-testnet`       |
| Optimism            | Mainnet | `optimism`            |
| Plasma              | Mainnet | `plasma`              |
| Polygon             | Mainnet | `polygon`             |
| Polygon Amoy        | Testnet | `polygon-amoy`        |
| Soneium             | Mainnet | `soneium`             |
| Sonic               | Mainnet | `sonic`               |
| Sonic Blaze Testnet | Testnet | `sonic-blaze-testnet` |
| Stable              | Mainnet | `stable`              |
| Stable              | Testnet | `stable-testnet`      |
| Taiko               | Mainnet | `taiko`               |
| Unichain            | Mainnet | `unichain`            |

## In preview

| Name               | Type    | Network Slug         |
| ------------------ | ------- | -------------------- |
| Camp Sepolia       | Testnet | `camp-sepolia`       |
| Frax               | Mainnet | `frax`               |
| Ink                | Mainnet | `ink`                |
| Ink Sepolia        | Testnet | `ink-sepolia`        |
| Polynomial         | Mainnet | `polynomial`         |
| Polynomial Sepolia | Testnet | `polynomial-sepolia` |
| Shape              | Mainnet | `shape`              |
| Shape Sepolia      | Testnet | `shape-sepolia`      |
| Soneium Sepolia    | Testnet | `soneium-sepolia`    |
| Unichain Sepolia   | Testnet | `unichain-sepolia`   |
| Worldchain         | Mainnet | `worldchain`         |
| Worldchain Sepolia | Testnet | `worldchain-sepolia` |
| Xai                | Mainnet | `xai`                |
| Xai Testnet        | Testnet | `xai-testnet`        |
| Zora               | Mainnet | `zora`               |
| Zora Sepolia       | Testnet | `zora-sepolia`       |

## Ecosystem partners

<div
  className="not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto'
}}
>
  <a
    href="/dedicated-env/overview"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'block'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    padding: '1.25rem 1.5rem'
  }}
    >
      <div style={{ display: 'flex', alignItems: 'center', marginBottom: '0.5rem' }}>
        <div style={{ color: '#3E744D', marginRight: '0.75rem' }}>
          <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round">
            <rect width="20" height="8" x="2" y="2" rx="2" ry="2" />

            <rect width="20" height="8" x="2" y="14" rx="2" ry="2" />

            <line x1="6" x2="6.01" y1="6" y2="6" />

            <line x1="6" x2="6.01" y1="18" y2="18" />
          </svg>
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          Chains running on our custom infrastructure
        </div>
      </div>

      <p className="text-gray-600 text-sm" style={{ margin: 0, lineHeight: '1.4' }}>
        Explore chain ecosystems hosted on Ormi's dedicated infrastructure for high availability, faster indexing, and real-time data performance.
      </p>
    </div>
  </a>
</div>

## Need another chain?

<div
  className="grid grid-cols-1 md:grid-cols-2 gap-6 not-prose"
  style={{
marginBottom: '4rem',
maxWidth: '1200px',
margin: '0 auto 4rem auto',
alignItems: 'stretch'
}}
>
  <a
    href="https://forms.fillout.com/t/66AyD9bdZvus"
    style={{
  textDecoration: 'none',
  color: 'inherit',
  display: 'flex'
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: '200px',
    display: 'flex',
    flexDirection: 'column',
    width: '100%'
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: '#3E744D' }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ebadba019a911b27f922ea79588b939d" alt="ecosystem icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/boxes.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d13c22a16e1077c57a96e4eea973eb85 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=fc8ccea3fe21d83c7391877396575949 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=1c91a2a34350eed8e9f6018ca47919a0 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8cd2cb4551e3d0655fb8e73da106826e 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4b534dcd403e58e53cf1b2ff6dd5160b 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/boxes.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ee44bdce4df96eaa59c74d5c426a19dc 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">For ecosystems</div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Partner with Ormi to power your ecosystem with subgraphs and APIs that are real-time, reliable, and fully white-labeled. Give your developers enterprise-grade data under your own brand.
      </p>
    </div>
  </a>

  {" "}

  <a
    href="https://forms.fillout.com/t/2U1EKfDebbus"
    style={{
  textDecoration: "none",
  color: "inherit",
  display: "flex",
}}
  >
    <div
      className="group border border-gray-200 rounded-xl p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
      style={{
    minHeight: "200px",
    display: "flex",
    flexDirection: "column",
    width: "100%",
  }}
    >
      <div className="flex items-center mb-4">
        <div className="mr-3" style={{ color: "#3E744D" }}>
          <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7abf3ee5e020a6c691989d0333b1bf3f" alt="builder icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/laptop.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=162396f09b219713bf2ba0bfdb68228d 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=611c4abf9ce174932c3c122eef2b3729 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ceb463055475f5fdc8a77379c03bee1f 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=aee69538cc9b9a846316fdcb58300876 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=c091bafac5ce7476fbc10c00a314f7bb 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/laptop.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=bf47d74856b0891e7ae019fb1404cd54 2500w" />
        </div>

        <div className="text-lg font-semibold text-gray-900" role="heading" aria-level="3">
          For builders
        </div>
      </div>

      <p className="text-gray-600 text-sm flex-grow">
        Request support for any chain, and we'll spin up real-time subgraphs and APIs with enterprise grade reliability. No throttling, or stale data – just the
        data you need to build high-throughput applications.
      </p>
    </div>
  </a>
</div>


# null
Source: https://docs.ormilabs.com/welcome



<div
  style={{
  display: "flex",
  flexDirection: "column",
  alignItems: "center",
  justifyContent: "center",
  textAlign: "center",
  width: "100%",
  maxWidth: "1200px",
  margin: "0 auto",
  padding: "2rem 1rem 1rem 1rem",
}}
>
  <h1
    style={{
    fontSize: "clamp(2rem, 8vw, 4rem)",
    fontWeight: "700",
    marginBottom: "1rem",
    color: "#1a1a1a",
    lineHeight: "1.1",
    textAlign: "center",
    wordBreak: "break-word",
  }}
  >
    **Ormi Documentation**
  </h1>

  <p
    style={{
    fontSize: "clamp(1rem, 3vw, 1.5rem)",
    color: "#6b7280",
    maxWidth: "800px",
    margin: "0 auto 2rem auto",
    lineHeight: "1.6",
    textAlign: "center",
    padding: "0 1rem",
  }}
  >
    Learn how to index and query blockchain data via Subgraphs and Data API
  </p>

  <div
    style={{
    width: "100%",
    maxWidth: "350px",
    margin: "0 auto",
    padding: "0 1rem",
  }}
  >
    <button
      type="button"
      id="home-search-entry"
      onMouseDown={() => {
      setTimeout(() => {
        const btn = document.getElementById("search-bar-entry") || document.querySelector('button[aria-label="Open search"]');
        if (btn) btn.click();
      }, 0);
    }}
      style={{
      width: "100%",
      padding: "0.75rem 1rem",
      border: "1px solid #e5e7eb",
      borderRadius: "8px",
      fontSize: "0.9rem",
      backgroundColor: "#f9fafb",
      color: "#9ca3af",
      cursor: "pointer",
      textAlign: "left",
      outline: "none",
    }}
    >
      Search...
    </button>
  </div>
</div>

<div
  style={{
fontSize: 'clamp(1.25rem, 4vw, 1.75rem)',
fontWeight: '600', 
marginBottom: '1.5rem',
marginTop: '2rem',
color: '#1a1a1a',
textAlign: 'center',
padding: '0 1rem'
}}
>
  ## 0xGraph (Subgraphs)
</div>

<div
  className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-4 md:gap-6 not-prose"
  style={{
marginBottom: '3rem',
maxWidth: '1200px',
margin: '0 auto 3rem auto',
width: '100%',
padding: '0 1rem'
}}
>
  <div
    className="group border border-gray-200 rounded-xl p-4 md:p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
    style={{
  minHeight: '140px',
  display: 'flex',
  flexDirection: 'column'
}}
    onClick={() => window.location.href = '/subgraphs/overview'}
  >
    <div className="flex items-center mb-3 md:mb-4">
      <div className="mr-3" style={{ color: '#3E744D' }}>
        <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/table-of-contents.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ece9dc4d518cb8f0b5e0c235b8789c1d" alt="TOC icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/table-of-contents.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/table-of-contents.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=6ee177a98e60e1d6e3e219f0737939f6 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/table-of-contents.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=78b001cf3d2caebaf43aa1dcb8b33012 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/table-of-contents.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=63053de3e5167c53fa06ee96cdb97802 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/table-of-contents.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=0d060fc40f814e7bef2d2dbf1f23e169 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/table-of-contents.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=24ebf1db5f137dfe703c78e52ab41b55 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/table-of-contents.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=1592a9436f582387ed510d15a20aab1d 2500w" />
      </div>

      <h3 className="text-base md:text-lg font-semibold text-gray-900">Overview</h3>
    </div>

    <p className="text-gray-600 text-xs md:text-sm flex-grow">
      Learn more about subgraphs and what is available on the Ormi platform.
    </p>
  </div>

  {" "}

  <div
    className="group border border-gray-200 rounded-xl p-4 md:p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
    style={{
  minHeight: "140px",
  display: "flex",
  flexDirection: "column",
}}
    onClick={() => (window.location.href = "/subgraphs/quickstart")}
  >
    <div className="flex items-center mb-3 md:mb-4">
      <div className="mr-3" style={{ color: "#3E744D" }}>
        <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=cca7b26ac73e65453815fbe85b6c6d01" alt="start icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/quickstart.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=499bcd7a2f5b526ff905dd5e83885798 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=57aa39e42ca0bf768ce458874ad42321 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8062bcadbdaa365483ea6e545d413bb4 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7f3546557b416294e5b6f71c1949d230 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4dad90676bccde6863759fb27ad456c7 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7960022f64f10a2b868b24c3bbdc1791 2500w" />
      </div>

      <h3 className="text-base md:text-lg font-semibold text-gray-900">Quickstart</h3>
    </div>

    <p className="text-gray-600 text-xs md:text-sm flex-grow">See the different ways to create, deploy, and query a subgraph in minutes.</p>
  </div>

  {" "}

  <div
    className="group border border-gray-200 rounded-xl p-4 md:p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
    style={{
  minHeight: "140px",
  display: "flex",
  flexDirection: "column",
}}
    onClick={() => (window.location.href = "/subgraphs/features")}
  >
    <div className="flex items-center mb-3 md:mb-4">
      <div className="mr-3" style={{ color: "#3E744D" }}>
        <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/features.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=95203ba6b4ae4507b28fc8df1523527c" alt="features" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/features.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/features.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d4078970ebbbb3bc0a008b33b4962adf 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/features.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=39554d3ba47d537390e3cce166eee2db 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/features.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8184dd47a0b325a948a962801a332c29 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/features.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=c444141c644a5cee13c3d1a12935d913 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/features.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=e4bf2ccfda6375cf85b6bc175c833e1c 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/features.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=0629de00e2f483350ccdac8e6f0840de 2500w" />
      </div>

      <h3 className="text-base md:text-lg font-semibold text-gray-900">Features</h3>
    </div>

    <p className="text-gray-600 text-xs md:text-sm flex-grow">Explore the advanced features and capabilities available on Ormi 0xGraph.</p>
  </div>

  <div
    className="group border border-gray-200 rounded-xl p-4 md:p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
    style={{
  minHeight: "140px",
  display: "flex",
  flexDirection: "column",
}}
    onClick={() => (window.location.href = "/api-reference/0xGraph/overview")}
  >
    <div className="flex items-center mb-3 md:mb-4">
      <div className="mr-3" style={{ color: "#3E744D" }}>
        <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=dc1325f759209b38621fab13f4f37e17" alt="code" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/api-reference.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=30c07c6cfa89263e1350f2bf42ec5ca9 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=cfeea64b2a5a95339bd85f0a74b602d6 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f16bff35784f67eecd08de87049ce293 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=989c763850054f29f1689e04ab2a9ebf 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d0568d036c49c97058391408f1e27167 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=04d36ac4b8d783ebabe121b9b72c8b66 2500w" />
      </div>

      <h3 className="text-base md:text-lg font-semibold text-gray-900">API reference</h3>
    </div>

    <p className="text-gray-600 text-xs md:text-sm flex-grow">Explore references to the GraphQL API for Ormi subgraphs.</p>
  </div>

  {" "}

  <div
    className="group border border-gray-200 rounded-xl p-4 md:p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
    style={{
  minHeight: "140px",
  display: "flex",
  flexDirection: "column",
}}
    onClick={() => (window.location.href = "dedicated-env/overview")}
  >
    <div className="flex items-center mb-3 md:mb-4">
      <div className="mr-3" style={{ color: "#3E744D" }}>
        <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/dedicated-environment.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8b93a1dac0575f5294a9d43ca65a66a6" alt="server cog" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/dedicated-environment.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/dedicated-environment.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=88c71514d28147663363b35a67fe2588 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/dedicated-environment.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=18cec7a901f805832261a11549c76119 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/dedicated-environment.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=9de5a83a4f2ea03132d21fa25fe80ec7 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/dedicated-environment.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=affa8d8271c7d33c1048ae16981b0253 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/dedicated-environment.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=1d0b5ed2a8b8166e6a2fe58abe84fc76 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/dedicated-environment.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=04cc559c6b8e94362c9de7c15ae5c302 2500w" />
      </div>

      <h3 className="text-base md:text-lg font-semibold text-gray-900">Dedicated environment</h3>
    </div>

    <p className="text-gray-600 text-xs md:text-sm flex-grow">Learn how Ormi's custom infrastructure provides better performance at scale.</p>
  </div>

  {" "}

  <div
    className="group border border-gray-200 rounded-xl p-4 md:p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
    style={{
  minHeight: "140px",
  display: "flex",
  flexDirection: "column",
}}
    onClick={() => (window.location.href = "/supported-chains/subgraphs")}
  >
    <div className="flex items-center mb-3 md:mb-4">
      <div className="mr-3" style={{ color: "#3E744D" }}>
        <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=763219942a929fb35f1e728ffbcca310" alt="chains" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/link.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d2eb9296c3fc41d23b4a3cf2dee8c1e7 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=451350aeeed6a9b4d4366b7ae6d63dcd 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8f9ea18cdf4deeee05e3c44db0cf432d 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7f838361856d778ae65ddc91ca5609cc 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=34b862e55631e82b514e2db6302c5dfc 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5dde712015493301b0829c0b1565020f 2500w" />
      </div>

      <h3 className="text-base md:text-lg font-semibold text-gray-900">Supported chains</h3>
    </div>

    <p className="text-gray-600 text-xs md:text-sm flex-grow">See the full list of supported chains and networks on Ormi 0xGraph.</p>
  </div>
</div>

<div
  style={{
fontSize: 'clamp(1.25rem, 4vw, 1.75rem)',
fontWeight: '600',
marginBottom: '1.5rem',
marginTop: '2rem',
color: '#1a1a1a',
textAlign: 'center',
padding: '0 1rem'
}}
>
  ## 0xAPI (Data API)
</div>

<div
  className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-4 md:gap-6 not-prose"
  style={{
marginBottom: '3rem',
maxWidth: '1200px',
margin: '0 auto 3rem auto',
width: '100%',
padding: '0 1rem'
}}
>
  <div
    className="group border border-gray-200 rounded-xl p-4 md:p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
    style={{
  minHeight: "140px",
  display: "flex",
  flexDirection: "column",
}}
    onClick={() => (window.location.href = "/data-api/overview")}
  >
    <div className="flex items-center mb-3 md:mb-4">
      <div className="mr-3" style={{ color: "#3E744D" }}>
        <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/table-of-contents.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=ece9dc4d518cb8f0b5e0c235b8789c1d" alt="TOC icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/table-of-contents.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/table-of-contents.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=6ee177a98e60e1d6e3e219f0737939f6 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/table-of-contents.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=78b001cf3d2caebaf43aa1dcb8b33012 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/table-of-contents.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=63053de3e5167c53fa06ee96cdb97802 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/table-of-contents.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=0d060fc40f814e7bef2d2dbf1f23e169 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/table-of-contents.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=24ebf1db5f137dfe703c78e52ab41b55 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/table-of-contents.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=1592a9436f582387ed510d15a20aab1d 2500w" />
      </div>

      <h3 className="text-base md:text-lg font-semibold text-gray-900">Overview</h3>
    </div>

    <p className="text-gray-600 text-xs md:text-sm flex-grow">Learn more about our data API and what is available on the Ormi platform.</p>
  </div>

  <div
    className="group border border-gray-200 rounded-xl p-4 md:p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
    style={{
  minHeight: "140px",
  display: "flex",
  flexDirection: "column",
}}
    onClick={() => (window.location.href = "/data-api/quickstart")}
  >
    <div className="flex items-center mb-3 md:mb-4">
      <div className="mr-3" style={{ color: "#3E744D" }}>
        <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=cca7b26ac73e65453815fbe85b6c6d01" alt="start icon" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/quickstart.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=499bcd7a2f5b526ff905dd5e83885798 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=57aa39e42ca0bf768ce458874ad42321 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8062bcadbdaa365483ea6e545d413bb4 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7f3546557b416294e5b6f71c1949d230 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=4dad90676bccde6863759fb27ad456c7 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/quickstart.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7960022f64f10a2b868b24c3bbdc1791 2500w" />
      </div>

      <h3 className="text-base md:text-lg font-semibold text-gray-900">Quickstart</h3>
    </div>

    <p className="text-gray-600 text-xs md:text-sm flex-grow">Set up and make your first queries with the Data API in minutes.</p>
  </div>

  {" "}

  <div
    className="group border border-gray-200 rounded-xl p-4 md:p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
    style={{
  minHeight: "140px",
  display: "flex",
  flexDirection: "column",
}}
    onClick={() => (window.location.href = "/data-api/features")}
  >
    <div className="flex items-center mb-3 md:mb-4">
      <div className="mr-3" style={{ color: "#3E744D" }}>
        <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/features.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=95203ba6b4ae4507b28fc8df1523527c" alt="features" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/features.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/features.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d4078970ebbbb3bc0a008b33b4962adf 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/features.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=39554d3ba47d537390e3cce166eee2db 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/features.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8184dd47a0b325a948a962801a332c29 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/features.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=c444141c644a5cee13c3d1a12935d913 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/features.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=e4bf2ccfda6375cf85b6bc175c833e1c 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/features.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=0629de00e2f483350ccdac8e6f0840de 2500w" />
      </div>

      <h3 className="text-base md:text-lg font-semibold text-gray-900">Features</h3>
    </div>

    <p className="text-gray-600 text-xs md:text-sm flex-grow">Explore the advanced features and capabilities available on Ormi 0xAPI.</p>
  </div>

  {" "}

  <div
    className="group border border-gray-200 rounded-xl p-4 md:p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
    style={{
  minHeight: "140px",
  display: "flex",
  flexDirection: "column",
}}
    onClick={() => (window.location.href = "/api-reference/0xAPI/overview")}
  >
    <div className="flex items-center mb-3 md:mb-4">
      <div className="mr-3" style={{ color: "#3E744D" }}>
        <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=dc1325f759209b38621fab13f4f37e17" alt="code" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/api-reference.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=30c07c6cfa89263e1350f2bf42ec5ca9 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=cfeea64b2a5a95339bd85f0a74b602d6 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=f16bff35784f67eecd08de87049ce293 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=989c763850054f29f1689e04ab2a9ebf 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d0568d036c49c97058391408f1e27167 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/api-reference.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=04d36ac4b8d783ebabe121b9b72c8b66 2500w" />
      </div>

      <h3 className="text-base md:text-lg font-semibold text-gray-900">API reference</h3>
    </div>

    <p className="text-gray-600 text-xs md:text-sm flex-grow">Discover available data endpoints, their capabilities, and references.</p>
  </div>

  {" "}

  <div
    className="group border border-gray-200 rounded-xl p-4 md:p-6 transition-all duration-200"
    style={{
  minHeight: "140px",
  display: "flex",
  flexDirection: "column",
}}
  >
    <div className="flex items-center mb-3 md:mb-4">
      <div className="mr-3" style={{ color: "#3E744D" }}>
        <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/sdk.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=004209e57e4a1b5b17bf6c2a80cb952c" alt="blocks" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/sdk.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/sdk.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=b2e1fedfb8f1330259dd6a8cdc6abff7 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/sdk.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=2ed3369011047a69b07d08bb76625732 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/sdk.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=9b13d966a67327e7db603fdf10032830 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/sdk.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8f0a711c3113a0e398d754e69869170f 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/sdk.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=74279ffb43f46069e22b9877ddea2d21 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/sdk.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=b22e6bd7400afbffd8a1d3001ea7ec30 2500w" />
      </div>

      <div style={{ display: "flex", alignItems: "center", gap: "0.5rem", flexWrap: "wrap" }}>
        <h3 className="text-base md:text-lg font-semibold text-gray-900">SDKs</h3>

        <span
          style={{
        display: "inline-block",
        padding: "0.125rem 0.5rem",
        fontSize: "0.625rem",
        fontWeight: "600",
        backgroundColor: "#FEF3C7",
        color: "#92400E",
        borderRadius: "0.375rem",
        whiteSpace: "nowrap",
      }}
        >
          COMING SOON
        </span>
      </div>
    </div>

    <p className="text-gray-600 text-xs md:text-sm flex-grow">Use our SDKs for JavaScript, Python, and other languages.</p>
  </div>

  {" "}

  <div
    className="group border border-gray-200 rounded-xl p-4 md:p-6 hover:border-green-500 hover:shadow-lg transition-all duration-200 cursor-pointer"
    style={{
  minHeight: "140px",
  display: "flex",
  flexDirection: "column",
}}
    onClick={() => (window.location.href = "/supported-chains/data-api")}
  >
    <div className="flex items-center mb-3 md:mb-4">
      <div className="mr-3" style={{ color: "#3E744D" }}>
        <img src="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=763219942a929fb35f1e728ffbcca310" alt="chains" width="20" height="20" data-og-width="24" data-og-height="24" data-path="images/icons/link.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=280&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=d2eb9296c3fc41d23b4a3cf2dee8c1e7 280w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=560&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=451350aeeed6a9b4d4366b7ae6d63dcd 560w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=840&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=8f9ea18cdf4deeee05e3c44db0cf432d 840w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=1100&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=7f838361856d778ae65ddc91ca5609cc 1100w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=1650&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=34b862e55631e82b514e2db6302c5dfc 1650w, https://mintcdn.com/ormilabs/LCyQhOClKZ_IpXev/images/icons/link.svg?w=2500&fit=max&auto=format&n=LCyQhOClKZ_IpXev&q=85&s=5dde712015493301b0829c0b1565020f 2500w" />
      </div>

      <h3 className="text-base md:text-lg font-semibold text-gray-900">Supported chains</h3>
    </div>

    <p className="text-gray-600 text-xs md:text-sm flex-grow">See the full list of supported chains and networks on Ormi 0xAPI.</p>
  </div>
</div>

<div
  style={{
marginBottom: '2rem',
marginTop: '2rem',
}}
/>