Provider Return

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

🚧

Time Range Limit

The maximum time range (difference between endDate and startDate) is 31 days.

📘

Not specifying startDate and endDate

If the startDate and endDate query parameters are not provided, the API will return a 404 error as these are required parameters in order to pull the data.

Response Data

FieldTypeDescription
payload[].protocolstringThe name of the protocol, i.e. "uniswapv2".
payload[].startnumberTimestamp start of the query interval.
payload[].endnumberTimestamp end of the query interval.
payload[].poolAddressstringThe address of the token, i.e. the address of the pair or liquidity pool.
payload[].holderAddressstringThe address of the token holder, i.e. the address of the liquidity provider.
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[].tokens0IfHeldnumberHow 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[].tokens1IfHeldnumberHow 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[].tokens0LpnumberHow many units of token0 the liquidity provider holds at the end of the query interval.
payload[].tokens1Lpnumberhow many units of token1 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[].fees0TotalnumberTotal units of token0 fees earned. fees0Total = fees0Unclaimed + fees0Claimed.
payload[].fees1TotalnumberTotal units of token1 fees earned. fees1Total = fees1Unclaimed + fees1Claimed.
payload[].fees0UnclaimednumberTotal units of token0 fees the liquidity provider has claimed and removed from the pool.
payload[].fees1UnclaimednumberTotal units of token1 the liquidity provider has claimed and removed from the pool.
payload[].fees0ClaimednumberTotal units of token0 fees the liquidity provider has removed from the pool.
payload[].fees1ClaimednumberTotal units of token1 fees the liquidity provider has claimed and removed from the pool.
payload[].feesnumberTotal fees earned in USD. fees = feesClaimed + feesUnclaimed.
payload[].feesClaimednumberTotal fees claimed in USD.
payload[].feesUnclaimednumberTotal fees unclaimed in USD.
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!