Getting Started

GitHub - openocean-finance/Widget
GitHub
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.
Change the iframe src to "https://widget.openocean.finance"
Refresh the page and check whether the component is installed.
<iframe src="https://widget.openocean.finance"></iframe>
We highly recommend using the custom mode to integrate wallets to make sure it works properly. More Details​
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
The default referral fee on widget will be 1% and OpenOcean will share 15% of it. You may contact us for any adjustments.
​
Method #2 - contact us
Feel free to reach out to our team on Telegram or Discord regarding the fee rate that you want to customize. In this method, the address from the above referral link will not be included.
​
​
​
Last modified 11mo ago