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.
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: Asset;
sponsor?: string;
claimant: string;
};
type GetClaimableBalancesResult = {
builder: ClaimableBalanceCallBuilder;
response: Horizon.ServerApi.CollectionPage<Horizon.ServerApi.ClaimableBalanceRecord>;
};Usage
import { core } from "@bluxcc/core";
const result = await core.getClaimableBalances({});