Installation

Get up and running with Freighter by installing the browser extension and choosing the right integration method for your app.

Prerequisites

Install the Freighter browser extension from the Chrome Web Store or Firefox Add-ons.
Choose an integration method below based on your project setup.

Use this when building with a bundler (Webpack, Vite, etc.) in a React, Next.js, or other modern JS framework.

Ideal for:

npm install @stellar/freighter-api

yarn add @stellar/freighter-api

Then import in your code. You can import the entire library:

import freighterApi from "@stellar/freighter-api";

Or import only what you need:

import {
  isConnected,
  getAddress,
  signAuthEntry,
  signTransaction,
  signMessage,
  addToken,
} from "@stellar/freighter-api";

See the Extension Integration for the full API reference.

Use this for plain HTML pages or projects without a build step. The library is loaded directly in the browser.

Ideal for:

Add to your <head>:

<script src="https://unpkg.com/@stellar/freighter-api/build/index.min.js"></script>

This always loads the latest version automatically. To pin a specific version:

<script src="https://unpkg.com/@stellar/freighter-api@6.0.1/build/index.min.js"></script>

Then access the API via window.freighterApi:

const { address } = await window.freighterApi.requestAccess();

I want to...

Go to

Connect my app to Freighter

Sign a transaction

Add a token

Last updated 1 month ago

Was this helpful?