Get an Item's Holders

Use this method to get the holders of items.

Usage in your script

JavaScript

const response = await alturaItem.getHolders();

// customize options
const response = await alturaItem.getHolders({
  perPage: 20,
  page: 1,
  includeListed: false
});

const holders = response.holders;

TypeScript

const response: {holders: IAlturaUser[]} = await alturaItem.getHolders();

// customize options
const response: {holders: IAlturaUser[]} = await alturaItem.getHolders({
  perPage: 20,
  page: 1,
  includeListed: false
});

const holders = response.holders;

Parameters

Parameter	Type	Required	Description
perPage	number	Optional	The number of users to return
page	number	Optional	The offset for returned items. Calculated as (page - 1) * perPage
includeListed		Optional	If user's who have their item listed should be included (listed NFTs are still owned by the user, however on the blockchain they are held by a marketplace smart contract)boolean