# SQD Documentation

> **Documentation Index**
> This file provides a structured overview of SQD's documentation for efficient LLM indexing.
> Last updated: 2026-01-26

## Overview

SQD provides a complete blockchain data infrastructure with 4 integrated products:

1. **SQD Network**: A decentralized network of 2000+ worker nodes providing blockchain data
2. **Portal**: Gateway to query blockchain data from the SQD Network via streaming HTTP API. Can be used directly via raw API or through SDKs. Users can also run their own Portal instance
3. **SDKs**: Developer tools for building blockchain indexers
   - **Pipes SDK**: SDK with composable data pipelines using sources, transformers, and targets
   - **Squid SDK**: SDK with TypeORM integration, GraphQL server support, and schema-based data modeling
4. **Cloud**: Managed hosting platform for deploying and running indexers built with the SDKs

## Getting Started

- [Home](/en/home): Introduction to SQD and quick navigation to key sections
- [Portal Overview](/en/portal/overview): Overview of SQD Portal and its capabilities
- [Portal Migration Hub](/en/portal/migration): Choose your migration path to Portal (Cloud, SDK, or RPC)

## Migration Guides

- [Cloud Portal Migration (EVM)](/en/portal/migration/cloud-portal-evm): Migrate Cloud squids from gateways to Portal
- [SDK Gateway to Portal](/en/sdk/migration/gateway-to-portal): Migrate SDK-based squids from gateways to Portal
- [RPC to Portal Migration](/en/sdk/migration/rpc-to-portal): Migrate EVM indexers from RPC-based real-time data to Portal API

## EVM Development

### Portal API (Raw)
- [EVM Portal Overview](/en/portal/evm/overview): Introduction to the raw Portal API for EVM chains
- [EVM Quickstart](/en/portal/evm/getting-started-quickstart): Get started with Portal API for EVM
- [Query Logs](/en/portal/evm/examples/query-logs): Example of querying EVM logs via Portal API
- [Query Transactions](/en/portal/evm/examples/query-transactions): Example of querying EVM transactions
- [Query Traces](/en/portal/evm/examples/query-traces): Example of querying EVM traces
- [NFT Transfers](/en/portal/evm/examples/nft-transfers): Track NFT transfers using Portal API
- [DEX Swaps](/en/portal/evm/examples/dex-swaps): Index DEX swap events
- [Contract Deployments](/en/portal/evm/examples/contract-deployments): Track smart contract deployments
- [State Diffs](/en/portal/evm/examples/state-diffs): Query state changes in EVM

### Pipes SDK (Beta)
- [Pipes SDK Quickstart](/en/sdk/pipes-sdk/evm.autogenerated/quickstart): Quick start guide for Pipes SDK on EVM
- [Pipes SDK Introduction](/en/sdk/pipes-sdk/evm.autogenerated/introduction): Core concepts and architecture of Pipes SDK
- [Getting Started Guide](/en/sdk/pipes-sdk/evm.autogenerated/guides/getting-started): Step-by-step setup for Pipes SDK
- [Event Decoding](/en/sdk/pipes-sdk/evm.autogenerated/guides/event-decoding): Decode EVM events with Pipes SDK
- [Data Persistence](/en/sdk/pipes-sdk/evm.autogenerated/guides/data-persistence): Store indexed data with Pipes SDK
- [Factory Pattern](/en/sdk/pipes-sdk/evm.autogenerated/guides/factory-pattern): Handle factory contracts in Pipes SDK
- [Sources & Query Builder](/en/sdk/pipes-sdk/evm.autogenerated/core-concepts/sources-query-builder): Define data sources and queries
- [Decoders](/en/sdk/pipes-sdk/evm.autogenerated/core-concepts/decoders): Decode blockchain data
- [Transformers](/en/sdk/pipes-sdk/evm.autogenerated/core-concepts/transformers): Transform and process data
- [Targets & Persistence](/en/sdk/pipes-sdk/evm.autogenerated/core-concepts/targets-persistence): Output processed data
- [ClickHouse Integration](/en/sdk/pipes-sdk/evm.autogenerated/integration-advanced/clickhouse): Use ClickHouse with Pipes SDK
- [PostgreSQL with Drizzle](/en/sdk/pipes-sdk/evm.autogenerated/integration-advanced/postgres-drizzle): PostgreSQL integration using Drizzle ORM
- [API Reference](/en/sdk/pipes-sdk/evm.autogenerated/reference/api-reference): Complete Pipes SDK API documentation

### Squid SDK
- [Squid SDK Quickstart](/en/sdk/squid-sdk/evm.autogenerated/quickstart): Get started with Squid SDK for EVM
- [Squid SDK Design](/en/sdk/squid-sdk/evm.autogenerated/design): Architecture and design principles
- [Make an Indexer](/en/sdk/squid-sdk/evm.autogenerated/guides/make-an-indexer): Create an EVM indexer with Squid SDK
- [Writing to Postgres](/en/sdk/squid-sdk/evm.autogenerated/guides/writing-to-postgres): Store data in PostgreSQL
- [Serving GraphQL](/en/sdk/squid-sdk/evm.autogenerated/guides/serving-graphql): Expose data via GraphQL API
- [Migrate from The Graph](/en/sdk/squid-sdk/evm.autogenerated/guides/migration/migrate-from-thegraph): Migration guide for The Graph users

## Solana Development

### Portal API (Raw)
- [Solana Portal Overview](/en/portal/solana/overview): Introduction to Portal API for Solana
- [Solana Quickstart](/en/portal/solana/quickstart): Get started with Solana Portal API
- [Query Instructions](/en/portal/solana/examples/query-instructions): Example of querying Solana instructions
- [Token Transfers](/en/portal/solana/examples/token-transfers): Track Solana token transfers
- [Query Transactions](/en/portal/solana/examples/query-transactions): Query Solana transactions
- [DEX Swaps](/en/portal/solana/examples/dex-swaps): Index Solana DEX swaps
- [Program Deployments](/en/portal/solana/examples/program-deployments): Track Solana program deployments

### Pipes SDK (Beta)
- [Solana Pipes SDK Quickstart](/en/sdk/pipes-sdk/solana.autogenerated/quickstart): Quick start for Solana Pipes SDK
- [Instruction Decoding](/en/sdk/pipes-sdk/solana.autogenerated/guides/instruction-decoding): Decode Solana instructions
- [DEX Swaps Guide](/en/sdk/pipes-sdk/solana.autogenerated/guides/dex-swaps): Index DEX swaps on Solana
- [Solana Data Persistence](/en/sdk/pipes-sdk/solana.autogenerated/guides/data-persistence): Store Solana data

### Squid SDK
- [Solana Squid SDK Quickstart](/en/sdk/squid-sdk/solana.autogenerated/quickstart): Get started with Squid SDK for Solana

## Substrate Development

- [Substrate Squid SDK Quickstart](/en/sdk/squid-sdk/substrate.autogenerated/quickstart): Quick start for Polkadot and Substrate chains
- [Make a Substrate Indexer](/en/sdk/squid-sdk/substrate.autogenerated/guides/make-an-indexer): Create a Substrate indexer

## Other Chains

### Fuel Network
- [Fuel Squid SDK Quickstart](/en/sdk/squid-sdk/fuel.autogenerated/quickstart): Get started with Fuel Network indexing

### Tron
- [Tron Squid SDK Quickstart](/en/sdk/squid-sdk/tron.autogenerated/quickstart): Index Tron blockchain data

### Starknet
- [Starknet Squid SDK Quickstart](/en/sdk/squid-sdk/starknet.autogenerated/quickstart): Index Starknet data

## Developer Tools & AI Integration

- [MCP Server](/en/other/ai/mcp-server): Model Context Protocol server for AI assistants to access SQD blockchain data

## Data & Networks

- [EVM Networks](/en/data/networks/evm): List of supported EVM networks with Portal URLs and dataset slugs
- [Solana Networks](/en/data/networks/solana): Supported Solana networks
- [Substrate Networks](/en/data/networks/substrate): Supported Substrate-based chains

## Cloud Deployment

- [Cloud Overview](/en/cloud/overview): Introduction to SQD Cloud deployment
- [Deploy a Squid](/en/cloud/deploy): Deploy your indexer to SQD Cloud
- [Cloud Pricing](/en/cloud/pricing): Cloud deployment pricing and plans
- [Organizations](/en/cloud/reference/organizations): Manage Cloud organizations
- [Secrets Management](/en/cloud/reference/secrets): Manage environment secrets in Cloud

## Self-Hosting & Advanced

- [Self-Hosting Portal](/en/portal/self-hosting): Run your own Portal instance
- [Accessing Self-Hosted Portal](/en/portal/self-hosting/accessing-portal): Connect to self-hosted Portal
- [SDK Self-Hosting](/en/sdk/self-hosting): Self-host SDK components

## SQD Network

- [Network Overview](/en/subsquid-network/overview): Introduction to the decentralized SQD Network
- [Network Architecture](/en/subsquid-network/architecture): How the SQD Network works
- [Become a Worker](/en/subsquid-network/worker): Participate in the network as a worker node
- [Network Rewards](/en/subsquid-network/rewards): Learn about network incentives

## Portal Pricing

- [Portal Pricing](/en/portal/pricing): Portal API pricing and usage tiers

## SDK Options Comparison

- [SDK Options Comparison](/en/sdk/options-comparison): Compare Pipes SDK, Squid SDK, and Portal API approaches
- [SDK Overview](/en/sdk/overview): Overview of all SDK tools and when to use each

## Portal API Reference

### EVM Portal API Endpoints

Base URL: `https://portal.sqd.dev/datasets/{dataset-slug}`

- **GET /metadata**: Retrieve dataset metadata including name, aliases, start block, and real-time support status
- **POST /stream**: Stream blocks matching a data query, including real-time data. Returns blocks as JSON lines
- **POST /finalized-stream**: Stream only finalized blocks matching a data query. Ensures data immutability
- **GET /head**: Get the current chain head block information
- **GET /finalized-head**: Get the latest finalized block information

Full specification: See [EVM Portal API OpenAPI](/api/build/stream) documentation

### Solana Portal API Endpoints

Base URL: `https://portal.sqd.dev/datasets/{dataset-slug}`

- **GET /metadata**: Retrieve dataset metadata including name, aliases, start block, and real-time support status
- **POST /stream**: Stream blocks matching a data query, including real-time data. Returns blocks as JSON lines
- **POST /finalized-stream**: Stream only finalized blocks matching a data query. Ensures data immutability
- **GET /head**: Get the current chain head block information
- **GET /finalized-head**: Get the latest finalized block information

Full specification: See [Solana Portal API OpenAPI](/api/build/solana/stream) documentation

---

## Support

- Telegram: [Squid Devs](https://t.me/HydraDevs)
- Telegram: [SQD Portal Beta Chat](https://t.me/+JHrJZPz34kRjYmFk)
- GitHub: https://github.com/subsquid