Analytics Response Fields
This page describes the fields of the response provided by the Position Analytics API
Returns an
object containing two array elements:data:arraycontaining the actual analytics data per daymetadata:arraylisting the pool's tokens
Applicable for Uniswap V2 positions.
Parameter | Type | Description |
|---|---|---|
data | array | array of objects containing the actual analytics data per day |
-- timestamp | long | date for which the analytics apply; unix timestamp format |
-- token0Amount | double | user's reserve in the pool: token0 balance |
-- token1Amount | double | user's reserve in the pool: token1 balance |
-- token0UsdRate | double | user's reserve in the pool: token0 USD valuation |
-- token1UsdRate | double | user's reserve in the pool: token1 USD valuation |
-- lpPrice | double | LP token price of the day |
-- lpTokenAmount | double | user's reserve in the pool: LP token balance |
-- dailyLpTokenMinted | double | user's reserve in the pool: amount of LP tokens gained for the day |
-- lpTokenValueUSD | double | user's reserve in the pool: LP token USD valuation |
-- userPoolShare | double | user's share of the pool at date (timestamp); % |
-- poolTvlUSD | double | overall pool's TVL at date (timestamp) |
-- dailyFeesToken0 | double | user earned Fees (Yield) for the day: token0 balance |
-- dailyFeesToken1 | double | user earned Fees (Yield) for the day: token1 balance |
-- dailyFeesToken0USD | double | user earned Fees (Yield) for the day: token0 USD valuation |
-- dailyFeesToken1USD | double | user earned Fees (Yield) for the day: token1 USD valuation |
-- dailyFeesUSD | double | overall user earned Fees (Yield) for the day: USD valuation |
-- cumulativeFeesToken0 | double | user cumulated Fees (Yield) to data: token0 balance |
-- cumulativeFeesToken1 | double | user cumulated Fees (Yield) to data: token1 balance |
-- cumulativeFeesToken0USD | double | user cumulated Fees (Yield) to data: token0 USD valuation |
-- cumulativeFeesToken1USD | double | user cumulated Fees (Yield) to data: token1 USD valuation |
-- cumulativeFeesUSD | double | overall user cumulated Fees to date: USD valuation |
-- dailyTxFees | double | user position amount of transaction fees for the day: native token balance; if transactions occurred during the day |
-- dailyTxFeesUSD | double | user position amount of transaction fees for the day: USD valuation; if transactions occurred during the day |
-- cumulativeTxFees | double | user position cumulated transaction fees to date: native token balance |
-- cumulativeTxFeesUSD | double | user position cumulated transaction fees to date: USD valuation |
-- events | array of object | list of transactions which occurred during the day on the user's position |
--/-- timestamp | long | date & time of the transaction; unix timestamp format |
--/-- blockNumber | long | blockchain block number containing the transaction |
--/-- eventType | string | module's function name |
--/-- balances | array of <long, biginteger> | token movements: tokenID and amount moved |
--/-- isOpposite | boolean | opposite transaction available (identified) |
--/-- transaction | string | transaction hash |
--/-- txInfo | object | transaction related information |
--/--/-- txFee | biginteger | amount of transaction fees |
--/--/-- txFeeUSDD | double | amount of transaction fees USD valuation |
metadata | array | listing the pool's tokens |
-- address | string | token ID |
-- symbol | string | token symbol |
-- name | string | token symbol |
-- decimals | long | token value number of decimals |
-- logo | string | URL link to token logo |
Applies for Uniswap V2 & V3 positions.
Parameter | Type | Details |
|---|---|---|
timestamp | long | date & time for which the analytics apply; unix timestamp format |
blockNumber | long | |
lpTokensData | array | list of objects, user's positions with their corresponding current (timestamp) analytics status; the id key is:
|
-- lpTokenAddress | string | LP token address |
-- nftId | biginteger | position NFT ID for Uniswap V3 |
-- underlyingTokens | array of string | array with the position's underlying token addresses |
-- lpTokensMinted | biginteger | amount of LP token minted for the day |
-- lpPriceUsd | double | LP price of the day |
-- dailyFeesUsd | double | Fees (Yield) for the date |
-- cumulativeFeesUsd | double | Total Fees (Yield) cumulated to date |
-- collectedFeesUsd | double | Fees (Yield) collected to date |
-- dailyTxFeesUsd | double | transaction fees of the day USD valuation; if movement during the day |
-- cumulativeTxFeesUsd | double | cumulated transaction fees to date, for the position |
-- currencyDiffUsd | double | position's underlying tokens current price fluctuation with regard to token entry price |
-- pnLUsdPnLToDate | double | position total P&L: Cumulative Fees + Cumulative Tx Fees + Currency Difference |
-- pnLUsdRealized | double | realized P&L, in relation with collected Yield |
-- impermanentLoss | double | impermanent loss USD value to date |
Last modified 2mo ago