Liquid Locker

Liquid Locker Integration Guide

1. Schema Endpoint Structure

2. Get the right asset & provider slug

3. Example Endpoint Structure

---

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 interacting with your protocol.
  "totalBalanceUsd": number; // (Optional) The total balance held in USD.
  "supportedAssets": [ // Array of liquid token(s) your service supports.
    {
      "contractAddress": string; // On-Chain contract of the locker.
      "symbol": string; // The symbol of the token.
      "slug": string; // The token slug (Coingecko ID or learn more below).
      "baseSlug": string; // The slug of the base asset.
      "chain": string; // The chain the vault is deployed on, use of the coingecko slug
      "supply": number; // The total token supply of the token.
      "balanceUSD": number; // The $ value of tokens in the locker.
      "apr": number; // Annual percentage rate before fees.
      "aprBreakdown": [ // Breakdown of the APR components
            {
            "slug": string; // The token slug (Coingecko ID or learn more below).
            "apr": number; // Annual percentage rate
            }
          ]
      "fee": number; // Fee percentage for staking services.
      "users": number; // Number of individual wallets holding the token.
      "unstakingTime": number; // Time in seconds to unbond - not exchanging!
      "exchangeRatio": number; // Ratio of the base asset to the token.
    }
  ]
}

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:

Welcome | Staking Rewards - API Docs

---

3. Example Endpoint Schema

{
  "name": "Stake DAO",
  "totalUsers": 3205, // users holding sdTokens
  "totalBalanceUsd": 30000000000, // value of all sdTokens summed up
  "supportedAssets": [
    {
      "contractAddress": "0xcDd374F491fBF3f4FcF6E9023c99043774005137",
      "symbol": "sdCake",
      "slug": "sdcake", // coingecko id
      "baseSlug": "cake", // coingecko id
      "chain": "binance-smart-chain", // coingecko id
      "supply": 100000, // sdCake balance
      "balanceUSD": 3500000, // Cake with this $ value is in the locker
      "apr": 184.8, // in % before fees!
      "aprBreakdown": [ 
            {
            "slug": "cake", // The token slug (Coingecko ID or learn more below).
            "apr": 17.80 // Annual percentage rate
            },
            {
            "slug": "sdcake",
            "apr": 167
            }
          ]
      "fee": 10, // in % the user has to pay
      "users": 500, // sdCake holders
      "exchangeRatio": 0.98 // conversion from LST to ETH
    } 
  ] 
} 

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