Provider Return

Retrieves a Liquidity Provider’s return in a time interval including fees earned, impermanent loss and related metadata.

Response Data

Field

Type

Description

payload[].protocol

string

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

payload[].start

number

Timestamp start of the query interval.

payload[].end

number

Timestamp end of the query interval.

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

How many units of 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

How many units of 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

How many units of token0 the liquidity provider holds at the end of the query interval.

payload[].tokens1Lp

number

how many units of 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

Total units of token0 fees earned. fees0Total = fees0Unclaimed + fees0Claimed.

payload[].fees1Total

number

Total units of token1 fees earned. fees1Total = fees1Unclaimed + fees1Claimed.

payload[].fees0Unclaimed

number

Total units of token0 fees the liquidity provider has claimed and removed from the pool.

payload[].fees1Unclaimed

number

Total units of token1 the liquidity provider has claimed and removed from the pool.

payload[].fees0Claimed

number

Total units of token0 fees the liquidity provider has removed from the pool.

payload[].fees1Claimed

number

Total units of token1 fees the liquidity provider has claimed and removed from the pool.

payload[].fees

number

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

payload[].feesClaimed

number

Total fees claimed in USD.

payload[].feesUnclaimed

number

Total fees unclaimed in USD.

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!