rtClient.fundingGroups

Methods

rtClient.fundingGroups.listFundingGroups(params?)

List funding groups. Returns PaginatedResponse<FundingGroup> - unwrap data.items. Accepts FundingGroupListParams (search, status, includeBlacklisted, plus paging).

const res = await rtClient.fundingGroups.listFundingGroups();
const groups = res.data.items;

// Filter to a single status
const verified = await rtClient.fundingGroups.listFundingGroups({ status: "VERIFIED" });

status is a single FundingGroupStatus ('PENDING' | 'APPROVED' | 'VERIFIED' | 'REJECTED' | 'SUSPENDED'), not an array.

rtClient.fundingGroups.getFundingGroupById(id)

Get a single funding group by numeric id. Returns ApiResponse<FundingGroup>. To look one up by wallet, use getFundingGroupByAddress(stxAddress).

const { data: group } = await rtClient.fundingGroups.getFundingGroupById(3);
console.log(group.stxAddress);
console.log(group.status); // "APPROVED"

rtClient.fundingGroups.createFundingGroup(input) (operator)

Register a new funding group. Operator action - requires elevated privileges; also reachable via rtAdmin.fundingGroups.createFundingGroup.

const { data: group } = await rtClient.fundingGroups.createFundingGroup({
  name: "Rainforest Trust",
  description: "Protecting tropical rainforests",
  stxAddress: "SP...",
  website: "https://example.org",
});

rtClient.fundingGroups.updateFundingGroup(id, patch) (operator)

Patch a funding group, including its lifecycle status. There is no dedicated updateStatus method - pass status in the patch body.

await rtClient.fundingGroups.updateFundingGroup(groupId, { status: "APPROVED" });

See FundingGroupStatus for valid transitions. Also available: deleteFundingGroup(id). There is no per-group stats method; read what a group received from the ledger with rtClient.payments.