Lending Protocols

The endpoints listed can be used to retrieve the data analytics and score analysis of various lending markets and the assets listed in these markets.

Retrieves the available lending markets for all supported protocols.

This endpoint returns the list of available lending markets supported in our product. You can use the information from this endpoint to make requests other data and score endpoints for lending markets.

get

/data/liquidity/lending/available-markets

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.alterscope.org/data/liquidity/lending/available-markets' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

500

200

{
  "chain": "ethereum",
  "protocol": "aave",
  "version": "V3",
  "pool_address": 7.737253817192762e+47,
  "market_name": "Ethereum Market",
  "base_asset": {
    "token_index": 0,
    "token_address": 9.175510568426712e+47,
    "token_symbol": "USDC",
    "token_decimal": 6
  }
}

OK

Sample Request

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

Sample Response

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "pool_address":"0x87870bca3f3fd6335c3f4ce8392d69350b4fa4e2",
         "market_name":"Ethereum Market",
         "base_asset":{
            "token_index":0,
            "token_address":"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
            "token_name":"",
            "token_symbol":"USDC",
            "token_decimal":6
         }
      },
      {
         "chain":"ethereum",
         "protocol":"compound",
         "version":"V3",
         "pool_address":"0xa17581a9e3356d9a858b789d68b4d866e593ae94",
         "market_name":"Ethereum ETH Market",
         "base_asset":{
            "token_index":0,
            "token_address":"0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
            "token_name":"",
            "token_symbol":"ETH",
            "token_decimal":18
         }
      },
      {
         "chain":"ethereum",
         "protocol":"compound",
         "version":"V3",
         "pool_address":"0xc3d688b66703497daa19211eedff47f25384cdc3",
         "market_name":"Ethereum USDC Market",
         "base_asset":{
            "token_index":0,
            "token_address":"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
            "token_name":"",
            "token_symbol":"USDC",
            "token_decimal":6
         }
      }
   ]
}

Sample Response Description

Chain: This refers to the blockchain network that is utilized.

Protocol: This indicates the specific protocol being used within the blockchain network.

Version: This represents the version number associated with the protocol being utilized.

Pool Address: Refers to the address or location of a liquidity pool within the specified blockchain protocol or chain.

Market Name: Denotes the name of lending market.

Base Asset: Defines a nested structure that contains information about base asset in the lending market.

• Token Index: An index representing the token position in a list.

• Token Address: Refers to the blockchain address of the token.

• Token Symbol: Represents the symbol associated with the token.

• Token Decimal: Indicates the decimal precision used for the token. It is represented as an integer.

---

Retrieves the Liquidity Data for corresponding token address in a given protocol.

This endpoint returns the data of a token given a lending market, e.g. WETH in AAVE V3. It includes total supply, borrow, number of wallets supplying or borrowing, etc.

get

/data/liquidity/lending/asset-analytics/{chain}//{protocol}//{version}//{baseAsset}//{tokenAddress}

Authorizations

Path parameters

chainstringrequired

the name of the chain that lending market is hosted, e.g. ethereum

protocolstringrequired

the name of the protocol, e.g. compound

versionstringrequired

the version of the protocol, e.g. V3

baseAssetstringrequired

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

tokenAddressstringrequired

the address of the token that is listed in a lending market, e.g. WETH, WBTC

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.alterscope.org/data/liquidity/lending/asset-analytics/{chain}/{protocol}/{version}/{baseAsset}/{tokenAddress}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

406

500

200

{
  "chain": "ethereum",
  "protocol": "aave",
  "version": "V3",
  "base_asset_symbol": "USDC",
  "token_address": 1.0970776880180083e+48,
  "total_supply_token": 323005.283684409,
  "total_supply_usd": 703709542.1043013,
  "total_borrow_token": 100532.75931809883,
  "total_borrow_usd": 219023854.3282252,
  "num_unique_wallets_supply": 3287,
  "num_unique_wallets_borrow": 274,
  "timestamp": "12-12-2023"
}

OK

Sample Request

Note: The sample request below shows liquidity data for the ethereum chain and aave V3 protocol with USDCbase asset.

curl https://api.alterscope.org/data/liquidity/lending/asset-analytics/ethereum/aave/V3/USDC/0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48 -H "Authorization: Bearer <your_access_token>"

For a supported list of chains, protocol version, base asset and token addresses whose liqudity data can be requested please refer to sample response for retrieving the available lending markets for all supported protocols API endpoint.

Sample Response

Note: The sample response below will show liquidity data for corresponding token address in a given protocol for past 7 days.

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "token_address":"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
         "total_supply_token":340421642.3255271,
         "total_supply_usd":340403092.8143083,
         "total_borrow_token":308499055.38582575,
         "total_borrow_usd":308481196.18072337,
         "num_unique_wallets_supply":1458,
         "num_unique_wallets_borrow":1960,
         "timestamp":"14-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "token_address":"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
         "total_supply_token":330482908.6205832,
         "total_supply_usd":330482908.61812496,
         "total_borrow_token":303079223.0795486,
         "total_borrow_usd":303079228.96959996,
         "num_unique_wallets_supply":1451,
         "num_unique_wallets_borrow":1947,
         "timestamp":"13-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "token_address":"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
         "total_supply_token":335155679.7888121,
         "total_supply_usd":335155671.1786365,
         "total_borrow_token":306935299.5459048,
         "total_borrow_usd":306935331.1520797,
         "num_unique_wallets_supply":1454,
         "num_unique_wallets_borrow":1939,
         "timestamp":"12-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "token_address":"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
         "total_supply_token":328796731.0676419,
         "total_supply_usd":328796720.50708324,
         "total_borrow_token":308637364.5833498,
         "total_borrow_usd":308637333.8920293,
         "num_unique_wallets_supply":1436,
         "num_unique_wallets_borrow":1952,
         "timestamp":"11-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "token_address":"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
         "total_supply_token":344572348.9055059,
         "total_supply_usd":344566846.500288,
         "total_borrow_token":312604542.15189904,
         "total_borrow_usd":312604502.41446704,
         "num_unique_wallets_supply":1427,
         "num_unique_wallets_borrow":1943,
         "timestamp":"10-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "token_address":"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
         "total_supply_token":345283806.602963,
         "total_supply_usd":345283807.2498739,
         "total_borrow_token":311421464.92596304,
         "total_borrow_usd":311421469.7870546,
         "num_unique_wallets_supply":1429,
         "num_unique_wallets_borrow":1936,
         "timestamp":"09-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "token_address":"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
         "total_supply_token":342179361.136759,
         "total_supply_usd":342179361.14774317,
         "total_borrow_token":310259797.23210716,
         "total_borrow_usd":310259725.34522635,
         "num_unique_wallets_supply":1422,
         "num_unique_wallets_borrow":1925,
         "timestamp":"08-12-2023"
      }
   ]
}

Sample Response Description

Chain: Specifies the blockchain or network on which the data pertains.

Protocol: Indicates the financial protocol or smart contract system associated with the data.

Version: Represents the version number of the protocol or smart contract being referred to.

Base Asset Symbol: Denotes the symbol of the primary asset in the protocol, often representing the native or primary token.

Token Address: Specifies the unique address of the token within the blockchain.

Total Supply Token: Represents the total quantity of tokens supplied within the protocol.

Total Supply USD: Indicates the total value, in USD, of the supplied tokens based on market prices.

Total Borrow Token: Represents the total quantity of tokens borrowed within the protocol.

Total Borrow USD: Indicates the total value, in USD, of the borrowed tokens based on market prices.

Num Unique Wallets Supply: Indicates the number of unique wallets or addresses participating in the token supply within the protocol.

Num Unique Wallets Borrow: Indicates the number of unique wallets or addresses participating in token borrowing within the protocol.

Timestamp: Represents the date and time at which the data snapshot was taken.

---

Retrieves the lending market analytics data for corresponding protocol.

This endpoint returns the data of a given lending market, e.g. AAVE V3. It includes total supply, borrow, number of wallets actively using, etc.

get

/data/liquidity/lending/protocol-analytics/{chain}//{protocol}//{version}//{baseAsset}

Authorizations

Path parameters

chainstringrequired

the name of the chain that lending market is hosted, e.g. ethereum

protocolstringrequired

the name of the protocol, e.g. compound

versionstringrequired

the version of the protocol, e.g. V3

baseAssetstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.alterscope.org/data/liquidity/lending/protocol-analytics/{chain}/{protocol}/{version}/{baseAsset}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

406

500

200

{
  "chain": "ethereum",
  "protocol": "compound",
  "version": "V3",
  "base_asset_symbol": "ETH",
  "total_supply_base": 6533.728544236163,
  "total_supply_usd": 14221622.02159755,
  "total_borrow_base": 5373.2928373334325,
  "total_borrow_usd": 11695780.737790361,
  "num_unique_wallets": 182,
  "timestamp": "12-12-2023"
}

OK

Sample Request

Note: The sample request below shows lending market analytics data for the ethereum chain and aave V3 protocol with USDCbase asset.

curl https://api.alterscope.org/data/liquidity/lending/protocol-analytics/ethereum/aave/V3/USDC -H "Authorization: Bearer <your_access_token>"

For a supported list of chains, protocol version and base asset whose protocol analytics data can be requested please refer to sample response for retrieving the available lending markets for all supported protocols API endpoint.

Sample Response

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "total_supply_base":2878820982.8682137,
         "total_supply_usd":2878659940.4149656,
         "total_borrow_base":906520874.6053952,
         "total_borrow_usd":906472191.0667465,
         "num_unique_wallets":7122,
         "timestamp":"14-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "total_supply_base":2838951175.0063663,
         "total_supply_usd":2838509448.414361,
         "total_borrow_base":901035188.2139912,
         "total_borrow_usd":900893914.5519366,
         "num_unique_wallets":7087,
         "timestamp":"13-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "total_supply_base":2782644266.685767,
         "total_supply_usd":2783495657.950993,
         "total_borrow_base":918892957.9033206,
         "total_borrow_usd":919174568.0360827,
         "num_unique_wallets":7069,
         "timestamp":"12-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "total_supply_base":2813077441.4603868,
         "total_supply_usd":2814014104.632634,
         "total_borrow_base":914052234.0271267,
         "total_borrow_usd":914373446.6518799,
         "num_unique_wallets":7029,
         "timestamp":"11-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "total_supply_base":2842456406.332089,
         "total_supply_usd":2842502916.9715533,
         "total_borrow_base":902767060.7422364,
         "total_borrow_usd":902787363.2231638,
         "num_unique_wallets":6976,
         "timestamp":"10-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "total_supply_base":2900330065.118432,
         "total_supply_usd":2899980947.9287543,
         "total_borrow_base":896729710.6875285,
         "total_borrow_usd":896615746.3415108,
         "num_unique_wallets":6950,
         "timestamp":"09-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "total_supply_base":2873284126.4426575,
         "total_supply_usd":2872696264.3808937,
         "total_borrow_base":864636042.0447346,
         "total_borrow_usd":864445991.7177348,
         "num_unique_wallets":6912,
         "timestamp":"08-12-2023"
      }
   ]
}
    

Sample Response Description

Chain: This field represents the blockchain or network on which the data pertains.

Protocol: Refers to the specific protocol or set of rules governing the interactions on the mentioned blockchain.

Version: Indicates the version of the mentioned protocol. It is expected to be a string that specifies the version number.

Base Asset Symbol: Represents the base asset symbol within the blockchain.

Total Supply Base: Denotes the total base asset supply in the blockchain.

Total Supply USD: Represents the total supply of the base asset converted to US dollars.

Total Borrow Base: Indicates the total amount borrowed in terms of the base asset on the blockchain.

Total Borrow USD: Represents the total amount borrowed converted to US dollars.

Num Unique Wallets: Denotes the number of unique wallets addresses interacting with the blockchain.

Timestamp: Represents the time at which the data was recorded.

---

Retrieves all available market data for corresponding protocol in last 7 days.

This endpoint returns the data of a given lending market across all chains, versions, and base assets we support. It includes total supply, borrow, number of wallets supplying or borrowing, etc for last 7 days.

get

/data/liquidity/lending/market-overview/{protocol}

Authorizations

Path parameters

protocolstringrequired

the name of the protocol, e.g. aave

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.alterscope.org/data/liquidity/lending/market-overview/{protocol}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

406

500

200

{
  "chain": "ethereum",
  "protocol": "compound",
  "version": "V3",
  "base_asset_symbol": "ETH",
  "total_supply_base": 6533.728544236163,
  "total_supply_usd": 14221622.02159755,
  "total_borrow_base": 5373.2928373334325,
  "total_borrow_usd": 11695780.737790361,
  "num_unique_wallets": 182,
  "timestamp": "12-12-2023"
}

OK

Sample Request

Note: The sample request below shows available market data for the compoundprotocol.

curl https://api.alterscope.org/data/liquidity/lending/market-overview/compound -H "Authorization: Bearer <your_access_token>"

For a supported list of protocols whose liqudity data can be requested please refer to sample response for retrieving the available lending markets for all supported protocols API endpoint.

Sample Response

Note: The sample response below is shortened for formatting purposes the actual response should display data for past 7 days.

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"compound",
         "version":"V3",
         "base_asset_symbol":"ETH",
         "total_supply_base":6538.422684003617,
         "total_supply_usd":14984484.292815153,
         "total_borrow_base":5373.258868556242,
         "total_borrow_usd":12314197.342828833,
         "num_unique_wallets":182,
         "timestamp":"14-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"compound",
         "version":"V3",
         "base_asset_symbol":"ETH",
         "total_supply_base":6543.912038080257,
         "total_supply_usd":14723167.867672145,
         "total_borrow_base":5373.222940553029,
         "total_borrow_usd":12086901.904030131,
         "num_unique_wallets":182,
         "timestamp":"13-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"compound",
         "version":"V3",
         "base_asset_symbol":"ETH",
         "total_supply_base":6533.728544236163,
         "total_supply_usd":14221622.02159755,
         "total_borrow_base":5373.2928373334325,
         "total_borrow_usd":11695780.737790361,
         "num_unique_wallets":182,
         "timestamp":"12-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"compound",
         "version":"V3",
         "base_asset_symbol":"ETH",
         "total_supply_base":6509.581764413908,
         "total_supply_usd":14591755.308133202,
         "total_borrow_base":5373.31728356628,
         "total_borrow_usd":12051619.333045226,
         "num_unique_wallets":182,
         "timestamp":"11-12-2023"
      }
      {
         "chain":"ethereum",
         "protocol":"compound",
         "version":"V3",
         "base_asset_symbol":"ETH",
         "total_supply_base":6489.574905092473,
         "total_supply_usd":14523425.912140682,
         "total_borrow_base":5373.108240164578,
         "total_borrow_usd":12025060.11440216,
         "num_unique_wallets":182,
         "timestamp":"10-12-2023"
      },
}

Sample Response Description

• Chain: This field represents the blockchain network or protocol.

• Protocol: Refers to the specific protocol on the mentioned blockchain.

• Version: Indicates the version of the mentioned protocol.

• Base Asset Symbol: Represents the symbol for the base asset

• Total Supply Base: Denotes the total supply of the base asset in the blockchain.

• Total Supply USD: Represents the total supply of the base asset converted to US dollars.

• Total Borrow Base: Indicates the total amount borrowed in terms of the base asset on the blockchain.

• Total Borrow USD: Represents the total amount borrowed converted to US dollars.

• Num Unique Wallets: Denotes the number of unique wallets interacting with the blockchain.

• Timestamp: Represents the time at which the data was recorded.

Scores

Retrieves the Liquidity Health Score for corresponding protocol.

This endpoint returns key metrics and the Liquidity Health Score for the specified protocol from the last 7 days (Note: Supports "ethereum" as chain and "aave" and "compound" as protocols so far. please use version as "v3" for both protocols Base asset for AAVE is USDC. Base asset options for Compound V3 are USDC and ETH.).

get

/scores/liquidity/lending/protocol-score/{chain}//{protocol}//{version}//{baseAsset}

Authorizations

Path parameters

chainstringrequired

the name of the chain, e.g. ethereum

protocolstringrequired

the name of the protocol, e.g. aave

versionstringrequired

the version of the protocol, e.g. V3

baseAssetstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.alterscope.org/scores/liquidity/lending/protocol-score/{chain}/{protocol}/{version}/{baseAsset}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

406

500

200

{
  "chain": "ethereum",
  "protocol": "compound",
  "version": "V3",
  "base_asset_symbol": "USDC",
  "health_factor": 1.3626472202750812,
  "health_score": 0.7196295386891731,
  "timestamp": "14-10-2023"
}

OK

Sample Request

Note: The sample request below shows available liquidity health score data for for the ethereum chain and aave V3 protocol with USDCbase asset.

curl https://api.alterscope.org/scores/liquidity/lending/protocol-score/ethereum/aave/v3/usdc -H "Authorization: Bearer <your_access_token>"

For a supported list of chains, protocol version and base asset whose liqudity lending data can be requested please refer to sample response for retrieving the available lending markets for all supported protocols API endpoint.

Sample Response

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":1.9989934085499454,
         "health_score":0.969893922765294,
         "timestamp":"20-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":1.995340081249512,
         "health_score":0.9695057647803356,
         "timestamp":"19-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":2.0078564688631757,
         "health_score":0.9708151943694336,
         "timestamp":"18-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":1.9259702161806895,
         "health_score":0.9611080571399585,
         "timestamp":"17-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":1.9186552098352436,
         "health_score":0.9600975550875323,
         "timestamp":"16-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":1.9227334104533926,
         "health_score":0.9606641171689398,
         "timestamp":"15-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":1.9534534875010936,
         "health_score":0.9646811992023516,
         "timestamp":"14-12-2023"
      }
   ]
}

Sample Response Description

1. Chain: Ethereum - This indicates that the data is related to the Ethereum blockchain.

2. Protocol: Aave - Name of a decentralized finance protocol that allows users to lend and borrow a variety of cryptocurrencies.

3. Version: V3 - This could refer to the third version or iteration of the decentralized finance protocol.

4. Base Asset Symbol: USDC - USDC stands for USD Coin, which is a stablecoin connected to the US dollar.

5. Health Factor: The health factor is a measure of the health or safety of a user's position in a lending protocol. A health factor above 1 generally indicates a safe position.

6. Health Score: The health score is another metric indicating the health of a corresponding protocol.

7. Timestamp: This indicates the date and time of the data.

Retrieves the Liquidity Health Score for corresponding protocol.

This endpoint returns key metrics and the Liquidity Health Score for the specified protocol from the last 7 days for all chains and versions we support. (Note: Supports "aave" and "compound".).

get

/scores/liquidity/lending/market-overview/{protocol}

Authorizations

Path parameters

protocolstringrequired

the name of the protocol, e.g. aave

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.alterscope.org/scores/liquidity/lending/market-overview/{protocol}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

406

500

200

{
  "chain": "ethereum",
  "protocol": "compound",
  "version": "V3",
  "base_asset_symbol": "USDC",
  "health_factor": 1.3626472202750812,
  "health_score": 0.7196295386891731,
  "timestamp": "14-10-2023"
}

OK

Sample Request

Note: The sample request below shows liquidity health score data for the aave protocol.

curl https://api.alterscope.org/scores/liquidity/lending/market-overview/aave -H "Authorization: Bearer <your_access_token>"

For a comprehensive list of lending protocols whose data can be requested please refer to sample response for retrieving the available lending markets for all supported protocols API endpoint.

Sample Response

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":1.9989934085499454,
         "health_score":0.969893922765294,
         "timestamp":"20-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":1.995340081249512,
         "health_score":0.9695057647803356,
         "timestamp":"19-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":2.0078564688631757,
         "health_score":0.9708151943694336,
         "timestamp":"18-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":1.9259702161806895,
         "health_score":0.9611080571399585,
         "timestamp":"17-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":1.9186552098352436,
         "health_score":0.9600975550875323,
         "timestamp":"16-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":1.9227334104533926,
         "health_score":0.9606641171689398,
         "timestamp":"15-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":1.9534534875010936,
         "health_score":0.9646811992023516,
         "timestamp":"14-12-2023"
      }
   ]
}

Sample Response Description

1. Chain: Ethereum - This indicates that the data is related to the Ethereum blockchain.

2. Protocol: Name of a decentralized finance protocol that allows users to lend and borrow a variety of cryptocurrencies.

3. Version: V3 - This could refer to the third version of the decentralized finance protocol.

4. Base Asset Symbol: A base asset symbol typically refers to the symbol associated with a base asset within a trading pair on a decentralized exchange (DEX).

5. Health Factor: The health factor is a measure of the health of a user's position in a lending protocol.

6. Health Score: The health score is a metric indicating health of a corresponding protocol.

7. Timestamp: This indicates the date and time of the data.

Retrieves the Liquidity Health Score for all lending markets in our system.

This endpoint returns key metrics and the Liquidity Health Score for all protocols from the last 7 days (Note: Only supported protocols are AAVE and Compound).

get

/scores/liquidity/lending/all-markets

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.alterscope.org/scores/liquidity/lending/all-markets' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

500

200

{
  "chain": "ethereum",
  "protocol": "compound",
  "version": "V3",
  "base_asset_symbol": "USDC",
  "health_factor": 1.3626472202750812,
  "health_score": 0.7196295386891731,
  "timestamp": "14-10-2023"
}

OK

Sample Request

curl https://api.alterscope.org/scores/liquidity/lending/all-markets -H "Authorization: Bearer <your_access_token>"

Sample Response

The sample response below contains liquidity health score data for all markets for a single day. The actual response will contain liquidity health score data for past 7 days.

{   
"status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"3.0.0",
         "base_asset_symbol":"fFRAX(AAVE)-20",
         "health_factor":2.056872282880017,
         "health_score":0.9754239736538908,
         "timestamp":"13-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"1.0.0",
         "base_asset_symbol":"FraxlendV1 - FXS/FRAX",
         "health_factor":1.9592329979723293,
         "health_score":0.9653897723718741,
         "timestamp":"13-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"3.0.0",
         "base_asset_symbol":"fFRAX(sfrxETH)-16",
         "health_factor":0,
         "health_score":1,
         "timestamp":"13-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"1.0.0",
         "base_asset_symbol":"FraxlendV1 - CRV/FRAX",
         "health_factor":3.0273035205957655,
         "health_score":0.9991821709024659,
         "timestamp":"13-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"2.0.0",
         "base_asset_symbol":"fFRAX(sfrxETH)-9",
         "health_factor":0,
         "health_score":1,
         "timestamp":"13-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"compound",
         "version":"V3",
         "base_asset_symbol":"USDC",
         "health_factor":2.5051128729330827,
         "health_score":0.9948961770955288,
         "timestamp":"13-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"1.0.0",
         "base_asset_symbol":"FraxlendV1 - WETH/FRAX",
         "health_factor":3.3096703416721436,
         "health_score":0.9996961549762363,
         "timestamp":"13-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"2.0.0",
         "base_asset_symbol":"fFRAX(FPI)-10",
         "health_factor":10.498936738135564,
         "health_score":0.9999999999999966,
         "timestamp":"13-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"1.0.0",
         "base_asset_symbol":"FraxlendV1 - CRV/FRAX",
         "health_factor":0,
         "health_score":1,
         "timestamp":"13-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"radiantcapital",
         "version":"V2",
         "base_asset_symbol":"USDC",
         "health_factor":1.5301976798685928,
         "health_score":0.8441979303294648,
         "timestamp":"13-03-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"3.0.0",
         "base_asset_symbol":"fFRAX(crvFRAX)-22",
         "health_factor":1.0541930804673707,
         "health_score":0.1730666455211115,
         "timestamp":"13-03-2024"
      },

Sample Response Description

1. Chain: This indicates that data is related to the Ethereum blockchain.

2. Protocol: Name of a decentralized finance protocol.

3. Version: V3 - This could refer to the third version of the decentralized finance protocol.

4. Base Asset Symbol: A base asset symbol typically refers to the symbol associated with a base asset within a trading pair on a decentralized exchange (DEX) platform.

5. Health Factor: The health factor is a measure of the user's position in a lending protocol.

6. Health Score: The health score is another metric indicating the health of all lending markets.

7. Timestamp: This indicates the date and time of the data.