> ## Documentation Index
> Fetch the complete documentation index at: https://developers.avacloud.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

The **Avalanche SDK for TypeScript** is a modular suite of tools designed for building powerful applications on the Avalanche ecosystem. Whether you're building DeFi applications, NFT platforms, or cross-chain bridges, our SDKs provide everything you need.

<Frame>
  <img src="https://mintcdn.com/avalabs-47ea3976/Wi87V1LwXev8P44s/images/avalanche_sdk.jpg?fit=max&auto=format&n=Wi87V1LwXev8P44s&q=85&s=1e10ff983be444a989bf30e2dedf1cb8" width="1984" height="604" data-path="images/avalanche_sdk.jpg" />
</Frame>

### Core Capabilities

* **Direct Chain Access** - RPC calls, wallet integration, and transaction management.
* **Indexed Data & Metrics** - Access Glacier Data API & Metrics API with type safety.
* **Interchain Messaging** - Build cross-L1 applications with ICM/Teleporter.

<Warning>
  **Developer Preview**: This suite of SDKs is currently in beta and is subject to change. Use in production at your own risk.
</Warning>

<Info>
  We'd love to hear about your experience! **<a href="https://forms.gle/kpunVSkA9nuCa1wM9" target="_blank" rel="noopener noreferrer">Please share your feedback here</a>.**
</Info>

<CardGroup cols={1}>
  <Card title="Open Source on GitHub" icon="github" href="https://github.com/ava-labs/avalanche-sdk-typescript">
    Check out the code, contribute, or report issues. The Avalanche SDK TypeScript is fully open source.
  </Card>
</CardGroup>

## Which SDK Should I Use?

Choose the right SDK based on your specific needs:

| SDK Package                                                                  | Description                                                      |
| :--------------------------------------------------------------------------- | :--------------------------------------------------------------- |
| [`@avalanche-sdk/client`](/avalanche-sdk/client-sdk/getting-started)         | Direct blockchain interaction - transactions, wallets, RPC calls |
| [`@avalanche-sdk/chainkit`](/avalanche-sdk/chainkit-sdk/getting-started)     | Complete suite: Data, Metrics and Webhooks API                   |
| [`@avalanche-sdk/interchain`](/avalanche-sdk/interchain-sdk/getting-started) | Send messages between Avalanche L1s using ICM/Teleporter         |

## Quick Start

<Tabs>
  <Tab title="npm">
    ```bash theme={null}
    npm install @avalanche-sdk/client
    ```
  </Tab>

  <Tab title="yarn">
    ```bash theme={null}
    yarn add @avalanche-sdk/client
    ```
  </Tab>

  <Tab title="pnpm">
    ```bash theme={null}
    pnpm add @avalanche-sdk/client
    ```
  </Tab>
</Tabs>

### Basic Example

```typescript theme={null}
import { createClient } from '@avalanche-sdk/client';

// Initialize the client
const client = createClient({
  network: 'mainnet'
});

// Get balance
const balance = await client.getBalance({
  address: '0x...',
  chainId: 43114
});

console.log('Balance:', balance);
```

## Available SDKs

### Client SDK

The main Avalanche client SDK for interacting with Avalanche nodes and building blockchain applications.

**Key Features:**

* **Complete API coverage** for P-Chain, X-Chain, and C-Chain.
* **Full viem compatibility** - anything you can do with viem works here.
* **TypeScript-first design** with full type safety.
* **Smart contract interactions** with first-class APIs.
* **Wallet integration** and transaction management.
* **Cross-chain transfers** between X, P and C chains.

**Common Use Cases:**

* Retrieve balances and UTXOs for addresses
* Build, sign, and issue transactions to any chain
* Add validators and delegators
* Create subnets and blockchains.
* Convert subnets to L1s.

<Card title="Get Started with Client SDK" icon="arrow-right" href="/avalanche-sdk/client-sdk/getting-started">
  Learn how to integrate blockchain functionality into your application
</Card>

### ChainKit SDK

Combined SDK with full typed coverage of Avalanche Data (Glacier) and Metrics APIs.

**Key Features:**

* **Full endpoint coverage** for Glacier Data API and Metrics API
* **Strongly-typed models** with automatic TypeScript inference
* **Built-in pagination** helpers and automatic retries/backoff
* **High-level helpers** for transactions, blocks, addresses, tokens, NFTs
* **Metrics insights** including network health, validator stats, throughput
* **Webhook support** with payload shapes and signature verification

**API Endpoints:**

* Glacier API: <a href="https://glacier-api.avax.network/api" target="_blank" rel="noopener noreferrer">[https://glacier-api.avax.network/api](https://glacier-api.avax.network/api)</a>
* Metrics API: <a href="https://metrics.avax.network/api" target="_blank" rel="noopener noreferrer">[https://metrics.avax.network/api](https://metrics.avax.network/api)</a>

<Card title="Get Started with ChainKit SDK" icon="arrow-right" href="/avalanche-sdk/chainkit-sdk/getting-started">
  Access comprehensive blockchain data and analytics
</Card>

### Interchain SDK

SDK for building cross-L1 applications and bridges.

**Key Features:**

* **Type-safe ICM client** for sending cross-chain messages
* **Seamless wallet integration** with existing wallet clients
* **Built-in support** for Avalanche C-Chain and custom subnets
* **Message tracking** and delivery confirmation
* **Gas estimation** for cross-chain operations

**Use Cases:**

* Cross-chain token bridges
* Multi-L1 governance systems
* Interchain data oracles
* Cross-subnet liquidity pools

<Card title="Get Started with Interchain SDK" icon="arrow-right" href="/avalanche-sdk/interchain-sdk/getting-started">
  Build powerful cross-chain applications
</Card>

## Support

### Community & Help

* <a href="https://discord.gg/avax" target="_blank" rel="noopener noreferrer">Discord</a> - Get real-time help in the #avalanche-sdk channel
* <a href="https://t.me/+KDajA4iToKY2ZjBk" target="_blank" rel="noopener noreferrer">Telegram</a> - Join discussions
* <a href="https://x.com/AvaxDevelopers" target="_blank" rel="noopener noreferrer">Twitter</a> - Stay updated

### Feedback Sessions

* <a href="https://calendar.google.com/calendar/appointments/schedules/AcZssZ1RkNFpny9hBimkOmBXghLkGJ8RXV0GgHZb2tfrIRoZ9Su3s1wYZOP2R_OjXpwG2aQw_zlHf2JQ?gv=true" target="_blank" rel="noopener noreferrer">Book a Google Meet Feedback Session</a> - Schedule a 1-on-1 session to share your feedback and suggestions

### Issue Tracking

* <a href="https://github.com/ava-labs/avalanche-sdk-typescript/issues/new?template=bug_report.md" target="_blank" rel="noopener noreferrer">Report a Bug</a>
* <a href="https://github.com/ava-labs/avalanche-sdk-typescript/issues/new?template=feature_request.md" target="_blank" rel="noopener noreferrer">Request a Feature</a>
* <a href="https://github.com/ava-labs/avalanche-sdk-typescript/issues" target="_blank" rel="noopener noreferrer">View All Issues</a>

### Direct Support

* Technical Issues: <a href="https://github.com/ava-labs/avalanche-sdk-typescript/issues" target="_blank" rel="noopener noreferrer">GitHub Issues</a>
* Security Issues: <a href="mailto:security@avalabs.org">[security@avalabs.org](mailto:security@avalabs.org)</a>
* General Inquiries: <a href="mailto:data-platform@avalabs.org">[data-platform@avalabs.org](mailto:data-platform@avalabs.org)</a>