Collect Fees

Integrator Fee Structure

Squid v2 allows integrators to implement their own fee structure on top of Squid's platform fees. This document details the structure of Integrator fees implemented on through Squid.

To implement fees please contact the Squid team.

Integrator Fee Configuration

As an integrator, you can implement the following fee structures:

Flat fee: A fixed amount per transaction
Percentage fee: A percentage of the transaction amount
Secondary address fees (optional): Fees sent to a second address
Option to waive platform fee (if allowed by Squid)

Implementing Integrator Fees

In order to prevent abuse an abuse of the fee collection system, we implement the collectFees parameter on the backend for integrators:

const params = {
  // ... other route parameters
  collectFees: {
    integratorAddress: "0x123...abc", // Your address to receive fees
    fee: 50, // Fee in basis points (e.g., 50 = 0.5%)
    integratorAddress2: "0x456...def", // Optional secondary address
    fee2: 25, // Optional fee for secondary address (in basis points)
  }
};

const { route } = await squid.getRoute(params);

Fee Precision

You can set fees with precision up to thousandths of a percent (0.001% - 100% or 0.00001 - 1 in decimal form).

Fee Display

Within the returned route request, all fees (including your integrator fees and Squid's platform fees) are aggregated into a single "Service fee" in the route response. This appears in the feeCosts array and route.actions:

{
  "feeCosts": [
    {
      "amount": "31178739678247",
      "amountUsd": "0.12",
      "description": "Service fee",
      "name": "Service fee",
      "token": {
        "type": "evm",
        "chainId": "42161",
        "address": "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
        "name": "Ethereum",
        "symbol": "ETH",
        "decimals": 18,
        "logoURI": "https://raw.githubusercontent.com/0xsquid/assets/main/images/tokens/eth.svg",
        "coingeckoId": "ethereum",
        "usdPrice": 3798.076408348585
      }
    }
  ],
  "actions": [
    {
      // ... other action properties
      "provider": "Service fee",
      "description": "Service fee",
      "priceImpact": 0,
      "exchangeRate": "0.99"
    }
  ]
}

Platform Fee Structure

Squid splits all fees collected by integrators 50/50.

In the future, Squid may charge additional platform fees on top of integrator fees. These may include:

Platform Base Fee
Chain-specific Fees
Token-specific Fees
Volatility Tier Fees

The total fee for a transaction is calculated as:

Total Fee = Platform Fees + Integrator Fees

Note: In some cases, Squid may allow integrators to waive certain platform fees. Please contact us for more information on fee customization options.

Last updated 7 months ago

const params = { // ... other route parameters collectFees: { integratorAddress: "0x123...abc", // Your address to receive fees fee: 50, // Fee in basis points (e.g., 50 = 0.5%) integratorAddress2: "0x456...def", // Optional secondary address fee2: 25, // Optional fee for secondary address (in basis points) } }; const { route } = await squid.getRoute(params);

{ "feeCosts": [ { "amount": "31178739678247", "amountUsd": "0.12", "description": "Service fee", "name": "Service fee", "token": { "type": "evm", "chainId": "42161", "address": "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE", "name": "Ethereum", "symbol": "ETH", "decimals": 18, "logoURI": "https://raw.githubusercontent.com/0xsquid/assets/main/images/tokens/eth.svg", "coingeckoId": "ethereum", "usdPrice": 3798.076408348585 } } ], "actions": [ { // ... other action properties "provider": "Service fee", "description": "Service fee", "priceImpact": 0, "exchangeRate": "0.99" } ] }