Skip to main content

Graph Node Documentation

Index and query blockchain data with GraphQL. Graph Node is the core indexing component of The Graph protocol, enabling efficient access to blockchain data.

Graph Node

Quick Start

Get Graph Node running in minutes with Docker

1

Install Prerequisites

Ensure you have Docker, PostgreSQL, and IPFS installed on your system.
# Verify Docker installation
docker --version
2

Clone and Configure

Clone the repository and set up your configuration file.
git clone https://github.com/graphprotocol/graph-node
cd graph-node
3

Start with Docker Compose

Launch Graph Node, IPFS, and PostgreSQL using Docker Compose.
docker-compose up
graph-node_1  | Starting JSON-RPC admin server at: http://localhost:8020
graph-node_1  | Starting GraphQL HTTP server at: http://localhost:8000
graph-node_1  | Starting index node server at: http://localhost:8030
4

Access GraphQL Endpoint

Graph Node is now running. Access the GraphiQL interface at http://localhost:8000.You can query subgraphs using:
http://localhost:8000/subgraphs/name/<subgraph-name>

Explore by Topic

Jump into the documentation based on what you need to accomplish

Core Concepts

Understand how Graph Node works, from architecture to data flow

Running Graph Node

Set up and configure Graph Node in production or development

Deploy Subgraphs

Learn how to deploy and manage subgraphs on your Graph Node

GraphQL API

Query your indexed blockchain data with powerful GraphQL APIs

Graphman CLI

Manage deployments and perform operations with the Graphman CLI

Advanced Configuration

Scale with sharding, multi-database setups, and advanced tuning

Key Features

What makes Graph Node powerful for blockchain indexing

Multi-Chain Support

Index data from Ethereum, NEAR, and other blockchain networks with unified tooling

GraphQL Queries

Access indexed data through a powerful GraphQL API with filtering, sorting, and pagination

WASM Runtime

Execute custom data transformations with WebAssembly for flexible indexing logic

Scalable Architecture

Scale horizontally with database sharding and replicas for high-throughput workloads

Community & Support

Connect with the Graph Node community

GitHub Repository

Contribute to the project, report issues, and explore the source code

The Graph Forum

Join discussions and get help from the community

Ready to Start Indexing?

Deploy Graph Node and start querying blockchain data with GraphQL in minutes

Get Started Now