ClaimableRewardEntry

One reward token an account holds from one source, on the chain the claim runs on. Amounts are raw base-unit strings.

chainIdstring

Chain the CLAIM runs on (Merkl may distribute elsewhere than the position).

sourcestring

Possible values: [merkl, aave-incentives, flying-tulip, lista]

sourceIdstring

Example: merkl

token object

addressstring

EVM contract address, lowercase or checksummed hex.

symbolstring

Token symbol, e.g. WETH.

decimalsinteger

Token decimals — divide raw amounts by 10 ** decimals.

priceUsdnumber

claimablestring

Claimable now.

pendingstring

Accrued, not claimable yet (Merkl: waits for the next root).

claimedstring

Lifetime claimed (Merkl).

claimableUsdnumber

pendingUsdnumber

claimSupportedboolean

false when a dry run of the standard claim reverts — claim in the protocol app (see warning).

warningstring

breakdowns object[]

Array [

market object

The market a slice of a reward balance came from. Lending markets carry marketUid; vault-shaped deposits carry the share token in vault; Aave-fork incentives also name the aToken/vToken in reserveToken.

chainIdstring

EVM chain id, as a decimal string. See the ChainId schema.

Example: 1

marketUidstring

Market identifier, formatted lender:chainId:address.

Example: DOLOMITE:1:0x8d0d000ee44948fc98c9b98a4fa4921476f08b0d

lenderstring

Protocol identifier. See the LenderId schema.

underlyingstring

reserveTokenstring

vaultstring

sidestring

Possible values: [deposit, borrow]

amountstring

claimablestring

claimedstring

pendingstring

merklOpportunityIdstring

campaignIdstring

reasonstring

]

claim object

What the claim calls: merkl (Distributor), aave-incentives (controller + assets), flying-tulip (PositionsManager + assets + FT), lista (BNB Merkle distributor: program lending-v1 | lending | holder | velista-rebate | credit, shape single | multi, cumulative totalAmount, proof).

property name*any

ClaimableRewardEntry
{
  "chainId": "string",
  "source": "merkl",
  "sourceId": "merkl",
  "token": {
    "address": "string",
    "symbol": "string",
    "decimals": 0,
    "priceUsd": 0
  },
  "claimable": "string",
  "pending": "string",
  "claimed": "string",
  "claimableUsd": 0,
  "pendingUsd": 0,
  "claimSupported": true,
  "warning": "string",
  "breakdowns": [
    {
      "market": {
        "chainId": "1",
        "marketUid": "DOLOMITE:1:0x8d0d000ee44948fc98c9b98a4fa4921476f08b0d",
        "lender": "string",
        "underlying": "string",
        "reserveToken": "string",
        "vault": "string",
        "side": "deposit"
      },
      "amount": "string",
      "claimable": "string",
      "claimed": "string",
      "pending": "string",
      "merklOpportunityId": "string",
      "campaignId": "string",
      "reason": "string"
    }
  ],
  "claim": {}
}