### Squid SDK Quickstart Guide

Source: https://beta.docs.sqd.dev/en/portal/evm/examples/contract-deployments

This section provides a quickstart guide for the Squid SDK, designed to help users get up and running with the SDK rapidly. It typically includes basic setup and a simple example.

```markdown
## Squid SDK Quickstart

This guide will walk you through the essential steps to start using the Squid SDK.

1.  **Installation:**
    ```bash
    npm install @subsquid/squid-sdk
    ```

2.  **Basic Usage:**
    ```typescript
    import { Squid } from '@subsquid/squid-sdk';

    const squid = new Squid();
    // ... further configuration and usage
    ```

This quickstart assumes you have Node.js and npm installed.
```

--------------------------------

### Pipes SDK Quickstart Guide

Source: https://beta.docs.sqd.dev/en/sdk/pipes-sdk/evm.autogenerated/core-concepts/sources-query-builder

A guide to help users get started with the Pipes SDK in minutes. It provides the initial steps and configurations needed to begin using the SDK.

```markdown
## Pipes SDK Quickstart

This guide will walk you through the essential steps to start using the Pipes SDK for EVM data processing.

1. **Installation:**
   ```bash
   npm install @pipes/sdk
   ```

2. **Initialization:**
   ```javascript
   import { Pipes } from '@pipes/sdk';

   const pipes = new Pipes({
     apiKey: 'YOUR_API_KEY'
   });
   ```

3. **First Pipe:**
   ```javascript
   async function run() {
     const stream = pipes.streamBlocks({
       query: {
         fromBlock: 1000000
       }
     });

     for await (const block of stream) {
       console.log(`Block ${block.number} processed.`);
     }
   }

   run();
   ```
```

--------------------------------

### Solana Quickstart Guide

Source: https://beta.docs.sqd.dev/en/subsquid-network/architecture

Provides a starting point for developing with Solana, covering essential setup and basic operations.

```markdown
# Solana Quickstart

This guide will walk you through the initial steps to start developing on the Solana blockchain using our SDKs.
```

--------------------------------

### Solana Pipes SDK Quickstart and Introduction

Source: https://beta.docs.sqd.dev/en/home

Guides for getting started with the Solana Pipes SDK. Covers essential concepts and initial setup for utilizing the SDK's features for data processing and integration on Solana.

```plaintext
en/sdk/pipes-sdk/solana.autogenerated/quickstart
en/sdk/pipes-sdk/solana.autogenerated/introduction
```

--------------------------------

### EVM Quickstart Guide (Markdown)

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/starknet.autogenerated/quickstart

This markdown snippet outlines the quickstart guide for the EVM module within the SQD SDK. It details the steps to get started with indexing EVM data, focusing on practical examples.

```markdown
en/portal/evm/quickstart
```

--------------------------------

### Solana SDK: Pipes SDK Guides

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/tron.autogenerated/quickstart

Guides for the Solana Pipes SDK, covering essential topics like getting started, decoding instructions, and handling DEX swaps. These guides aim to facilitate practical application development.

```markdown
en/sdk/pipes-sdk/solana.autogenerated/guides/getting-started
en/sdk/pipes-sdk/solana.autogenerated/guides/instruction-decoding
en/sdk/pipes-sdk/solana.autogenerated/guides/dex-swaps
```

--------------------------------

### Solana SDK: Pipes SDK Quickstart

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/tron.autogenerated/quickstart

Quickstart guide for the Solana Pipes SDK. This provides an initial overview and setup instructions for developers beginning with the Solana SDK.

```markdown
en/sdk/pipes-sdk/solana.autogenerated/quickstart
```

--------------------------------

### Pipes SDK Solana: Getting Started Guide

Source: https://beta.docs.sqd.dev/en/subsquid-network/architecture

A comprehensive guide on getting started with Solana data processing using the Pipes SDK, covering setup and basic usage.

```markdown
# Pipes SDK: Solana Autogenerated Guides - Getting Started

This guide covers the essential steps to begin using the Pipes SDK for Solana data.
```

--------------------------------

### EVM Quickstart Example - SQD SDK

Source: https://beta.docs.sqd.dev/en/portal/solana/examples/token-transfers

This example demonstrates how to quickly set up and start indexing data from EVM-compatible chains using the SQD SDK. It covers basic configuration and data retrieval.

```typescript
import { Squid } from '@subsquid/squid-sdk';

const squid = new Squid({
  // Configuration options for the Squid SDK
  // e.g., chain endpoint, archive endpoint, etc.
});

async function main() {
  await squid.start();
  console.log('SQD SDK started successfully!');
}

main().catch(error => {
  console.error('Error starting SQD SDK:', error);
});
```

--------------------------------

### Pipes SDK EVM Guides - Getting Started (Markdown)

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/starknet.autogenerated/quickstart

This markdown snippet links to the 'Getting Started' guide within the Pipes SDK's EVM module. It offers a foundational understanding for using the Pipes SDK with EVM data.

```markdown
en/sdk/pipes-sdk/evm.autogenerated/guides/getting-started
```

--------------------------------

### Squid SDK - Examples & Tutorials

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/substrate.autogenerated/quickstart

Practical examples and tutorials to help users understand and implement the Squid SDK for various use cases.

```APIDOC
## Squid SDK - Examples & Tutorials

### Description
This section provides practical examples and step-by-step tutorials to demonstrate the capabilities of the Squid SDK and guide users in building their own solutions.

### Build Indexer From Scratch
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/examples-tutorials/build-indexer-from-scratch`
- **Description**: A tutorial on building an indexer from the ground up using the Squid SDK.

### Auto-Generate Indexer
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/examples-tutorials/auto-generate-indexer`
- **Description**: Guide on how to automatically generate an indexer using the SDK's tools.

### Examples Widget
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/examples-tutorials/examples-widget`
- **Description**: Demonstrates how to use the examples widget provided by the SDK.
```

--------------------------------

### Substrate Chain Indexing Quickstart

Source: https://beta.docs.sqd.dev/en/portal/solana/examples/dex-swaps

A quickstart guide to setting up a Substrate blockchain indexer in 5 minutes using the Squid SDK. This provides a rapid way to start indexing data from Polkadot or other Substrate-based chains.

```bash
sqd create-squid --chain substrate --template <template_name>
```

--------------------------------

### Pipes SDK - Quickstart

Source: https://beta.docs.sqd.dev/en/sdk/pipes-sdk/evm.autogenerated/integration-advanced/postgres-drizzle

Get started with Pipes SDK in minutes.

```APIDOC
## Pipes SDK Quickstart

### Description
This guide provides a quick introduction to setting up and using the Pipes SDK for blockchain data streaming.

### Endpoint
/en/sdk/pipes-sdk/evm.autogenerated/quickstart

### Usage
Follow the steps outlined in the documentation to integrate Pipes SDK into your project.
```

--------------------------------

### Squid SDK - Guides

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/substrate.autogenerated/quickstart

A collection of guides for using the Squid SDK, covering various aspects from making indexers to advanced configurations and data destinations.

```APIDOC
## Squid SDK - Guides

### Description
This section provides in-depth guides on various functionalities and use cases of the Squid SDK, including building indexers, managing data, and best practices.

### Make an Indexer
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/guides/make-an-indexer`
- **Description**: Guide on how to create a custom indexer using the Squid SDK.

### Writing to PostgreSQL
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/guides/writing-to-postgres`
- **Description**: Instructions on configuring the SDK to write indexed data to a PostgreSQL database.

### Serving GraphQL
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/guides/serving-graphql`
- **Description**: Guide on how to serve indexed data via a GraphQL API.

### Other Data Destinations
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/guides/other-data-destinations`
- **Description**: Information on alternative data storage and destination options available with the SDK.

### Migration
- **Group**: Migration
  - **Migrate from The Graph**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/guides/migration/migrate-from-thegraph`
    - **Description**: Steps and considerations for migrating existing indexers from The Graph to Squid.

### Best Practices
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/guides/best-practices`
- **Description**: Recommended practices for developing efficient and robust indexers with the Squid SDK.
```

--------------------------------

### Solana Pipes SDK - Guides: Getting Started

Source: https://beta.docs.sqd.dev/en/portal/migration/cloud-portal-evm

Basic Solana pipe patterns.

```APIDOC
## GET /en/sdk/pipes-sdk/solana.autogenerated/guides/getting-started

### Description
Basic Solana pipe patterns.

### Method
GET

### Endpoint
/en/sdk/pipes-sdk/solana.autogenerated/guides/getting-started

### Parameters
#### Query Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
HTML page content for the Getting Started guide.

#### Response Example
N/A
```

--------------------------------

### Solana Pipes SDK - Quickstart

Source: https://beta.docs.sqd.dev/en/portal/migration/cloud-portal-evm

Get started with the Pipes SDK for Solana in minutes.

```APIDOC
## GET /en/sdk/pipes-sdk/solana.autogenerated/quickstart

### Description
Get started with the Pipes SDK for Solana in minutes.

### Method
GET

### Endpoint
/en/sdk/pipes-sdk/solana.autogenerated/quickstart

### Parameters
#### Query Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
HTML page content for the quickstart guide.

#### Response Example
N/A
```

--------------------------------

### Quick Start Example

Source: https://beta.docs.sqd.dev/en/portal/evm/overview

A quick start example using curl to stream data from the Ethereum mainnet.

```APIDOC
## Quick Start

### Description
Get started with Portal by using this example curl command to stream data from the Ethereum mainnet.

### Method
POST

### Endpoint
`https://portal.sqd.dev/datasets/ethereum-mainnet/stream`

### Request Example
```shell
curl --compressed -X POST 'https://portal.sqd.dev/datasets/ethereum-mainnet/stream' \
 -H 'Content-Type: application/json' \
 -d '{
  "query": "SELECT * FROM ethereum.logs LIMIT 10"
}'
```

### Response
#### Success Response (200)
- **data** (array) - An array of results matching the query.

#### Response Example
```json
{
  "data": [
    {
      "block_number": 18000000,
      "transaction_hash": "0x...",
      "log_index": 0,
      "contract_address": "0x...",
      "topics": ["0x..."],
      "data": "0x..."
    }
  ]
}
```
```

--------------------------------

### Scaffold New Squid Project with Fuel Example

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/fuel.autogenerated/quickstart

Create a new Squid project using the Fuel example template. This command initializes a project named 'hello-squid' from a specified GitHub repository. Alternatively, if Squid CLI is not installed, you can clone the repository directly.

```shellscript
sqd init hello-squid https://github.com/subsquid-labs/fuel-example -t
cd hello-squid
```

```shellscript
git clone https://github.com/subsquid-labs/fuel-example hello-squid
cd hello-squid
```

--------------------------------

### Clone Fuel Example Squid Project

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/fuel.autogenerated/quickstart

Clones the Fuel Example Squid project from GitHub and navigates into the project directory. This is the initial step to get the project files.

```bash
git clone https://github.com/subsquid-labs/fuel-example hello-squid
cd hello-squid
```

--------------------------------

### Install Dependencies with npm, pnpm, yarn, and bun

Source: https://beta.docs.sqd.dev/en/sdk/pipes-sdk/evm.autogenerated/quickstart

These commands demonstrate how to install the '@subsquid/pipes' and '@clickhouse/client' packages using different package managers. Ensure you have the respective package manager installed on your system.

```shellscript
npm install @subsquid/pipes @clickhouse/client
```

```shellscript
pnpm add @subsquid/pipes @clickhouse/client
```

```shellscript
yarn add @subsquid/pipes @clickhouse/client
```

```shellscript
bun add @subsquid/pipes @clickhouse/client
```

--------------------------------

### Scaffold a New Squid Project from Template (Shell)

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/solana.autogenerated/quickstart

Initializes a new Squid project named 'hello-squid' using a Solana example template from GitHub. This command requires the Squid CLI to be installed globally.

```shellscript
sqd init hello-squid -t https://github.com/subsquid-labs/solana-example
```

--------------------------------

### Clone Tron Example Project

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/tron.autogenerated/quickstart

Clones the official Tron example project from GitHub to your local machine.

```bash
git clone https://github.com/subsquid-labs/tron-example hello-squid
cd hello-squid
```

--------------------------------

### Clone and Navigate Solana Example Project

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/solana.autogenerated/quickstart

This snippet shows the basic commands to clone the Solana example project from GitHub and navigate into its directory. It's the initial step for setting up the project.

```bash
git clone https://github.com/subsquid-labs/solana-example hello-squid
cd hello-squid
```

--------------------------------

### Pipes SDK - Quickstart

Source: https://beta.docs.sqd.dev/en/sdk/self-hosting

Get started with Pipes SDK in minutes.

```APIDOC
## Pipes SDK Quickstart

### Description
Get started with Pipes SDK in minutes.

### Method
N/A (This is a guide, not an API endpoint)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Further Information
Refer to the Pipes SDK documentation for detailed instructions and examples on how to integrate and use the SDK.
```

--------------------------------

### Solana Squid SDK Examples and Tutorials

Source: https://beta.docs.sqd.dev/en/home

Examples and tutorials for the Solana Squid SDK, demonstrating how to build an indexer from scratch, auto-generate an indexer, and use the examples widget. Practical resources for hands-on learning.

```plaintext
en/sdk/squid-sdk/solana.autogenerated/examples-tutorials/build-indexer-from-scratch
en/sdk/squid-sdk/solana.autogenerated/examples-tutorials/auto-generate-indexer
en/sdk/squid-sdk/solana.autogenerated/examples-tutorials/examples-widget
```

--------------------------------

### Pipes SDK - Guides - Getting Started

Source: https://beta.docs.sqd.dev/en/sdk/self-hosting

Basic pipe patterns for Pipes SDK.

```APIDOC
## Pipes SDK Guides - Getting Started

### Description
Covers basic pipe patterns for Pipes SDK.

### Method
N/A (This is a guide, not an API endpoint)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Further Information
This guide explains fundamental pipe patterns. Refer to specific examples within the SDK documentation for code implementations.
```

--------------------------------

### Local Setup Documentation

Source: https://beta.docs.sqd.dev/en/subsquid-network/worker

Guides for setting up and running a local EVM indexer using Docker.

```APIDOC
## Local EVM Devnet Indexing

### Description
This section provides documentation for setting up and using a local EVM development environment.

### Topics
- **Overview**: Introduction to local EVM devnet indexing.
- **Configuration**: Instructions on configuring Docker services for local EVM indexing.
- **Usage**: Guidance on running and querying your local EVM indexer.

### Accessing Documentation
Documentation for local setup can be found at:
`/en/data/evm-local-setup/[overview|configuration|usage]`

For example, to access the configuration guide:
`/en/data/evm-local-setup/configuration`
```

--------------------------------

### Pipes SDK EVM Quickstart - SQD

Source: https://beta.docs.sqd.dev/en/portal/solana/examples/token-transfers

This example provides a quickstart for using the Pipes SDK with EVM chains. It outlines the basic setup for creating a data processing pipeline.

```typescript
import { createProcessor } from '@subsquid/squid-processor';

const processor = createProcessor({
  chain: 'eth',
  // Other configuration options
});

processor.run();
console.log('Pipes SDK processor started!');
```

--------------------------------

### Indexer Progress Output Example

Source: https://beta.docs.sqd.dev/en/sdk/pipes-sdk/evm.autogenerated/quickstart

This is an example of the console output you can expect while the indexing process is running. It shows the current block being processed, the percentage of completion, the estimated time remaining, and the indexing speed in blocks per second.

```shellscript
[12:46:37.044] INFO: Start indexing from 0 block
[12:46:42.035] INFO: 1,501,277 / 38,429,144 (3.91%), ETA: 6m 43s
 blocks: "91444 blocks/second"
```

--------------------------------

### GET /api/build/metadata

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/fuel.autogenerated/quickstart

Retrieves metadata describing the dataset, including its name, aliases, start block, and real-time status.

```APIDOC
## GET /api/build/metadata

### Description
Retrieves metadata describing the dataset, including its name, aliases, start block, and real-time status.

### Method
GET

### Endpoint
/api/build/metadata

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **name** (string) - The name of the dataset.
- **aliases** (array) - An array of aliases for the dataset.
- **start_block** (integer) - The starting block number of the dataset.
- **real_time_status** (string) - The real-time status of the dataset (e.g., 'synced', 'lagging').

#### Response Example
```json
{
  "name": "ethereum",
  "aliases": ["eth"],
  "start_block": 0,
  "real_time_status": "synced"
}
```
```

--------------------------------

### Install Pipes SDK and ClickHouse Client (npm)

Source: https://beta.docs.sqd.dev/en/sdk/pipes-sdk/evm.autogenerated/quickstart

Installs the necessary packages for the Pipes SDK and the ClickHouse client using npm. This is the first step in setting up the project.

```bash
npm install @subsquid/pipes @clickhouse/client
```

--------------------------------

### Start Data Processor

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/solana.autogenerated/quickstart

This command starts the data processor using Node.js. The processor fetches, decodes, and stores data in PostgreSQL. Its logic is defined in 'main.ts'. Ensure Node.js is installed and the processor dependencies are met.

```shellscript
node
```

--------------------------------

### POST /datasets/solana-mainnet/stream

Source: https://beta.docs.sqd.dev/en/portal/solana/quickstart

Query recent Solana slots and retrieve block data with transaction counts. This endpoint is free and rate-limited, suitable for getting started.

```APIDOC
## POST /datasets/solana-mainnet/stream

### Description
Queries recent Solana slots and retrieves block data, including transaction counts and details. This endpoint is part of the Public Portal, which is free and rate-limited.

### Method
POST

### Endpoint
`https://portal.sqd.dev/datasets/solana-mainnet/stream`

### Parameters
#### Request Body
- **type** (string) - Required - Specifies the data type, should be "solana".
- **fromBlock** (integer) - Required - The starting block number for the query.
- **toBlock** (integer) - Required - The ending block number for the query.
- **fields** (object) - Optional - Specifies which fields to include in the response.
  - **block** (object) - Optional - Fields related to the block.
    - **number** (boolean) - Optional - Include block number.
    - **timestamp** (boolean) - Optional - Include block timestamp.
  - **transaction** (object) - Optional - Fields related to transactions within the block.
    - **signatures** (boolean) - Optional - Include transaction signatures.
    - **feePayer** (boolean) - Optional - Include the fee payer of the transaction.
    - **err** (boolean) - Optional - Include transaction error status.
- **transactions** (array) - Optional - An array of transaction filters. An empty object `{}` fetches all transactions.

### Request Example
```json
{
  "type": "solana",
  "fromBlock": 259984800,
  "toBlock": 259984801,
  "fields": {
    "block": {
      "number": true,
      "timestamp": true
    },
    "transaction": {
      "signatures": true,
      "feePayer": true,
      "err": true
    }
  },
  "transactions": [{}]
}
```

### Response
#### Success Response (200)
Returns a stream of newline-delimited JSON objects, one per block, containing the requested block and transaction data.
- **block.number** (integer) - The block number (slot).
- **block.timestamp** (integer) - The block timestamp.
- **transaction.signatures** (array) - An array of transaction signatures.
- **transaction.feePayer** (string) - The fee payer address.
- **transaction.err** (null or object) - Transaction error status (null if successful).

#### Response Example
```json
{
  "block": {
    "number": 259984800,
    "timestamp": 1678886400
  },
  "transaction": {
    "signatures": ["sig1", "sig2"],
    "feePayer": "feePayerAddress",
    "err": null
  }
}
```
```

--------------------------------

### Squid SDK - Solana Autogenerated

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/evm.autogenerated/guides/make-an-indexer

Documentation for the Squid SDK, specifically for Solana, covering quickstart, design, how it works, FAQs, guides, examples, and reference materials.

```APIDOC
## Squid SDK - Solana Autogenerated

### Description
SDK for building indexers and data services on Solana.

### Overview
- `/en/sdk/squid-sdk/solana.autogenerated/quickstart`
- `/en/sdk/squid-sdk/solana.autogenerated/design`
- `/en/sdk/squid-sdk/solana.autogenerated/how-it-works`
- `/en/sdk/squid-sdk/solana.autogenerated/faq-troubleshooting`

### Guides
- `/en/sdk/squid-sdk/solana.autogenerated/guides/make-an-indexer`
- `/en/sdk/squid-sdk/solana.autogenerated/guides/writing-to-postgres`
- `/en/sdk/squid-sdk/solana.autogenerated/guides/serving-graphql`
- `/en/sdk/squid-sdk/solana.autogenerated/guides/other-data-destinations`

#### Migration
- `/en/sdk/squid-sdk/solana.autogenerated/guides/migration/migrate-from-thegraph`

### Best Practices
- `/en/sdk/squid-sdk/solana.autogenerated/guides/best-practices`

### Advanced Guides
- `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/batch-processing`
- `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/development-environment-setup`
- `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/cli-cheatsheet`
- `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/proxy-contracts`
- `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/factory-contracts`
- `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/multichain-indexing`
- `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/external-apis-ipfs`
- `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/firesquid-release`

### Examples & Tutorials
- `/en/sdk/squid-sdk/solana.autogenerated/examples-tutorials/build-indexer-from-scratch`
- `/en/sdk/squid-sdk/solana.autogenerated/examples-tutorials/auto-generate-indexer`
- `/en/sdk/squid-sdk/solana.autogenerated/examples-tutorials/examples-widget`

### Reference
- `/en/sdk/squid-sdk/solana.autogenerated/reference/packages-overview`
- `/en/sdk/squid-sdk/solana.autogenerated/reference/project-structure`

#### Solana Stream Processor Reference
- `/en/sdk/squid-sdk/solana.autogenerated/reference/solana-stream/general`
- `/en/sdk/squid-sdk/solana.autogenerated/reference/solana-stream/instructions`
- `/en/sdk/squid-sdk/solana.autogenerated/reference/solana-stream/transactions`
- `/en/sdk/squid-sdk/solana.autogenerated/reference/solana-stream/logs`
- `/en/sdk/squid-sdk/solana.autogenerated/reference/solana-stream/balances`
- `/en/sdk/squid-sdk/solana.autogenerated/reference/solana-stream/token-balances`
```

--------------------------------

### SQD CLI Installation Guide

Source: https://beta.docs.sqd.dev/en/portal/solana/overview

This snippet provides instructions for installing the SQD CLI. It's a crucial part of the SQD documentation for developers using the command-line interface.

```bash
/en/cloud/reference/cli/installation
```

--------------------------------

### Solana Squid SDK

Source: https://beta.docs.sqd.dev/en/home

Develop indexers for Solana using the Squid SDK. This section covers quickstart, design principles, how it works, FAQs, guides, examples, and reference materials.

```APIDOC
## Solana Squid SDK

### Description
An SDK for building indexers on Solana, enabling efficient data retrieval and processing.

### Getting Started
- **Quickstart**: `/en/sdk/squid-sdk/solana.autogenerated/quickstart`
- **Design**: `/en/sdk/squid-sdk/solana.autogenerated/design`
- **How it Works**: `/en/sdk/squid-sdk/solana.autogenerated/how-it-works`
- **FAQ & Troubleshooting**: `/en/sdk/squid-sdk/solana.autogenerated/faq-troubleshooting`

### Guides
- **Make an Indexer**: `/en/sdk/squid-sdk/solana.autogenerated/guides/make-an-indexer`
- **Writing to Postgres**: `/en/sdk/squid-sdk/solana.autogenerated/guides/writing-to-postgres`
- **Serving GraphQL**: `/en/sdk/squid-sdk/solana.autogenerated/guides/serving-graphql`
- **Other Data Destinations**: `/en/sdk/squid-sdk/solana.autogenerated/guides/other-data-destinations`
- **Best Practices**: `/en/sdk/squid-sdk/solana.autogenerated/guides/best-practices`

### Migration Guides
- **Migrate from TheGraph**: `/en/sdk/squid-sdk/solana.autogenerated/guides/migration/migrate-from-thegraph`

### Advanced Guides
- **Batch Processing**: `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/batch-processing`
- **Development Environment Setup**: `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/development-environment-setup`
- **CLI Cheatsheet**: `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/cli-cheatsheet`
- **Proxy Contracts**: `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/proxy-contracts`
- **Factory Contracts**: `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/factory-contracts`
- **Multichain Indexing**: `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/multichain-indexing`
- **External APIs & IPFS**: `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/external-apis-ipfs`
- **FireSquid Release**: `/en/sdk/squid-sdk/solana.autogenerated/guides/advanced/firesquid-release`

### Examples & Tutorials
- **Build Indexer from Scratch**: `/en/sdk/squid-sdk/solana.autogenerated/examples-tutorials/build-indexer-from-scratch`
- **Auto-Generate Indexer**: `/en/sdk/squid-sdk/solana.autogenerated/examples-tutorials/auto-generate-indexer`
- **Examples Widget**: `/en/sdk/squid-sdk/solana.autogenerated/examples-tutorials/examples-widget`

### Reference
- **Packages Overview**: `/en/sdk/squid-sdk/solana.autogenerated/reference/packages-overview`
- **Project Structure**: `/en/sdk/squid-sdk/solana.autogenerated/reference/project-structure`

#### Solana Stream Processor Reference
- **General**: `/en/sdk/squid-sdk/solana.autogenerated/reference/solana-stream/general`
```

--------------------------------

### Squid SDK - Advanced Guides

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/substrate.autogenerated/quickstart

Advanced topics and techniques for utilizing the full potential of the Squid SDK, including batch processing, development environments, and handling complex scenarios.

```APIDOC
## Squid SDK - Advanced Guides

### Description
This section covers advanced features and configurations for the Squid SDK, enabling users to tackle complex indexing challenges and optimize performance.

### Batch Processing
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/guides/advanced/batch-processing`
- **Description**: Guide on implementing batch processing for efficient data indexing.

### Development Environment Setup
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/guides/advanced/development-environment-setup`
- **Description**: Instructions for setting up a local development environment for Squid SDK projects.

### CLI Cheatsheet
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/guides/advanced/cli-cheatsheet`
- **Description**: A quick reference for common commands used with the Squid SDK's command-line interface.

### Proxy Contracts
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/guides/advanced/proxy-contracts`
- **Description**: Information on how to handle proxy contracts within your indexer.

### Factory Contracts
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/guides/advanced/factory-contracts`
- **Description**: Guide on working with factory contracts for dynamic contract deployment.

### Multichain Indexing
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/guides/advanced/multichain-indexing`
- **Description**: Techniques and considerations for indexing data across multiple blockchains.

### External APIs & IPFS
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/guides/advanced/external-apis-ipfs`
- **Description**: How to integrate external APIs and IPFS data into your indexing process.

### FireSquid Release
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/guides/advanced/firesquid-release`
- **Description**: Information regarding the FireSquid release and its features.
```

--------------------------------

### Solana Raw Portal API

Source: https://beta.docs.sqd.dev/en/home

Access Solana and SVM compatible chains through the Raw Portal API. This section includes an overview, quickstart guide, examples, and API reference.

```APIDOC
## Solana Raw Portal API

### Description
Provides access to Solana and SVM compatible chains through a raw portal API.

### Endpoints
- **Overview**: `/en/portal/solana/overview`
- **Quickstart**: `/en/portal/solana/quickstart`

### Examples
- **Query Instructions**: `/en/portal/solana/examples/query-instructions`
- **Token Transfers**: `/en/portal/solana/examples/token-transfers`
- **Query Transactions**: `/en/portal/solana/examples/query-transactions`
- **DEX Swaps**: `/en/portal/solana/examples/dex-swaps`
- **Program Deployments**: `/en/portal/solana/examples/program-deployments`

### API Reference
- **OpenAPI Specification**: `/en/api/build/solana/openapi.yaml`
- **Metadata**: `/en/api/build/solana/metadata`
- **Stream**: `/en/api/build/solana/stream`
- **Finalized Stream**: `/en/api/build/solana/finalized-stream`
- **Head**: `/en/api/build/solana/head`
- **Finalized Head**: `/en/api/build/solana/finalized-head`
```

--------------------------------

### Squid SDK - Reference

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/substrate.autogenerated/quickstart

Detailed reference documentation for the Squid SDK, covering packages, project structure, and specific components like the Substrate processor and data stores.

```APIDOC
## Squid SDK - Reference

### Description
This section provides comprehensive reference material for the Squid SDK, including details on its packages, project structure, and the various components that constitute the SDK.

### Packages Overview
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/packages-overview`
- **Description**: An overview of all available packages within the Squid SDK.

### Project Structure
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/project-structure`
- **Description**: Details on the standard project structure for Squid SDK applications.

### Substrate Processor Package
- **Group**: `substrate-processor` package
  - **Architecture**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/substrate-processor/architecture`
    - **Description**: Explanation of the architecture of the `substrate-processor` package.
  - **General**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/substrate-processor/general`
    - **Description**: General information and usage guidelines for the `substrate-processor`.
  - **Data Requests**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/substrate-processor/data-requests`
    - **Description**: How to make data requests using the `substrate-processor`.
  - **Field Selection**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/substrate-processor/field-selection`
    - **Description**: Guide on selecting specific fields for data retrieval.
  - **Context Interfaces**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/substrate-processor/context-interfaces`
    - **Description**: Details on the context interfaces available in the `substrate-processor`.

### Data Stores
- **Group**: Data stores
  - **Store Interface**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/data-stores/store-interface`
    - **Description**: Description of the generic store interface.
  - **TypeORM Store**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/data-stores/typeorm-store`
    - **Description**: Information on using TypeORM as a data store.
  - **BigQuery Store**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/data-stores/bigquery-store`
    - **Description**: Guide for configuring BigQuery as a data store.
  - **File Store**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/data-stores/file-store`
    - **Description**: Details on using the file store option.

### Schema Files
- **Group**: Schema files
  - **Schema Files Codegen**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/schema-files/schema-files-codegen`
    - **Description**: Information on code generation for schema files.
  - **Entities**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/schema-files/entities`
    - **Description**: Definition and usage of entities in schema files.
  - **Entity Relations**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/schema-files/entity-relations`
    - **Description**: How to define relationships between entities.
  - **Indexes & Constraints**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/schema-files/indexes-constraints`
    - **Description**: Configuration of indexes and constraints in schema files.
  - **Interfaces**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/schema-files/interfaces`
    - **Description**: Usage of interfaces within schema files.
  - **Unions & Typed JSON**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/schema-files/unions-typed-json`
    - **Description**: Handling unions and typed JSON in schema files.

### TypeORM Codegen
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/typeorm-codegen`
- **Description**: Documentation for the TypeORM code generation tool.

### TypeORM Migration
- **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/typeorm-migration`
- **Description**: Guide on performing database migrations with TypeORM.

### OpenReader
- **Group**: OpenReader
  - **Overview**
    - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/openreader/overview`
    - **Description**: An introduction to the OpenReader component of the SDK.
  - **API Reference**
    - **Group**: API reference
      - **Intro**
        - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/openreader/api/intro`
        - **Description**: Introduction to the OpenReader API.
      - **Queries**
        - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/openreader/api/queries`
        - **Description**: How to perform queries using the OpenReader API.
      - **AND/OR Filters**
        - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/openreader/api/and-or-filters`
        - **Description**: Using AND/OR logical filters in queries.
      - **Sorting**
        - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/openreader/api/sorting`
        - **Description**: How to sort query results.
      - **Paginate Query Results**
        - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/openreader/api/paginate-query-results`
        - **Description**: Implementing pagination for query results.
      - **Nested Field Queries**
        - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/openreader/api/nested-field-queries`
        - **Description**: Querying nested fields.
      - **Cross-Relation Field Queries**
        - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/openreader/api/cross-relation-field-queries`
        - **Description**: Querying fields across related entities.
      - **JSON Queries**
        - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/openreader/api/json-queries`
        - **Description**: Performing queries on JSON data types.
      - **Resolve Union Types & Interfaces**
        - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/openreader/api/resolve-union-types-interfaces`
        - **Description**: Handling union types and interfaces in queries.
  - **Server Configuration**
    - **Group**: Server configuration
      - **Custom Resolvers**
        - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/openreader/configuration/custom-resolvers`
        - **Description**: Configuring custom resolvers for the OpenReader server.
      - **Authorization**
        - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/openreader/configuration/authorization`
        - **Description**: Setting up authorization rules for the OpenReader API.
      - **Caching**
        - **Endpoint**: `/en/sdk/squid-sdk/substrate.autogenerated/reference/openreader/configuration/caching`
        - **Description**: Configuring caching mechanisms for OpenReader.
```

--------------------------------

### MDX Content for Getting Started with Portal

Source: https://beta.docs.sqd.dev/en/portal/migration

This JavaScript code snippet represents the compiled MDX content for a 'Getting Started with Portal' page. It includes dynamic component rendering and defines the structure for page content, such as paragraphs and headings.

```javascript
"use strict";
const {jsx: _jsx} = arguments[0];
const {useMDXComponents: _provideComponents} = arguments[0];
function _createMdxContent(props) {
 const _components = {
 p: "p",
 ..._provideComponents(),
 ...props.components
 };
 return _jsx(_components.p, {
 children: "Choose your Portal setup path: migrate Cloud squids, develop locally, or self-host your own Portal instance"
 });
}
function MDXContent(props = {}) {
 const {wrapper: MDXLayout} = {
 ..._provideComponents(),
 ...props.components
 };
 return MDXLayout ? _jsx(MDXLayout, {
 ...props,
 children: _jsx(_createMdxContent, {
 ...props
 })
 }) : _createMdxContent(props);
}
return {
 default: MDXContent
};

```

--------------------------------

### Scaffold a new Squid project using Git clone

Source: https://beta.docs.sqd.dev/en/sdk/squid-sdk/tron.autogenerated/quickstart

Clones the Tron example Squid project into a directory named 'hello-squid'. This method is an alternative if the Squid CLI is not installed. It directly clones the repository from GitHub.

```shellscript
git clone https://github.com/subsquid-labs/tron-example hello-squid
```

--------------------------------

### Pipes SDK Introduction Link

Source: https://beta.docs.sqd.dev/en/sdk/pipes-sdk/evm.autogenerated/quickstart

Provides a link to learn about the Pipes SDK architecture, data flow, and use cases. This card is part of the 'Next Steps' section.

```jsx
{
  title: "What is Pipes SDK?",
  icon: "lightbulb",
  href: "/en/sdk/pipes-sdk/introduction",
  children: <p>Learn about the architecture, data flow, and when to use Pipes SDK</p>
}
```