Interface INFTsApiGetOwnershipTokensRequest

interface INFTsApiGetOwnershipTokensRequest {
    allPages?: boolean;
    blockchainDescriptor?: GetOwnershipTokensBlockchainDescriptorEnum;
    collectionIds?: string;
    ids?: string;
    ncwAccountIds?: string;
    order?: GetOwnershipTokensOrderEnum;
    pageCursor?: string;
    pageSize?: number;
    search?: string;
    sort?: GetOwnershipTokensSortEnum[];
    spam?: GetOwnershipTokensSpamEnum;
    status?: GetOwnershipTokensStatusEnum;
    vaultAccountIds?: string;
}

Hierarchy

  • Omit<NFTsApiGetOwnershipTokensRequest, "ncwId" | "walletType">
    • INFTsApiGetOwnershipTokensRequest

Properties

allPages? blockchainDescriptor? collectionIds? ids? ncwAccountIds? order? pageCursor? pageSize? search? sort? spam? status? vaultAccountIds?

Properties

OptionalallPages

allPages?: boolean

Optional ReadonlyblockchainDescriptor

blockchainDescriptor?: GetOwnershipTokensBlockchainDescriptorEnum

Blockchain descriptor filter

Memberof

NFTsApiGetOwnershipTokens

Optional ReadonlycollectionIds

collectionIds?: string

A comma separated list of collection IDs. Up to 100 are allowed in a single request.

Memberof

NFTsApiGetOwnershipTokens

Optional Readonlyids

ids?: string

A comma separated list of NFT IDs. Up to 100 are allowed in a single request.

Memberof

NFTsApiGetOwnershipTokens

Optional ReadonlyncwAccountIds

ncwAccountIds?: string

A comma separated list of Non-Custodial account IDs. Up to 100 are allowed in a single request. This field will be ignored when walletType=VAULT_ACCOUNT or ncwId is not provided.

Memberof

NFTsApiGetOwnershipTokens

Optional Readonlyorder

order?: GetOwnershipTokensOrderEnum

Order direction, it can be `ASC` for ascending or `DESC` for descending

Memberof

NFTsApiGetOwnershipTokens

Optional ReadonlypageCursor

pageCursor?: string

Page cursor to fetch

Memberof

NFTsApiGetOwnershipTokens

Optional ReadonlypageSize

pageSize?: number

Items per page (max 100)

Memberof

NFTsApiGetOwnershipTokens

Optional Readonlysearch

search?: string

Search owned tokens and their collections. Possible criteria for search: token name and id within the contract/collection, collection name, blockchain descriptor and name.

Memberof

NFTsApiGetOwnershipTokens

Optional Readonlysort

sort?: GetOwnershipTokensSortEnum[]

Sort by param, it can be one param or a list of params separated by comma

Memberof

NFTsApiGetOwnershipTokens

Optional Readonlyspam

spam?: GetOwnershipTokensSpamEnum

Token ownership spam status.

Memberof

NFTsApiGetOwnershipTokens

Optional Readonlystatus

status?: GetOwnershipTokensStatusEnum

Token ownership status

Memberof

NFTsApiGetOwnershipTokens

Optional ReadonlyvaultAccountIds

vaultAccountIds?: string

A comma separated list of Vault Account IDs. Up to 100 are allowed in a single request. This field will be ignored when walletType=END_USER_WALLET or ncwId is provided.

Memberof

NFTsApiGetOwnershipTokens

Settings

Member Visibility

On This Page

Properties