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 |
| The name of the protocol, i.e. "uniswapv2". |
payload[].timestamp |
| The UTC midnight timestamp at which the results were calculated. |
payload[].firstLiquidityEvent |
| The first time the holderAddress provided liquidity to the pool. |
payload[].poolAddress |
| The address of the token, i.e. the address of the pair or liquidity pool. |
payload[].holderAddress |
| The address of the token holder, i.e. the address of the liquidity provider. |
payload[].token0Address |
| The address of token0, i.e. the first token in the pool. |
payload[].token1Address |
| The address of token1, i.e. the second token in the pool. |
payload[].tokens0IfHeld |
| 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 |
| Token1 position if the liquidity provider simply held these tokens and did not provide liquidity. |
payload[].tokens0Lp |
| Token0 the liquidity provider holds at the end of the query interval. |
payload[].tokens1Lp |
| Token1 the liquidity provider holds at the end of the query interval. |
payload[].change0 |
| The difference between tokens0Lp and Tokens0IfHeld less fees. change0 = tokens0IfHeld - (tokens0Lp - fees0Total) |
payload[].change1 |
| The difference between tokens1Lp and Tokens1IfHeld less fees. change1 = tokens1IfHeld - (tokens1Lp - fees1Total) |
payload[].fees0Total |
| Token0 fees earned. fees0Total = fees0Unclaimed + fees0Claimed. |
payload[].fees1Total |
| Token1 fees earned. fees1Total = fees1Unclaimed + fees1Claimed. |
payload[].fees0Unclaimed |
| Token0 earned in trading fees that is unclaimed. |
payload[].fees1Unclaimed |
| Token1 earned in trading fees that is unclaimed. |
payload[].fees0Claimed |
| Token0 earned in trading fees that is claimed (as a result of burns or transfers). |
payload[].fees1Claimed |
| Token1 earned in trading fees that is claimed (as a result of burns or transfers). |
payload[].price0 |
| Price of token0 in USD. |
payload[].price1 |
| Price of token1 in USD. |
payload[].fees |
| Total fees earned in USD. |
payload[].feesClaimed |
| Total fees claimed in USD. |
payload[].feesUnclaimed |
| Total fees unclaimed in USD. |
payload[].impermanentLoss |
| Loss in USD as a result of providing liquidity (relative to holding). |
payload[].return |
| Total USD return. |