🎯Information and Utilities API Usage Guide

Network Information

• Blockchain Network: Ethereum Mainnet

• DEX Information: All DEX information is derived from Uniswap V3 pools.

Xtreamly API Documentation

Overview

This document outlines the APIs available under two categories:

1. Information from Uniswap V3 Pools

2. different types of slippage

Please ensure you have the necessary permissions and credentials to access these APIs.

---

Information from Uniswap V3 Pools

Uniswap V3 Volatility Report for All Pools

• Endpoint: GET /api/v1/Volatility/GetVolatilityForAllPools

• Description: Retrieves the standard deviation of price, variance, and average true range for each supported pool address.

• Parameters:

  • start (required): Start time of the report period, in epoch seconds UTC.

  • end (required): End time of the report period, in epoch seconds UTC.

• Example Request:

  curl -X 'GET' \
    'https://test.xtreamly.io:5000/api/v1/Volatility/GetVolatilityForAllPools?start=1712927510&end=1713026510' \
    -H 'accept: */*'

Uniswap V3 Volatility Report for a Specific Pool

• Endpoint: GET /api/v1/Volatility/GetVolatilityForPool

• Description: Retrieves the volatility data (standard deviation, variance, average true range) for a specified pool address.

• Parameters:

  • start (required): Start time of the report period, in epoch seconds UTC.

  • end (required): End time of the report period, in epoch seconds UTC.

  • poolAddress (required): Ethereum address of the Uniswap V3 pool.

• Example Request:

  curl -X 'GET' \
    'https://test.xtreamly.io:5000/api/v1/Volatility/GetVolatilityForPool?start=1712927510&end=1713026510&poolAddress=0x11b815efb8f581194ae79006d24e0d814b7697f6' \
    -H 'accept: */*'

(Description and endpoints for Web3 Utilities will be added once available.)

Uniswap Pool Trade Volume for All Tokens

• Endpoint: GET /api/v1/Volume/GetVolumeForAllTokens

• Description: Returns the volume of all trades and swaps monitored by Xtreamly in a given time period.

• Parameters:

  • start (required): Start timestamp of the period in epoch seconds UTC.

  • end (required): End timestamp of the period in epoch seconds UTC.

• Example Request:

  curl -X 'GET' \
    'https://test.xtreamly.io:5000/api/v1/Volume/GetVolumeForAllTokens?start=1712927510&end=1713026510' \
    -H 'accept: */*'

Uniswap Pool Trade Volume for a Specific Token

• Endpoint: GET /api/v1/Volume/GetVolumeForToken

• Description: Returns trade volume data for a specific token contract address within a given time period.

• Parameters:

  • tokenAddress (required): Ethereum token contract address.

  • start (required): Start timestamp of the period in epoch seconds UTC.

  • end (required): End timestamp of the period in epoch seconds UTC.

• Example Request:

  curl -X 'GET' \
    'https://test.xtreamly.io:5000/api/v1/Volume/GetVolumeForToken?tokenAddress=0x6b175474e89094c44da98b954eedeac495271d0f&start=1712927510&end=1713026510' \
    -H 'accept: */*'

Get Supported Pools

• Endpoint: GET /api/v1/Info/GetSupportedPools

• Description: Returns the list of supported pools for the current version of Xtreamly.

• Example Request:

  curl -X 'GET' \
    'https://test.xtreamly.io:5000/api/v1/Info/GetSupportedPools' \
    -H 'accept: */*'

Impermanent Loss for All Supported Uniswap V3 Pools

• Endpoint: GET /api/v1/ImpermanentLoss/GetForAllPools

• Description: Returns information about minted, collected, and burnt positions on all pools in USD and calculates impermanent loss for each pool for a given time period.

• Parameters:

  • startTime (required): Start time of the period in epoch milliseconds UTC.

  • endTime (required): End time of the period in epoch milliseconds UTC.

• Example Request:

  curl -X 'GET' \
    'https://test.xtreamly.io:5000/api/v1/ImpermanentLoss/GetForAllPools?startTime=1712927510000&endTime=1713026510000' \
    -H 'accept: */*'

Impermanent Loss for a Specific Supported Pool in Uniswap V3

• Endpoint: GET /api/v1/ImpermanentLoss/GetForPool

• Description: Returns information about minted, collected, and burnt positions as well as impermanent loss for a specific pool for a given time period.

• Parameters:

  • startTime (required): Start time of the period in epoch milliseconds UTC.

  • endTime (required): End time of the period in epoch milliseconds UTC.

  • pool (required): Ethereum address of the Uniswap V3 pool.

• Example Request:

  curl -X 'GET' \
    'https://test.xtreamly.io:5000/api/v1/ImpermanentLoss/GetForPool?startTime=1712927510000&endTime=1713026510000&pool=0x4e68Ccd3E89f51C3074ca5072bbAC773960dFa36' \
    -H 'accept: */*'

Block Information

• Endpoint: GET /api/v1/Utilities/BlockInfo

• Description: Returns information of a specified block.

• Parameters:

  • blockNumber (required): The number of the block for which information is requested.

• Example Request:

  curl -X 'GET' \
    'https://test.xtreamly.io:5000/api/v1/Utilities/BlockInfo?blockNumber=25' \
    -H 'accept: */*'

Block-to-TimeBlock to Time Conversion

• Endpoint: GET /api/v1/Utilities/BlockToTime

• Description: Returns the timestamp of a specified block.

• Parameters:

  • blockNumber (required): The block number to convert to a timestamp.

• Example Request:

  curl -X 'GET' \
    'https://test.xtreamly.io:5000/api/v1/Utilities/BlockToTime?blockNumber=65' \
    -H 'accept: */*'

Time to Block Conversion

• Endpoint: GET /api/v1/Utilities/TimeToBlock

• Description: Returns the nearest block number to a given timestamp.

• Parameters:

  • timestamp (required): The timestamp in epoch Unix seconds to convert to a block number.

• Example Request:

  curl -X 'GET' \
    'https://test.xtreamly.io:5000/api/v1/Utilities/TimeToBlock?timestamp=1712846554' \
    -H 'accept: */*'