Methods & Playground
Get Assets By Group
Return the list of assets given a group (key, value) pair.
Use groupKey: "collection" to fetch assets in a Token Metadata or mpl-core collection. Use groupKey: "group" to fetch members of an mpl-core GroupV1 account — collections, assets, and nested groups that belong to the group.
To get the group name and member count without listing every asset, use getGrouping.
Parameters
| Name | Required | Description |
|---|---|---|
groupKey | ✅ | The key of the group (e.g., "collection" or "group" for mpl-core groups). |
groupValue | ✅ | The value of the group. |
sortBy | Sorting criteria. This is specified as an object { sortBy: <value>, sortDirection: <value> }, where sortBy is one of ["created", "updated", "recentAction", "id", "none"] and sortDirection is one of ["asc", "desc"] | |
limit | The maximum number of assets to retrieve. | |
page | The index of the "page" to retrieve. | |
before | Retrieve assets before the specified ID. | |
after | Retrieve assets after the specified ID. | |
options | Display options object. See Display Options for details. |