Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.orca.so/llms.txt

Use this file to discover all available pages before exploring further.

Build on Orca

Orca’s Whirlpool Program is an open-source concentrated liquidity automated market maker (CLMM) powering efficient DeFi operations on Solana. Integrate swaps, manage liquidity positions, build custom trading applications, or power autonomous agents and LP management bots with our comprehensive SDK suite.

SDKs

High-level TypeScript and Rust SDKs for swaps, positions, and pool management

Architecture

Understand Whirlpool accounts, ticks, and fee structures

Examples

Code samples and integration patterns

API Reference

REST API for pool data and analytics

AI Agents & Bots

Build autonomous LP managers and trading agents on Whirlpools

Quick Start

Install the high-level TypeScript SDK:
npm install @orca-so/whirlpools @solana/kit
Execute a simple swap:
import { createSolanaRpc, address } from "@solana/kit";
import { setWhirlpoolsConfig, swapInstructions } from "@orca-so/whirlpools";

// Configure for mainnet
await setWhirlpoolsConfig("solanaMainnet");

const rpc = createSolanaRpc("https://api.mainnet-beta.solana.com");
const poolAddress = address("YOUR_POOL_ADDRESS"); // Whirlpool account address
const inputAmount = 1_000_000n; // 1 USDC (6 decimals)

const { instructions, quote } = await swapInstructions(
  rpc,
  { inputAmount, mint: address("YOUR_TOKEN_MINT") }, // mint of the token you are swapping in
  poolAddress,
  100, // 1% slippage tolerance (in basis points)
  wallet
);
The addresses above are placeholders. For complete, runnable examples using real devnet addresses, see Executing a Token Swap.

Resources

GitHub

Source code & audits

npm Packages

TypeScript SDKs

Rust Crates

Rust SDKs

Support

Need help with your integration?
  • In-App Support: Use the Support function in the wallet menu
  • Community: Discord or Telegram
  • GitHub Issues: Report bugs or request features
  • API Docs: api.orca.so/docs for REST endpoints