Custodial API

Custodial API 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; // Provider Name
  "totalUsers": number; // (Optional) Total number of individual wallets holding the LST.
  "totalBalanceUsd": number; // (Optional) The total balance held in USD.
  "supportedAssets": [ 
    {
      "label": string; // Name of the Earn Tier, limit to 25 characters.
      "slug": string; //  Use the Staking Rewards Asset Slug (Learn more below).
      "apr": number; // Annual Reward Rate before Fees and in %
      "fee": number; // Fees in % deducted from the APR
      "aprBreakdown": [ // % breakdown of rewards origin, check example
        {
         "slug": string; // Slug of the payout asset
         "apr": number //  Portion of total APR by this asset
        }
       ]
       "duration": number; // Time in Seconds the user locks the funds
       "minDepositAmount": number; // Minimum amount the user has to deposit, token unit - not $ !
       "maxDepositAmount": number // Maximum amount the user can deposit, token unit - not $ !
    }
  ]
}

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 staking 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

1. Visit https://www.stakingrewards.com/staking-data-api to get your free key.

2. Then, go to https://api-docs.stakingrewards.com/playground and put in the key

3. Run this query and take the corresponding slug for your API

---

3. Example Endpoint Schematype Provider

    {
      "name": "Nexo",
     "totalUsers": 32225, // (Optional)
     "totalBalanceUsd": 32556765; // (Optional)
     "supportedAssets": [ 
       {
         "label": "Bronze Tier",
         "slug": "polkadot", //ensure to take the right slug! Learn more here
         "apr": 21.2, // 21.2% yield on DOT
         "fee": 10, // Fees deducted from the APR
         "aprBreakdown": [ // % breakdown of rewards origin, check example
           {
            "slug": "polkadot", // Slug of the payout asset
            "apr": 18.2 //  Portion of total APR by this asset
           },
           {
           "slug": "nexo",
           "apr": 3
          ]
          "duration": 86400, // 1d lockup, for flexible take 0
          "minDepositAmount": 0, // no minimum for deposits
          "maxDepositAmount": 10000000 // max deposit of 10,000,000 DOT
       }
     ]
   }

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