Fields Definitions

userTransactionStatuses

JSON field name	Description
requestId	A field that returns a string that can be used to lookup the request and troubleshoot any errors
indexingStatus	An array of fields, see next section for field definitions
items	An array of fields specific to the userTransactionStatuses entity
exceptions	An array of fields with exceptions related to data population.

indexingStatus object

JSON field name	Description
headBlock	The block number a blueprint's data source is up to. This is usually very close to the actual head block of the chain. In cases when there's a problem with the data source (subgraph, node, RPC, etc) then this headBlock may fall behind the actual head block of the blueprint's chain.
headTimestamp	The timestamp of the headBlock field's reported block. This is typically close to the real time timestamp of the chain's head block. However, if there is an issue with the data source (e.g., subgraph, node, RPC, etc.), the headBlock field and headTimestamp may lag behind the actual head block/timestamp of the blueprint's chain.
lastSyncedBlock	While syncing, lastSyncedBlock returns the block number of the last synced block of the position. When we have found no more entries to populate, the lastSyncedBlock is updated to match the headBlock. Therefore when lastSyncedBlock = headBlock the query data is up to date.
lastSyncedTimestamp	Just like the headTimestamp mentioned above, this is a timestamp for the block reported in lastSynchedBlock. This can be used to compare this value with the current timestamp for a sense of how up to date the data in the query is.
totalPositions	Total number of positions found up to the current snapshotData block

totalPositions

JSON field name	Description
count	The number of unique position identifiers for a particular address within a particular blueprint.
requestId	A field that returns a string that can be used to lookup the request and troubleshoot any errors
activePositions	An array of position identifiers. Each of these positions is an open position, meaning its position shares is greater than zero at the time of the response.
positions	An array showing each positionIdentifier for the positions indexed up through the lastSyncedblock. When in the indexingStatus object in the totalPositions entity lastSyncedBlock = headBlock then all of the transactions for the user interacting with this blueprint have been collected and classified.

positions entity fields

Field name	Description
userIdentifier	User's wallet address.
blueprintId	Blueprint's name. This identifies the blueprint by adding it as a param to the API call. The blueprint is also chain specific, so this also is used to retrieve the correct data based on the chain and protocol requested.
chainId	Identifier of the chain
positionIdentifier	The main contract associated with the blueprint. For univ3 and similar positions, this is the NFT ID.

snapshotData definitions

Field name	Description
positionSnapshotCount	Returns the number of transactions for a selected wallet interacting with a given protocol. One transaction can have multiple operations (see "operations" below).
positionAgeSeconds	The number of seconds the position has been open. This value is -1 for fully exited positions.
totalFeeUsd	The sum of all the txFeeUsd fields represents the total transaction fees paid for the position. Calculated in USD at the time of the transaction. It doesn’t double-count snapshots with the same hash.
userPositionSnapshots	An array listing the transactions related to this position. One snapshot (or transaction) can have multiple operations.
blockNumber	The block number of the transaction.
date	Date of the transaction snapshot. Format: Day/Month/Year.
timestamp	Timestamp of the transaction snapshot.
txHash	The hash number for the transaction.
txFeeUsd	The transaction or gas fee paid in the transaction (denominated in USD).
gasTokenAmount	The number of Gas tokens paid in this transaction. Note: At times, we will show multiple transactions with the same block number if multiple actions occurred. We will repeat the same gasTokenAmount for each transaction. However, totalFeeUsd accounts for this and only sums one fee from each block.
isLiabilityPosition	(true/false) defaults to FALSE. TRUE indicates that the position is a debt or a liability. When this is TRUE some calculations are done differently and many of these positions open with a WITHDRAW operation instead of a deposit operation. For example: when a user withdraws DAI from a lending protocol like Aave, the protocol actually sends the user tokens that represent their debt in the protocol. In that case the position is a liability position that will return TRUE for this field.
positionSharesAtBlock	The balance in tokens of this position. Usually returns the balance of receipt tokens or whatever the blueprint is using as the position balance of the position. Not a USD value. For specific protocols with compounding mechanisms, this value can increase/decrease. For example, if it is a Uniswap v2 position, then the quantity of the LP tokens.
userPrincipalShares	This is similar to positionSharesAtBlock. It tracks the position shares in the position but does not include any changes in balances coming from the protocol. Actual deposits, withdraws, and transfers will affect userPrincipalShares, but changes like auto-compounding, rebasing, and interest rates don't affect this field. The main purpose of this is to isolate the number of tokens coming from the protocol, for example, from compounding.
userPrincipalCostUsd	The average cost basis in USD of the position. Additional deposits increase the cost basis. Withdrawals reduce the cost basis proportionally by how much of the asset was withdrawn. For example, if I deposited $100 worth (10 receipt tokens), and later that position is worth $500 and then I removed $100 (2 receipt tokens). Then the userPrincipalCostUsd would be 100 * (8/10) = 80, where 8 is the number of receipt tokens remaining in the position, and 10 is the number of receipt tokens immediately before the exit (last snapshot).
userPrincipalUnitCostUsd	The cost basis per unit, where the unit is the receipt token. The userPrincipalUnitCostUsd only changes at DEPOSIT-type transactions. For example, if I deposited $100 worth of 10 receipt tokens, my userPrincipalUnitCostUsd is $10 at the time of entry (deposit) and exit (withdrawal). Calculation: userPrincipalCostUsd / userPrincipalShares
positionUsdValueAtBlock	The value (in USD) of the position or main asset if the user were to exit everything from the protocol. Note: this doesn’t include any pending/collected income. This value is calculated via the receipt token value and not directly from the non-receipt tokens.
ifHeldAllAmountEth	Hypothetical amount of ETH tokens if the user held the full amount of the position in Ether. Additions to the position are converted to more ETH and added to the running ifHeldAllAmountEth. Withdraws reduce the ifHeldAllAmountEth by the same ratio as the portion of the position exited.
ifHeldAllAmountBtc	Hypothetical amount of tokens if the user held the full amount of the position in Bitcoin. Additions to the position are converted to more BTC and added to the running ifHeldAllAmountBtc. Withdraws reduce the ifHeldAllAmountBtc by the same ratio as the portion of the position exited.
isNewSession	Indicates if the transaction starts a new user session or not. A session can start at a user's first operation into a position (usually a deposit). or If there is a full exit of the position, a new session will start at the next operation into the position.
isFullyExitedSession	Indicating if the transaction results in a full exit or not. It’s fully exited when positionSharesAtBlock & userPrincipalShares equal 0.
userPositionSnapshotOperations	An array incorporating all operations in a given transaction. One transaction can have multiple operations. For example, a claim and exit in one transaction would have two operations.
exitRatio	Value between 0 and 1, indicating the proportion of the exit.
exitedCostUsd	In this transaction, the cost basis is in USD of the withdrawn portion of the position. At any WITHDRAW userPrincipalCostUsd + exitedCostUsd = the previous userPrincipalCostUsd. The position’s previous cost basis is split into the exited portion and the portion that remains with the current asset. For example, if I deposited $100 USD worth (10 receipt tokens), later that position is worth $500 and then I removed $100 (2 receipt tokens). Then the userPrincipalCostUsd would be 100 * (8/10) = 80 and exitedCostUsd would be 20. The $100 original investment is split up into $80 remaining with the current portion and $20 as the cost basis of the exited portion.
exitedValueUsd	In this transaction, the current value in USD of the withdrawn portion of the position. For example, if I deposited $100 USD worth (10 receipt tokens), later that position is worth $500 and then I removed $100 (2 receipt tokens). exitedValueUsd would be $100. The current value of each LP token is 500/10= 50 and I exited 2 LP tokens, so those 2 LP tokens have a total current value at the time of exit of $100.
exitedHodlValueUsd	Hypothetical USD value if the user didn’t enter the position multiplied by the exit ratio. Calculation: hodlValueUsd * exitRatio
warnings	An array of fields with warnings related to data quality and potential problems with the data. Some examples would be issues getting a particular price for a specific token-chain-block combination.

operations definitions

Field name	Description
operationType	operationType describes the type of operations happening in a given snapshot. There is always at least 1 operation in all of the snapshots stored. There can be more than 1 operation in given snapshot. The current operationType possibilities are: deposit, withdraw, transfer_in, transfer_out, income, and null_op Deposit: an increase in an asset position or decrease in a liability position with token movement within an address Withdraw: a decrease in an asset position or increase in a liability position with token movement within an address Transfer_in: generally a wallet to wallet transfer or transfer to a contract that is not tracked as a part of the blueprint. Transfer_in will increase the position shares of a position Transfer_out: the opposite of the transfer in Income: revenue generated by the position that does not change the amount of capital of the position. For example trade fees from Uniswap v3 are not automatically compounded and are collected separately from the underlying position. Income from a vault that is automatically compounded back into the position is not tracked by this operation Null_op: This is reserved for a operation that the blueprint tracks but does not make adjustments to position shares for the activity taking place. An example might be a position being staked in a farm for example. We don't adjust position shares but the operation is recorded without any effects
operationValueUsd	A measurement of the total value of the operation. This isn't cumulative, both sides of the transaction are not counted. The pricing of this value may vary by blueprint. This is usually the market value of the most marketable and priceable side of the transaction. This is calculated using the non-receipt tokens for transactions involving non-receipt tokens and income tokens for those types of transactions.
adjustmentValueUsd	This field is available for blueprint developers to use to capture some sort of positive or negative adjustment that can then be applied to the position. Our lending and borrowing blueprints are currently using this field to capture the expense of a liquidation. Liquidations are a complex transaction to track in our current schema so we provide this field as a place to capture the cost of liquidations. What this field does can vary depending on how the blueprint is applying it. note for format, -xx.xx will indicate a fee or expense and xx.xx will indicate a positive adjustment
warnings	An array of fields with warnings related to data quality and potential problems with the data. Some examples would be issues getting a particular price for a specific token-chain-block combination.

tokens definitions

Field name	Description
userPositionSnapshotOperationTokens	An array listing all tokens in this position.
tokenName	Name of the token.
tokenAddress	Address of the token.
tokenType	It can be Non Receipt, Receipt or Income
tag	If specified by the integration's developer, this field provides additional information on the token. By default, it is empty. For example, certain transactions that users perform gives the user the protocol fees (for being a liquidity provider) in addition to farming rewards in the same transaction. In those cases, it's helpful to distinguish between the two. We would add a different tag for each.
tokenDirection	It can either be INPUT or OUTPUT. INPUT if the user deposits to a protocol/contract. OUTPUT if the user receives tokens. For example, if I provide liquidity to a Uniswap v2 pool, then the two tokens that are deposited are INPUT tokens, and the LP tokens I receive after my deposit are OUTPUT tokens coming from the protocol.
isReceiptToken	Returns "true" if the token is a receipt token and "false" if the token is a non- receipt token.
netTokenAmount	This is all of the deposits of this token netted with all of the withdraws of this token. Note: this value can be positive or negative. Calculation: totalAmountDeposited - totalAmountWithdrawn This is often NOT the same value as tokenAmountatBlock. For example, in a Uniswap v2 LP position the underlying assets in your position are shown in tokenAmountAtBlock (based on the number of LP tokens you have) but the netTokenAmount is calculated based only on your deposits and withdraws of the underlying assets. Note that this field is only applicable if the tokenType does not equal Income
decimals	The decimal value used by this token.
tokenRawAmount	This is the raw token amount received from the blockchain.
totalAmountDeposited	Running total of all deposits, NOT the current balance. For example, if a user goes in and out of a position with 10 tokens ten times. totalAmountDeposited would be 100 even though the balance would be 0 after all of that. Note that this field is only applicable if the tokenType does not equal Income
totalAmountWithdrawn	Running total of all withdraws. Note that this field is only applicable if the tokenType does not equal Income
amountDepositedChange	For INPUT tokens: the exact token value amount that changed in this transaction/snapshot for the occurred operation. Note that this field is only applicable if the tokenType does not equal Income
amountWithdrawnChange	For OUTPUT tokens: the exact token value amount that changed in this transaction/snapshot for the occurred operation. Note that this field is only applicable if the tokenType does not equal Income
amountIncomeChange	The token amount in an INCOME operation related to a claim or other type of transfer of an income token. For example, claiming tokens from a farm contract blueprint will populate the amount of claimed tokens into this field. Note that this field is only applicable if the tokenType = Income
tokenIncomeUsd	The value, USD, of the tokens in amountIncomeChange Note that this field is only applicable if the tokenType = Income
tokenPriceUsd	The token price for the token in the same tokenLedger object.
tokenPriceSource	Price source of tokenPriceUsd.
tokenAmountatBlock	Token amount the user would get if they exited the position at this block. In other words, it's the underlying token amount the user has rights or access to. On chain data is needed here to check the current balances at the time of snapshots. This field is not provided for tracked underlying tokens. For example: User deposits 10 ETH into the position. The position appreciates in value and the user has the same positionSharesAtBlock (same amount of receipt tokens), but the position is now worth 10.5 ETH. At this point tokenAmountAtBlock will be 10.5ETH even though the amount of the receipt token hasn't changed. Note that this field is only applicable if the tokenType does not equal Income
tokenValueUsd	The value of the tokens in this section at the time of the snapshot
ifHeldAmountToken	Hypothetical amount of tokens the user would have now if they had not deposited them, but instead just held them. Additional deposits of this token are added to the running total of ifHeldAmountToken. Withdraws reduce the ifHeldAmountToken by the same ratio as the overall portion of the position exited. This field is not provided for output tokens or any tokens if the netTokenAmount is less than zero. For example: User deposits 10 ETH into the position, position has 10 ETH ifHeldAmountToken: 10 ETH exitedIfHeldAmountToken: 0 ETH User withdraws 20% (2.4 ETH) from this position, position grew and was 12 ETH before this withdraw ifHeldAmountToken: 8 ETH exitedIfHeldAmountToken: 2 ETH (this just applies to this exited session) User deposits 1 ETH into the position, position has 10.6 ETH. (12-2.4+1) ifHeldAmountToken: 9 ETH exitedIfHeldAmountToken: 0 ETH (prev. exited session records the 2 ETH) User withdraws 100% (14 ETH) from the position, position has grown to 14 ETH ifHeldAmountToken: 0 ETH exitedIfHeldAmountToken: 9 ETH Note that this field is only applicable if the tokenType does not equal Income
ifHeldAllAmountToken	Hypothetical amount of tokens if the user had taken the TOTAL USD value of what was invested into the position and instead had swapped that for only this token. Additions to the position are converted to more of the token and added to the running ifHeldAllAmountToken number. Withdraws reduce the ifHeldAllAmountToken by the same ratio as the portion of the position exited. This field is not provided for output tokens or any tokens if the netTokenAmount is less than zero. For example: User deposits 1 ETH ($3000) and 3000 USDC ($3000) into the position, position value is $6000 ifHeldAllAmountToken: 2 ETH (if we took the 6k and just held ETH) exitedIfHeldAmountToken: 0 ETH User withdraws 20% (.15 ETH & 3375 USDC ) from this position, before withdraw with new $6000 Eth price, position was .75 Eth & 4500 USDC ifHeldAmountToken: 1.6 ETH [2 Eth * (1-.2)] exitedIfHeldAmountToken: .4 ETH (this just applies to this exited session) User deposits 1 ETH & 6000 USDC into the position, position has 1.6 ETH & 9600 USDC ifHeldAmountToken: 3.6 ETH exitedIfHeldAmountToken: 0 ETH (prev. exited session records the .4 ETH) User withdraws 100% (1.6 Eth and 9600 USDC) from the position ifHeldAmountToken: 0 ETH exitedIfHeldAmountToken: 3.6 ETH Note that this field is only applicable if the tokenType does not equal Income
exitedIfHeldAmountToken	This is the exited side of ifHeldAmountToken: Hypothetical amount of tokens the user would have now if they had not deposited them, but instead just held them. Additional deposits of this token are added to the running total of ifHeldAmountToken. Withdraws reduce the ifHeldAmountToken by the same ratio as the overall portion of the position exited. This field is not provided for output tokens or any tokens if the netTokenAmount is less than zero. For example: User deposits 10 ETH into the position, position has 10 ETH ifHeldAmountToken: 10 ETH exitedIfHeldAmountToken: 0 ETH User withdraws 20% (2.4 ETH) from this position, position grew and was 12 ETH before this withdraw ifHeldAmountToken: 8 ETH exitedIfHeldAmountToken: 2 ETH (this just applies to this exited session) User deposits 1 ETH into the position, position has 10.6 ETH. (12-2.4+1) ifHeldAmountToken: 9 ETH exitedIfHeldAmountToken: 0 ETH (prev. exited session records the 2 ETH) User withdraws 100% (14 ETH) from the position, position has grown to 14 ETH ifHeldAmountToken: 0 ETH exitedIfHeldAmountToken: 9 ETH Note that this field is only applicable if the tokenType does not equal Income
exitedIfHeldAllAmountToken	Similar to exitedIfHeldAmountToken but instead of the original amount, this field looks at how many tokens of this type would be present if the user used the USD value of the deposits to instead swap for just this token at each time of deposit. For example: User deposits 1 ETH ($3000) and 3000 USDC ($3000) into the position, position value is $6000 ifHeldAllAmountToken: 2 ETH (if we took the 6k and just held ETH) exitedIfHeldAmountToken: 0 ETH User withdraws 20% (.15 ETH & 3375 USDC ) from this position, before withdraw with new $6000 Eth price, position was .75 Eth & 4500 USDC ifHeldAmountToken: 1.6 ETH [2 Eth * (1-.2)] exitedIfHeldAmountToken: .4 ETH (this just applies to this exited session) User deposits 1 ETH & 6000 USDC into the position, position has 1.6 ETH & 9600 USDC ifHeldAmountToken: 3.6 ETH exitedIfHeldAmountToken: 0 ETH (prev. exited session records the .4 ETH) User withdraws 100% (1.6 Eth and 9600 USDC) from the position ifHeldAmountToken: 0 ETH exitedIfHeldAmountToken: 3.6 ETH Note that this field is only applicable if the tokenType does notequal Income Note that this field is only applicable if there was a withdraw or trasnfer_out operation
warning	An array of fields with warnings related to data quality and potential problems with the data. Some examples would be issues getting a particular price for a specific token-chain-block combination.

currentIntervalData & intervalData fields

JSON field name	Further details
userPositionIntervalData	An array, incorporating daily position data
positionIdentifier	A field to differentiate the position from other positions in the same protocol, often a contract address. A user can have multiple positions in the same protocol, but each position will have a unique positionIdentifier. For example, for Uniswap v2 we use the LP token contract address as the positionIdentifier. For Matic staking we use the 1 Matic staking contract. For Univ3 and similar protocols this is the NFT ID.
date	aka Baseline Day, which is the date of the snapshot
positionAgeSeconds	Number of seconds the position has been open
blockNumber	Block number the day data snapshot data is coming from
timestamp	Timestamp corresponding to the baseline date & block number
intervalDataType	Determines the type of the dayData. It can be Snapshot, EOD and OnDemand. Snapshot: the day data generated at the time of a transaction OnDemand: latest data returned when the endpoint is called EOD: end of the day data, generated at UTC midnight.
isLiabilityPosition	It can be true or false. The field's value is true if this is a borrow position-related day data.
positionSharesAtBlock	The balance in tokens of this position. Usually returns the balance of receipt tokens or whatever the blueprint is using as the position balance of the position. Not a USD value. For example, if it is a Uniswap v2 position, then the quantity of the LP tokens.
userPrincipalShares	This is similar to positionSharesAtBlock. It tracks the position shares in the position but does not include any changes in balances coming from the protocol. Actual deposits, withdraws and trasnfers will affect userPrincipalShares, but changes like auto-compounding, rebasing, and interest rates don't affect this field. The main purpose of this is to be able to isolate the number of tokens coming from protocol changes.
positionShareChange	Applicable to protocols where the positionSharesAtBlock field changes, such as auto-compounding, and rebasing protocols. Not a USD value. Calculation: positionSharesAtBlock - userPrincipalShares
positionShareChangeUsd	The USD value of the positionShareChange. Calculation: positionShareChange * Price
positionUsdValueAtBlock	The value (in USD) of the position or main asset if the user were to exit everything from the protocol. Note: this doesn’t include any pending/collected income. This value is calculated via the receipt token value and not directly from the non-receipt tokens.
userPrincipalCostUsd	The cost basis in USD of the position where additions increase the cost basis, and withdrawals reduce the cost basis proportionally by how much of the asset was withdrawn. For example, if I deposited $100 worth (10 receipt tokens), and later that position is worth $500 and then I removed $100 (2 receipt tokens). Then the userPrincipalCostUsd would be 100 * (8/10) = 80, where 8 is the number of receipt tokens remaining in the position, and 10 is the number of receipt tokens immediately before the exit (last snapshot).
userPrincipalUnitCostUsd	The cost basis per unit, where the unit is the receipt token. In the above example, the userPrincipalUnitCostUsd would be 10 at the time of entry and exit. The userPrincipalUnitCostUsd only changes at DEPOSIT-type transactions. Calculation: userPrincipalCostUsd / userPrincipalShares
netMarketGainUsd	The market gain of the current open position (doesn’t include any exited activity, doesn’t include income). Total amount invested (in USD) by the user is = userPrincipalCostUsd Total value of the position is positionUsdValueAtBlock Calculation: positionUsdValueAtBlock (which is the value of a position at a given block) - userPrincipalCostUsd
netMarketGainPct	This value is the net market gain in % (can be positive or negative). Total amount invested (in USD) by the user is = userPrincipalCostUsd Total value of the position is positionUsdValueAtBlock Calculation: (positionUsdValueAtBlock - userPrincipalCostUsd)/userPrincipalCostUsd * 100
hodlValueUsd	Hypothetical USD value if the user didn’t enter the position. This uses the net amount of the underlying assets supplied * price of those tokens at the timestamp of the day data snapshot. Exit ratio method is used when there is a partial exit. If there is a 60% exit of the position the hodlValueUsd is also reduced 60% at that time.
roiVsHodlUsd	roiVsHodlUsd compares the current underlying tokens and their value to the original tokens deposited and the hypothetical current value of those original tokens in their original quantities at the current market price. Additions to the position will increase the number of tokens in the comparison by the exact amount added. Partial withdraws from the position will reduce the benchmark tokens by the same proportion as the exit. Note: this is the impermanent loss (in USD) for user positions in protocols where the income is separated from the underlying tokens (not compounding). Calculation: roiVsHodlUsd = positionUsdValueAtBlock - hodlValueUsd
roiVsHodlPct	Compares the positionUsdValueAtBlock with hodlValueUsd to get the percentage difference. Note: this is the impermanent loss (percentage) for user positions in protocols where the income is separated from the underlying tokens (not compounding). Calculation: (positionUsdValueAtBlock - hodlValueUsd) / hodlValueUsd * 100
ethPriceUsd	Ether's price at the time of the transaction.
ifHeldAllAmountEth	Hypothetical amount of tokens if the user held the full amount of the position in Ether. Additions to the position are converted to more Eth and added to the running ifHeldAllAmountEth. Withdraws reduce the ifHeldAllAmountEth by the same ratio as the portion of the position exited.
ifHeldAllAmountEthValueUsd	The USD value of ifHeldAllAmountEth.
btcPriceUsd	Bitcoin's price at the time of the transaction.
ifHeldAllAmountBtc	Hypothetical amount of tokens if the user held the full amount of the position in BTC. Additions to the position are converted to more BTC and added to the running ifHeldAllAmountBtc. Withdraws reduce the ifHeldAllAmountBtc by the same ratio as the portion of the position exited.
ifHeldAllAmountBtcValueUsd	The USD value of ifHeldAllAmountBtc.
avgOpenInterestUsd	This is the time-weighted average of how much in USD terms the user has invested into this position. It is calculated from the ledger (if the user enters $1000 on block 100, adds $500 on block 110, the avg open interest on block 111 is ((1000 10) + (500 1)) / 11 = $954.545 note: this field uses seconds and the seconds between two blocks to calculate avgOpenInterestUsd.
cumulativeCollectedIncomeUsd	Sum of the USD value of withdrawn income priced at the time of collection within the current session. Partial exits will split this value using the exitRatio into part cumulativeCollectedIncomeUsd (active session) and partly to exitedCollectedIncomeAmountUsd (exited session). If there are multiple income tokens, this field sums up their values. This field is also available at the token level for a token by token breakdown. Note: income data is only available for user positions in protocols where the income is separated from the underlying tokens (not compounding).
pendingIncomeUsd	USD value of income claimable but not withdrawn yet. In a partial exit, pendingIncomeUsd is not distributed proportinally to an exited and active session. If income is not collected it will remain with the active session. Note: income data is only available for user positions in protocols where the income is separated from the underlying tokens (not compounding).
incomeApyInception	The APY from the last full exit until the present time of the snapshot. Or for an exited position, the APY from the second to last full exit. This field is calculated using the pending and collected income fields. Note: There are situations when pending income is not collected at time of exit then the APY for the active position can be skewed with the pending income generated prior to the exit. Only happens if income isn't collected at the time of an exit.
positionShareAPY	Position share change-based (token amount-based) APY of the position.
positionShareUsdAPY	USD-based APY of the position, using the USD value of the positionShareChange (positionShareChangeUsd). Protocols with a compounding mechanism use this.
userPositionIntervalDataTokens	An array listing all tokens involved in this position with related financial data. See more info on the next page.
incomeSinceLastSnapshotUsd	A USD amount of income earned by the position since the last snapshot.
incomeApySinceLastSnapshot	The APY of the incomeSinceLastSnapshotUsd.
averageDailyIncomeSinceLastSnapshotUsd	Using the time passed since the last snapshot and the incomeSinceLastSnapshotUsd, we convert this into a daily figure.
exitRatio	Value between 0 and 1, indicating the proportion of the exit.
exitedSessionLength	The length of the exited session in seconds.
exitedPositionSharesAtBlock	The positionSharesAtBlock multiplied by the exitRatio.
exitedUserPrincipalShares	The userPrincipalShares multiplied by the exitRatio. userPrincipalShares tracks the position shares in the position but does not include any changes in balances coming from the protocol.
exitedPositionShareChange	The positionShareChange multiplied by the exitRatio.
exitedPositionShareChangeUsd	The positionShareChangeUsd multiplied by the exitRatio.
exitedPositionShareAPY	Position share change-based APY for the exited portion of the position.
exitedPositionShareUsdAPY	USD-based APY, using the USD value of the positionShareChange for the exited portion of the position.
exitedCostUsd	In this transaction, the cost basis is in USD of the withdrawn portion of the position. At any WITHDRAW userPrincipalCostUsd + exitedCostUsd = the previous userPrincipalCostUsd. The position’s previous cost basis is split into the exited portion and the portion that remains with the current asset. For example, if I deposited $100 USD worth (10 receipt tokens), later that position is worth $500 and then I removed $100 (2 receipt tokens). Then the userPrincipalCostUsd would be 100 * (8/10) = 80 and exitedCostUsd would be 20. The $100 original investment is split up into $80 remaining with the current portion and $20 as the cost basis of the exited portion.
exitedValueUsd	In this transaction, the current value in USD of the withdrawn portion of the position. For example, if I deposited $100 USD worth (10 receipt tokens), later that position is worth $500 and then I removed $100 (2 receipt tokens). exitedValueUsd would be $100. The current value of each LP token is 500/10= 50 and I exited 2 LP tokens, so those 2 LP tokens have a total current value at the time of exit of $100.
exitedNetGainUsd	In this transaction, the net gain or loss for the exited portion of a position. Calculation: exitedNetGainUsd = exitedValueUsd - exitedCostUsd
exitedNetGainPct	In this transaction, this value is the net market gain in percentage (can be positive or negative) of the exited portion of a transaction. The total amount invested (in USD) in the exited asset by the user is exitedCostUsd. The total value of the exit is exitedValueUsd. Calculation: (exitedValueUsd - exitedCostUsd) / exitedCostUsd * 100
exitedCollectedIncomeUsd	The current value in USD of the withdrawn portion of the collected income to date. Example 1, a session has $10 in collected income (shown in the last collectedIncomeUsd) and there is a 100% exit. exitedCollectedIncomeUsd would be $10 Example 2 a session has $10 in collected income and $1 in pending income. There is a 100% exit and a withdraw & income operation collecting the pending income. exitedCollectedIncomeUsd would be $11 Example 3, a session has $10 in collected income and there is a 20% exit. exitedCollectedIncomeUsd would be $2 (and collectedIncomeUsd at that point would then be $8)
exitedIncomeAPY	The income APY of the exited session. Calculation: exitedCollectedIncomeUsd / exitedSessionLength * secondsInAYear / exitedCostUsd * 100 Note: In situations when pending income is not collected at time of exit then the APY for the active and exited session can be skewed with the pending income generated prior to the exit. Only happens if income is not collected at the time of an exit.
exitedRoiVsHodlUsd	exitedRoiVsHodlUsd compares the exited token value at the time of exit to the original token values at the time of deposit. Note: this is the impermanent (or permanent) loss (in USD) for user positions in protocols, where the income is separated from the underlying tokens (not compounding). Calculation: exitedValueUsd - exitedhodlValueUsd
exitedRoiVsHodlPct	exitedRoiVsHodlPct (percentage) value for the exited session. Note: this is the impermanent (or permanent) loss (in percentage) for user positions in protocols, where the income is separated from the underlying tokens (not compounding).
exitedHodlValueUsd	Hypothetical USD value if the user didn’t enter the position multiplied by the exit ratio. Calculation: hodlValueUsd * exitRatio
exitedIfHeldAllAmountBtcValueUsd	At a withdraw or transfer out this field preserves the value of IfHeldAllAmountBtcValueUsd (definition reference below) for the exited portion of the position at the time of the exit. In other words, this answers "For what I just withdrew, if instead of that position, what would I have in USD if that whole position was a BTC position in that same timeframe". IfHeldAllAmountBtcValueUsd: Hypothetical amount of tokens if the user held the full amount of the position in BTC. Additions to the position are converted to more BTC and added to the running ifHeldAllAmountBtc. Withdraws reduce the ifHeldAllAmountBtc by the same ratio as the portion of the position exited.
exitedIfHeldAllAmountEthValueUsd	At a withdraw or transfer out this field preserves the value of IfHeldAllAmountEthValueUsd (definition reference below) for the exited portion of the position at the time of the exit. In other words, this answers "For what I just withdrew, if instead of that position, what would I have in USD if that whole position was an ETH position in that same timeframe". IfHeldAllAmountEthValueUsd: Hypothetical amount of tokens if the user held the full amount of the position in Ether. Additions to the position are converted to more ETH and added to the running ifHeldAllAmountEth. Withdraws reduce the ifHeldAllAmountEth by the same ratio as the portion of the position exited.
warning	An array of fields with warnings related to data quality and potential problems with the data. Some examples would be issues getting a particular price for a specific token-chain-block combination.

Interval data tokens definitions - intervalDataTokens:

JSON field name	Further details
userPositionIntervalDataTokens	An array containing token-related metrics and data
tokenName	The token name
tokenAddress	The token address
tokenType	It can be Non Receipt or Receipt and Income
tag	If specified by the integration's developer, this field provides additional information on the token. By default, it is empty.
priceUsd	Price of the token at baseline date (at the end of the day)
priceSource	The source of the price
pendingIncomeAmount	The amount (and not USD) of the pending income tokens Note:pendingIncome is only reduced by collections, it's not automatically reduced when the principle asset is withdraw fully or partially.
collectedIncomeAmount	The amount of collected tokens
totalIncomeAmount	The pending income amount of tokens plus the amount of collected tokens (not a USD field) Calculation: totalIncomeAmount = pendingIncomeAmount + collectedIncomeAmount
cumulativeCollectedIncomeUsd	By token, sum of the USD value of withdrawn income priced at the time of collection within the current session. Partial exits will split this value using the exitRatio into part cumulativeCollectedIncomeUsd (active session) and partly to exitedCollectedIncomeAmountUsd (exited session). Note: income data is only available for user positions in protocols where the income is separated from the underlying tokens (not compounding).
dailyIncomeAmount	Amount in tokens of income earned since the previous end of day entry. In other words, the amount of tokens earned in the last 24 hours. Calculation: Today’s tokenIncomeAmount - yesterday’s tokenIncomeAmount
tokenAmountAtBlock	If user exits at this block, the token amount + pending tokens the user would get
tokenValueUsd	USD value of the token on a given day. Calculation: token price * the quantity of the tokens
isVirtualToken	Boolean field (true/false) that is false by default. This field is set to false when we can observe that the token has transferred definitively. In certain cases, however, token transfers happen outside of something that can be observed on-chain which is still useful to track. In those cases we create an entry for a token like this and set this field to true. Example 1: when a user unwraps wstEth to stEth we do not see a specific amount of WETH from the transaction logs, but we can derive an amount of WETH in the position based on other means, in this case based on the redemption rate of stEth to WETH Example 2: when a user is liquidated on a lending and borrowing platform, the liquidation might not be logged as an event but it would be useful to know what the amount in the token terms it would be. In that case we would set the isVirtualToken = true for an amount of tokens deducted from the user
ifHeldAmountToken	Hypothetical amount of tokens the user would have now if they had not deposited it, but instead just held it. Additional deposits of this token are added to the running total of ifHeldAmountToken. Withdraws reduce the ifHeldAmountToken by the same ratio as the overall portion of the position exited. This field is not provided for output tokens or any tokens if the netTokenAmount is less than zero.
ifHeldAllAmountToken	This is the amount of tokens the user would have if the value of the deposit events was converted all to this token at those points. At withdraws we use the exit ratio to reduce this value. Generally, we won’t provide this field for output tokens or any tokens if the netTokenAmount is less than zero.
ifHeldAllAmountTokenValueUsd	token value in USD which is ifHeldAllAmountToken* priceUsd Generally, we won’t provide this field for output tokens or any tokens if the netTokenAmount is less than zero.
exitedCumulativeCollectedIncomeAmount	The collected income amount is allocated proportionally to the exited session. For example: if I exited 50% of the position, then 50% of the collected income amount is allocated to the exited portion of the position. Note that this field is only applicable if the tokenType != Income Note that this field is only applicable if there was a withdraw or trasnfer_out operation
exitedCumulativeCollectedIncomeUsd	This is the USD value of the collected income amounts allocated to this exit. This uses the token price at each time of collection times the amount collected at that point. For example: if I exited 50% of the position, then 50% of the collected income (USD) is allocated to the exited portion of the position. Note that this field is only applicable if the tokenType != Income Note that this field is only applicable if there was a withdraw or trasnfer_out operation
exitedTokenAmount	In this transaction, the amount of the token exited. Note that this field is only applicable if the tokenType != (Receipt or Income) Note that this field is only applicable if there was a withdraw or transfer_out operation
warning	An array of fields with warnings related to data quality and potential problems with the data. Some examples would be issues getting a particular price for a specific token-chain-block combination.

Interval dependent data field definitions - intervalDependentData

JSON field name	Further details
intervalDependentData	This array incorporates daily income and APY metrics of the user's position.
identifier	A field to differentiate the position from other positions in the same protocol, often a contract address. A user can have multiple positions in the same protocol, but each position will have a unique positionIdentifier.
userAddress	User's wallet address.
date	Date of the data.
blockNumber	Block number the day data snapshot data is coming from
timestamp	Timestamp corresponding to the day data & block number
dailyIncomeUsd	The USD value of the income earned since the last end of day snapshot. Note: income data is only available for user positions in protocols where the income is separated from the underlying tokens (not compounding). Calculation: Today’s cumulative - yesterday’s cumulative
incomeApy1d	This is the income generated by the position based on the average open interest of the position. The income is the pending and also collected portion of the position. The xxd parameter refers to the APY based on the last xx days. Note: income APY data is only available for user positions in protocols, where the income is separated from the underlying tokens (not compounding). Example of incomeApy1d Given the price of this token is $2. Day 30 complete: - Collected Fees 25 ($50) - Pending Fees 50 ($100)Day 31 complete: - Collected Fees 25 ($50) - Pending Fees 52.5 ($105)Calculating incomeApy1d on day 32Total fees two days ago (Day 30) (not the most recent end-of-day data, but the one before that) in terms of token amounts (collected & pending) = 25 + 50 = 75Total fees yesterday (Day 31) = 25 + 52.5 = 77.5Total fees in our 1 day period = 77.5 - 75 = 2.5 (in token amount), then we can translate that into USD.Total fees USD in our 1 day period = 2.5 _ 2 = $5# number of 1 day periods in a year = 365 so annual income of $5 _ 365 = $1825Then compare that to the average open interest $1033.87, which is (1000 10) + (1050 21) / 311825 / 1033.87= 1.7652 * 100 = 176.52% APY (annualized yield of the income accrued yesterday) Or in other words, if all things remained constant, the position would yield 176.52% over 365 days
incomeApy7d	same as above, but for the past 7 days annualized
incomeApy14d	same as above, but for the past 14 days annualized
incomeApy30d	same as above, but for the past 30 days annualized
incomeApy60d	same as above, but for the past 60 days annualized
incomeApy90d	same as above, but for the past 90 days annualized
incomeApyInception	The APY from the last full exit until the present time of the snapshot. Or for an exited position, the APY from the second to last full exit.
warning	An array of fields with warnings related to data quality and potential problems with the data. Some examples would be issues getting a particular price for a specific token-chain-block combination.