Provider Total Return

Retrieves a Liquidity Provider's return since inception (the first time they provided liquidity or received LP tokens) including fees earned, impermanent loss and related metadata. 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[].firstLiquidityEvent

number

The first time the holderAddress provided liquidity to the pool.

payload[].poolAddress

string

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

payload[].holderAddress

string

The address of the token holder, i.e. the address of the liquidity provider.

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 position if the liquidity provider simply held these tokens and did not provide 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[].fees0Unclaimed

number

Token0 earned in trading fees that is unclaimed.

payload[].fees1Unclaimed

number

Token1 earned in trading fees that is unclaimed.

payload[].fees0Claimed

number

Token0 earned in trading fees that is claimed (as a result of burns or transfers).

payload[].fees1Claimed

number

Token1 earned in trading fees that is claimed (as a result of burns or transfers).

payload[].price0

number

Price of token0 in USD.

payload[].price1

number

Price of token1 in USD.

payload[].fees

number

Total fees earned in USD.

payload[].feesClaimed

number

Total fees claimed in USD.

payload[].feesUnclaimed

number

Total fees unclaimed in USD.

payload[].impermanentLoss

number

Loss in USD as a result of providing liquidity (relative to holding).

payload[].return

number

Total USD return.

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