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.
Response Parameters
Name | Type | Description |
---|---|---|
type |
| The type of claimable. Options are |
walletAddress |
| The address of the wallet that can claim this asset. |
supplier.name |
| The name of the company or protocol associated with the asset. |
supplier.imageUrl |
| The URL of the image representing the company or protocol. |
title |
| A title of the asset. |
description |
| A description of the asset. |
claimStatus |
| One of three options: |
imageUrl |
| The URL of an image that represents the asset. |
action |
| Information about the action available for this opportunity. |
action.type |
| The type of action associated with the asset. Options: |
action.url |
| The URL to take action on the asset. |
worth.worthUSDFloat |
| The worth of the asset in USD as a float value. |
worth.worthUSDString |
| The worth of the asset in USD as a string value. |
worth.hasWorth |
| Indicates if the asset’s worth can be calculated in USD or not. |
expires |
| The epoch date of when the asset expires |
tokenAmount |
| Token amount the wallet is eligible for |
tokenName |
| Token symbol |
createdAt |
| Unix epoch in milliseconds for when the claimable was added |
Example Request
Example Response
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.
Last updated