### Example AI Assistant Prompts

Source: https://docs.openocean.finance/docs/mcp-server/examples

Sample prompts for performing common tasks like getting swap quotes, checking token lists, or building transactions.

```text
# Get a swap quote
"Get me a quote for swapping 1 ETH to USDC on Ethereum"

# Check token list
"What tokens are available on BSC?"

# Get gas price
"What's the current gas price on Polygon?"

# Build a swap transaction
"Build a swap transaction for 100 USDC to ETH on Arbitrum for address 0x..."

# Check DEXes
"What DEXes are supported on Avalanche?"
```

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

### Complete React Application Setup with OpenOcean Widget

Source: https://docs.openocean.finance/docs/widget/complete-example

This snippet shows the full `main.tsx` file for a React application. It includes setting up Wagmi for wallet management, configuring RainbowKit, and initializing the OpenOceanWidget with custom styling and wallet connection logic. Ensure all necessary dependencies like react-dom, @openocean.finance/widget, and @rainbow-me/rainbowkit are installed.

```typescript
import { createRoot } from 'react-dom/client'
import { OpenOceanWidget } from "@openocean.finance/widget";
import { useConnectModal, RainbowKitProvider } from '@rainbow-me/rainbowkit'
import { http, createConfig, useAccount, WagmiProvider, useDisconnect } from 'wagmi'
import { mainnet } from 'wagmi/chains'
import { injected } from 'wagmi/connectors'
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import '@rainbow-me/rainbowkit/styles.css'

// Wagmi Configuration
export const config = createConfig({
  chains: [mainnet],
  connectors: [
    injected({
      shimDisconnect: true,
    }),
  ],
  transports: {
    [mainnet.id]: http(),
  },
})

const queryClient = new QueryClient()

function App() {
  const { openConnectModal } = useConnectModal()
  const { isConnected } = useAccount()
  const { disconnect } = useDisconnect()
    
  const handleDisconnectWallet = () => {
    try {
      console.log("Attempting to disconnect wallet")
      disconnect()
      console.log("Wallet disconnected")
    } catch (error) {
      console.error("Disconnect failed:", error)
    }
  }
    
  const widgetConfig = {
    variant: "compact" as const,
    appearance: "dark" as const,
    subvariant: "split" as const,
    theme: {
      palette: {
        primary: {
          main: "#fb534f"
        },
        secondary: {
          main: "#FFC800"
        },
        background: {
          default: "#222037",
          paper: "#29273D"
        },
        text: {
          primary: "#ffffff",
          secondary: "#8C7F8C"
        },
        grey: {
          200: "#EEEFF2",
          300: "#D5DAE1",
          700: "#555B62",
          800: "#373F48"
        }
      },
      shape: {
        borderRadius: 12,
        borderRadiusSecondary: 12,
        borderRadiusTertiary: 24
      },
      typography: {
        fontFamily: "Inter, sans-serif"
      },
      container: {
        boxShadow: "0px 8px 32px rgba(0, 0, 0, 0.08)",
        borderRadius: "16px"
      },
      components: {
        MuiCard: {
          defaultProps: {
            variant: "filled"
          }
        },
        MuiTabs: {
          styleOverrides: {
            root: {
              backgroundColor: "#29273D",
              ".MuiTabs-indicator": {
                backgroundColor: "#17122b"
              }
            }
          }
        }
      }
    },
    walletConfig: {
      onConnect: ()=> {
        openConnectModal?.()
      }
    }
  }

  return (
    <div style={{ background: "#0a0a0a", minHeight: "100vh" }}>
      <nav style={{  
        background: "#1a1a1a",  
        padding: "15px 20px",  
        borderBottom: "1px solid #333",  
        display: "flex",  
        gap: "20px",  
        alignItems: "center"
      }}>
        <h2 style={{ color: "#ffffff", margin: 0 }}>OpenOcean Widget Demo</h2>
      </nav>
        
      <div style={{ padding: "20px" }}>
        <div style={{   
          background: "#1a1a1a",   
          padding: "10px",   
          marginBottom: "20px",   
          borderRadius: "8px",  
          color: "#ffffff",  
          fontSize: "12px"
        }}>
          {!isConnected && <button   
            onClick={openConnectModal}
            style={{  
              background: "#2196F3",  
              color: "#ffffff",  
              border: "none",  
              padding: "8px 16px",  
              borderRadius: "4px",  
              cursor: "pointer",  
              marginRight: "10px"
            }}
          >  
            Open Connect Modal  
          </button>}
            
          {isConnected && (
            <button   
              onClick={handleDisconnectWallet}
              style={{  
                background: "#f44336",  
                color: "#ffffff",  
                border: "none",  
                padding: "8px 16px",  
                borderRadius: "4px",  
                cursor: "pointer"
              }}
            >
              Disconnect
            </button>
          )}
        </div>
        <OpenOceanWidget {...widgetConfig} />
      </div>
    </div>
  )
}

const root = createRoot(document.getElementById('root')!)
root.render(
  <WagmiProvider config={config}>
    <QueryClientProvider client={queryClient}>
      <RainbowKitProvider>
        <App />
      </RainbowKitProvider>
    </QueryClientProvider>
  </WagmiProvider>
)
```

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

### Get Swap Quote Examples

Source: https://docs.openocean.finance/docs/ai-agents/skills

Use the `/quote` command to get the best swap route and price for a token pair. This command only requires GET requests and no local installation.

```bash
/quote 1 ETH to USDC on ethereum
```

```bash
/quote 100 USDC to WBTC on arbitrum
```

```bash
/quote 0.5 WBTC to DAI on polygon
```

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

### Install Dependencies

Source: https://docs.openocean.finance/docs/widget/complete-example

Command to install the necessary project dependencies.

```bash
npm install
```

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

### Install Reown Dependencies

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Install the necessary packages for Reown (WalletConnect) integration.

```bash
npm install @openocean.finance/widget @reown/appkit @reown/appkit-adapter-wagmi
npm install wagmi viem @tanstack/react-query
```

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

### Example HTTP GET Request for Quote

Source: https://docs.openocean.finance/docs/sdk/quote

This is an example of how to directly call the Open API to quote a token exchange amount. Replace placeholder addresses and values with your specific requirements.

```http
https://open-api.openocean.finance/v3/bsc/quote?inTokenAddress=0x55d398326f99059ff775485246999027b3197955&outTokenAddress=0xe9e7cea3dedca5984780bafc599bd69add087d56&amount=10&gasPrice=5
```

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

### Remix Installation

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Install the OpenOcean widget and React Query for integration into a Remix project.

```shell
npm install @openocean.finance/widget @tanstack/react-query
```

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

### Install ConnectKit Dependencies

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Install the necessary packages for OpenOcean widget and ConnectKit wallet integration.

```sh
npm install @openocean.finance/widget @openocean.finance/wallet-management
npm install connectkit wagmi viem @tanstack/react-query
```

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

### Start Development Server

Source: https://docs.openocean.finance/docs/widget/complete-example

Command to launch the local development server.

```bash
npm run dev
```

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

### Example OpenOcean Widget Configuration

Source: https://docs.openocean.finance/docs/widget/variants

This example demonstrates a full widget configuration, including the 'compact' variant and 'bridge' subvariant, along with custom appearance and theme settings. It shows how to integrate the widget into your application using the OpenOceanWidget component.

```javascript
const widgetConfig = {
  variant: "compact",
  subvariant: "bridge", // Enable cross-chain functionality
  appearance: "dark",
  theme: {
    container: {
      border: '1px solid rgb(234, 234, 234)',
      borderRadius: '16px',
    },
  },
}

<OpenOceanWidget integrator="your-app" config={widgetConfig} />
```

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

### Install SDK with yarn

Source: https://docs.openocean.finance/docs/sdk/install

Use this command to install the OpenOcean Aggregator SDK via yarn.

```bash
yarn add @openocean.finance/openocean-sdk
```

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

### Install Privy Dependencies

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Install the required packages for Privy authentication and React Query.

```bash
npm install @openocean.finance/widget @privy-io/react-auth
npm install @tanstack/react-query
```

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

### Install Dynamic Dependencies

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Install the required packages for Dynamic Labs integration.

```bash
npm install @openocean.finance/widget @dynamic-labs/sdk-react-core
npm install @tanstack/react-query
```

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

### Install SDK with npm

Source: https://docs.openocean.finance/docs/sdk/install

Use this command to install the OpenOcean Aggregator SDK via npm.

```bash
npm i @openocean.finance/openocean-sdk
```

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

### Install Additional Dependencies

Source: https://docs.openocean.finance/docs/sdk/install

Install web3 and bignumber.js if you plan to build wallet and contract objects yourself. These are required for manual object construction.

```bash
npm install bignumber.js
```

```bash
npm install web3
```

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

### Install RainbowKit Dependencies

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Install the necessary packages for OpenOcean widget and RainbowKit wallet integration.

```sh
npm install @openocean.finance/widget @rainbow-me/rainbowkit wagmi viem
npm install @tanstack/react-query
```

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

### Install Next.js Dependencies

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Install the widget SDK and MUI packages for Next.js projects.

```bash
npm install @openocean.finance/widget @openocean.finance/widget-sdk
npm install @mui/material-nextjs
```

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

### Install Widget for Deposit Flow

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Installs the OpenOcean widget package for the deposit flow implementation.

```sh
npm install @openocean.finance/widget
```

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

### Install Dependencies for OpenOcean Widget Integration

Source: https://docs.openocean.finance/docs/widget/complete-example

Installs the necessary packages for integrating the OpenOcean Widget with Wagmi and RainbowKit. Ensure you have Node.js and npm/yarn/pnpm installed.

```bash
npm install @openocean.finance/widget wagmi @tanstack/react-query @rainbow-me/rainbowkit react react-dom
```

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

### Svelte Installation

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Install the OpenOcean widget and necessary Vite plugins for Svelte integration.

```shell
npm install @openocean.finance/widget
npm install --save-dev @vitejs/plugin-react @vitejs/plugin-svelte
```

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

### Install Vite + React Dependencies

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Install the necessary widget, wallet management, and build-time polyfill packages for a Vite project.

```bash
npm install @openocean.finance/widget @openocean.finance/wallet-management
npm install @tanstack/react-query wagmi viem
npm install --save-dev vite-plugin-node-polyfills
```

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

### Install Widget Dependencies

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Installs the required OpenOcean widget, Zustand, and Material UI packages.

```sh
npm install @openocean.finance/widget zustand
npm install @mui/material
```

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

### Get Ticket List Response Example

Source: https://docs.openocean.finance/docs/ticket-api/api

This JSON object demonstrates the response when retrieving a list of tickets associated with a referrer address. It includes details for each ticket, such as hash, question, process status, and creation time.

```json
{
    "code": 200,
    "data": [
            {
                "hash": "0xcaf525986a879ca5017ca9b934a402aa55232c5e983b245937d39a3583c2c49a",
                "remark": null,
                "process": "01",
                "question": "question",
                "answer": null,
                "params": {
                    "quote": {
                        "chain": "bsc",
                        "inTokenAddress": "0x55d398326f99059ff775485246999027b3197955",
                        "outTokenAddress": "0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d",
                        "amount": 5,
                        "gasPrice": 1,
                        "slippage": 1,
                        "account": "0x2FF855378Cd29f120CDF9d675E959cb5422ec5f2",
                        "referrer": "0xD4eb4cbB1ECbf96a1F0C67D958Ff6fBbB7B037BB",
                        "referrerFee": "",
                        "enabledDexIds": "",
                        "disabledDexIds": "",
                        "sender": ""
                    }
                },
                "account": "0x72f16Cae8F50Ad615AB5A8e231A496b2ace52532",
                "createAt": "2025-04-07T08:04:46.000Z"
            }
        ]
}
```

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

### OpenOcean SDK Vue.js Integration Example

Source: https://docs.openocean.finance/docs/sdk/examples

This example demonstrates the full lifecycle of an OpenOcean integration, including wallet connection, token list retrieval, quoting, and swap execution.

```vue
<template>  
  <div id="app">  
    <div v-if="chain">chain: {{ chain.chainName }}</div>  
    <div v-if="myWallet">walletName: {{ myWallet.name }}, address: {{ myWallet.address }}</div>  
    <div v-if="inToken">inToken: {{ inToken.symbol }} Balance: {{ inTokenBalance }}</div>  
    <div v-if="outToken">outToken: {{ outToken.symbol }} Balance: {{ outTokenBalance }}</div>  
    <div>  
      <h3>ConnectWallet</h3>  
      <button @click="connectWallet('eth')">connectWallet eth</button>  
      <button @click="connectWallet('bsc')">connectWallet bsc</button>  
      <button @click="connectWallet('polygon')">connectWallet polygon</button>  
    </div>  
    <div>  
      <h3>Quote</h3>  
      <div v-if="inToken && outToken">{{ inAmount }} {{ inToken.symbol }} swap to {{ outAmount }} {{ outToken.symbol }}</div>  
      <button @click="quote">quote</button>  
    </div>  
    <div><h3>Swap</h3><button @click="swap">swap</button></div>  
    <div><h3>GetBalance</h3><button @click="getBalance">GetBalance</button></div>  
  </div>  
</template>  

<script>  
import { OpenoceanSdk } from '@openocean.finance/openocean-sdk';  
import BigNumber from 'bignumber.js';  
const genSdk = new OpenoceanSdk()  
const { api, swapSdk, config } = genSdk  

export default {  
  data() {  
    return {  
      chainName: 'bsc', walletName: 'MetaMask',  
      inToken: null, outToken: null, gasPrice: 5,  
      inTokenBalance: null, outTokenBalance: null, inAmount: 1, outAmount: null,  
      myWallet: null, chain: null,  
    }  
  },  
  methods: {  
    async getGasPrice() { this.gasPrice = await api.getGasPrice({ chain: this.chainName }) },  
    async getTokenList() {  
      let { data } = await api.getTokenList({ chain: this.chainName })  
      this.inToken = data.find(item => item.symbol == 'USDC')  
      this.outToken = data.find(item => item.symbol == 'BUSD')  
      this.getBalance()  
    },  
    async quote() {  
      let response = await api.quote({  
        chain: this.chainName, inTokenAddress: this.inToken.address,  
        outTokenAddress: this.outToken.address, amount: this.inAmount, gasPrice: this.gasPrice  
      })  
      if (response.code == 200)  
        this.outAmount = new BigNumber(response.data.outAmount).div(10 ** this.outToken.decimals).toFixed(4)  
      else alert('Error:' + response.message)  
    },  
    async swap() {  
      if (!this.myWallet) { alert('Please connect the wallet.'); return }  
      if (this.inTokenBalance < this.inAmount) { alert(this.inToken.symbol + ' Insufficient balance.'); return }  
      let { data } = await api.exchange({ chain: this.chainName })  
      let allowance = await this.getAllowance(data.approveContract)  
      if (new BigNumber(allowance).lt(this.inAmount)) { await this.approve(data.approveContract); return }  
      let response = await swapSdk.swapQuote({  
        chain: this.chainName, inTokenAddress: this.inToken.address, outTokenAddress: this.outToken.address,  
        amount: this.inAmount, gasPrice: this.gasPrice, slippage: 1, account: this.myWallet.address,  
      })  
      if (response.code == 200) {  
        swapSdk.swap(response.data)  
          .on('error', (error) => {})  
          .on('transactionHash', (hash) => {})  
          .on('receipt', (data) => { this.getBalance() })  
          .on('success', (data) => {})  
      } else alert('Error:' + response.message)  
    },  
    async connectWallet(chainName) {  
      try {  
        if (chainName) this.chainName = chainName  
        let data = await swapSdk.connectWallet({ chainName: this.chainName, walletName: this.walletName })  
        if (data) { this.myWallet = data.wallet; this.chain = data.chain; this.getTokenList(); this.getGasPrice() }  
      } catch (error) { this.myWallet = null; this.chain = null }  
    },  
    async getBalance() {  
      if (!this.myWallet) { alert('Please connect the wallet.'); return }  
      this.inTokenBalance = (await swapSdk.getBalance({ account: this.myWallet.address, chain: this.chainName, tokenAddressOrSymbol: this.inToken.address, decimals: this.inToken.decimals })).short  
      this.outTokenBalance = (await swapSdk.getBalance({ account: this.myWallet.address, chain: this.chainName, tokenAddressOrSymbol: this.outToken.address, decimals: this.outToken.decimals })).short  
    },  
    async getAllowance(approveContract) {
```

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

### Globally Install MCP Server

Source: https://docs.openocean.finance/docs/mcp-server/installation

Install the MCP server globally once. Then, you can run it directly from your MCP client configuration.

```bash
pnpm add -g openocean-mcp
```

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

### Install Vue 3 Dependencies

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Install the widget and necessary build plugins for Vue 3.

```bash
npm install @openocean.finance/widget veaury
npm install --save-dev @vitejs/plugin-react @vitejs/plugin-vue
```

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

### Install Privy and Ethers Dependencies

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Install dependencies for Privy authentication with Ethers.js support.

```bash
npm install @openocean.finance/widget @privy-io/react-auth ethers
npm install @tanstack/react-query
```

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

### Install OpenOcean Widget Dependencies

Source: https://docs.openocean.finance/docs/widget/install

Install the required packages for the OpenOcean Widget, including wagmi, bigmi, Solana wallet adapters, and TanStack Query.

```shell
npm install @openocean.finance/widget wagmi @bigmi/react @solana/wallet-adapter-react @tanstack/react-query
```

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

### Nuxt 3 Installation

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Install the OpenOcean widget and veaury package for Nuxt 3 integration.

```shell
npm install @openocean.finance/widget veaury
```

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

### Configure MCP Server with Global Installation

Source: https://docs.openocean.finance/docs/mcp-server/examples

Use this configuration if the OpenOcean MCP server is installed globally on your system.

```json
{
  "mcpServers": {
    "openocean-mcp-server": {
      "command": "openocean-mcp",
      "args": []
    }
  }
}
```

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

### Quote API Integration Examples

Source: https://docs.openocean.finance/docs/overview/fetching-quote

Implementation examples for fetching quotes using JavaScript (axios) and Python (requests).

```javascript
const axios = require('axios');

const chain = 'bsc';
const url = `https://open-api.openocean.finance/v4/${chain}/quote`;

const params = {
  inTokenAddress: '0x55d398326f99059ff775485246999027b3197955',
  outTokenAddress: '0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d',
  amount: 1,
  gasPrice: 3
};

async function main() {
  try {
    const { data } = await axios.get(url, { params });
    if (data?.code === 200) {
      console.log('Quote success:', data.data);
    }
  } catch (error) {
    console.error('Error:', error);
  }
}

main();
```

```python
import requests

chain = 'bsc'
url = f'https://open-api.openocean.finance/v4/{chain}/quote'

params = {
  'inTokenAddress': '0x55d398326f99059ff775485246999027b3197955',
  'outTokenAddress': '0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d',
  'amount': 1,
  'gasPrice': 3
}

def main():
  response = requests.get(url, params=params)
  if response.status_code == 200:
    data = response.json()
    print(data)
  else:
    print("Error occurred:", response.text)

if __name__ == "__main__":
  main()
```

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

### Example API Response for Token List

Source: https://docs.openocean.finance/docs/sdk/tokens

An example of the JSON response structure when fetching a token list from the OpenOcean API.

```json
{
  "code": 200,
  "data": [
    {
      "id": 2377,
      "code": "grove",
      "name": "GroveCoin",
      "address": "0xf33893de6eb6ae9a67442e066ae9abd228f5290c",
      "decimals": 8,
      "symbol": "GRV",
      "icon": "https://s3.openocean.finance/token_logos/logos/..",
      "chain": "bsc",
      "usd": "0.948606"
    }
  ]
}
```

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

### Swap Request with minOutput

Source: https://docs.openocean.finance/docs/swap-api/v4

Example of a swap request including the minOutput parameter for transaction protection.

```http
https://open-api.openocean.finance/v4/1/swap?amountDecimals=10000000&gasPriceDecimals=1900000000&slippage=1&referrer=0x39041f1b366fe33f9a5a79de5120f2aee2577ebc&account=0xceCfC852f8cE51D92A5A291f6999DEE147bc2169&disableRfq=true&referrerFee=1&inTokenAddress=0xdac17f958d2ee523a2206206994597c13d831ec7&outTokenAddress=0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48&minOutput=9900000
```

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

### Execute Swap Request

Source: https://docs.openocean.finance/docs/swap-api/v4

Example of a swap request using decimal-adjusted amounts and gas prices.

```http
https://open-api.openocean.finance/v4/bsc/swap?inTokenAddress=0x55d398326f99059ff775485246999027b3197955&outTokenAddress=0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d&amountDecimals=5000000000000000000&gasPriceDecimals=1000000000&slippage=1&account=0x9116780aEf4B376499358fa7dEeC00cCF64fA801&referrer=0xD4eb4cbB1ECbf96a1F0C67D958Ff6fBbB7B037BB
```

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

### Quote API Request Examples

Source: https://docs.openocean.finance/docs/overview/fetching-quote

Examples of HTTP GET requests to the quote endpoint, including the recommended format using decimals and the deprecated format.

```http
https://open-api.openocean.finance/v4/bsc/quote?inTokenAddress=0x55d398326f99059ff775485246999027b3197955&outTokenAddress=0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d&amountDecimals=5000000000000000000&gasPriceDecimals=1000000000
```

```http
https://open-api.openocean.finance/v4/bsc/quote?inTokenAddress=0x55d398326f99059ff775485246999027b3197955&outTokenAddress=0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d&amount=5&gasPrice=1
```

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

### Initialize OpenOcean SDK

Source: https://docs.openocean.finance/docs/sdk/configure

Import and instantiate the SDK to gain access to all available modules like api, swapSdk, and config. This is the first step to using the SDK's functionalities.

```javascript
import { OpenoceanSdk } from '@openocean.finance/openocean-sdk'  

const openoceanSdk = new OpenoceanSdk()  
const { api, swapSdk, config } = openoceanSdk  
```

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

### Quote Request (with decimals)

Source: https://docs.openocean.finance/docs/swap-api/v4

Example of a GET request to the quote endpoint using token amounts with full decimals. Ensure all values are passed with their respective decimals.

```HTTP
https://open-api.openocean.finance/v4/bsc/quote?inTokenAddress=0x55d398326f99059ff775485246999027b3197955&outTokenAddress=0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d&amountDecimals=5000000000000000000&gasPriceDecimals=1000000000
```

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

### Fast Swap Execution Examples

Source: https://docs.openocean.finance/docs/ai-agents/skills

Use the `/swap-execute-fast` command to build and execute a swap in a single step without a confirmation prompt. This is extremely dangerous and requires `cast`, `curl`, and `jq`. Use only when fully trusting parameters and understanding risks.

```bash
/swap-execute-fast 1 ETH to USDC on base from 0xYourAddress
```

```bash
/swap-execute-fast 100 USDC to ETH on arbitrum from 0xYourAddress keystore mykey
```

```bash
/swap-execute-fast 0.5 WBTC to DAI on polygon from 0xYourAddress ledger
```

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

### Quote Request (deprecated, without decimals)

Source: https://docs.openocean.finance/docs/swap-api/v4

Example of a GET request to the quote endpoint using deprecated 'amount' and 'gasPrice' parameters without decimals. Use 'amountDecimals' and 'gasPriceDecimals' for new implementations.

```HTTP
https://open-api.openocean.finance/v4/bsc/quote?inTokenAddress=0x55d398326f99059ff775485246999027b3197955&outTokenAddress=0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d&amount=5&gasPrice=1
```

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

### Python Quote API Request

Source: https://docs.openocean.finance/docs/swap-api/v4

Example of making a GET request to the OpenOcean API V4 quote endpoint using Python's requests library. This snippet uses the deprecated 'amount' and 'gasPrice' parameters.

```Python
import requests
chain = 'bsc'
url = f'https://open-api.openocean.finance/v4/{chain}/quote'
params = {
  'inTokenAddress': '0x55d398326f99059ff775485246999027b3197955',
  'outTokenAddress': '0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d',
  'amount': 1,
  'gasPrice': 3
}
def main():
  response = requests.get(url, params=params)
  if response.status_code == 200:
    data = response.json()
    print(data)
  else:
    print("Error occurred:", response.text)
if __name__ == "__main__":
  main()
```

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

### Get Token Exchange Quote with Axios

Source: https://docs.openocean.finance/docs/swap-api/sdk

Use this snippet to directly query the OpenOcean API for token exchange amounts. Ensure Axios is installed and imported. The parameters specify the chain, input/output tokens, amount, gas price, and slippage.

```javascript
const res = await axios.get("https://open-api.openocean.finance/v3/bsc/quote", {
  chain: 'bsc',
  inTokenAddress: '0x9029FdFAe9A03135846381c7cE16595C3554e10A',
  outTokenAddress: '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE',
  amount: 10,
  gasPrice: 5,
  slippage: 1,
}).then((res) => {
  const result = res.data
}).catch((err) => {
  throw new Error(err)
})
```

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

### OpenOcean Widget Basic Configuration

Source: https://docs.openocean.finance/docs/widget/configuration

Demonstrates how to initialize and configure the OpenOcean Widget with essential parameters for swaps and bridges.

```APIDOC
## OpenOcean Widget Basic Configuration

### Description
This section outlines the basic configuration options for the OpenOcean Widget, enabling users to set up swap and bridge functionalities.

### Method
JavaScript Initialization

### Endpoint
N/A (Client-side Widget)

### Parameters
#### Configuration Object (`widgetConfig`)
- **fromChain** (number) - Required - The chain ID for the source chain.
- **toChain** (number) - Required - The chain ID for the destination chain. Use the same value as `fromChain` for same-chain swaps.
- **fromToken** (string) - Required - The token address for the source token. Use `0x0000000000000000000000000000000000000000` for native tokens.
- **toToken** (string) - Required - The token address for the destination token. Use `0x0000000000000000000000000000000000000000` for native tokens.
- **fromAmount** (string) - Required - The default amount to be swapped, represented as a string.
- **subvariant** (string) - Optional - Set to `"bridge"` to enable cross-chain functionality. Defaults to swap functionality.
- **theme** (object) - Optional - An object for customizing the widget's appearance. See Theme Customization section for details.
- **languages** (object) - Optional - An object to control language settings. It accepts an `allow` array of language codes (e.g., `['en']`) to restrict available languages.

### Request Example
```javascript
import { OpenOceanWidget } from '@openocean.finance/widget';

const widgetConfig = {
  fromChain: 8453,
  toChain: 8453,
  fromToken: '0x0000000000000000000000000000000000000000',
  toToken: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913',
  fromAmount: '1',
  subvariant: "bridge",
  theme: {
    container: {
      border: '1px solid rgb(234, 234, 234)',
      borderRadius: '16px',
    },
  },
  languages: {
    allow: ['en'],
  },
};

export const WidgetPage = () => (
  <OpenOceanWidget integrator="Your dApp/company name" config={widgetConfig} />
);
```

### Response
N/A (Widget renders UI elements)

### Success Response (200)
N/A

### Response Example
N/A
```

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

### Build MCP Server from Source

Source: https://docs.openocean.finance/docs/mcp-server/installation

Clone the repository, navigate into the directory, and install dependencies to build the MCP server from source. This is suitable for development or custom modifications.

```bash
git clone https://github.com/openocean-finance/openocean-mcp.git
cd openocean-mcp
pnpm install
pnpm run build
```

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

### Build Swap Transaction Examples

Source: https://docs.openocean.finance/docs/ai-agents/skills

Use the `/swap-build` command to construct a full swap transaction, including route and encoded calldata. This requires a sender address and shows quote details before confirmation. It does not submit the transaction on-chain.

```bash
/swap-build 100 USDC to ETH on arbitrum from 0xYourAddress
```

```bash
/swap-build 1 ETH to USDC on ethereum from 0xYourAddress slippage 100
```

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

### Zap Response Example

Source: https://docs.openocean.finance/docs/zap-api/api

Example JSON response structure returned by the Zap API.

```json
{
    "code": 200,
    "data": {
        "chainId": 8453,
        "poolDetail": {
            "poolId": "0xC18F50d6A832f12F6DcAaeEe8D0c87A65B96787E",
            "dex": "UNISWAP_V3",
            "token0": {
                "symbol": "DAI",
                "name": "Dai",
                "address": "0x50c5725949a6f0c72e6c4a641f24049a917db0cb",
                "decimals": 18,
                "price": 0.999871
            },
            "token1": {
                "symbol": "USDC",
                "name": "USDC",
                "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
                "decimals": 6,
                "price": 0.99988
            }
        },
        "zapDetails": {
            "initialAmountUsd": 99.938006,
            "actions": [
                {
                    "type": "ACTION_TYPE_PROTOCOL_FEE",
                    "data": {
                        "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
                        "amount": "50000",
                        "amountUsd": 0.049994000000000004,
                        "zapFeeRate": 0.0005
                    }
                },
                {
                    "type": "ACTION_TYPE_AGGREGATOR_SWAP",
                    "data": {
                        "tokenIn": {
                            "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
                            "amount": "36601537",
                            "amountUsd": 36.59714481556
                        },
                        "tokenOut": {
                            "address": "0x50c5725949a6f0c72e6c4a641f24049a917db0cb",
                            "amount": "36662253061107726432",
                            "amountUsd": 36.65752363046284
                        },
                        "swapImpact": 0.0016498230997837053
                    }
                },
                {
                    "type": "ACTION_TYPE_ADD_LIQUIDITY",
                    "data": {
                        "token0": {
                            "address": "0x50c5725949a6f0c72e6c4a641f24049a917db0cb",
                            "amount": "36662253061107726432",
                            "amountUsd": 36.65752363046284
                        },
                        "token1": {
                            "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
                            "amount": "63348463",
                            "amountUsd": 63.34086118444
                        },
                        "liquidity": "20034656042451628"
                    }
                }
            ],
            "addedLiquidityUsd": 99.99838481490283,
            "zapImpact": 0.0006041626936486331
        }
    }
}
```

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

### Project Structure for OpenOcean Demo

Source: https://docs.openocean.finance/docs/widget/complete-example

Outlines the file structure for the OpenOcean Widget integration demo. This project consolidates the implementation into a single file for simplicity.

```txt
src/
├── main.tsx          # Main application file (everything in one file)
├── components/
│   └── wagmi.ts      # Wagmi configuration
└── index.css         # Global styles
```

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

### Zap Request Body Example

Source: https://docs.openocean.finance/docs/zap-api/api

Example JSON payload for a zap request into a Uniswap V3 pool.

```json
{
    "dex": "UNISWAP_V3",
    "pool": "0xc18f50d6a832f12f6dcaaeee8d0c87a65b96787e",
    "positionTickUpper": -276305,
    "positionTickLower": -276405,
    "tokens": [
        {
            "token": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
            "amount": 100000000
        }
    ],
    "slippage": 100,
    "referrer": "0xD01ef7C0A5d8c432fc2d1a85c66cF2327362E5C6"
}
```

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

### Configure Wagmi and AppKit

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Set up the Wagmi adapter and AppKit configuration for Reown.

```typescript
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'
import { createAppKit } from '@reown/appkit/react'
import { WagmiAdapter } from '@reown/appkit-adapter-wagmi'

const metadata = {
  name: 'OpenOcean Widget',
  description: 'OpenOcean Widget Example',
  url: 'https://openocean.finance',
  icons: ['/logo.avif'],
}

const wagmiAdapter = new WagmiAdapter({
  ssr: true,
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

createAppKit({
  adapters: [wagmiAdapter],
  chains: [mainnet, sepolia],
  projectId: 'YOUR_PROJECT_ID',
  metadata,
})
```

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

### Configure Frontend for Custom Mode

Source: https://docs.openocean.finance/docs/widget/reference

Implement the script and iframe on the frontend to integrate the widget.

```html
<script>  
  document.domain = "openocean.net";  
</script>  
<iframe src="https://app.openocean.net?domain=openocean.net"></iframe>  
```

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

### Connect Wallet via SDK

Source: https://docs.openocean.finance/docs/swap-api/sdk

Connects to a wallet using the swap SDK configuration.

```javascript
async connectWallet () {  
  try {  
    let AllChainNames = config.chains.chainNames  
    let AllWalletNames = config.wallets.walletList.map(item => item.key)  
    // ["MetaMask","CryptoCom","TrustWallet",...]  
    // ["eth","ropsten","rinkeby","bsc","solana","flow","polygon","avax",...]  
    let data = await swapSdk.connectWallet({  
      chainName: this.chainName,  
      walletName: this.walletName  
    })  
    if (data) {  
      this.myWallet = data.wallet  
      // this.chain = data.chain  
      // this.getBalance()  
    }  
  } catch (error) {  
    this.myWallet = null  
    this.chain = null  
  }  
}
```

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

### Initialize OpenOcean SDK in Project

Source: https://docs.openocean.finance/docs/swap-api/sdk

Import and initialize the OpenOceanSdk in your JavaScript project. This sets up the SDK for use, providing access to its API and swap functionalities.

```javascript
import { OpenoceanSdk } from '@openocean.finance/openocean-sdk'
const openoceanSdk = new OpenoceanSdk()
const { api, swapSdk, config } = openoceanSdk
```

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

### Project Directory Layout

Source: https://docs.openocean.finance/docs/skills/structure

Illustrates the hierarchical structure of the OpenOcean Skills project, including the placement of skill definitions, shared references, and test files.

```bash
openocean-skills/
├── skills/
│ ├── quote/# Get a swap quote
│ │ └── SKILL.md
│ ├── swap-build/# Build swap calldata (with confirmation)
│ │ └── SKILL.md
│ ├── swap-execute/# Execute a swap via Foundry cast (with confirmation)
│ │ └── SKILL.md
│ ├── swap-execute-fast/# Build and execute in one step (no confirmation)
│ │ ├── SKILL.md
│ │ └── scripts/
│ │ ├── fast-swap.sh# Token resolution and route building
│ │ └── execute-swap.sh# Calls fast-swap.sh and then broadcasts
│ └── error-handling/# Troubleshooting and error codes
│ └── SKILL.md
├── references/# Shared docs
│ ├── api-reference.md
│ └── token-registry.md
├── test/# Prompt test cases
│ └── agent-test-cases.md# English test prompts
└── README.md
```

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

### Get Transaction Body via Swap Quote API

Source: https://docs.openocean.finance/docs/overview/transaction-example

Retrieves transaction calldata for a swap by sending a GET request to the OpenOcean API with specified token and chain parameters.

```javascript
async function swap() {  
  const params = {  
    chain: 'bsc',  
    inTokenAddress: '0x55d398326f99059ff775485246999027b3197955',  
    outTokenAddress: '0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d',  
    slippage: 1,   
    amount: 1,   
    gasPrice: 1,   
    account: '0xB3cbe...'  
  };  
  const { data } = await axios({   
    url: `https://open-api.openocean.finance/v4/bsc/swap`,   
    method: 'GET',   
    params   
  });  
  return data;  
}
```

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

### Connect Wallet via MetaMask Class

Source: https://docs.openocean.finance/docs/swap-api/sdk

Directly instantiates and connects to a MetaMask wallet.

```javascript
import { MetaMask } from "@openocean.finance/wallet";  

const connectWallet = async (params) => {  
  const myWallet = new MetaMask()  
  const result = await myWallet.requestConnect(params.chainId);  
  // you can use the requestConnect function to trigger your wallet  
}
```

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

### Configure QueryClient

Source: https://docs.openocean.finance/docs/widget/v2/integration-examples

Initialize the React Query client for state management.

```ts
import { QueryClient } from '@tanstack/react-query'

export const queryClient = new QueryClient()
```

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

### Get Token List

Source: https://docs.openocean.finance/docs/swap-api/v4

Retrieve a list of supported tokens for a specific chain. Use this endpoint to get token details like ID, code, name, address, decimals, symbol, and icon.

```HTTP
https://open-api.openocean.finance/v4/bsc/tokenList
```