Pool Total Return

Aggregates fees earned and impermanent loss for each liquidity provider in a pool to calculate pool level fees earned and impermanent loss. These values are calculated daily at midnight UTC.

📘

Not specifying startDate and endDate

If the startDate and endDate query parameters are not provided, the API will return the latest data, meaning from inception date up to the current date.

Response Data

FieldTypeDescription
payload[].protocolstringThe name of the protocol, i.e. "uniswapv2".
payload[].timestampnumberThe UTC midnight timestamp at which the results were calculated.
payload[].poolAddressstringThe address of the token, i.e. the address of the pair or liquidity pool.
payload[].token0AddressstringThe address of token0, i.e. the first token in the pool.
payload[].token1AddressstringThe address of token1, i.e. the second token in the pool.
payload[].tokens0IfHeldnumberToken0 the liquidity provider holds at the end of the query interval if they simply held them in his wallet instead of providing liquidity.
payload[].tokens1IfHeldnumberToken1 the liquidity provider holds at the end of the query interval if they simply held them in his wallet instead of providing liquidity.
payload[].tokens0LpnumberToken0 the liquidity provider holds at the end of the query interval.
payload[].tokens1LpnumberToken1 the liquidity provider holds at the end of the query interval.
payload[].change0numberThe difference between tokens0Lp and Tokens0IfHeld less fees. change0 = tokens0IfHeld - (tokens0Lp - fees0Total)
payload[].change1numberThe difference between tokens1Lp and Tokens1IfHeld less fees. change1 = tokens1IfHeld - (tokens1Lp - fees1Total)
payload[].fees0TotalnumberToken0 fees earned. fees0Total = fees0Unclaimed + fees0Claimed.
payload[].fees1TotalnumberToken1 fees earned. fees1Total = fees1Unclaimed + fees1Claimed.
payload[].price0numberPrice of token0 in USD.
payload[].price1numberPrice of token1 in USD.
payload[].feesnumberTotal fees earned in USD. fees = feesClaimed + feesUnclaimed.
payload[].impermanentLossnumberLoss as a result of providing liquidity in USD.
payload[].returnnumbertotal return in USD.
Language
Authentication
Header
Click Try It! to start a request and see the response here!