Get Grouping (Core Extension)

Summary

das.getGrouping returns summary metadata for a group key/value pair without listing every member.

• Returns group_key, group_name, and group_size
• Use groupKey: "collection" for collections or groupKey: "group" for GroupV1
• To list members, use getAssetsByGroup (Core) or the base DAS method

Code example

das.getGrouping takes the Umi instance and a GroupV1 address, and returns the group name and size without listing members.

1import { createUmi } from '@metaplex-foundation/umi-bundle-defaults'
2import { dasApi } from '@metaplex-foundation/digital-asset-standard-api'
3import { das } from '@metaplex-foundation/mpl-core-das'
4import { publicKey } from '@metaplex-foundation/umi'
5
6const umi = createUmi('<ENDPOINT>').use(dasApi())
7
8const grouping = await das.getGrouping(umi, {
9  groupKey: 'group',
10  groupValue: publicKey('<GroupPublicKey>'),
11})
12
13console.log(grouping.group_name, grouping.group_size)

Parameters

The helper accepts the Umi instance followed by an options object.

Notes

• group_size reflects what the indexer has recorded, not necessarily live on-chain vector lengths.
• Requires DAS client ≥ 2.1.0 and RPC support for getGrouping.