Get Claimable Balances
Fetch a paginated list of claimable balances using the Blux core SDK.
The getClaimableBalances function returns a paginated list of claimable balances.
Both claimant and sponsor accept G…, M…, SEP-2 federation, or .xlm
names; see address resolution.
The return value contains two properties:
response— the records you can use directlybuilder— exposesnext()andprev()to paginate through results
Type
export type CallBuilderOptions = {
cursor?: string;
limit?: number;
network?: string;
order?: "asc" | "desc";
};
type GetClaimableBalancesOptions = CallBuilderOptions & {
asset: AssetArg;
sponsor?: string; // G…/M…, SEP-2 address, or .xlm name
claimant: string; // G…/M…, SEP-2 address, or .xlm name
};
type GetClaimableBalancesResult = {
builder: ClaimableBalanceCallBuilder;
response: Horizon.ServerApi.CollectionPage<Horizon.ServerApi.ClaimableBalanceRecord>;
};Usage
import { core } from "@bluxcc/core";
const result = await core.getClaimableBalances({
asset: "xlm",
claimant: "alice.xlm",
});