Provider API

Having accurate and, most importantly, complete Verified Provider data is a core responsibility of the Staking Rewards Infra Ratings.

There are two ways to have correct data in the Provider profile.

Map Validators with Integration Form

Complete your verified provider profile with accurate information and a list of validators on vsp.stakingrewards.com.

After you submit the validator addresses we will check and map them to your profile. For networks that we do not support yet, as a verified staking provider you can provide us with the data via an API. More about this in the right tab.

Provider API

You can see below the required structure of the provider API. Please follow the required format so that no difficulties arise during integration!

Please provide the data in JSON format as shown below:

type Provider = {
    name: string;
    users: number;
    balanceUsd: number;
    supportedAssets: [
        Array<{
            name: string; # Asset name
            slug: string; # Asset slug, preferred slugs can be found below
            nodes: [
                Array<{
                    nodeType: string; # hostingNode/operatorNode/posNode
                    address: string; # mandatory for pos nodeType, optional for operator nodeType
                    feeUsd: number; # (optional) Hosting Fee, a USD fixed price for hostingNodes
                    fee: number; # (optional) commission in % for posNodes
                    users: number; # for eth nodes number of validators
                    balanceUsd: number; # (optional)
                    balanceToken: number;
                    liquidStakingProvider: string; # (optional) identifier for liquid staking protocol, only for operator nodeType
                }>;
            ]
        }>;
    ]
};

You can search for the preferred slug for each asset by searching the asset in Staking Rewards and copying it from the url ex. https://www.stakingrewards.com/asset/ethereum-2-0 -> slug = "ethreum-2-0"

We have included detailed descriptions of each data point in General Data, Supported Assets, and Nodes.

Cosmos focused Providers can use the cosmos validator directory to get an API. Please follow these instructions -> https://github.com/eco-stake/validator-registry/wiki/Staking-Rewards