Deploy a new NFT Collection contract.

POST 
https://minatokens.com/api/v1//nft/launch

The launch endpoint is used to deploy a new NFT Collection on the Mina blockchain. It allows users to create a new NFT Collection with customizable parameters.

Request

application/json

Bodyrequired

oneOf
LaunchNftCollectionStandardAdminParams
txTypeNftTransactionType (string)
Must be "nft:launch"
Possible values: [nft:launch]
collectionAddressstring
Optional. The address of the collection.
nftAddressstring
Optional. The address of the NFT.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
adminContractstringrequired
Must be "standard" for standard admin contract.
Possible values: [standard]
symbolstring
The symbol of the NFT collection. Use NFT as a default value.
urluri
The URL of the NFT collection.
collectionNamestringrequired
The name of the NFT collection.
creatorstring
The creator of the NFT collection. Should be the public key of the creator starting with B62.
baseURLuri
The base URL of the NFT collection, can be 'ipfs' or url with or without https://. Default is 'ipfs'.
collectionData object
royaltyFeeint32
The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%)
transferFeeint64
The transfer fee amount
requireTransferApprovalboolean
If true, transferring NFTs requires approval from the admin contract
mintingIsLimitedboolean
If true, the minting is stopped and cannot be resumed
isPausedboolean
Indicates whether the collection is currently paused
masterNFT objectrequired
namestringrequired
The name of the NFT
addressstring
The address of the NFT contract
addressPrivateKeystring
The private key of the NFT contract
tokenIdint64
The token ID of the NFT
data objectrequired
The data associated with the NFT, including owner, approved, version, id, permissions and flags
ownerstringrequired
The public key of the owner of the NFT
approvedstring
The public key of the approved address of the NFT
versionint32
The version number of the NFT state
idstring
The unique identifier of the NFT within the collection. A bigint encoded as a string.
canChangeOwnerByProofboolean
Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly)
canTransferboolean
Specifies if the NFT's ownership can be transferred (readonly)
canApproveboolean
Specifies if the NFT's approved address can be changed (readonly)
canChangeMetadataboolean
Indicates whether the NFT's metadata can be updated (readonly)
canChangeStorageboolean
Determines whether the storage associated with the NFT can be altered (readonly)
canChangeNameboolean
Specifies if the name of the NFT can be changed (readonly)
canChangeMetadataVerificationKeyHashboolean
Indicates whether the verification key hash for the metadata can be changed (readonly)
canPauseboolean
Specifies if the NFT contract can be paused, preventing certain operations (readonly)
isPausedboolean
Indicates whether the NFT contract is currently paused
requireOwnerAuthorizationToUpgradeboolean
Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly)
feeint64
The fee associated with minting the NFT
metadata objectrequired
The metadata associated with the NFT, Field as a string or NftMetadata object
oneOf
MOD1
string
NftMetadata
namestringrequired
The name of the NFT
imagestringrequired
The image URL or IPFS hash associated with the NFT
descriptionstring
Optional description of the NFT
bannerstring
Optional banner image URL or IPFS hash. Required for Collection Master NFT.
traits object[]
Array [
keystringrequired
The trait key/name
typestringrequired
The type of the trait value
Possible values: [string, text, image, url, field, number, address, map, tree]
value objectrequired
The trait value, can be a string or complex object depending on type
oneOf
MOD1
string
MOD2
object
isPrivateboolean
Optional flag indicating if this trait is private
]
storagestring
The off-chain storage information (e.g., IPFS hash)
metadataVerificationKeyHashstring
The hash of the verification key used for metadata proofs, Field as a string
expiryint32
The expiry time slot for minting the NFT
adminContractAddressstring
Optional. The address of the admin contract.
collectionContractPrivateKeystring
Optional. Private key for the collection contract.
adminContractPrivateKeystring
Optional. Private key for the admin contract.
LaunchNftCollectionAdvancedAdminParams
txTypeNftTransactionType (string)
Must be "nft:launch"
Possible values: [nft:launch]
collectionAddressstring
Optional. The address of the collection.
nftAddressstring
Optional. The address of the NFT.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
adminContractstringrequired
Must be "advanced" for advanced admin contract.
Possible values: [advanced]
symbolstring
The symbol of the NFT collection. Use NFT as a default value.
urluri
The URL of the NFT collection.
collectionNamestringrequired
The name of the NFT collection.
creatorstring
The creator of the NFT collection. Should be the public key of the creator starting with B62.
baseURLuri
The base URL of the NFT collection, can be 'ipfs' or url with or without https://. Default is 'ipfs'.
collectionData object
royaltyFeeint32
The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%)
transferFeeint64
The transfer fee amount
requireTransferApprovalboolean
If true, transferring NFTs requires approval from the admin contract
mintingIsLimitedboolean
If true, the minting is stopped and cannot be resumed
isPausedboolean
Indicates whether the collection is currently paused
masterNFT objectrequired
namestringrequired
The name of the NFT
addressstring
The address of the NFT contract
addressPrivateKeystring
The private key of the NFT contract
tokenIdint64
The token ID of the NFT
data objectrequired
The data associated with the NFT, including owner, approved, version, id, permissions and flags
ownerstringrequired
The public key of the owner of the NFT
approvedstring
The public key of the approved address of the NFT
versionint32
The version number of the NFT state
idstring
The unique identifier of the NFT within the collection. A bigint encoded as a string.
canChangeOwnerByProofboolean
Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly)
canTransferboolean
Specifies if the NFT's ownership can be transferred (readonly)
canApproveboolean
Specifies if the NFT's approved address can be changed (readonly)
canChangeMetadataboolean
Indicates whether the NFT's metadata can be updated (readonly)
canChangeStorageboolean
Determines whether the storage associated with the NFT can be altered (readonly)
canChangeNameboolean
Specifies if the name of the NFT can be changed (readonly)
canChangeMetadataVerificationKeyHashboolean
Indicates whether the verification key hash for the metadata can be changed (readonly)
canPauseboolean
Specifies if the NFT contract can be paused, preventing certain operations (readonly)
isPausedboolean
Indicates whether the NFT contract is currently paused
requireOwnerAuthorizationToUpgradeboolean
Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly)
feeint64
The fee associated with minting the NFT
metadata objectrequired
The metadata associated with the NFT, Field as a string or NftMetadata object
oneOf
MOD1
string
NftMetadata
namestringrequired
The name of the NFT
imagestringrequired
The image URL or IPFS hash associated with the NFT
descriptionstring
Optional description of the NFT
bannerstring
Optional banner image URL or IPFS hash. Required for Collection Master NFT.
traits object[]
Array [
keystringrequired
The trait key/name
typestringrequired
The type of the trait value
Possible values: [string, text, image, url, field, number, address, map, tree]
value objectrequired
The trait value, can be a string or complex object depending on type
oneOf
MOD1
string
MOD2
object
isPrivateboolean
Optional flag indicating if this trait is private
]
storagestring
The off-chain storage information (e.g., IPFS hash)
metadataVerificationKeyHashstring
The hash of the verification key used for metadata proofs, Field as a string
expiryint32
The expiry time slot for minting the NFT
adminContractAddressstring
Optional. The address of the admin contract.
collectionContractPrivateKeystring
Optional. Private key for the collection contract.
adminContractPrivateKeystring
Optional. Private key for the admin contract.
upgradeAuthoritystringrequired
The address of the upgrade authority contract
adminData object
The admin data for the NFT collection
canPauseboolean
Indicates whether the contract can be paused
isPausedboolean
Indicates whether the contract is currently paused
allowChangeRoyaltyboolean
Indicates whether the contract can change the royalty fee
allowChangeTransferFeeboolean
Indicates whether the contract can change the transfer fee
allowChangeBaseUriboolean
Indicates whether the contract can change the base URI
allowChangeCreatorboolean
Indicates whether the contract can change the creator
allowChangeAdminboolean
Indicates whether the contract can change the admin
allowChangeNameboolean
Indicates whether the contract can change the name
whitelist object
Optional. List of whitelisted addresses with optional amounts, or a string.
oneOf
MOD1
Array [
addressstringrequired
The whitelisted address.
amountdouble
Optional. The amount allowed to bid.
]
MOD2
string

Responses

200

Successful deployment of a new NFT Collection.

application/json

Schema

Schema

senderstringrequired

The address initiating the transaction.

nonceint64required

The nonce for the transaction.

memostringrequired

A memo for the transaction.

feedoublerequired

The fee for the transaction.

walletPayload objectrequired

nonceint64

The nonce for the transaction.

transactionstring

The transaction data.

onlySignboolean

Indicates if only signature is needed.

feePayer object

feedouble

The fee for the transaction.

memostring

A memo for the transaction.

minaSignerPayload objectrequired

zkappCommand objectrequired

The zkApp command data.

property name*any

The zkApp command data.

feePayer objectrequired

feePayerstring

The fee payer's address.

feedouble

The fee for the transaction.

nonceint64

The nonce for the transaction.

memostring

A memo for the transaction.

proverPayloadstringrequired

The payload for the prover.

signedDatastringrequired

The signed data for the transaction.

transactionstringrequired

The raw transaction data.

sendTransactionboolean

Optional. Whether to broadcast the transaction after proving.

symbolstringrequired

The symbol of the NFT collection.

collectionNamestringrequired

The name of the NFT collection.

nftNamestringrequired

The name of the NFT.

storagestring

The storage of the NFT (IPFS hash).

privateMetadatastring

The private metadata of the NFT.

metadataRootstring

The metadata root of the NFT.

mapobject

The serialized metadata map of the NFT.

request objectrequired

oneOf

LaunchNftCollectionStandardAdminParams

txTypeNftTransactionType (string)

Must be "nft:launch"

Possible values: [nft:launch]

collectionAddressstring

Optional. The address of the collection.

nftAddressstring

Optional. The address of the NFT.

senderstringrequired

The address (public key) of the sender.

senderPrivateKeystring

The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.

nonceint64

Optional. The nonce for the transaction.

memostring

Optional. A memo for the transaction.

developerFeedouble

Optional. The developer fee for the transaction.

adminContractstringrequired

Must be "standard" for standard admin contract.

Possible values: [standard]

symbolstring

The symbol of the NFT collection. Use NFT as a default value.

urluri

The URL of the NFT collection.

collectionNamestringrequired

The name of the NFT collection.

creatorstring

The creator of the NFT collection. Should be the public key of the creator starting with B62.

baseURLuri

The base URL of the NFT collection, can be 'ipfs' or url with or without https://. Default is 'ipfs'.

collectionData object

royaltyFeeint32

The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%)

transferFeeint64

The transfer fee amount

requireTransferApprovalboolean

If true, transferring NFTs requires approval from the admin contract

mintingIsLimitedboolean

If true, the minting is stopped and cannot be resumed

isPausedboolean

Indicates whether the collection is currently paused

masterNFT objectrequired

namestringrequired

The name of the NFT

addressstring

The address of the NFT contract

addressPrivateKeystring

The private key of the NFT contract

tokenIdint64

The token ID of the NFT

data objectrequired

The data associated with the NFT, including owner, approved, version, id, permissions and flags

ownerstringrequired

The public key of the owner of the NFT

approvedstring

The public key of the approved address of the NFT

versionint32

The version number of the NFT state

idstring

The unique identifier of the NFT within the collection. A bigint encoded as a string.

canChangeOwnerByProofboolean

Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly)

canTransferboolean

Specifies if the NFT's ownership can be transferred (readonly)

canApproveboolean

Specifies if the NFT's approved address can be changed (readonly)

canChangeMetadataboolean

Indicates whether the NFT's metadata can be updated (readonly)

canChangeStorageboolean

Determines whether the storage associated with the NFT can be altered (readonly)

canChangeNameboolean

Specifies if the name of the NFT can be changed (readonly)

canChangeMetadataVerificationKeyHashboolean

Indicates whether the verification key hash for the metadata can be changed (readonly)

canPauseboolean

Specifies if the NFT contract can be paused, preventing certain operations (readonly)

isPausedboolean

Indicates whether the NFT contract is currently paused

requireOwnerAuthorizationToUpgradeboolean

Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly)

feeint64

The fee associated with minting the NFT

metadata objectrequired

The metadata associated with the NFT, Field as a string or NftMetadata object

oneOf

MOD1

string

NftMetadata

namestringrequired

The name of the NFT

imagestringrequired

The image URL or IPFS hash associated with the NFT

descriptionstring

Optional description of the NFT

bannerstring

Optional banner image URL or IPFS hash. Required for Collection Master NFT.

traits object[]

Array [

keystringrequired

The trait key/name

typestringrequired

The type of the trait value

Possible values: [string, text, image, url, field, number, address, map, tree]

value objectrequired

The trait value, can be a string or complex object depending on type

oneOf

MOD1

string

MOD2

object

isPrivateboolean

Optional flag indicating if this trait is private

]

storagestring

The off-chain storage information (e.g., IPFS hash)

metadataVerificationKeyHashstring

The hash of the verification key used for metadata proofs, Field as a string

expiryint32

The expiry time slot for minting the NFT

adminContractAddressstring

Optional. The address of the admin contract.

collectionContractPrivateKeystring

Optional. Private key for the collection contract.

adminContractPrivateKeystring

Optional. Private key for the admin contract.

LaunchNftCollectionAdvancedAdminParams

txTypeNftTransactionType (string)

Must be "nft:launch"

Possible values: [nft:launch]

collectionAddressstring

Optional. The address of the collection.

nftAddressstring

Optional. The address of the NFT.

senderstringrequired

The address (public key) of the sender.

senderPrivateKeystring

The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.

nonceint64

Optional. The nonce for the transaction.

memostring

Optional. A memo for the transaction.

developerFeedouble

Optional. The developer fee for the transaction.

adminContractstringrequired

Must be "advanced" for advanced admin contract.

Possible values: [advanced]

symbolstring

The symbol of the NFT collection. Use NFT as a default value.

urluri

The URL of the NFT collection.

collectionNamestringrequired

The name of the NFT collection.

creatorstring

The creator of the NFT collection. Should be the public key of the creator starting with B62.

baseURLuri

The base URL of the NFT collection, can be 'ipfs' or url with or without https://. Default is 'ipfs'.

collectionData object

royaltyFeeint32

The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%)

transferFeeint64

The transfer fee amount

requireTransferApprovalboolean

If true, transferring NFTs requires approval from the admin contract

mintingIsLimitedboolean

If true, the minting is stopped and cannot be resumed

isPausedboolean

Indicates whether the collection is currently paused

masterNFT objectrequired

namestringrequired

The name of the NFT

addressstring

The address of the NFT contract

addressPrivateKeystring

The private key of the NFT contract

tokenIdint64

The token ID of the NFT

data objectrequired

The data associated with the NFT, including owner, approved, version, id, permissions and flags

ownerstringrequired

The public key of the owner of the NFT

approvedstring

The public key of the approved address of the NFT

versionint32

The version number of the NFT state

idstring

The unique identifier of the NFT within the collection. A bigint encoded as a string.

canChangeOwnerByProofboolean

Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly)

canTransferboolean

Specifies if the NFT's ownership can be transferred (readonly)

canApproveboolean

Specifies if the NFT's approved address can be changed (readonly)

canChangeMetadataboolean

Indicates whether the NFT's metadata can be updated (readonly)

canChangeStorageboolean

Determines whether the storage associated with the NFT can be altered (readonly)

canChangeNameboolean

Specifies if the name of the NFT can be changed (readonly)

canChangeMetadataVerificationKeyHashboolean

Indicates whether the verification key hash for the metadata can be changed (readonly)

canPauseboolean

Specifies if the NFT contract can be paused, preventing certain operations (readonly)

isPausedboolean

Indicates whether the NFT contract is currently paused

requireOwnerAuthorizationToUpgradeboolean

Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly)

feeint64

The fee associated with minting the NFT

metadata objectrequired

The metadata associated with the NFT, Field as a string or NftMetadata object

oneOf

MOD1

string

NftMetadata

namestringrequired

The name of the NFT

imagestringrequired

The image URL or IPFS hash associated with the NFT

descriptionstring

Optional description of the NFT

bannerstring

Optional banner image URL or IPFS hash. Required for Collection Master NFT.

traits object[]

Array [

keystringrequired

The trait key/name

typestringrequired

The type of the trait value

Possible values: [string, text, image, url, field, number, address, map, tree]

value objectrequired

The trait value, can be a string or complex object depending on type

oneOf

MOD1

string

MOD2

object

isPrivateboolean

Optional flag indicating if this trait is private

]

storagestring

The off-chain storage information (e.g., IPFS hash)

metadataVerificationKeyHashstring

The hash of the verification key used for metadata proofs, Field as a string

expiryint32

The expiry time slot for minting the NFT

adminContractAddressstring

Optional. The address of the admin contract.

collectionContractPrivateKeystring

Optional. Private key for the collection contract.

adminContractPrivateKeystring

Optional. Private key for the admin contract.

upgradeAuthoritystringrequired

The address of the upgrade authority contract

adminData object

The admin data for the NFT collection

canPauseboolean

Indicates whether the contract can be paused

isPausedboolean

Indicates whether the contract is currently paused

allowChangeRoyaltyboolean

Indicates whether the contract can change the royalty fee

allowChangeTransferFeeboolean

Indicates whether the contract can change the transfer fee

allowChangeBaseUriboolean

Indicates whether the contract can change the base URI

allowChangeCreatorboolean

Indicates whether the contract can change the creator

allowChangeAdminboolean

Indicates whether the contract can change the admin

allowChangeNameboolean

Indicates whether the contract can change the name

whitelist object

Optional. List of whitelisted addresses with optional amounts, or a string.

oneOf

MOD1

Array [

addressstringrequired

The whitelisted address.

amountdouble

Optional. The amount allowed to bid.

]

MOD2

string

NftMintTransactionParams

txTypeNftTransactionType (string)required

Must be "nft:mint"

Possible values: [nft:mint]

collectionAddressstringrequired

The address of the NFT collection.

nftAddressstring

Optional. The address of the NFT.

senderstringrequired

The address (public key) of the sender.

senderPrivateKeystring

The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.

nonceint64

Optional. The nonce for the transaction.

memostring

Optional. A memo for the transaction.

developerFeedouble

Optional. The developer fee for the transaction.

nftMintParams objectrequired

namestringrequired

The name of the NFT

addressstring

The address of the NFT contract

addressPrivateKeystring

The private key of the NFT contract

tokenIdint64

The token ID of the NFT

data objectrequired

The data associated with the NFT, including owner, approved, version, id, permissions and flags

ownerstringrequired

The public key of the owner of the NFT

approvedstring

The public key of the approved address of the NFT

versionint32

The version number of the NFT state

idstring

The unique identifier of the NFT within the collection. A bigint encoded as a string.

canChangeOwnerByProofboolean

Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly)

canTransferboolean

Specifies if the NFT's ownership can be transferred (readonly)

canApproveboolean

Specifies if the NFT's approved address can be changed (readonly)

canChangeMetadataboolean

Indicates whether the NFT's metadata can be updated (readonly)

canChangeStorageboolean

Determines whether the storage associated with the NFT can be altered (readonly)

canChangeNameboolean

Specifies if the name of the NFT can be changed (readonly)

canChangeMetadataVerificationKeyHashboolean

Indicates whether the verification key hash for the metadata can be changed (readonly)

canPauseboolean

Specifies if the NFT contract can be paused, preventing certain operations (readonly)

isPausedboolean

Indicates whether the NFT contract is currently paused

requireOwnerAuthorizationToUpgradeboolean

Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly)

feeint64

The fee associated with minting the NFT

metadata objectrequired

The metadata associated with the NFT, Field as a string or NftMetadata object

oneOf

MOD1

string

NftMetadata

namestringrequired

The name of the NFT

imagestringrequired

The image URL or IPFS hash associated with the NFT

descriptionstring

Optional description of the NFT

bannerstring

Optional banner image URL or IPFS hash. Required for Collection Master NFT.

traits object[]

Array [

keystringrequired

The trait key/name

typestringrequired

The type of the trait value

Possible values: [string, text, image, url, field, number, address, map, tree]

value objectrequired

The trait value, can be a string or complex object depending on type

oneOf

MOD1

string

MOD2

object

isPrivateboolean

Optional flag indicating if this trait is private

]

storagestring

The off-chain storage information (e.g., IPFS hash)

metadataVerificationKeyHashstring

The hash of the verification key used for metadata proofs, Field as a string

expiryint32

The expiry time slot for minting the NFT

NftSellTransactionParams

txTypeNftTransactionType (string)required

Must be "nft:sell"

Possible values: [nft:sell]

collectionAddressstringrequired

The address of the NFT collection.

nftAddressstringrequired

The address of the NFT.

senderstringrequired

The address (public key) of the sender.

senderPrivateKeystring

The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.

nonceint64

Optional. The nonce for the transaction.

memostring

Optional. A memo for the transaction.

developerFeedouble

Optional. The developer fee for the transaction.

nftSellParams objectrequired

pricenumberrequired

The price of the NFT

offerAddressstring

The address of the offer contract

offerPrivateKeystring

The private key of the offer contract

NftBuyTransactionParams

txTypeNftTransactionType (string)required

Must be "nft:buy"

Possible values: [nft:buy]

collectionAddressstringrequired

The address of the NFT collection.

nftAddressstringrequired

The address of the NFT.

senderstringrequired

The address (public key) of the sender.

senderPrivateKeystring

The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.

nonceint64

Optional. The nonce for the transaction.

memostring

Optional. A memo for the transaction.

developerFeedouble

Optional. The developer fee for the transaction.

nftBuyParams objectrequired

buyerstring

The address of the buyer

NftTransferTransactionParams

txTypeNftTransactionType (string)required

Must be "nft:transfer"

Possible values: [nft:transfer]

collectionAddressstringrequired

The address of the NFT collection.

nftAddressstringrequired

The address of the NFT.

senderstringrequired

The address (public key) of the sender.

senderPrivateKeystring

The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.

nonceint64

Optional. The nonce for the transaction.

memostring

Optional. A memo for the transaction.

developerFeedouble

Optional. The developer fee for the transaction.

nftTransferParams objectrequired

fromstringrequired

The address of the owner or approved

tostringrequired

The address of the recipient

pricenumber

The price of the NFT being transferred

requireApprovalboolean

If true, the transfer requires approval from the admin contract

context object

The custom context for the transfer

customstring[]

The custom context for the transfer, 3 Fields

NftApproveTransactionParams

txTypeNftTransactionType (string)required

Must be "nft:approve"

Possible values: [nft:approve]

collectionAddressstringrequired

The address of the NFT collection.

nftAddressstringrequired

The address of the NFT.

senderstringrequired

The address (public key) of the sender.

senderPrivateKeystring

The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.

nonceint64

Optional. The nonce for the transaction.

memostring

Optional. A memo for the transaction.

developerFeedouble

Optional. The developer fee for the transaction.

nftApproveParams objectrequired

tostring

The address of the recipient. If not provided, the existing approval will be removed.

Example (auto)

{
  "sender": "string",
  "nonce": 0,
  "memo": "string",
  "fee": 0,
  "walletPayload": {
    "nonce": 0,
    "transaction": "string",
    "onlySign": true,
    "feePayer": {
      "fee": 0,
      "memo": "string"
    }
  },
  "minaSignerPayload": {
    "zkappCommand": {},
    "feePayer": {
      "feePayer": "string",
      "fee": 0,
      "nonce": 0,
      "memo": "string"
    }
  },
  "proverPayload": "string",
  "signedData": "string",
  "transaction": "string",
  "sendTransaction": true,
  "symbol": "string",
  "collectionName": "string",
  "nftName": "string",
  "storage": "string",
  "privateMetadata": "string",
  "metadataRoot": "string",
  "map": {},
  "request": {
    "txType": "nft:launch",
    "collectionAddress": "string",
    "nftAddress": "string",
    "sender": "string",
    "senderPrivateKey": "string",
    "nonce": 0,
    "memo": "string",
    "developerFee": 0,
    "adminContract": "standard",
    "symbol": "string",
    "url": "string",
    "collectionName": "string",
    "creator": "string",
    "baseURL": "string",
    "collectionData": {
      "royaltyFee": 0,
      "transferFee": 0,
      "requireTransferApproval": true,
      "mintingIsLimited": true,
      "isPaused": true
    },
    "masterNFT": {
      "name": "string",
      "address": "string",
      "addressPrivateKey": "string",
      "tokenId": 0,
      "data": {
        "owner": "string",
        "approved": "string",
        "version": 0,
        "id": "string",
        "canChangeOwnerByProof": true,
        "canTransfer": true,
        "canApprove": true,
        "canChangeMetadata": true,
        "canChangeStorage": true,
        "canChangeName": true,
        "canChangeMetadataVerificationKeyHash": true,
        "canPause": true,
        "isPaused": true,
        "requireOwnerAuthorizationToUpgrade": true
      },
      "fee": 0,
      "metadata": "string",
      "storage": "string",
      "metadataVerificationKeyHash": "string",
      "expiry": 0
    },
    "adminContractAddress": "string",
    "collectionContractPrivateKey": "string",
    "adminContractPrivateKey": "string"
  }
}

400

Bad request - invalid input parameters.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

401

Unauthorized - user not authenticated.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

403

Forbidden - user doesn't have permission.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

429

Too many requests.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

500

Internal server error - something went wrong during the request.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

503

Service unavailable - blockchain or other external service is down.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

Authorization: x-api-key

name: x-api-keytype: apiKeyin: headerdescription: API key for authorization. Get your API key at https://minatokens.com/api

• curl
• javascript
• nodejs
• python
• rust
• ocaml
• go
• java
• powershell

• CURL

curl -L 'https://minatokens.com/api/v1/nft/launch' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-api-key: <x-api-key>' \
-d '{
  "txType": "nft:launch",
  "collectionAddress": "string",
  "nftAddress": "string",
  "sender": "string",
  "senderPrivateKey": "string",
  "nonce": 0,
  "memo": "string",
  "developerFee": 0,
  "adminContract": "standard",
  "symbol": "string",
  "url": "string",
  "collectionName": "string",
  "creator": "string",
  "baseURL": "string",
  "collectionData": {
    "royaltyFee": 0,
    "transferFee": 0,
    "requireTransferApproval": true,
    "mintingIsLimited": true,
    "isPaused": true
  },
  "masterNFT": {
    "name": "string",
    "address": "string",
    "addressPrivateKey": "string",
    "tokenId": 0,
    "data": {
      "owner": "string",
      "approved": "string",
      "version": 0,
      "id": "string",
      "canChangeOwnerByProof": true,
      "canTransfer": true,
      "canApprove": true,
      "canChangeMetadata": true,
      "canChangeStorage": true,
      "canChangeName": true,
      "canChangeMetadataVerificationKeyHash": true,
      "canPause": true,
      "isPaused": true,
      "requireOwnerAuthorizationToUpgrade": true
    },
    "fee": 0,
    "metadata": "string",
    "storage": "string",
    "metadataVerificationKeyHash": "string",
    "expiry": 0
  },
  "adminContractAddress": "string",
  "collectionContractPrivateKey": "string",
  "adminContractPrivateKey": "string"
}'

Request Collapse all

Base URL

https://minatokens.com/api/v1

Auth

ApiKeyAuth

Body required

{
  "txType": "nft:launch",
  "collectionAddress": "string",
  "nftAddress": "string",
  "sender": "string",
  "senderPrivateKey": "string",
  "nonce": 0,
  "memo": "string",
  "developerFee": 0,
  "adminContract": "standard",
  "symbol": "string",
  "url": "string",
  "collectionName": "string",
  "creator": "string",
  "baseURL": "string",
  "collectionData": {
    "royaltyFee": 0,
    "transferFee": 0,
    "requireTransferApproval": true,
    "mintingIsLimited": true,
    "isPaused": true
  },
  "masterNFT": {
    "name": "string",
    "address": "string",
    "addressPrivateKey": "string",
    "tokenId": 0,
    "data": {
      "owner": "string",
      "approved": "string",
      "version": 0,
      "id": "string",
      "canChangeOwnerByProof": true,
      "canTransfer": true,
      "canApprove": true,
      "canChangeMetadata": true,
      "canChangeStorage": true,
      "canChangeName": true,
      "canChangeMetadataVerificationKeyHash": true,
      "canPause": true,
      "isPaused": true,
      "requireOwnerAuthorizationToUpgrade": true
    },
    "fee": 0,
    "metadata": "string",
    "storage": "string",
    "metadataVerificationKeyHash": "string",
    "expiry": 0
  },
  "adminContractAddress": "string",
  "collectionContractPrivateKey": "string",
  "adminContractPrivateKey": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!