Helius TypeScript SDK

!Downloads

The Helius TypeScript SDK provides access to Helius APIs and enhanced Solana RPC functionality, making building on Solana as easy as possible.

Agent Account Sign Up

> For AI Agents: You can create a Helius account and generate an API key programmatically using the helius-cli. See the agent signup guide or helius-cli agent file for complete details.

Documentation

API reference documentation is available at helius.dev/docs.

For detailed SDK API docs (auto-generated from source), see the TypeDoc Reference.

See the CHANGELOG for version history and release notes.

Contributions

Interested in contributing? Read the following contributions guide before opening a PR.

Installation

Using pnpm (recommended):

pnpm add helius-sdk

Using npm:

npm install helius-sdk

Using yarn:

yarn add helius-sdk

Usage

The package needs to be configured with your account's API key, which is available in the Helius Dashboard.

import { createHelius } from "helius-sdk";
(async () => {
  const apiKey = ""; // From Helius dashboard
  const helius = createHelius({ apiKey });
  try {
    const assets = await helius.getAssetsByOwner({
      ownerAddress: "owner_address_goes_here",
      page: 1,
      limit: 50,
      sortBy: { sortBy: "created", sortDirection: "asc" },
    });
    console.log("Fetched assets:", assets);
  } catch (error) {
    console.error("Error:", error);
  }
})();

Migrating to helius-sdk 2.0.0

The Helius Node.js SDK has been rewritten from the ground up in version 2.0.0 to use @solana/kit (i.e., Kit) under the hood, replacing the dependency on @solana/web3.js versions higher than 1.73.2.

We've gone to great lengths to ensure that the developer experience remains largely the same, with minimal impact on existing code. The API methods and namespaces are designed to be intuitive and an improvement on previous versions, so migrating to the latest version is relatively straightforward. There are a plethora of examples found in the examples directory, organized by namespace, to aid in this migration.

For more detailed migration help, refer to the following migration guide

For general help with Kit, please refer to Kit's new documentation site

Handling errors

When the API returns a non-success status code

... [truncated — view full README on GitHub]