Skip to main content

NFT

Methods for creating and managing NFTs

CollectionTransactions

CollectionTransactions({
  tenantId,
  collectionId,
  filterOptions // optional
})

Retrieve information about transactions for the specified collection

Returns: Promise<Array> - A list of transactions matching the specified filters.

Parameters

NameTypeRequiredDescription
tenantIdstring

The ID of the tenant

collectionIdstring

The ID of the NFT collection containing the NFT

filterOptionsObject

Options for filtering transactions

(default: {})
filterOptions.emailstring

Filter transactions by email.

filterOptions.transactionIdstring

Filter transactions by transaction ID.

filterOptions.maxstring

The maximum number of transactions to return. Default is 500.

filterOptions.statusstring
  • Filter transactions by status. Allowed statuses are 'complete', 'failed' and (empty), meaning unprocessed.
filterOptions.fromOrdinalstring

The internal transaction ordinal to start from. Note that negative values are supported and are interpreted as meaning 'from the last current transaction'. Default is 0 - i.e. the beginning.

MintNFT

MintNFT({
  tenantId,
  address, // optional
  marketplaceId,
  items,
  extraData // optional
})

Mint NFTs for the specified user

Returns: Promise - An object containing the address for whom the NFT was minted and the transactionId of the minting request.

Parameters

NameTypeRequiredDescription
tenantIdstring

The ID of the tenant

addressstring

The address of the NFT recipient

marketplaceIdstring

The ID of the marketplace containing the NFT

itemsArray.<Object>

List of items

items.skustring

SKU of the NFT

items.quantitynumber

Number to mint

(default: 1)
items.tokenIdstring | Array.<string>

Custom token IDs for these items (must be unique).

items.extraDataObject

Additional data to put in the transaction

(default: {})
extraDataObject

Additional data to put in the transaction

(default: {})