Get Asset By Group

Return the list of assets given a group (key, value) pair. For example this can be used to get all assets in a collection.

Parameters

Name	Required	Description
`groupKey`	✅	The key of the group (e.g., `"collection"`).
`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", "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.

Example

getAssetByGroup Example

import { publicKey } from '@metaplex-foundation/umi';
import { createUmi } from '@metaplex-foundation/umi-bundle-defaults';
import { dasApi } from '@metaplex-foundation/digital-asset-standard-api';

const umi = createUmi('<ENDPOINT>').use(dasApi());

const assets = await umi.rpc.getAssetsByGroup({
    groupKey: 'collection',
    groupValue: 'J2ZfLdQsaZ3GCmbucJef3cPnPwGcgjDW1SSYtMdq3L9p',
});
console.log(assets.items.length > 0);