Liquid Staking Protocols

The endpoints listed can be used to retrieve the liquidity exposure score analysis of Liquid Staking protocols into the other DeFi protocols.

Retrieves the available lending protocol options for Lido exposure.

This endpoint returns key metrics and the Lido exposure for the specified protocol from the last 7 days.

GEThttps://api.alterscope.org/data/liquidity/liquid-staking/available-lending-markets-exposure

Authorization

bearerAuth

Response

200500

OK

Body

application/json

aavearray of object

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/data/liquidity/liquid-staking/available-lending-markets-exposure', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "aave": [
    {
      "protocol": "text",
      "version": "text",
      "baseAsset": "text"
    }
  ]
}

Sample Request

Note: The sample request below retrieves available lending markets for lido exposure.

curl https://api.alterscope.org/data/liquidity/liquid-staking/available-lending-markets-exposure -H "Authorization: Bearer <your_access_token>"

Sample Response

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC"
      },
      {
         "chain":"ethereum",
         "protocol":"compound",
         "version":"V3",
         "base_asset_symbol":"ETH"
      }
   ]
}

Sample Response Description

Chain: This indicates the blockchain network on which the financial protocol operates. In this case, it is Ethereum.

Protocol: Refers to the specific decentralized finance (DeFi) protocol in this case its AAVE or Compound.

Version: Denotes the version of the protocol being used.

Base Asset Symbol: Represents the symbol of the base asset involved in the protocol.

Retrieves the available lending protocol options for Lido exposure.

This endpoint returns key metrics and the Lido exposure for the specified protocol from the last 7 days.

GEThttps://api.alterscope.org/data/liquidity/liquid-staking/available-dexes-exposure

Authorization

bearerAuth

Response

200500

OK

Body

application/json

uniswaparray of object

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/data/liquidity/liquid-staking/available-dexes-exposure', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "uniswap": [
    {
      "protocol": "text",
      "version": "text",
      "baseAsset": "text"
    }
  ]
}

Sample Request

curl https://api.alterscope.org/data/liquidity/liquid-staking/available-dexes-exposure -H "Authorization: Bearer <your_access_token>"

Sample Response

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "pool_addresses":[
            "0xdc24316b9ae028f1497c275eb9192a3ea0f67022"
         ]
      }
   ]
}

Sample Response Description

Chain: This indicates the blockchain network on which the financial protocol operates. In this case, it is Ethereum.

Protocol: Refers to the specific decentralized finance (DeFi) protocol in this case its AAVE or Compound.

Version: Denotes the version of the protocol being used.

Base Asset Symbol: Represents the symbol of the base asset involved in the protocol. Pool Address: In the context of decentralized exchanges (DEX), a pool address typically refers to a liquidity pool's smart contract address.

Retrieves the Lido asset analytics and exposure in corresponding lending protocol.

This endpoint returns key metrics and the Lido exposure for the specified protocol from the last 7 days.

GEThttps://api.alterscope.org/data/liquidity/liquid-staking/asset-analytics-in-lending/{chain}/{protocol}/{version}/{baseAsset}/{inRisk}

Authorization

bearerAuth

Path parameters

chain*string

the name of the chain, e.g. ethereum

protocol*string

the name of the protocol, e.g. aave

version*string

the version of the protocol, e.g. V3

baseAsset*string

the base asset of the protocol, e.g. USDC, ETH

inRisk*string

analysis for risky wallets or for all. e.g. true or false

Response

200404406500

OK

Body

application/json

protocolstring

versionstring

baseAssetstring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/data/liquidity/liquid-staking/asset-analytics-in-lending/{chain}/{protocol}/{version}/{baseAsset}/{inRisk}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "protocol": "text",
  "version": "text",
  "baseAsset": "text"
}

Sample Request

Note: The sample request below requests asset analytics data for aave lending protocol on ethereum chain.

curl https://api.alterscope.org/data/liquidity/liquid-staking/asset-analytics-in-lending/ethereum/aave/V3/ETH/true -H "Authorization: Bearer <your_access_token>"

For a list of supported lending protocol versions and chains please check sample response for Retrieves the available lending protocol options for Lido exposure API endpoint.

Sample Response

The response is shortened for formatting purposes. The actual response will display data for a whole week.

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"ETH",
         "token_data":[
            {
               "token_address":"0x0b925ed163218f6662a35e0f0371ac234f9e9371",
               "token_symbol":"aEthwstETH",
               "token_decimal":18
            },
            {
               "token_address":"0xc96113eed8cab59cd8a66813bcb0ceb29f06d2e4",
               "token_symbol":"variableDebtEthwstETH",
               "token_decimal":18
            }
         ],
         "total_supply_base":62529.80335288431,
         "total_supply_usd":166803477.2101942,
         "total_borrow_token":210.38017458743823,
         "total_borrow_usd":561206.7010547178,
         "in_risk":true,
         "unique_wallet_num":131,
         "timestamp":"21-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"ETH",
         "token_data":[
            {
               "token_address":"0x0b925ed163218f6662a35e0f0371ac234f9e9371",
               "token_symbol":"aEthwstETH",
               "token_decimal":18
            },
            {
               "token_address":"0xc96113eed8cab59cd8a66813bcb0ceb29f06d2e4",
               "token_symbol":"variableDebtEthwstETH",
               "token_decimal":18
            }
         ],
         "total_supply_base":67149.0861399047,
         "total_supply_usd":180443729.18166983,
         "total_borrow_token":130.01454127157507,
         "total_borrow_usd":349376.4401500226,
         "in_risk":true,
         "unique_wallet_num":121,
         "timestamp":"21-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"ETH",
         "token_data":[
            {
               "token_address":"0x0b925ed163218f6662a35e0f0371ac234f9e9371",
               "token_symbol":"aEthwstETH",
               "token_decimal":18
            },
            {
               "token_address":"0xc96113eed8cab59cd8a66813bcb0ceb29f06d2e4",
               "token_symbol":"variableDebtEthwstETH",
               "token_decimal":18
            }
         ],
         "total_supply_base":74524.7145546395,
         "total_supply_usd":201723371.51253065,
         "total_borrow_token":204.68799171957352,
         "total_borrow_usd":554049.110346184,
         "in_risk":true,
         "unique_wallet_num":127,
         "timestamp":"21-01-2024"
      }

Sample Response Description

Chain: This field provides information related to the used blockchain in this case its ethereum.

Protocol: Refers to the specific decentralized finance (DeFi) protocol in this case it can be AAVE or Compound.

Version: Specifies the version of the protocol being used.

Base Asset Symbol: Represents the symbol of the base asset involved in the protocol.

Token Data: Provides details about specific tokens within the protocol.

Total Supply Base: Represents the total supply of the base asset.

Total Supply USD: Indicates the total value of the supplied assets in USD.

Total Borrow Token: Specifies the total amount of borrowed tokens within the protocol.

Total Borrow USD: Represents the total value of borrowed assets in USD.

In Risk: A boolean (true or false)when true will perform analysis of risky wallets within the protocol.

Unique Wallet Number: Denotes the number of unique wallets involved with the protocol.

Timestamp: Represents the date and time when the data was recorded.

Retrieves the data analytics for given pool.

This endpoint returns the data analytics for given pool address. You can get the list of pool addresses using /available-dexes and /available-pools/... endpoints.

GEThttps://api.alterscope.org/data/liquidity/liquid-staking/pool-analytics-in-dex/{poolAddress}

Authorization

bearerAuth

Path parameters

poolAddress*string

the address of the pool to be examined

Response

200404406500

OK

Body

application/json

chainstring

protocolstring

versionstring

pool_addressstring

token_amountsarray of object

token_amount_changesarray of object

token_volumesarray of object

volume_usdnumber

fee_usdnumber

tvl_usdnumber

num_unique_walletsnumber

num_transactionsnumber

timestampstring

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/data/liquidity/liquid-staking/pool-analytics-in-dex/{poolAddress}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "chain": "text",
  "protocol": "text",
  "version": "text",
  "pool_address": "text",
  "token_amounts": [
    {
      "token_index": 0,
      "token_amount": 0,
      "token_amount_usd": 0
    }
  ],
  "token_amount_changes": [
    {
      "token_index": 0,
      "token_exchange_amount": 0,
      "token_exchange_usd": 0
    }
  ],
  "token_volumes": [
    {
      "token_index": 0,
      "token_exchange_amount": 0,
      "token_exchange_usd": 0
    }
  ],
  "volume_usd": 0,
  "fee_usd": 0,
  "tvl_usd": 0,
  "num_unique_wallets": 0,
  "num_transactions": 0,
  "timestamp": "text"
}

Sample Request

Note: The sample request below retrieves data analytics for 0xdc24316b9ae028f1497c275eb9192a3ea0f67022 dex pool.

curl https://api.alterscope.org/data/liquidity/liquid-staking/pool-analytics-in-dex/0xdc24316b9ae028f1497c275eb9192a3ea0f67022 -H "Authorization: Bearer <your_access_token>"

For a list of supported dex protocols and pools please check sample response for Retrieves the available dex protocol options API endpoint.

Sample Response

The sample response is shortened for formatting purposes. The actual response will list data for a whole week.

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "pool_address":"0xdc24316b9ae028f1497c275eb9192a3ea0f67022",
         "token_amounts":[
            {
               "token_index":0,
               "token_amount":45825.051570790754,
               "token_amount_usd":107083088.0258394
            },
            {
               "token_index":1,
               "token_amount":46639.517868612966,
               "token_amount_usd":108953303.93172133
            }
         ],
         "token_amount_changes":[
            {
               "token_index":0,
               "token_exchange_amount":284.9471890490022,
               "token_exchange_usd":672211.0749278218
            },
            {
               "token_index":1,
               "token_exchange_amount":-284.3447827082491,
               "token_exchange_usd":-672073.139674915
            }
         ],
         "token_volumes":[
            {
               "token_index":0,
               "token_exchange_amount":7456.42691047269,
               "token_exchange_usd":17586712.729608826
            },
            {
               "token_index":1,
               "token_exchange_amount":7460.860423080255,
               "token_exchange_usd":17566542.10582555
            }
         ],
         "volume_usd":17576627.417717185,
         "fee_usd":1757.6627417717186,
         "tvl_usd":216036391.95756072,
         "num_unique_wallets":31,
         "num_transactions":153,
         "timestamp":"22-01-2024"
      }
   ]
}

Sample Response Description

• Data:

  • Chain: The blockchain network used.

  • Protocol: The specific protocol used.

  • Version: The version of the protocol.

  • Pool Address: The address of the liquidity pool on the Ethereum blockchain.

  • Token Amounts: Information about the amounts of tokens in the pool.

  • Token Amount Changes: Changes in token amounts due to exchanges.

  • Token Volumes: Information about token exchange volumes.

  • Volume USD: Total exchange volume in USD.

  • Fee USD: The total fees generated from transactions.

  • TVL USD: Total Value Locked in the pool in USD.

  • Num Unique Wallets: The number of unique wallets involved with the dex protocol.

  • Num Transactions: The total number of transactions.

  • Timestamp: The date and time of the data.

Retrieves the Lido asset analytics and exposure in corresponding lending protocol.

This endpoint returns key metrics and the Lido exposure for the specified protocol from the last 7 days.

GEThttps://api.alterscope.org/data/liquidity/liquid-staking/asset-market-exposure-in-lending/{chain}/{protocol}/{version}/{baseAsset}/{inRisk}

Authorization

bearerAuth

Path parameters

chain*string

the name of the chain, e.g. ethereum

protocol*string

the name of the protocol, e.g. aave

version*string

the version of the protocol, e.g. V3

baseAsset*string

the base asset of the protocol, e.g. USDC, ETH

inRisk*string

analysis for risky wallets or for all. e.g. true or false

Response

200404406500

OK

Body

application/json

protocolstring

versionstring

baseAssetstring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/data/liquidity/liquid-staking/asset-market-exposure-in-lending/{chain}/{protocol}/{version}/{baseAsset}/{inRisk}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "protocol": "text",
  "version": "text",
  "baseAsset": "text"
}

Sample Request

Note: The sample request below provides score data for aave lending protocol on ethereum chain with USDC base asset.

curl https://api.alterscope.org/scores/liquidity/liquid-staking/exposure-in-lending/ethereum/aave/V3/USDC/true -H "Authorization: Bearer <your_access_token>"

For a list of supported protocol versions, base asset and chains please check sample response for Retrieving the available lending protocol options for Lido exposure API endpoint.

Sample Response

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":1.0595224219074546,
         "liquidity_score":0.18837658303544902,
         "in_risk":true,
         "timestamp":"18-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":1.0597013895267886,
         "liquidity_score":0.18888576589766792,
         "in_risk":true,
         "timestamp":"18-01-2024"
      }

Sample Response Description

Chain: This indicates the blockchain network on which the financial protocol operates. In this case, it is Ethereum.

Protocol: Refers to the specific decentralized finance (DeFi) protocol in this case its AAVE.

Version: Denotes the version of the protocol being used.

Base Asset Symbol: Represents the symbol of the base asset involved in the protocol.

Health Factor: Indicates the health factor of the protocol which is a metric used in decentralized lending platforms to assess the health of a user's position.

Liquidity Score: Represents a liquidity score associated with the protocol.

In Risk: Indicates whether the protocol is currently considered to be at risk.

Timestamp: Specifies the date and time when this data was recorded

Retrieves the Dex Pool for corresponding protocol.

This endpoint returns key metrics and the Dex Volume score for the specified pool from the last 7 days.

GEThttps://api.alterscope.org/scores/liquidity/liquid-staking/dex-pool-scores/{poolAddress}

Authorization

bearerAuth

Path parameters

poolAddress*string

the address of the dex pool

Response

200404406500

OK

Body

application/json

chainstring

protocolstring

versionstring

pool_addressstring

mean_volume_usdnumber

median_volume_usdnumber

volume_continuity_scorenumber

timestampstring

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/scores/liquidity/liquid-staking/dex-pool-scores/{poolAddress}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "chain": "text",
  "protocol": "text",
  "version": "text",
  "pool_address": "text",
  "mean_volume_usd": 0,
  "median_volume_usd": 0,
  "volume_continuity_score": 0,
  "timestamp": "text"
}

Sample Request

Note: The sample request below provides score data for a given dex pool.

curl https://api.alterscope.org/scores/liquidity/liquid-staking/dex-pool-scores/0xdc24316b9ae028f1497c275eb9192a3ea0f67022 -H "Authorization: Bearer <your_access_token>"

For a list of supported dex protocols and pools please check sample response for Retrieving the available dex protocol options for Lido exposure API endpoint.

Sample Response

The sample response below is shortened for formatting purposes and only display data for single day. The actual response will display data for whole week.

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "pool_address":"0xdc24316b9ae028f1497c275eb9192a3ea0f67022",
         "mean_volume_usd":160788.45423113377,
         "median_volume_usd":75693.37095945826,
         "volume_continuity_score":0.48608374767192025,
         "timestamp":"14-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "pool_address":"0xdc24316b9ae028f1497c275eb9192a3ea0f67022",
         "mean_volume_usd":208847.73139931157,
         "median_volume_usd":48219.52534662029,
         "volume_continuity_score":0.31886541907022636,
         "timestamp":"13-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "pool_address":"0xdc24316b9ae028f1497c275eb9192a3ea0f67022",
         "mean_volume_usd":124548.97114337476,
         "median_volume_usd":14230.237988262397,
         "volume_continuity_score":0.1680855461767164,
         "timestamp":"12-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "pool_address":"0xdc24316b9ae028f1497c275eb9192a3ea0f67022",
         "mean_volume_usd":154866.88146855406,
         "median_volume_usd":21948.537969712954,
         "volume_continuity_score":0.2650899167825727,
         "timestamp":"11-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "pool_address":"0xdc24316b9ae028f1497c275eb9192a3ea0f67022",
         "mean_volume_usd":98548.42896632815,
         "median_volume_usd":18706.88092443729,
         "volume_continuity_score":0.2968387715540281,
         "timestamp":"10-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "pool_address":"0xdc24316b9ae028f1497c275eb9192a3ea0f67022",
         "mean_volume_usd":71154.21795126011,
         "median_volume_usd":4334.401435388576,
         "volume_continuity_score":0.022883097505936548,
         "timestamp":"09-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "pool_address":"0xdc24316b9ae028f1497c275eb9192a3ea0f67022",
         "mean_volume_usd":82328.59841106525,
         "median_volume_usd":23075.42467400653,
         "volume_continuity_score":0.3969760086078749,
         "timestamp":"08-03-2024"
      }
   ]
}

Sample Response Description

Chain: Specifies the blockchain platform or network on which the DEX operates.

Protocol: Indicates the underlying set of rules and specifications governing the operation of the system or network.In this case its curve.

Version: Specifies the version or release of the protocol being used.

Pool Address: Refers to the unique address associated with a liquidity pool on the decentralized exchange.

Mean Volume (USD):Represents the average trading or transaction volume in US dollars over a certain period.

Median Volume (USD): Indicates the middle value of the trading or transaction volume when arranged in ascending order, providing a measure of central tendency.

Volume Continuity Score: Represents a numerical score indicating the consistency or continuity of transaction volumes over time.

Timestamp: Specifies the date and time when the data or information was recorded or retrieved.