Overview

Integrate Freighter into your web application using @stellar/freighter-api. This library lets you send and receive data from a user's Freighter extension.

@stellar/freighter-api adheres to the SEP-43 standard for wallet interfaces on Stellar, and also offers additional methods beyond the spec such as getNetworkDetails, addToken, and WatchWalletChanges.

Error Type

All methods return an optional error field of type FreighterApiError:

interface FreighterApiError {
  code: number;
  message: string;
  ext?: string[];
}

API Reference

Category	Description
Connecting	Detect Freighter, check permissions, request access
Reading Data	Get the user's address and network configuration
Signing	Sign transactions, auth entries, and messages
Token Management	Add contract tokens to the user's wallet
Watching Changes	Monitor wallet state changes in real time