Openocean APIs
  • Developer
    • âš™ī¸APIs
      • Swap API
        • Guide
        • API V4
        • API V3
        • GMX Exclusive API
        • SDK
      • Limit Order API
        • Guide
        • API
        • SDK
      • Sweep Swap API
        • Guide
        • API
      • DCA API
        • Guide
        • API
        • SDK
      • Meme API
        • Data API
        • Transaction API
        • Websocket API
      • Ticket API
        • API
      • 🤖Swagger
    • 👾Widget
      • Getting Started
      • Customize Theme
      • Other Reference
      • Widget V2
        • Getting Started
    • â„šī¸Developer Resources
      • 🔗Supported Chains
      • 📋Contracts of Chains
      • 🚩Common Error Code
      • 📖Developer references & glossary
Powered by GitBook
On this page
  • Quick Install
  • Referral Fee
  1. Developer
  2. Widget

Getting Started

PreviousWidgetNextCustomize Theme

Last updated 6 days ago

Quick Install

There are three ways you can embed OpenOcean swap widget into your protocols/Apps.

Method #1 - Use <iframe> to inject the OpenOcean widget into your program.

  • Input <iframe> to your front-end code.

  • Refresh the page and check whether the component is installed.

<iframe src="https://widget.openocean.finance"></iframe>

Method #2 - Install the widget by using the OpenOcean SDK module.

You can check the detail in the SDK section.

Method #3 - Install the widget by using the OpenOcean API.

You can check the detail in the API section.

Referral Fee

Method #1 - add 'referral' which is fee charger address as query param in <iframe> request link

For example:

https://widget.openocean.finance?referral=0x3487ef9f9b36547e43268b8f0e2349a226c70b53#/BSC/BNB/BUSD

Method #2 - contact us

Change the iframe src to ""

We highly recommend using the custom mode to integrate wallets to make sure it works properly.

The default referrer fee is 0%. You could set up the referrer fee via the link . The default fee share for OpenOcean is 15% from the set referrer fee. You may for any adjustments for the fee share %.

Feel free to reach out to our team on or regarding the fee rate that you want to customize. In this method, the address from the above referral link will not be included.

👾
https://widget.openocean.finance
More Details
here
contact us
Telegram
Discord
GitHub - openocean-finance/WidgetGitHub
Logo