Comment on page
🖼
Get User's Items
Use this method to get the items of a specific user.
JavaScript
TypeScript
const response = await alturaUser.getItems();
// customize options
const response = await alturaUser.getItems({
perPage: 20,
page: 1,
sortBy: 'mintDate',
sortDir: 'desc',
includeListed: false,
slim: true,
});
// filter documents by any properties
const response = await alturaUser.getItems(
{}, // default options
{
collectionAddress: "0xdb0047cb1dfc44696f6e9868ef6bb40000280b05"
} // fetching items with the specified collection address only
)
const items = response.items;
const itemCount = response.count;
const response: { items: IAlturaItem[], count: number } = await alturaUser.getItems();
// customize options
const response: {items: IAlturaItem[], count: number} = await alturaUser.getItems({
perPage: 20,
page: 1,
sortBy: 'mintDate',
sortDir: 'desc',
includeListed: false;
slim: true;
stateOnly: false;
});
// filter documents by any properties
const response: {items: IAlturaItem[], count: number} = await alturaUser.getItems(
{}, // default options
{
collectionAddress: "0xdb0047cb1dfc44696f6e9868ef6bb40000280b05"
} // fetching items with the specified collection address only
)
const items = response.items;
const itemCount = response.count;
Parameter | Type | Required | Description |
|---|---|---|---|
perPage | number | Optional | The number of items to return |
page | number | Optional | The offset for returned items. Calculated as (page - 1) * perPage |
sortBy | string | Optional | The field to sort the items by (any field in the item schema may be used) |
sortDir | asc' | 'desc' | Optional | Choose to sort in ascending (asc) or descending (desc) order |
includeLIsted | boolean | Optional | If the user's listed NFTs should be included (listed NFTs are still owned by the user, however on the blockchain they are held by a marketplace smart contract) |
slim | boolean | Optional | Returns a more condensed version of the items. Limits the item schema to: name, properties, tokenId, collectionAddress, supply, maxSupply, image, imageUrl, imageIndex, and imageCount |
Last modified 1yr ago