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.

📘

Not specifying startDate and endDate

If the startDate and endDate query parameters are not provided, the API will return the latest data, meaning from inception date up to the current date.

Response Data

FieldTypeDescription
payload[].protocolstringThe name of the protocol, i.e. "uniswapv2".
payload[].timestampnumberThe UTC midnight timestamp at which the results were calculated.
payload[].firstLiquidityEventnumberThe first time the holderAddress provided liquidity to the pool.
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[].tokens0IfHeldnumberToken0 the liquidity provider holds at the end of the query interval if they simply held them in his wallet instead of providing liquidity.
payload[].tokens1IfHeldnumberToken1 position if the liquidity provider simply held these tokens and did not provide liquidity.
payload[].tokens0LpnumberToken0 the liquidity provider holds at the end of the query interval.
payload[].tokens1LpnumberToken1 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[].fees0TotalnumberToken0 fees earned. fees0Total = fees0Unclaimed + fees0Claimed.
payload[].fees1TotalnumberToken1 fees earned. fees1Total = fees1Unclaimed + fees1Claimed.
payload[].fees0UnclaimednumberToken0 earned in trading fees that is unclaimed.
payload[].fees1UnclaimednumberToken1 earned in trading fees that is unclaimed.
payload[].fees0ClaimednumberToken0 earned in trading fees that is claimed (as a result of burns or transfers).
payload[].fees1ClaimednumberToken1 earned in trading fees that is claimed (as a result of burns or transfers).
payload[].price0numberPrice of token0 in USD.
payload[].price1numberPrice of token1 in USD.
payload[].feesnumberTotal fees earned in USD.
payload[].feesClaimednumberTotal fees claimed in USD.
payload[].feesUnclaimednumberTotal fees unclaimed in USD.
payload[].impermanentLossnumberLoss in USD as a result of providing liquidity (relative to holding).
payload[].returnnumberTotal USD return.
Language
Authentication
Header
Click Try It! to start a request and see the response here!