Orca

https://docs.orca.so/
Admin
Orca is a decentralized exchange (DEX) on the Solana blockchain, facilitating token swaps and...
Tokens:185,278
Snippets:1,699
Trust Score:9.2
Update:6 days ago
Show doc for...
Tokens:
Raw
### Whirlpools SDK Quick Start - Initialize Client and Get Pool

Source: https://docs.orca.so/

Minimal example to initialize the WhirlpoolContext and client, then fetch a pool by address. Requires a connection and wallet to be defined beforehand.

```typescript
import { WhirlpoolContext, buildWhirlpoolClient }
  from "@orca-so/whirlpools-sdk";

const ctx = WhirlpoolContext.from(connection, wallet);
const client = buildWhirlpoolClient(ctx);
const pool = await client.getPool(poolAddress);

```

--------------------------------

### Install requests library

Source: https://docs.orca.so/developers/resources/python-devs

Installs the requests library, required for the REST API examples.

```bash
pip install requests
```

--------------------------------

### Quick Examples - Python

Source: https://docs.orca.so/api-reference/overview

Get token information using the requests library.

```python
import requests

# Get token information
response = requests.get("https://api.orca.so/v2/solana/tokens/search", params={"q": "USDC"})
data = response.json()
```

--------------------------------

### Quick Examples - cURL

Source: https://docs.orca.so/api-reference/overview

cURL commands to get all pools, search for SOL pools, and get protocol TVL.

```bash
# Get all pools on Solana
curl "https://api.orca.so/v2/solana/pools"

# Search for SOL pools
curl "https://api.orca.so/v2/solana/pools/search?q=SOL"

# Get protocol TVL
curl "https://api.orca.so/v2/solana/protocol"
```

--------------------------------

### Initialize npm and install Whirlpools SDK

Source: https://docs.orca.so/developers/examples/tour-de-whirlpool/setup

Run these commands from the tour_de_whirlpool directory to initialize a package.json and install the @orca-so/whirlpools-sdk. The npm ls command verifies the installation.

```bash
npm init -y  
npm install @orca-so/whirlpools-sdk  
npm ls

```

--------------------------------

### List Tokens - Example Response

Source: https://docs.orca.so/api-reference/tokens

Example JSON response showing token data and pagination metadata.

```json
{
  "data": [
    {
      "address": "So11111111111111111111111111111111111111112",
      "symbol": "SOL",
      "name": "Wrapped SOL",
      "decimals": 9,
      "imageUrl": "https://raw.githubusercontent.com/...",
      "programId": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA",
      "tags": ""
    },
    {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "symbol": "USDC",
      "name": "USD Coin",
      "decimals": 6,
      "imageUrl": "https://raw.githubusercontent.com/...",
      "programId": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA",
      "tags": ""
    }
  ],
  "meta": {
    "next": "eyJsYXN0X2lkIjo...",
    "previous": null
  }
}
```

--------------------------------

### Install Required Packages (Shell)

Source: https://docs.orca.so/developers/sdks/environment-setup

Installs TypeScript, the Orca Whirlpools SDK, and Solana Kit packages.

```bash
npm install typescript @orca-so/whirlpools @solana/kit
```

--------------------------------

### Initialize a new Node.js project

Source: https://docs.orca.so/developers/sdks/legacy/environment-setup

Initializes a new Node.js project with default settings using npm.

```bash
npm init -y

```

--------------------------------

### Get Pool by Address - Example Response

Source: https://docs.orca.so/api-reference/whirlpools

Example JSON response for the Get Pool by Address endpoint, showing the structure of the returned pool data including address, liquidity, price, TVL, and metadata.

```JSON
{
  "data": {
    "address": "7qbRF6YsyGuLUVs6Y1q64bdVrfe4ZcUUz1JRdoVNUJnm",
    "whirlpoolsConfig": "2LecshUwdy9xi7meFgHtFJQNSKk4KdTrcpvaB56dP2NQ",
    "tickSpacing": 64,
    "feeRate": 2000,
    "protocolFeeRate": 300,
    "liquidity": "12345678901234567890",
    "sqrtPrice": "1234567890123456789",
    "tickCurrentIndex": 1234,
    "tokenMintA": "So11111111111111111111111111111111111111112",
    "tokenMintB": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "tokenVaultA": "...",
    "tokenVaultB": "...",
    "feeGrowthGlobalA": "...",
    "feeGrowthGlobalB": "...",
    "protocolFeeOwedA": "0",
    "protocolFeeOwedB": "0",
    "price": "142.50",
    "tvlUsdc": "5000000.00",
    "tokenBalanceA": "35000.123456789",
    "tokenBalanceB": "5000000.00",
    "poolType": "whirlpool",
    "adaptiveFeeEnabled": true,
    "adaptiveFee": {
      "currentRate": 2000,
      "maxRate": 10000,
      "constants": { ... },
      "variables": { ... }
    },
    "feeTierIndex": 2,
    "hasWarning": false,
    "tokenA": { ... },
    "tokenB": { ... },
    "stats": { ... },
    "rewards": [],
    "lockedLiquidityPercent": [],
    "updatedAt": "2024-01-15T12:30:00Z",
    "updatedSlot": 245678901
  },
  "meta": {
    "next": null,
    "previous": null
  }
}
```

--------------------------------

### Example Response for Get Locked Liquidity

Source: https://docs.orca.so/api-reference/whirlpools

Example JSON response showing locked liquidity information with name and locked percentage.

```json
[
  {
    "name": "Raydium Lock",
    "lockedPercentage": "45.5"
  },
  {
    "name": "Team Lock",
    "lockedPercentage": "10.0"
  }
]
```

--------------------------------

### TypeScript Example (Kit SDK)

Source: https://docs.orca.so/reference/ai-agents

Complete TypeScript example using the Orca Whirlpools Kit SDK. It sets up the RPC and signer, fetches pool state and all positions for a wallet, then for each position harvests fees if they exceed a threshold and rebalances if out of range. Requires a wallet.json file and a mainnet RPC endpoint.

```typescript
import {
  setRpc,
  setPayerFromBytes,
  setDefaultFunder,
  fetchWhirlpool,
  fetchPositionsForOwner,
  harvestPosition,
  closePosition,
  openConcentratedPosition,
  WhirlpoolDeployment,
} from '@orca-so/whirlpools';
import { createSolanaRpc, address } from '@solana/kit';
import secret from "wallet.json";

await setRpc('https://api.mainnet-beta.solana.com');
const signer = await setPayerFromBytes(new Uint8Array(secret));
setDefaultFunder(signer.address);
const rpc = createSolanaRpc('https://api.mainnet-beta.solana.com');

// 1. Fetch pool state
const pool = await fetchWhirlpool(rpc, address('YOUR_POOL_ADDRESS'));

// 2. Fetch all positions for this wallet
const positions = await fetchPositionsForOwner(rpc, address('YOUR_WALLET_ADDRESS'), WhirlpoolDeployment.mainnet);

for (const position of positions) {
  const isInRange =
    pool.data.tickCurrentIndex >= position.data.tickLowerIndex &&
    pool.data.tickCurrentIndex < position.data.tickUpperIndex;

  // 3. Harvest if fees exceed threshold
  const { feesQuote, callback: harvest } = await harvestPosition(
    position.positionMint,
    { whirlpoolDeployment: WhirlpoolDeployment.mainnet },
  );
  if (feesQuote.feeOwedA + feesQuote.feeOwedB > FEE_THRESHOLD) {
    await harvest();
  }

  // 4. Rebalance if out of range
  if (!isInRange) {
    const { callback: close } = await closePosition(
      position.positionMint,
      {
        slippageToleranceBps: 100,
        whirlpoolDeployment: WhirlpoolDeployment.mainnet,
      },
    );
    await close();
    // Open a new position centered on current price
    const { callback: open } = await openConcentratedPosition(
      address('YOUR_POOL_ADDRESS'),
      { liquidity: TARGET_LIQUIDITY },
      NEW_LOWER_PRICE,
      NEW_UPPER_PRICE,
      {
        slippageToleranceBps: 100,
        withTokenMetadataExtension: true,
        whirlpoolDeployment: WhirlpoolDeployment.mainnet,
      },
    );
    await open();
  }
}
```

--------------------------------

### Setup: setRpc, setPayerFromBytes, setDefaultFunder

Source: https://docs.orca.so/llms.txt

Initializes the Whirlpools SDK with an RPC URL and a default funder. Requires a wallet.json file containing a secret key.

```typescript
import { setRpc, setPayerFromBytes, setDefaultFunder } from '@orca-so/whirlpools';
import secret from "wallet.json";

await setRpc('https://api.devnet.solana.com'); // or your mainnet RPC URL
const signer = await setPayerFromBytes(new Uint8Array(secret));
setDefaultFunder(signer.address); // makes signer the default funder for all subsequent calls
```

--------------------------------

### Get Total Supply - Response

Source: https://docs.orca.so/api-reference/protocol

Example JSON response for the total supply endpoint.

```json
{
  "data": {
    "total_supply": "100000000.000000"
  },
  "meta": {
    "next": null,
    "previous": null
  }
}
```

--------------------------------

### Get Circulating Supply - Response

Source: https://docs.orca.so/api-reference/protocol

Example JSON response for the circulating supply endpoint.

```json
{
  "data": {
    "circulating_supply": "50000000.000000"
  },
  "meta": {
    "next": null,
    "previous": null
  }
}
```

--------------------------------

### Get Protocol Stats - Response

Source: https://docs.orca.so/api-reference/protocol

Example JSON response for the protocol stats endpoint.

```json
{
  "data": {
    "tvl": "450000000.00",
    "volume24hUsdc": "125000000.00",
    "fees24hUsdc": "250000.00",
    "revenue24hUsdc": "75000.00"
  },
  "meta": {
    "next": null,
    "previous": null
  }
}
```

--------------------------------

### Create project directories

Source: https://docs.orca.so/developers/examples/tour-de-whirlpool/setup

Run these commands in the terminal to create the tour_de_whirlpool directory and a src subdirectory. Replace 'somewhere' with a directory where you have write permissions.

```bash
cd somewhere  
mkdir tour_de_whirlpool  
cd tour_de_whirlpool  
mkdir src

```

--------------------------------

### Create Project Directory (Shell)

Source: https://docs.orca.so/developers/sdks/environment-setup

Creates a new project directory and navigates into it. Replace `<project-name>` with your desired project name.

```bash
mkdir <project-name>  
cd <project-name>
```

--------------------------------

### Get token by address example response

Source: https://docs.orca.so/api-reference/tokens

Example JSON response for the get-by-address endpoint. Shows a single token object with full metadata and a meta object with null pagination fields.

```json
{
  "data": {
    "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "symbol": "USDC",
    "name": "USD Coin",
    "decimals": 6,
    "imageUrl": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
    "programId": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA",
    "tags": ""
  },
  "meta": {
    "next": null,
    "previous": null
  }
}

```

--------------------------------

### Get ORCA Token Info - Response

Source: https://docs.orca.so/api-reference/protocol

Example JSON response for the ORCA token info endpoint.

```json
{
  "data": {
    "symbol": "ORCA",
    "name": "Orca",
    "description": "Orca is the most user-friendly concentrated liquidity AMM on Solana.",
    "imageUrl": "https://arweave.net/...",
    "price": "4.25",
    "circulatingSupply": "50000000.00",
    "totalSupply": "100000000.00",
    "stats": {
      "24h": {
        "volume": "2500000.00"
      }
    }
  },
  "meta": {
    "next": null,
    "previous": null
  }
}
```

--------------------------------

### Quick Examples - TypeScript

Source: https://docs.orca.so/api-reference/overview

Fetch pools with minimum TVL using the fetch API.

```typescript
// Fetch pools with minimum TVL
const response = await fetch(
  "https://api.orca.so/v2/solana/pools?minTvl=100000&sortBy=tvl&sortDirection=desc"
);
const { data, meta } = await response.json();
```

--------------------------------

### Get Pool by Address - cURL Request

Source: https://docs.orca.so/api-reference/whirlpools

Retrieves detailed information for a specific Whirlpool by its address. The example uses a specific pool address.

```cURL
curl "https://api.orca.so/v2/solana/pools/7qbRF6YsyGuLUVs6Y1q64bdVrfe4ZcUUz1JRdoVNUJnm"
```

--------------------------------

### List installed node_modules

Source: https://docs.orca.so/developers/examples/tour-de-whirlpool/setup

Run this command to verify that the node_modules directory contains the installed libraries, including @orca-so and @solana.

```bash
$ ls node_modules  
@babel  
@ethersproject  
@metaplex-foundation  
@orca-so  
@project-serum  
@solana  
...  
...  
uuid  
webidl-conversions  
whatwg-url  
ws

```

--------------------------------

### Quick Start: Get protocol stats, search pools, and get token info with curl

Source: https://docs.orca.so/developers/api/overview

Use these curl commands to interact with the Orca Public API. The first retrieves protocol stats, the second searches for pools using a query parameter, and the third gets token information. All commands target the Solana base URL https://api.orca.so/v2/solana.

```bash
# Get protocol stats
curl "https://api.orca.so/v2/solana/protocol"

# Search for pools
curl "https://api.orca.so/v2/solana/pools/search?q=SOL-USDC"

# Get token info
curl "https://api.orca.so/v2/solana/tokens/search?q=ORCA"

```
Tokens:
Raw