💰Claimables

Find out whether an account has claimables waiting around. Claimables are any kind of on-chain actions an account can perform with positive outcome. Examples of this are yield that can be claimed.

Claimable markets represent a diverse array of opportunities within the cryptocurrency ecosystem where users can claim various forms of rewards or incentives. These markets are a fundamental aspect of decentralized finance (DeFi) platforms and protocols, offering participants the chance to earn additional tokens or benefits.

Claimables are actively claimable resources for a specific account.

The Claimables API

List all Claimables for a specific address

This endpoint allows you to concurrently fetch all supported claimables for a specific address.

Parameters to include or exclude are possible. The argument for these parameters are the protocol slugs

An example can be found here: https://claimables.decentri.fi/0xf18adf71266411FF39FfC268843c9A64b3292d86

Get Claimables for a specific address.

GET https://claimables.decentri.fi/{address}

This call gets all possible claimables for an address.

Path Parameters

Name	Type	Description
address*	String	address of the user

Query Parameters

Name	Type	Description
include	Array<String>	what protocols to include
exclude	Array<String>	what protocols to exclude

200: OK UserClaimableVO

[
  {
    "id": "string",
    "name": "string",
    "protocol": {
      "name": "string",
      "logo": "string",
      "slug": "string",
      "primitives": [
        "LENDING"
      ],
      "website": "string",
      "company": {
        "name": "string",
        "slug": "string"
      }
    },
    "network": {
      "name": "string",
      "logo": "string",
      "chainId": 0
    },
    "dollarValue": 0,
    "amount": 0,
    "token": {
      "network": {
        "name": "string",
        "logo": "string",
        "chainId": 0
      },
      "logo": "string",
      "name": "string",
      "symbol": "string",
      "address": "string",
      "decimals": 0,
      "type": "SINGLE",
      "totalSupply": 0,
      "underlyingTokens": [
        "string"
      ],
      "protocol": {
        "name": "string",
        "logo": "string",
        "slug": "string",
        "primitives": [
          "LENDING"
        ],
        "website": "string",
        "company": {
          "name": "string",
          "slug": "string"
        }
      }
    },
    "claimTransaction": {
      "network": {
        "name": "string",
        "logo": "string",
        "chainId": 0
      },
      "data": "string",
      "to": "string",
      "from": "string"
    }
  }
]

The Native Decentrifi API

Did you know you can also use the native API to get Claimables for specific protocols?

Fetch claimables pertaining to specific account for a protocol.

GET https://api.decentri.fi/{protocol}/{address}/claimables

Path Parameters

Name	Type	Description
protocol*	String	slug of the protocol
address*	String	address of the account

200: OK

[
  {
    "id": "3f71a866-1a4f-4a97-99cf-5aa670a8cacc",
    "name": "WETH/OP LP Gauge V2 reward",
    "type": "velodrome-reward",
    "protocol": {
      "name": "VELODROME_V2",
      "logo": "https://github.com/defitrack/data/raw/master/logo/protocol/velodrome.svg",
      "slug": "velodrome_v2",
      "primitives": [
        "POOLING",
        "FARMING"
      ],
      "website": "https://app.velodrome.finance",
      "company": {
        "name": "Velodrome",
        "slug": "velodrome"
      }
    },
    "network": {
      "name": "OPTIMISM",
      "logo": "https://github.com/defitrack/data/raw/master/logo/network/optimism.png",
      "chainId": 10
    },
    "dollarValue": 19.929648647161816,
    "amount": 254.2148754219806,
    "token": {
      "address": "0x9560e827af36c94d2ac33a39bce1fe78631088db",
      "name": "VelodromeV2",
      "decimals": 18,
      "symbol": "VELO",
      "logo": "https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/optimism/assets/0x9560e827aF36c94D2Ac33a39bCE1Fe78631088Db/logo.png",
      "type": "SINGLE",
      "totalSupply": 296514877005303546555804032
    },
    "claimTransaction": {
      "network": {
        "name": "OPTIMISM",
        "logo": "https://github.com/defitrack/data/raw/master/logo/network/optimism.png",
        "chainId": 10
      },
      "function": {
        "name": "getReward",
        "inputParameters": [
          {
            "value": "0xf18adf71266411ff39ffc268843c9a64b3292d86",
            "typeAsString": "address"
          }
        ],
        "outputParameters": []
      },
      "to": "0xcc53cd0a8ec812d46f0e2c7cc5aadd869b6f0292",
      "from": null,
      "data": "0xc00007b0000000000000000000000000f18adf71266411ff39ffc268843c9a64b3292d86"
    }
  },
  {
    "id": "76271ad2-99b3-454c-84f7-55db64019ef7",
    "name": "WETH/rETH LP Gauge V2 reward",
    "type": "velodrome-reward",
    "protocol": {
      "name": "VELODROME_V2",
      "logo": "https://github.com/defitrack/data/raw/master/logo/protocol/velodrome.svg",
      "slug": "velodrome_v2",
      "primitives": [
        "POOLING",
        "FARMING"
      ],
      "website": "https://app.velodrome.finance",
      "company": {
        "name": "Velodrome",
        "slug": "velodrome"
      }
    },
    "network": {
      "name": "OPTIMISM",
      "logo": "https://github.com/defitrack/data/raw/master/logo/network/optimism.png",
      "chainId": 10
    },
    "dollarValue": 0.5422478286164714,
    "amount": 6.916703181277941,
    "token": {
      "address": "0x9560e827af36c94d2ac33a39bce1fe78631088db",
      "name": "VelodromeV2",
      "decimals": 18,
      "symbol": "VELO",
      "logo": "https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/optimism/assets/0x9560e827aF36c94D2Ac33a39bCE1Fe78631088Db/logo.png",
      "type": "SINGLE",
      "totalSupply": 296514877005303546555804032
    },
    "claimTransaction": {
      "network": {
        "name": "OPTIMISM",
        "logo": "https://github.com/defitrack/data/raw/master/logo/network/optimism.png",
        "chainId": 10
      },
      "function": {
        "name": "getReward",
        "inputParameters": [
          {
            "value": "0xf18adf71266411ff39ffc268843c9a64b3292d86",
            "typeAsString": "address"
          }
        ],
        "outputParameters": []
      },
      "to": "0xd0e434831a765839051da9c0b9b99c6b0fb87201",
      "from": null,
      "data": "0xc00007b0000000000000000000000000f18adf71266411ff39ffc268843c9a64b3292d86"
    }
  }
]