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.

Response Data

Field

Type

Description

payload[].protocol

string

The name of the protocol, i.e. "uniswapv2".

payload[].timestamp

number

The UTC midnight timestamp at which the results were calculated.

payload[].poolAddress

string

The address of the token, i.e. the address of the pair or liquidity pool.

payload[].token0Address

string

The address of token0, i.e. the first token in the pool.

payload[].token1Address

string

The address of token1, i.e. the second token in the pool.

payload[].tokens0IfHeld

number

Token0 the liquidity provider holds at the end of the query interval if they simply held them in his wallet instead of providing liquidity.

payload[].tokens1IfHeld

number

Token1 the liquidity provider holds at the end of the query interval if they simply held them in his wallet instead of providing liquidity.

payload[].tokens0Lp

number

Token0 the liquidity provider holds at the end of the query interval.

payload[].tokens1Lp

number

Token1 the liquidity provider holds at the end of the query interval.

payload[].change0

number

The difference between tokens0Lp and Tokens0IfHeld less fees. change0 = tokens0IfHeld - (tokens0Lp - fees0Total)

payload[].change1

number

The difference between tokens1Lp and Tokens1IfHeld less fees. change1 = tokens1IfHeld - (tokens1Lp - fees1Total)

payload[].fees0Total

number

Token0 fees earned. fees0Total = fees0Unclaimed + fees0Claimed.

payload[].fees1Total

number

Token1 fees earned. fees1Total = fees1Unclaimed + fees1Claimed.

payload[].price0

number

Price of token0 in USD.

payload[].price1

number

Price of token1 in USD.

payload[].fees

number

Total fees earned in USD. fees = feesClaimed + feesUnclaimed.

payload[].impermanentLoss

number

Loss as a result of providing liquidity in USD.

payload[].return

number

total return in USD.

Language
Authentication
Header
Click Try It! to start a request and see the response here!