Decentralized Exchange Protocols

The DEX endpoints can be used to retrieve the data analytics and score analysis of various decentralized exchange pools and protocols.

Retrieves the available decentralized exchanges for all supported protocols.

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

GEThttps://api.alterscope.org/data/liquidity/dex/available-dexes

Response

200404406500

OK

Body

application/json

chainstring

protocolstring

versionstring

exchange_namestring

number_of_poolsnumber

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/data/liquidity/dex/available-dexes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "chain": "text",
  "protocol": "text",
  "version": "text",
  "exchange_name": "text",
  "number_of_pools": 0
}

Sample Request

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

Sample Response

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "exchange_name":"Curve.fi",
         "number_of_pools":69
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "exchange_name":"Uniswap",
         "number_of_pools":2663
      },
      {
         "chain":"ethereum",
         "protocol":"swaap",
         "version":"V2",
         "exchange_name":"Swaap",
         "number_of_pools":2
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"V2",
         "exchange_name":"Fraxswap",
         "number_of_pools":22
      },
      {
         "chain":"ethereum",
         "protocol":"balancer",
         "version":"V2",
         "exchange_name":"Balancer",
         "number_of_pools":100
      },
      {
         "chain":"ethereum",
         "protocol":"pancakeswap",
         "version":"V3",
         "exchange_name":"Pancakeswap",
         "number_of_pools":152
      },
      {
         "chain":"arbitrum",
         "protocol":"gmx",
         "version":"V2",
         "exchange_name":"GMX",
         "number_of_pools":11
      }
   ]
}

Sample Response Description

Chain: Indicates that the protocol operates on the Ethereum blockchain.

Protocol: Refers to the specific protocol being used, in this case, "Curve." which is a decentralized exchange protocol designed for stablecoin trading.

Version: Specifies the version of the protocol.

Exchange Name: Indicates the name of the decentralized exchange.

Number of Pools: Indicates the total number of liquidity pools available within the decentralized exchange.

Retrieves the available list of pools for a protocol.

This endpoint returns the list of available pools for a protocol. It helps you to fetch by pages using batch size and skipping batches. You can get the available number of pools using /available-dexes.

GEThttps://api.alterscope.org/data/liquidity/dex/available-pools/{chain}/{protocol}/{version}/{batchSize}/{skipBatch}

Path parameters

chain*string

the name of the chain

protocol*string

the name of the protocol

version*string

the version of the protocol

batchSize*string

the number of pools you want to get in this request

skipBatch*string

the number of batches to skip for pagination

Response

200404406500

OK

Body

application/json

chainstring

protocolstring

versionstring

pool_addressstring

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/data/liquidity/dex/available-pools/{chain}/{protocol}/{version}/{batchSize}/{skipBatch}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "chain": "text",
  "protocol": "text",
  "version": "text",
  "pool_address": "text"
}

Sample Request

The request below will return the total of 3 pools from which pools at page 2 will be skipped:

curl https://api.alterscope.org/data/liquidity/dex/available-pools/ethereum/curve/V3/3/2 -H "Authorization: Bearer <your_access_token>"

For a supported list of decentralised exchange chains and protocol versions please refer to sample response for retrieving the available decentralized exchange for all protocols API endpoint.

Sample Response

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "pool_address":"0x4f062658eaaf2c1ccf8c8e36d6824cdf41167956"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "pool_address":"0x42d7025938bec20b69cbae5a77421082407f053a"
      }
   ]

Sample Response Description

1. Status: Indicates the current status of the information being queried. In this case, it is set to "true," suggesting that the information is valid or active.

2. Data: This section contains an array of objects, with each object representing details about a specific instance of the Ethereum-based Curve protocol.

   a. Chain: Specifies the blockchain network, and in this case, it is set to "ethereum," indicating that the Curve protocol is implemented on the Ethereum blockchain.

   b. Protocol: Identifies the specific protocol being referred to, and here it is "curve," c. Version: Indicates the version of the protocol, and in this instance, it is "V3" .

   d. Pool Address: Provides the Ethereum address associated with the pool related to this specific instance of the Curve protocol.

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/dex/pool-analytics/{poolAddress}

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/dex/pool-analytics/{poolAddress}', {
    method: 'GET',
    headers: {},
});
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

Below is a sample request with0x4f062658eaaf2c1ccf8c8e36d6824cdf41167956 pool address.

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

To get a list of pool address for which data can be retrieved please check retrieve available list of pools for a protocol API endpoint.

Sample Response

The response below is shortened for formatting purposes and provide the details for a particular pool address.The actual response wil provide details for all pool addresses.

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "pool_address":"0x4f062658eaaf2c1ccf8c8e36d6824cdf41167956",
         "token_amounts":[
            {
               "token_index":0,
               "token_amount":518723.68,
               "token_amount_usd":519260.1532943955
            },
            {
               "token_index":1,
               "token_amount":670825.8747287109,
               "token_amount_usd":670859.2140995725
            },
            {
               "token_index":2,
               "token_amount":666719.049342,
               "token_amount_usd":666452.3617222633
            },
            {
               "token_index":3,
               "token_amount":416047.308811,
               "token_amount_usd":416172.1230036433
            }
         ],
         "token_amount_changes":[
            {
               "token_index":0,
               "token_exchange_amount":29604.499999999993,
               "token_exchange_usd":29640.07509009719
            },
            {
               "token_index":1,
               "token_exchange_amount":-39173.173061940266,
               "token_exchange_usd":-39179.774320744335
            },
            {
               "token_index":2,
               "token_exchange_amount":-0.9455979999984265,
               "token_exchange_usd":-12.740826937471866
            },
            {
               "token_index":3,
               "token_exchange_amount":10694.066072,
               "token_exchange_usd":10697.719318217047
            }
         ],
         "token_volumes":[
            {
               "token_index":0,
               "token_exchange_amount":141198.86,
               "token_exchange_usd":141367.05885017425
            },
            {
               "token_index":1,
               "token_exchange_amount":51458.13760116178,
               "token_exchange_usd":51465.78262826082
            },
            {
               "token_index":2,
               "token_exchange_amount":77916.80664,
               "token_exchange_usd":77905.22711062488
            },
            {
               "token_index":3,
               "token_exchange_amount":10694.066072,
               "token_exchange_usd":10697.719318217047
            }
         ],
         "volume_usd":140717.8939536385,
         "fee_usd":56.2871575814554,
         "tvl_usd":2272743.8521198747,
         "num_unique_wallets":5,
         "num_transactions":5,
         "timestamp":"10-01-2024"
      }
   ]
}

Sample Response Description

1. Status: Indicates whether the data retrieval was successful (true) or not (false).

2. 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.

     • For Token Index 0:

       • Token Amount: 518,723.68 units.

       • Token Amount USD: Equivalent value in USD

     • For Token Index 1:

       • Token Amount: 670,825.87 units.

       • Token Amount USD: Equivalent value in USD

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

     • For Token Index 0:

       • Token Exchange Amount: Increase of 29,604.50 units.

       • Token Exchange USD: Equivalent value in USD

     • For Token Index 1:

       • Token Exchange Amount: Decrease of 39,173.17 units.

       • Token Exchange USD: Equivalent value in USD

   • Token Volumes: Information about token exchange volumes.

     • For Token Index 0:

       • Token Exchange Amount: 141,198.86 units.

     • Token Exchange USD: Equivalent value in USD.

   • 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.

   • Num Transactions: The total number of transactions.

   • Timestamp: The date and time of the data.

Retrieves the data analytics for given protocol.

This endpoint returns the data analytics for given protocol. You can get the list of protocols using /available-dexes endpoint.

GEThttps://api.alterscope.org/data/liquidity/dex/protocol-analytics/{chain}/{protocol}/{version}

Path parameters

chain*string

the name of the chain

protocol*string

the name of the protocol

version*string

the version of the protocol

Response

200404406500

OK

Body

application/json

chainstring

protocolstring

versionstring

number_poolsstring

volume_usdnumber

fee_usdnumber

tvl_usdnumber

num_unique_walletsnumber

num_transactionsnumber

timestampstring

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/data/liquidity/dex/protocol-analytics/{chain}/{protocol}/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "chain": "text",
  "protocol": "text",
  "version": "text",
  "number_pools": "text",
  "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 shows data analytics for dex ethereum chain and curve protocol.

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

For a supported list of decentralised exchange chains and protocol versions please refer to sample response for retrieving the available decentralized exchange for all protocols API endpoint.

Sample Response

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "number_pools":134,
         "volume_usd":101815637.69406167,
         "fee_usd":14275.329625502236,
         "tvl_usd":1487691526.5125606,
         "num_unique_wallets":79,
         "num_transactions":611,
         "timestamp":"10-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "number_pools":134,
         "volume_usd":75259388.11619864,
         "fee_usd":12729.977378508884,
         "tvl_usd":1443831039.331556,
         "num_unique_wallets":89,
         "num_transactions":628,
         "timestamp":"09-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "number_pools":134,
         "volume_usd":93074663.78976387,
         "fee_usd":12558.170570493372,
         "tvl_usd":1436969776.8029768,
         "num_unique_wallets":89,
         "num_transactions":620,
         "timestamp":"08-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "number_pools":134,
         "volume_usd":42436635.78817472,
         "fee_usd":7022.872225321558,
         "tvl_usd":1421678889.0068808,
         "num_unique_wallets":51,
         "num_transactions":327,
         "timestamp":"07-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "number_pools":134,
         "volume_usd":458002095.9427567,
         "fee_usd":261488.89993302792,
         "tvl_usd":1432715552.7894251,
         "num_unique_wallets":52,
         "num_transactions":392,
         "timestamp":"06-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "number_pools":134,
         "volume_usd":646954602.5218725,
         "fee_usd":320251.97295946424,
         "tvl_usd":1452101011.0679977,
         "num_unique_wallets":78,
         "num_transactions":581,
         "timestamp":"05-01-2024"
      }
   ]
}

Sample Response Description

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

2. Protocol: Refers to the protocol, which is a decentralized finance (DeFi) protocol typically used for trading on the blockchain.

3. Version: Specifies the version of the protocol being utilized.

4. Number of Pools: Represents the total count of liquidity pools within the Curve protocol at the given timestamp.

5. Volume (USD): Indicates the total trading volume in USD within the specified time period.

6. Fee (USD): Represents the total fees earned in USD by the protocol during the given timeframe.

7. TVL (Total Value Locked) - USD: Denotes the total value of assets (cryptocurrencies or tokens) locked within the protocol, measured in USD.

8. Number of Unique Wallets: Represents the count of distinct wallets addresses that interacted with the protocol.

9. Number of Transactions: Indicates the total count of transactions that occurred within the protocol.

10. Timestamp: Specifies the date and time at which the provided data snapshot was taken.

Retrieves the data analytics in every chain and version supported for given protocol.

This endpoint returns the data analytics in every chain and version supported for given protocol. You can get the list of protocols using /available-dexes endpoint.

GEThttps://api.alterscope.org/data/liquidity/dex/protocol-overview/{protocol}

Path parameters

protocol*string

the name of the protocol

Response

200404406500

OK

Body

application/json

chainstring

protocolstring

versionstring

number_poolsstring

volume_usdnumber

fee_usdnumber

tvl_usdnumber

num_unique_walletsnumber

num_transactionsnumber

timestampstring

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/data/liquidity/dex/protocol-overview/{protocol}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "chain": "text",
  "protocol": "text",
  "version": "text",
  "number_pools": "text",
  "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 shows data analytics for curve protocol.

curl https://api.alterscope.org/data/liquidity/dex/protocol-overview/curve -H "Authorization: Bearer <your_access_token>".

For a supported list of decentralised exchange chains and protocol versions please refer to sample response for retrieving the available decentralized exchange for all protocols API endpoint.

Sample Response

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "number_pools":134,
         "volume_usd":45057465.201750934,
         "fee_usd":6754.376684376131,
         "tvl_usd":1435142290.6535392,
         "num_unique_wallets":64,
         "num_transactions":456,
         "timestamp":"20-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "number_pools":134,
         "volume_usd":199467749.27726495,
         "fee_usd":34069.45533276601,
         "tvl_usd":1438538956.177513,
         "num_unique_wallets":80,
         "num_transactions":665,
         "timestamp":"19-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "number_pools":134,
         "volume_usd":606290120.0112575,
         "fee_usd":314953.74537371466,
         "tvl_usd":1460936973.4823995,
         "num_unique_wallets":56,
         "num_transactions":465,
         "timestamp":"17-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "number_pools":134,
         "volume_usd":89868753.9839625,
         "fee_usd":12308.92627978903,
         "tvl_usd":1446979811.7493067,
         "num_unique_wallets":67,
         "num_transactions":372,
         "timestamp":"16-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "number_pools":134,
         "volume_usd":161160974.7780499,
         "fee_usd":18228.762776722844,
         "tvl_usd":1435149362.7714183,
         "num_unique_wallets":66,
         "num_transactions":430,
         "timestamp":"15-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "number_pools":134,
         "volume_usd":55421157.10479452,
         "fee_usd":7129.290138714996,
         "tvl_usd":1432652284.4134073,
         "num_unique_wallets":63,
         "num_transactions":343,
         "timestamp":"14-01-2024"
      }
   ]
}

Sample Response Description

1. Chain: This indicates that the protocol operates on the Ethereum blockchain, a popular blockchain platform known for smart contracts and decentralized applications (DApps).

2. Protocol: Refers to the specific decentralized finance (DeFi) protocol being discussed.

3. Version: Denotes the version of the Curve Finance protocol being used, in this case, version 3 (V3).

4. Number of Pools: Represents the total number of liquidity pools available within the Curve Finance protocol at the specified timestamp.

5. Volume (USD): Represents the total trading volume in USD across all pools within the Curve Finance protocol during the specified timestamp.

6. Fee (USD): Represents the total fees generated in USD across all pools within the Curve Finance protocol during the specified timestamp.

7. TVL (USD): Stands for Total Value Locked (TVL) and represents the total value of assets locked within the Curve Finance protocol, denominated in USD.

8. Number of Unique Wallets: Indicates the total number of unique wallets or addresses that participated in transactions within the Curve Finance protocol during the specified time period.

9. Number of Transactions: Represents the total number of transactions that occurred within the Curve Finance protocol during the specified time period.

10. Timestamp: Specifies the date and time when the provided data was recorded.

Scores

Retrieves the Volume Continuity Score for corresponding pool.

This endpoint returns key metrics and the Volume Continuity Score for the specified pool from the last 7 days (Note: Only supports pools in Uniswap V3, Curve, Swaap V2, Fraxswap V2, Balancer V2, Pancakeswap V3).

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

Authorization

BearerAuth

Path parameters

poolAddress*string

the address of the 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/dex/pool-score/{poolAddress}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
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 retrieves volume continuity score for a specific pool. To get a list of pool address for which data can be retrieved please check retrieve available list of pools for a protocol API endpoint.

curl https://api.alterscope.org/scores/liquidity/dex/pool-score/<pool_address> -H "Authorization: Bearer <your_access_token>"

Sample Response

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "pool_address":"0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640",
         "mean_volume_usd":39941.92704864373,
         "median_volume_usd":5751.8987987946,
         "volume_continuity_score":0.47549519879257934,
         "timestamp":"11-01-2024"
      }
   ]
}{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "pool_address":"0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640",
         "mean_volume_usd":39941.92704864373,
         "median_volume_usd":5751.8987987946,
         "volume_continuity_score":0.47549519879257934,
         "timestamp":"11-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "pool_address":"0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640",
         "mean_volume_usd":65218.66350777575,
         "median_volume_usd":9284.980469723163,
         "volume_continuity_score":0.4727939893721308,
         "timestamp":"10-01-2024"
      }
 
         "pool_address":"0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640",
         "mean_volume_usd":64029.12049476423,
         "median_volume_usd":5780.267556432212,
         "volume_continuity_score":0.4509446336730747,
         "timestamp":"09-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "pool_address":"0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640",
         "mean_volume_usd":61525.833440983115,
         "median_volume_usd":5266.460554879306,
         "volume_continuity_score":0.44649997366191396,
         "timestamp":"09-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "pool_address":"0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640",
         "mean_volume_usd":59659.464612770724,
         "median_volume_usd":5171.2880985818065,
         "volume_continuity_score":0.4480028467697199,
         "timestamp":"09-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "pool_address":"0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640",
         "mean_volume_usd":58107.24041761238,
         "median_volume_usd":5002.474439280519,
         "volume_continuity_score":0.44769126868695375,
         "timestamp":"09-01-2024"
      }
   ]
}

Sample Response Description

• Chain: Indicates the blockchain network or platform being used.

• Protocol: This field specify the dex protocol used.

• Version: Represents the version number associated with the blockchain or protocol.

• Mean Volume USD: Refers to the average trading transaction volume in US dollars over a certain period.

• Median Volume USD: Indicates the median trading or transaction volume in US dollars.

• Volume Continuity Score: This score could represent a measure of the consistency or regularity of transaction volumes over time.

• Timestamp: Represents the timestamp when the data was recorded.

Retrieves the Volume Continuity Score for corresponding protocol.

This endpoint returns key metrics and the Volume Continuity Score for the specified protocol from the last 7 days (Note: Only supported chain is "ethereum" and protocols are "uniswap v3, curve v3, swaap v2, fraxswap v2, balancer v2, and pancakeswap v3". Please use protocol names and versions as indicated in previous sentence while feeding as arguments for all protocols, e.g. /ethereum/uniswap/v3).

GEThttps://api.alterscope.org/scores/liquidity/dex/protocol-score/{chain}/{protocol}/{version}

Authorization

BearerAuth

Path parameters

chain*string

the name of the chain

protocol*string

the name of the protocol

version*string

the version of the protocol

Response

200404406500

OK

Body

application/json

chainstring

protocolstring

versionstring

mean_volume_usdnumber

median_volume_usdnumber

volume_continuity_scorenumber

timestampstring

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/scores/liquidity/dex/protocol-score/{chain}/{protocol}/{version}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

Sample Request

Note: The sample request below retrieves protocol score for ethereum chain and uniswap protocol.

curl https://api.alterscope.org/scores/liquidity/dex/protocol-score/ethereum/uniswap/V3 -H "Authorization: Bearer <your_access_token>"

For a supported list of decentralised exchange chains and protocol versions please refer to sample response for retrieving the available decentralized exchange for all protocols API endpoint.

Sample Response

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":30057.35683569536,
         "median_volume_usd":2439.114402775852,
         "volume_continuity_score":0.4823413434081393,
         "timestamp":"20-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":21661.180052610656,
         "median_volume_usd":2172.049829696295,
         "volume_continuity_score":0.4868080263267876,
         "timestamp":"19-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":24993.592458027866,
         "median_volume_usd":2578.539249292922,
         "volume_continuity_score":0.48752147729499223,
         "timestamp":"18-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":18606.02010425795,
         "median_volume_usd":1847.5820364396382,
         "volume_continuity_score":0.48707963884582645,
         "timestamp":"17-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":28319.970875951945,
         "median_volume_usd":1880.9502043386037,
         "volume_continuity_score":0.4824967705848901,
         "timestamp":"16-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":20433.871158236456,
         "median_volume_usd":2247.551193415587,
         "volume_continuity_score":0.489671700317849,
         "timestamp":"15-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":19955.648051362416,
         "median_volume_usd":2143.3246847353244,
         "volume_continuity_score":0.4891432579118372,
         "timestamp":"14-12-2023"
      }
   ]
}

Sample Response Description

• Chain: Indicates the blockchain network or platform, and in this case, it is specified as Ethereum. This suggests that the subsequent data is related to the Ethereum blockchain.

• Protocol: This field is intended to specify the dex protocol for which volume continuity score has to be calculated.

• Version: Represents the version number associated with the blockchain or cryptocurrency protocol.

• Mean Volume USD: Refers to the average trading or transaction volume in US dollars over a certain period.

• Median Volume USD: Indicates the median trading or transaction volume in US dollars.

• Volume Continuity Score: This score could represent a measure of the consistency or regularity of transaction volumes over time.

• Timestamp: Represents the timestamp or point in time when the data was recorded or when the specified measurements were taken.

Retrieves the Volume Continuity Score for corresponding protocol across all chains and versions that we support.

This endpoint returns key metrics and the Volume Continuity Score for the specified protocol from the last 7 days (Note: Only supports "uniswap, curve, swaap, fraxswap, balancer, and pancakeswap".).

GEThttps://api.alterscope.org/scores/liquidity/dex/protocol-overview/{protocol}

Authorization

BearerAuth

Path parameters

protocol*string

the name of the protocol

Response

200404406500

OK

Body

application/json

chainstring

protocolstring

versionstring

mean_volume_usdnumber

median_volume_usdnumber

volume_continuity_scorenumber

timestampstring

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/scores/liquidity/dex/protocol-overview/{protocol}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

Sample Request

Note: The sample request below retrieves volume continuity score for uniswap protocol.

curl https://api.alterscope.org/scores/liquidity/dex/protocol-overview/uniswap -H "Authorization: Bearer <your_access_token>"

For a supported list of decentralised exchange chains and protocol versions please refer to sample response for retrieving the available decentralized exchange for all protocols API endpoint.

Sample Response

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":24993.592458027866,
         "median_volume_usd":2578.539249292922,
         "volume_continuity_score":0.48752147729499223,
         "timestamp":"18-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":18606.02010425795,
         "median_volume_usd":1847.5820364396382,
         "volume_continuity_score":0.48707963884582645,
         "timestamp":"17-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":28319.970875951945,
         "median_volume_usd":1880.9502043386037,
         "volume_continuity_score":0.4824967705848901,
         "timestamp":"16-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":20433.871158236456,
         "median_volume_usd":2247.551193415587,
         "volume_continuity_score":0.489671700317849,
         "timestamp":"15-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":19955.648051362416,
         "median_volume_usd":2143.3246847353244,
         "volume_continuity_score":0.4891432579118372,
         "timestamp":"14-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":24734.69607204835,
         "median_volume_usd":2315.9890814078117,
         "volume_continuity_score":0.48695219403226414,
         "timestamp":"13-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":21023.387630533733,
         "median_volume_usd":2178.0373935742728,
         "volume_continuity_score":0.4878724636481174,
         "timestamp":"12-12-2023"
      }
   ]
}

Sample Response Description

• Chain: Indicates the blockchain network or platform and in this case, it is specified as Ethereum.

• Protocol: This field is likely intended to specify the protocol used in the context of the blockchain.

• version: Represents the version number associated with the protocol.

• mean_volume_usd: Refers to the average trading or transaction volume in US dollars over a certain period.

• median_volume_usd: Indicates the median trading or transaction volume in US dollars.

• volume_continuity_score: This score could represent a measure of the consistency or regularity of transaction volumes over time.

• timestamp: Represents the timestamp or point in time when the data was recorded.

Retrieves the Volume Continuity Score for all dex protocols in our system.

This endpoint returns key metrics and the Volume Continuity Score for all protocols from the last 7 days (Note: Only supported protocols are Uniswap and Curve so far).

GEThttps://api.alterscope.org/scores/liquidity/dex/all-protocols

Authorization

BearerAuth

Response

200404500

OK

Body

application/json

chainstring

protocolstring

versionstring

mean_volume_usdnumber

median_volume_usdnumber

volume_continuity_scorenumber

timestampstring

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/scores/liquidity/dex/all-protocols', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

Sample Request

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

Sample Response

The sample response below will display volume continuity score data for all dex protocols in last 7 days.

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"pancakeswap",
         "version":"V3",
         "mean_volume_usd":29589.14927246872,
         "median_volume_usd":6368.1783921135575,
         "volume_continuity_score":0.4659007013842846,
         "timestamp":"18-12-2023"
      },
      {
         "chain":"arbitrum",
         "protocol":"gmx",
         "version":"V2",
         "mean_volume_usd":6681.483814945259,
         "median_volume_usd":793.7822523097593,
         "volume_continuity_score":0.3055157947974464,
         "timestamp":"18-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":24993.592458027866,
         "median_volume_usd":2578.539249292922,
         "volume_continuity_score":0.48752147729499223,
         "timestamp":"18-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"swaap",
         "version":"V2",
         "mean_volume_usd":4482.255662164273,
         "median_volume_usd":4482.255662164273,
         "volume_continuity_score":0.7310585786300049,
         "timestamp":"18-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"V2",
         "mean_volume_usd":27486.726988694325,
         "median_volume_usd":24254.204259372476,
         "volume_continuity_score":0.5293918625053363,
         "timestamp":"18-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"balancer",
         "version":"V2",
         "mean_volume_usd":85850.7614282503,
         "median_volume_usd":4136.407823868942,
         "volume_continuity_score":0.0001308545790956831,
         "timestamp":"18-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "mean_volume_usd":313267.24748210487,
         "median_volume_usd":24593.33388618997,
         "volume_continuity_score":0.20139140135869218,
         "timestamp":"18-12-2023"
      },
      {
         "chain":"arbitrum",
         "protocol":"gmx",
         "version":"V2",
         "mean_volume_usd":4328.41116904584,
         "median_volume_usd":201.58422363585333,
         "volume_continuity_score":0.05793788269195299,
         "timestamp":"17-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"V2",
         "mean_volume_usd":17911.737782378004,
         "median_volume_usd":19948.500933084906,
         "volume_continuity_score":0.5294863104811488,
         "timestamp":"17-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"balancer",
         "version":"V2",
         "mean_volume_usd":37385.65147008538,
         "median_volume_usd":3480.2560048307223,
         "volume_continuity_score":0.008216865345538392,
         "timestamp":"17-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "mean_volume_usd":166992.16279540127,
         "median_volume_usd":20355.412414207007,
         "volume_continuity_score":0.2931618325576049,
         "timestamp":"17-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"pancakeswap",
         "version":"V3",
         "mean_volume_usd":20512.34336295109,
         "median_volume_usd":5009.574099113711,
         "volume_continuity_score":0.476398258173493,
         "timestamp":"17-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":18606.02010425795,
         "median_volume_usd":1847.5820364396382,
         "volume_continuity_score":0.48707963884582645,
         "timestamp":"17-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"pancakeswap",
         "version":"V3",
         "mean_volume_usd":21985.19854772773,
         "median_volume_usd":3800.7382050793685,
         "volume_continuity_score":0.44142837555675746,
         "timestamp":"16-12-2023"
      },
      {
         "chain":"arbitrum",
         "protocol":"gmx",
         "version":"V2",
         "mean_volume_usd":6059.4520742304085,
         "median_volume_usd":356.2810022115123,
         "volume_continuity_score":0.06051225818712912,
         "timestamp":"16-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"swaap",
         "version":"V2",
         "mean_volume_usd":187.55557027786864,
         "median_volume_usd":187.55557027786864,
         "volume_continuity_score":0.7310585786300049,
         "timestamp":"16-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"V2",
         "mean_volume_usd":21020.86713300575,
         "median_volume_usd":22215.49048834546,
         "volume_continuity_score":0.5369072873707963,
         "timestamp":"16-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"balancer",
         "version":"V2",
         "mean_volume_usd":22768.29295825683,
         "median_volume_usd":4496.2723497748,
         "volume_continuity_score":0.20624813274964288,
         "timestamp":"16-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "mean_volume_usd":1601035.7569652111,
         "median_volume_usd":25943.234676601907,
         "volume_continuity_score":0.000028679777510687358,
         "timestamp":"16-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":28319.970875951945,
         "median_volume_usd":1880.9502043386037,
         "volume_continuity_score":0.4824967705848901,
         "timestamp":"16-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"V2",
         "mean_volume_usd":25319.766521318998,
         "median_volume_usd":22171.5247545379,
         "volume_continuity_score":0.5356894178873546,
         "timestamp":"15-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"balancer",
         "version":"V2",
         "mean_volume_usd":16415.073721387234,
         "median_volume_usd":3715.931908593845,
         "volume_continuity_score":0.272400874756338,
         "timestamp":"15-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "mean_volume_usd":246458.1252632962,
         "median_volume_usd":20253.26336000146,
         "volume_continuity_score":0.1736256578914597,
         "timestamp":"15-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"pancakeswap",
         "version":"V3",
         "mean_volume_usd":17929.618575126187,
         "median_volume_usd":4958.202837016856,
         "volume_continuity_score":0.48192320399916966,
         "timestamp":"15-12-2023"
      },
      {
         "chain":"arbitrum",
         "protocol":"gmx",
         "version":"V2",
         "mean_volume_usd":8294.102454945452,
         "median_volume_usd":242.56038098041643,
         "volume_continuity_score":0.002539262604231573,
         "timestamp":"15-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":20433.871158236456,
         "median_volume_usd":2247.551193415587,
         "volume_continuity_score":0.489671700317849,
         "timestamp":"15-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"V2",
         "mean_volume_usd":22152.6047379183,
         "median_volume_usd":21894.621846931048,
         "volume_continuity_score":0.5369904325239573,
         "timestamp":"14-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"balancer",
         "version":"V2",
         "mean_volume_usd":17099.655196670687,
         "median_volume_usd":3717.480720364058,
         "volume_continuity_score":0.1905802188744348,
         "timestamp":"14-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"pancakeswap",
         "version":"V3",
         "mean_volume_usd":19178.41283137255,
         "median_volume_usd":7651.82885752177,
         "volume_continuity_score":0.4947253740359122,
         "timestamp":"14-12-2023"
      },
      {
         "chain":"arbitrum",
         "protocol":"gmx",
         "version":"V2",
         "mean_volume_usd":2041.5949848629216,
         "median_volume_usd":1.14807e-15,
         "volume_continuity_score":0,
         "timestamp":"14-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":19955.648051362416,
         "median_volume_usd":2143.3246847353244,
         "volume_continuity_score":0.4891432579118372,
         "timestamp":"14-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"swaap",
         "version":"V2",
         "mean_volume_usd":2302.81660266711,
         "median_volume_usd":2302.81660266711,
         "volume_continuity_score":0.7310585786300049,
         "timestamp":"14-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "mean_volume_usd":429121.2763210712,
         "median_volume_usd":14364.008934764559,
         "volume_continuity_score":0.0032950272711777706,
         "timestamp":"14-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"balancer",
         "version":"V2",
         "mean_volume_usd":108649.6245978276,
         "median_volume_usd":4813.829388811851,
         "volume_continuity_score":0.00011039822867207698,
         "timestamp":"13-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "mean_volume_usd":377857.96672422555,
         "median_volume_usd":41459.441435580025,
         "volume_continuity_score":0.2895916463048446,
         "timestamp":"13-12-2023"
      },
      {
         "chain":"arbitrum",
         "protocol":"gmx",
         "version":"V2",
         "mean_volume_usd":1664.8285733519542,
         "median_volume_usd":1.0884500000000002e-15,
         "volume_continuity_score":0,
         "timestamp":"13-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":24734.69607204835,
         "median_volume_usd":2315.9890814078117,
         "volume_continuity_score":0.48695219403226414,
         "timestamp":"13-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"swaap",
         "version":"V2",
         "mean_volume_usd":10523.775191594515,
         "median_volume_usd":10523.775191594515,
         "volume_continuity_score":0.7310585786300049,
         "timestamp":"13-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"V2",
         "mean_volume_usd":21481.57333423195,
         "median_volume_usd":23140.393402433852,
         "volume_continuity_score":0.523484572280371,
         "timestamp":"13-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"pancakeswap",
         "version":"V3",
         "mean_volume_usd":30684.72716688016,
         "median_volume_usd":8835.773758276891,
         "volume_continuity_score":0.4806109810280416,
         "timestamp":"13-12-2023"
      },
      {
         "chain":"arbitrum",
         "protocol":"gmx",
         "version":"V2",
         "mean_volume_usd":9378.398536093162,
         "median_volume_usd":395.36637908397455,
         "volume_continuity_score":0.06449611683911174,
         "timestamp":"12-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"uniswap",
         "version":"V3",
         "mean_volume_usd":21023.387630533733,
         "median_volume_usd":2178.0373935742728,
         "volume_continuity_score":0.4878724636481174,
         "timestamp":"12-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"swaap",
         "version":"V2",
         "mean_volume_usd":10730.053261165887,
         "median_volume_usd":1113.82115823055,
         "volume_continuity_score":0.012591904571556938,
         "timestamp":"12-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"fraxfinance",
         "version":"V2",
         "mean_volume_usd":22060.01871097381,
         "median_volume_usd":23988.302539731703,
         "volume_continuity_score":0.5271771107966989,
         "timestamp":"12-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"balancer",
         "version":"V2",
         "mean_volume_usd":32030.388967848772,
         "median_volume_usd":2999.109434195716,
         "volume_continuity_score":0.028193510807060274,
         "timestamp":"12-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"curve",
         "version":"V3",
         "mean_volume_usd":301607.93537603883,
         "median_volume_usd":35099.820452417676,
         "volume_continuity_score":0.28502787730945933,
         "timestamp":"12-12-2023"
      },
      {
         "chain":"ethereum",
         "protocol":"pancakeswap",
         "version":"V3",
         "mean_volume_usd":20102.78728770403,
         "median_volume_usd":6930.449322673427,
         "volume_continuity_score":0.49069686886270975,
         "timestamp":"12-12-2023"
      }
   ]
}      

Sample Response Description

• chain: Indicates the blockchain network or platform, and in this case, it is specified as Ethereum.

• protocol: This field is likely intended to specify the protocol used in the context of the blockchain or cryptocurrency.

• version: Represents the version number associated with the blockchain or cryptocurrency protocol.

• mean_volume_usd: Refers to the average trading or transaction volume in US dollars over a certain period.

• median_volume_usd: Indicates the median trading or transaction volume in US dollars.

• volume_continuity_score: This score could represent a measure of the consistency or regularity of transaction volumes over time.

• timestamp: Represents the timestamp or point in time when the data was recorded.