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.

👍

Protocols Supported

This endpoint only supports Uniswap v2.

👍

Blockchains Supported

This endpoint only supports data from ethereum-mainnet.

📘

Not specifying the endDate

If the endDate query parameter is not provided, the API will return the latest data, meaning from inception date up to the current date.

Response Data

Field

Type

Description

payload.data[index].protocol

string

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

payload.data[index].timestamp

number

The UTC midnight timestamp at which the results were calculated.

payload.data[index].poolAddress

string

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

payload.data[index].token0Address

string

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

payload.data[index].token1Address

string

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

payload.data[index].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.

  • *NOTE**: This is not the reserve of token0 in the pool.

payload.data[index].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.

  • *NOTE**: This is not the reserve of token1 in the pool.

payload.data[index].tokens0Lp

number

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

payload.data[index].tokens1Lp

number

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

payload.data[index].change0

number

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

payload.data[index].change1

number

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

payload.data[index].fees0Total

number

Token0 fees earned. fees0Total = fees0Unclaimed + fees0Claimed.

payload.data[index].fees1Total

number

Token1 fees earned. fees1Total = fees1Unclaimed + fees1Claimed.

payload.data[index].price0

number

Price of token0 in USD.

payload.data[index].price1

number

Price of token1 in USD.

payload.data[index].fees

number

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

payload.data[index].impermanentLoss

number

Loss as a result of providing liquidity in USD.

payload.data[index].return

number

total return in USD.

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