Helius SDK - v2.2.2
    Preparing search index...

    Type Alias HeliusClient

    HeliusClient: ResolvedHeliusRpcApi & {
        auth: AuthClient;
        enhanced: EnhancedTxClientLazy;
        getAllProgramAccounts: GetAllProgramAccountsFn;
        getAllTokenAccountsByOwner: GetAllTokenAccountsByOwnerFn;
        getAsset: GetAssetFn;
        getAssetBatch: GetAssetBatchFn;
        getAssetProof: GetAssetProofFn;
        getAssetProofBatch: GetAssetProofBatchFn;
        getAssetsByAuthority: GetAssetsByAuthorityFn;
        getAssetsByCreator: GetAssetsByCreatorFn;
        getAssetsByGroup: GetAssetsByGroupFn;
        getAssetsByOwner: GetAssetsByOwnerFn;
        getNftEditions: GetNftEditionsFn;
        getPriorityFeeEstimate: GetPriorityFeeEstimateFn;
        getProgramAccountsV2: GetProgramAccountsV2Fn;
        getSignaturesForAsset: GetSignaturesForAssetFn;
        getTokenAccounts: GetTokenAccountsFn;
        getTokenAccountsByOwnerV2: GetTokenAccountsByOwnerV2Fn;
        getTransactionsForAddress: GetTransactionsForAddressFn;
        raw: ResolvedHeliusRpcApi;
        searchAssets: SearchAssetsFn;
        stake: StakeClientLazy;
        tx: TxHelpersLazy;
        wallet: WalletClient;
        webhooks: {
            create(params: CreateWebhookRequest): Promise<Webhook>;
            delete(webhookID: string): Promise<boolean>;
            get(webhookID: string): Promise<Webhook>;
            getAll(): Promise<Webhook[]>;
            update(webhookID: string, params: UpdateWebhookRequest): Promise<Webhook>;
        } & WebhookClient;
        ws: WsAsync;
        zk: ZkClientLazy;
    }

    The main Helius SDK client. Provides access to all Helius and Solana RPC methods, DAS (Digital Asset Standard) queries, priority fee estimation, webhooks, enhanced transaction parsing, smart transaction helpers, WebSocket subscriptions, staking, and ZK compression.

    All standard Solana RPC methods (e.g. getBalance, getSlot) are available directly on this object via a Proxy that delegates to the underlying @solana/kit RPC client.

    Sub-clients (webhooks, enhanced, tx, ws, stake, zk, wallet) are lazily loaded on first access to keep the initial bundle minimal.

    Type Declaration

    • auth: AuthClient

      Auth client for agentic signup, checkout, and account management.

    • enhanced: EnhancedTxClientLazy

      Enhanced transaction parsing client. Requires an API key.

    • getAllProgramAccounts: GetAllProgramAccountsFn

      Auto-paginating variant that fetches all program accounts across pages.

    • getAllTokenAccountsByOwner: GetAllTokenAccountsByOwnerFn

      Auto-paginating variant that fetches all token accounts for an owner.

    • getAsset: GetAssetFn

      Fetch a single asset by its ID (mint address).

    • getAssetBatch: GetAssetBatchFn

      Fetch multiple assets by their IDs in a single batch request.

    • getAssetProof: GetAssetProofFn

      Get the Merkle proof for a compressed asset.

    • getAssetProofBatch: GetAssetProofBatchFn

      Get Merkle proofs for multiple compressed assets in a batch.

    • getAssetsByAuthority: GetAssetsByAuthorityFn

      List assets by their update authority address.

    • getAssetsByCreator: GetAssetsByCreatorFn

      List assets created by a specific creator address.

    • getAssetsByGroup: GetAssetsByGroupFn

      List assets belonging to a specific group (e.g. a collection).

    • getAssetsByOwner: GetAssetsByOwnerFn

      List all assets owned by a wallet address.

    • getNftEditions: GetNftEditionsFn

      Get print editions for an NFT master edition.

    • getPriorityFeeEstimate: GetPriorityFeeEstimateFn

      Estimate priority fees for a transaction or set of account keys.

    • getProgramAccountsV2: GetProgramAccountsV2Fn

      Paginated version of getProgramAccounts with cursor-based pagination.

    • getSignaturesForAsset: GetSignaturesForAssetFn

      Get transaction signatures related to an asset.

    • getTokenAccounts: GetTokenAccountsFn

      Get token accounts filtered by mint or owner.

    • getTokenAccountsByOwnerV2: GetTokenAccountsByOwnerV2Fn

      Paginated version of getTokenAccountsByOwner with cursor-based pagination.

    • getTransactionsForAddress: GetTransactionsForAddressFn

      Get transactions for a specific address with rich filtering and pagination.

    • raw: ResolvedHeliusRpcApi

      The unwrapped Solana RPC client for direct access to standard RPC methods.

    • searchAssets: SearchAssetsFn

      Search for assets using flexible filters (owner, creator, collection, etc.).

    • stake: StakeClientLazy

      Helius native staking helpers (stake, unstake, withdraw to the Helius validator).

    • tx: TxHelpersLazy

      Smart transaction helpers for building, signing, and sending transactions with automatic compute budget and priority fees.

    • wallet: WalletClient

      Wallet API client. Requires an API key.

    • webhooks: {
          create(params: CreateWebhookRequest): Promise<Webhook>;
          delete(webhookID: string): Promise<boolean>;
          get(webhookID: string): Promise<Webhook>;
          getAll(): Promise<Webhook[]>;
          update(webhookID: string, params: UpdateWebhookRequest): Promise<Webhook>;
      } & WebhookClient

      Webhook management client. Requires an API key.

    • ws: WsAsync

      WebSocket RPC subscriptions (logs, slots, signatures, programs, accounts).

    • zk: ZkClientLazy

      ZK compression RPC methods for Light Protocol compressed accounts and tokens.

    Settings

    Member Visibility