💰Earn Fees By Integrating

Anyone who integrates Shogun can earn fees, whether from our SDK, API, or Swap Widget.

How to Earn Fees

If you're integrating any of our services, you can include affiliateFee and affiliateAddress params to earn fees on any swaps done through your integration. The affiliateFee specifies the % of volume to take as a fee. Fees are instantly deposited to the address listed in the affiliateAddress param at the point of transaction execution.

The fee is taken out of the user's input asset and is automatically reflected in any quotes you receive through our API. Since the fee is specified at the point of quote, you can specify different address and fee rates for each chain.

The affiliateFee param expects a float (e.g. 2% would be 0.02).

Examples

SDK Example

import { Shogun } from '@{PLACEHOLDER}/sdk';

// Create a new instance of Shogun with desired affiliate fee parameters.
const shogun = new Shogun({
  affiliate: 'affiliate-example',
  defaultRouteOptions: {
    fee: 0.03,
  },
  // Other options...
});

Widget Example

import { ShogunSwapWidget, ShogunConfig } from '@{PLACEHOLDER}/widget';

const swapWidgetConfig: SwapWidgetConfig = {
  // Set 0x13A7DeDb7169a17bE92B0E3C7C2315B46f4772B3 as the affiliateAddress parameter.
  affiliateAddress: '0x13A7DeDb7169a17bE92B0E3C7C2315B46f4772B3',
  // Set 1% as the affiliateFee parameter.
  affiliateFee: 0.01,
  // Other options...
};

export const ExampleApp = () => {
  return (
    <ShogunSwapWidget integrator="affiliate-example" config={swapWidgetConfig} />
  );
};

API Example

const url = 'https://{PLACEHOLDER}/v1/quote?srcToken=0x4ecaba5870353805a9f068101a40e0f32ed605c6&destToken=0x13A7DeDb7169a17bE92B0E3C7C2315B46f4772B3&srcAddress=0x552008c0f6870c2f77e5cC1d2eb9bdff03e30Ea0&destAddress=0x552008c0f6870c2f77e5cC1d2eb9bdff03e30Ea0&amount=1000000&srcChain=arbitrum&destChain=base&affiliateAddress=affiliate-example&affiliateFee=0.03';
const options = {method: 'GET', headers: {accept: 'application/json'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));