Connecting

Detect whether a user has Freighter installed, check if your app is authorized, and request access to the user's public key.

Detecting Freighter

isConnected()

Check if the user has Freighter installed in their browser.

Returns: Promise<{ isConnected: boolean } & { error?: FreighterApiError }>

import { isConnected } from "@stellar/freighter-api";

const result = await isConnected();

if (result.isConnected) {
  console.log("Freighter is installed");
}

isConnected() checks whether the Freighter extension is installed. Note that it returns false for any user without the extension — not just mobile users. To detect Freighter Mobile's in-app browser specifically, check for window.stellar?.platform === "mobile".

Checking Authorization

isAllowed()

Check if the user has previously authorized your app to receive data from Freighter.

Returns: Promise<{ isAllowed: boolean } & { error?: FreighterApiError }>

import { isAllowed } from "@stellar/freighter-api";

const result = await isAllowed();

if (result.isAllowed) {
  console.log("App is on the Allow List");
}

Requesting Authorization

setAllowed()

Prompt the user to authorize your app and add it to Freighter's Allow List. Once approved, the extension can provide user data without additional prompts.

Returns: Promise<{ isAllowed: boolean } & { error?: FreighterApiError }>

import { setAllowed } from "@stellar/freighter-api";

const result = await setAllowed();

if (result.isAllowed) {
  console.log("App added to Allow List");
}

If the user has already authorized your app, setAllowed() resolves immediately with { isAllowed: true }.

Requesting Access

requestAccess()

Prompt the user to add your dapp to Freighter's Allow List and return their public key in one call. This is the recommended way to connect — it combines authorization and data retrieval in a single step.

Returns: Promise<{ address: string } & { error?: FreighterApiError }>

If the user has previously authorized your app, the public key is returned immediately without a popup.

import { isConnected, requestAccess } from "@stellar/freighter-api";

// Always check isConnected first
const connectResult = await isConnected();
if (!connectResult.isConnected) {
  console.error("Freighter is not installed");
  return;
}

const accessResult = await requestAccess();
if (accessResult.error) {
  console.error("Access denied:", accessResult.error.message);
} else {
  console.log("Public key:", accessResult.address);
}

Always check isConnected() before calling requestAccess() to ensure the extension is available.

Next steps

Once connected, you can read the user's address and network or sign transactions.