Install the App Kit SDK

Installing the App Kit SDK gives you every capability (Send, Bridge, Swap, Unified Balance, Onramp, and Earn) in a single package. To get started, install the latest version and the adapter that fits your environment.

An API key from the Circle Console is required for Onramp and optional for Swap and Earn. Without one, Swap and Earn requests run against a rate limit and Onramp won’t work.

Install the core package

npm install @circle-fin/app-kit

yarn add @circle-fin/app-kit

Need a lighter install? Individual App Kits are available

The App Kit SDK includes every capability in a single package. Or, install kits individually:

Bridge Kit
Swap Kit
Unified Balance Kit
Onramp Kit
Earn Kit

npm install @circle-fin/bridge-kit

yarn add @circle-fin/bridge-kit

npm install @circle-fin/swap-kit

yarn add @circle-fin/swap-kit

npm install @circle-fin/unified-balance-kit

yarn add @circle-fin/unified-balance-kit

npm install @circle-fin/onramp-kit

yarn add @circle-fin/onramp-kit

npm install @circle-fin/earn-kit

yarn add @circle-fin/earn-kit

Install your preferred adapter

Viem
Ethers
Solana
Circle Wallets

npm install @circle-fin/adapter-viem-v2 viem

yarn add @circle-fin/adapter-viem-v2 viem

npm install @circle-fin/adapter-ethers-v6 ethers

yarn add @circle-fin/adapter-ethers-v6 ethers

npm install @circle-fin/adapter-solana-kit @solana/kit @solana/web3.js

yarn add @circle-fin/adapter-solana-kit @solana/kit @solana/web3.js

If bridging, you should also install an EVM adapter (Viem or Ethers).

For the Bridge tokens across blockchains quickstart and adapter setup examples, the same adapter is used with @solana/kit and @solana/web3.js.

server-side onlyIf you have a Circle Wallets account, you can use the Circle Wallets adapter to connect to developer-controlled wallets and Circle Contracts.

npm install @circle-fin/adapter-circle-wallets

yarn add @circle-fin/adapter-circle-wallets