Create Projects

post

https://api.mintology.app/v1/projects

IMPORTANT: Call from the back-end.

Requires: API KEY in the header. Creates a new project under your account with the specified details.

Body Params

name

string

required

The name of your NFT project that is displayed on the Mintology dashboard. This cannot be changed once the contract is deployed.

description

string

required

The description of your NFT project.

mint_limit_per_address

number

This field represents the maximum number of NFTs that a single wallet can mint. It sets a limit to prevent any single wallet from minting an excessive number of NFTs. This limit should be less than or equal to the total supply of NFTs if the total supply is set.

contract_type

string

enum

required

Whether its a shared contract that multiple brands can mint under (no deployment costs), a dedicated contract you control and deploy, or an existing contract you've already deployed and used on another project. This cannot be changed once the contract is deployed.

Allowed:

wallet_type

string

enum

required

Select Non-custodial if you expect your users to already have a crypto wallet. Or if your users most likely don't have a crypto wallet, then select custodial. If a few users have a wallet, they can use their existing wallet and not need to create a custodial wallet.

Allowed:

base_uri

string

Base URI for metadata, if you want to use your own storage. If you leave this blank, we will handle this for you.

contract_name

string

required

The contract name that will appear in the blockchain. When creating the Project through Dashboard, this is set from the "name" parameter input. This is required if you select "Dedicated" as contract type. This cannot be changed once the contract is deployed.

symbol

string

The shortened term or ticker symbol unique to your contract (for example "XYZ"). This is required if you select "Dedicated" as contract type. This cannot be changed once the contract is deployed.

royalty

number

Royalty for secondary sales, in % - this uses ERC-2981 for on-chain royalties so that when any NFT is sold on a marketplace that supports on-chain royalties you will get this percentage of the sale. This cannot be changed once the contract is deployed.

total_supply

number

This is an optional field that specifies the total supply of your NFTs in your dedicated smart contract. You can provide the value if you choose dedicated smart contract or existing smart contracts as your contract type, This cannot be changed once the contract is deployed.. If you leave this empty, it will set unlimited number of NFTs that can be minted If you enter 100, only 100 NFTs can ever be minted under this contract.

contract_address

string

If you want to reuse one of your existing smart contract (example using the same contract that was created for a different project).

owner_address

string

This field is optional and is used when the contract type is set to "Dedicated". The user can provide their wallet address which will be set as the owner of the deployed smart contract. It's important that this address is not a public address of someone else, as it's like taking ownership of the contract. If left empty, Mintology's address will be set as the owner. Users can later request Mintology to transfer the ownership after the contract deployment.

network

number

enum

required

This is your network you want to deploy it to on Ethereum, your options are MAINNET = 1, SEPOLIA = 11155111 This cannot be changed once the contract is deployed.

Allowed:

chain

string

enum

required

The blockchain you want to use, either Ethereum or IMX. This cannot be changed once the contract is deployed.

Allowed:

total_volume

number

total_non_generative_premints

number

allow_claim_on_mintable

boolean

Responses

201

400Error

422Validation Failed