Claimables

Did you know? We used the Claimables API to build our very own user-facing Claimables product at bankless.com/claimables. Enter your wallet to see this endpoint working in the real world!

Introduction

This endpoint returns a list of Claimables for a given wallet address, currently supporting EVM, Solana and Cosmos. Read our FAQs to learn more about what Claimables are.

GET /claimables/{address}

---

Response Parameters

Name	Type	Description
type	string	The type of claimable. Options are airdrop, reward, alert, governance-vote, poap, mint
walletAddress	string	The address of the wallet that can claim this asset.
supplier.name	string	The name of the company or protocol associated with the asset.
supplier.imageUrl	string	The URL of the image representing the company or protocol.
title	string	A title of the asset.
description	string	A description of the asset.
claimStatus	ClaimStatus	One of three options: claimed, unclaimed, expired
imageUrl	string	The URL of an image that represents the asset.
action	object	Information about the action available for this opportunity.
action.type	string	The type of action associated with the asset. Options: claim, vote, alert
action.url	string	The URL to take action on the asset.
worth.worthUSDFloat	number	The worth of the asset in USD as a float value.
worth.worthUSDString	string	The worth of the asset in USD as a string value.
worth.hasWorth	boolean	Indicates if the asset’s worth can be calculated in USD or not.
expires	number | null	The epoch date of when the asset expires
tokenAmount	number | undefined	Token amount the wallet is eligible for
tokenName	string | undefined	Token symbol
createdAt	number	Unix epoch in milliseconds for when the claimable was added

---

Example Request

curl 'https://api.bankless.com/claimables/0x469b33E0B70725184175750920AfD81B4BD94619'

---

Example Response

[
    {
        "type": "airdrop",
        "title": "Degen Season 1 Airdrop 2",
        "action": {
            "url": "https://www.degen.tips/airdrop2/season2",
            "onEarnifi": false,
            "type": "claim"
        },
        "claimStatus": "expired",
        "description": "Degen's second round of first season airdrops for users who tipped and received tips using $degen on Warpcast.",
        "walletAddress": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
        "supplier": {
            "name": "Degen",
            "imageUrl": "https://banklesspublic.b-cdn.net/claimables/9jrvP_yG_400x400.jpg"
        },
        "imageUrl": "https://banklesspublic.b-cdn.net/claimables/9jrvP_yG_400x400.jpg",
        "expires": 1711843200000,
        "tokenAmount": 568508,
        "tokenName": "DEGEN",
        "worth": {
            "worthUSDFloat": 12328,
            "worthUSDString": "$12,328",
            "hasWorthInUSD": true
        },
        "created": 1677628800000
    }
]

---

Permissions

This endpoint requires you to have the CLAIMABLES permission.

---

Real Use Cases

Here's some real life use cases of products and features using the Claimables API, in production today:

• Bankless.com/claimables - Claimables is the user-facing version of this API, fully utilising the exact same API documented here to deliver value to over 400,000 Bankless accounts, finding an average of over $800 worth of onchain value for Bankless accounts.

• Etherscan - Etherscan built an "Airdrops & Claimables" card to surface all of the unclaimed Claimables on individual wallet pages.

• Farcaster Frame - We harnessed the power of the Claimables API into a Farcaster Frame, unlocking real onchain value to numerous Farcaster users.