Skip to content

Interface: iGetCollectionOwnersPayload

Only meaningful alongside tokenId. When true, the returned page is restricted to holders whose ownership currently covers now (active), excluding expired…

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/wrappers.ts:33

Properties

bookmark?

optional bookmark?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/wrappers.ts:34

oldestFirst?

optional oldestFirst?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/wrappers.ts:35

onlyActive?

optional onlyActive?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/wrappers.ts:47

Only meaningful alongside tokenId. When true, the returned page is restricted to holders whose ownership currently covers now (active), excluding expired holders.

tokenId?

optional tokenId?: NumberType

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/wrappers.ts:41

If set, filter owners to holders of this token ID (tier) server-side and include per-tier counts in the response. Enables tier-scoped views (e.g. subscriber management) to scale without paging every holder.

Edit this page on GitHub