DeFi Vault API

DeFi Vault Integration Guide

  1. Schema Endpoint Structure

  2. Get the right asset & provider slug

  3. Example Endpoint Structure

Integration Steps:

  • Prepare Your Data: Ensure your vault information aligns with our schema requirements.

  • Submit Your Data: Provide us with detailed information regarding your vaults.

  • Verification: Our team will verify the information before publishing your services.

By completing these steps, you help improve visibility and transparency for users exploring staking opportunities on our site. Let's enhance your service’s reach together!

To integrate your liquid staking services into stakingrewards.com, follow the structure defined below for the Provider object:

  1. Schema Endpoint Structure

{
  "name": string; // The name of your protocol.
  "totalUsers": number; // (Optional) Total number of individual wallets deposited into the protocol.
  "totalBalanceUsd": number; // (Optional) The total balance held in USD.
  "supportedVaults": [ // Array of vaults your protocol supports
    {
      "label": string; // The label of the vault.
      "contractAddress": string; // On-Chain contract of the vault.
      "chain": string; // The chain the strategy is deployed.
      "balanceUSD": number; // The total value locked in $.
      "assetBreakdown": [ // The supported assets for this vault. 
            {
            "slug": string // The token slug (Coingecko ID or learn more below).
            "balance" number // The token balance in the vault.
            }
          ]
      "users": number; // Individual wallets utilizing the strategy.
      "apr": number; // Annual percentage rate before fees.
      "aprBreakdown": [ // (Optional) Reward Rate pay out currencies.
            {
            "slug": string; // The token slug (Coingecko ID or learn more below).
            "apr": number; // Proportion of this token on the total APR in decimals.
            }
          ]
      "fee": [ // The fees taken by the protocol.
            {
            "management_fee": number; // Fee percentage the protocol takes for managing the vault.
            "performance_fee": number; // Fee percentage the protocol takes on the vault performance.
            "deposit_fee": number; // Fee percentage the protocol takes on deposits into the vault.
            "exit_fee": number; // Fee percentage the protocol takes when exit the vault.
             }
           ]
      "capacity": boolean // (Optional) Free capacity in the vault.
      "pointsBreakdown": [ // (Optional) Points on top of the vaults.
            {
            "name": string; // The issuer of the points.
            }
          ]
    }
  ]
}

The more detailed your breakdown is, the more data we can display on your provider profiles and the respective asset profiles.

2. Requesting Staking Rewards Asset and Operator Slugs

To request slugs for your assets and provider, complete the following steps:

  1. Prepare a list of the assets supported by your liquid service.

  2. Note down any specific chain details for each asset, such as APR and fees.

  3. Contact the Staking Rewards team with details of your operation.

The Staking Rewards team will guide you through the process of acquiring your slugs and assist with any queries you may have concerning the integration.

Staking Rewards Asset and Provider slugs can be requested here:

  1. Example Endpoint Schema

{
  "name": "Cian",
  "totalUsers": 3205,
  "totalBalanceUsd": 12500000, // in $
  "supportedVaults": [
    {
      "label": "Mainnet flagship",
      "contractAddress": "0xcDd374F491fBF3f4FcF6E9023c99043774005137",
      "chain": "Ethereum", // Avalanche, Arbitrum, Binance Smart Chain, etc.
      "balanceUSD": 31800000, // in $.
      "assetBreakdown": [ // The supported assets for this vault. 
            {
            "slug": "ethereum-2-0",
            "balance": 31241421
            },
            {
            "slug": "staked-ether", 
            "balance": 13241421
            }
          ]
      "users": 3123,
      "apr": 12, // in % before fees.
      "aprBreakdown": [ // mandatory if rewards are paid out in multiple token, e.g. you incentivze the vault with additional governance token
            {
            "slug": "ethereum-2-0",
            "apr": 5
            },
            {
            "slug": "cian-token", 
            "apr": 7
            }
            }
          ]
      "fee": [
            {
            "management_fee": 1,
            "performance_fee": 10,
            "deposit_fee": 1,
            "exit_fee": 0
             }
           ]
      "capacity": 1 // free capacity
      "pointsBreakdown": [ 
            {
            "name": "Eigenlayer"
            }
          ]
      }
   ]
}

The API provided must be updated with the latest data at least every 24 hours.

PreviousCustodial APINextLiquid Locker

Last updated