# Mints

## Mint Actions

The Mints APIs provide three methods to help users mint NFTs, including the custom minting, minting with a file and minting with metadata.

### Mint NFT

The `Mint NFT` provides users with the entry to call the ERC721 or ERC1155 contract to mint the NFT. Users need to [deploy their own contract](/api-reference/open-api/contract.md#deploy-contract) firstly. If the network is `Conflux_test` , [`set sponsor api`](/api-reference/open-api/contract.md#set-sponsor) needs to be called beforing minting.

{% openapi src="/files/9Xn6Obl1bD1nl4G8Wv3D" path="/v1/mints/" method="post" %}
[swagger.json](https://824600799-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3Ln5WTo00HxQnwIT1nSu%2Fuploads%2Fgit-blob-b7eb9a491644b192bf198732c032444b2d93114f%2Fswagger.json?alt=media)
{% endopenapi %}

{% tabs %}
{% tab title="Auth" %}

| Name          | Meaning      | Param Type | Data Type |
| ------------- | ------------ | ---------- | --------- |
| Authorization | Bearer Token | Header     | string    |
| {% endtab %}  |              |            |           |

{% tab title="Parameter" %}

<table><thead><tr><th>Name</th><th>Meaning</th><th>Param Type</th><th>Type</th><th data-type="checkbox">Required</th><th>Default</th></tr></thead><tbody><tr><td>token_id</td><td>The id of the NFT, which will be generated randomly if the field in the request is null.</td><td>body</td><td>string</td><td>false</td><td>random</td></tr><tr><td>chain</td><td>The chain type. The types include <code>conflux</code> and <code>conflux_test</code></td><td>body</td><td>string</td><td>true</td><td></td></tr><tr><td>mint_to_address</td><td>The owner of the NFT</td><td>body</td><td>string</td><td>true</td><td></td></tr><tr><td>contract_address</td><td>The address of the contract</td><td>body</td><td>string</td><td>true</td><td></td></tr><tr><td>metadata_uri</td><td>The uri of the metadata. It can be created thorugh <a href="/pages/IzIpk6d9ffTBspgxxzMG">create metadata uri</a>.</td><td>body</td><td>string</td><td>true</td><td></td></tr><tr><td>amount</td><td>The amount of the minted NFTs. For ERC721 contract, this field must be 1. For ERC1155 contract, this field can be greater than 0.</td><td>body</td><td>integer</td><td>false</td><td>1</td></tr></tbody></table>
{% endtab %}

{% tab title="Parameter Example" %}

```
{
    "chain": "conflux_test",
    "token_id": "123",
    "mint_to_address": "cfxtest:aasr1hmezez1wepvh8ew8sk9p40khhhj1ymxwmpaf0",
    "contract_address": "cfxtest:aca7psszv5pvak2hesk3e33m5yabkn3d5j2gzsmm5n",
    "metadata_uri": "https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png",
    "amount": 123
}
```

{% endtab %}

{% tab title="Response" %}

| Name           | Meaning                                                                                                                           | Type    |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------- |
| created\_at    | The time of creating the item in the database                                                                                     | string  |
| updated\_at    | The time of updating the item in the database                                                                                     | string  |
| deleted\_at    | The time of deleting the item in the database                                                                                     | string  |
| id             | The id of the item in the database                                                                                                | integer |
| amount         | The amount of the minted NFTs. For ERC721 contract, this field must be 1. For ERC1155 contract, this field can be greater than 0. | integer |
| app\_id        | The id of the app                                                                                                                 | integer |
| chain\_id      | The id of the chain. 1029-mainnet, 1-testnet                                                                                      | integer |
| chain\_type    | The type of the chain. 1-CFX, 2-ETH                                                                                               | integer |
| contract\_type | The type of the contract. 1-ERC721, 2-ERC1155                                                                                     | integer |
| contract       | The address of the contract                                                                                                       | string  |
| error          | The error during executing tx                                                                                                     | string  |
| hash           | The hash of the transaction                                                                                                       | string  |
| mint\_to       | The owner of the nft                                                                                                              | string  |
| status         | The status of the transaction. 0-pending, 1-success, 2-failed                                                                     | integer |
| token\_id      | The id of the token                                                                                                               | string  |
| token\_uri     | The uri of the token                                                                                                              | string  |
| tx\_id         | The id of the transaction                                                                                                         | integer |
| mint\_type     | The type of the mint. 1-easyMint, 2-customMint, 3-customBatchMint                                                                 | integer |
| {% endtab %}   |                                                                                                                                   |         |

{% tab title="Response Example" %}

```
        {
            "id": 8109,
            "created_at": "2022-08-24T04:56:09.841Z",
            "updated_at": "2022-08-24T04:56:52.986Z",
            "deleted_at": null,
            "app_id": 2,
            "chain_type": 1,
            "chain_id": 1,
            "contract": "cfxtest:acgraybn1g1upesed09g96vxev79sdhmxjmz7bxzyy",
            "contract_type": 0,
            "tx_id": 8121,
            "hash": "0x5e8eafa9cf8fc52f3fb0d0810a86b5ac97ef23c3ba057bfa8a9f889907e65209",
            "status": 1,
            "error": "",
            "mint_to": "cfxtest:aar9up0wsbgtw7f0g5tyc4hbwb2wa5wf7emmk94znd",
            "token_id": "123",
            "amount": 1,
            "token_uri": "https://dev.nftrainbow.cn/assets/metadata/0/nft/0b7ba21ca161facbf392e8b275f2d62bbf78eb5302f13564415de85879b7cd7b.json",
            "mint_type": 0
        }
```

{% endtab %}

{% tab title="Requst Sample" %}

```
curl --request POST \
  --url https://api.nftrainbow.cn/v1/mints/ \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json' \ 
  --data-raw '{
    "chain": "conflux_test",
    "token_id": "123",
    "mint_to_address": "cfxtest:aasr1hmezez1wepvh8ew8sk9p40khhhj1ymxwmpaf0",
    "contract_address": "cfxtest:acgat1yux2rk0xmk2s8ceferyprgm0u1hetj0w72yf",
    "metadata_uri": "http://dev.nftrainbow/assets/metadata/0/nft/2dfd6b3add9d5154cf4ccef7a040f4c5c3c965ec5845bd11ca297e8550ac63ee.json",
    "amount": 1
}'
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
The token\_id is the number like "123", whose type is string
{% endhint %}

### Batch Mint NFTs

The `Batch Mint NFTs` API provides users with the entry to call the ERC721 or ERC1155 contract to mint several NFTs once.

{% openapi src="/files/9Xn6Obl1bD1nl4G8Wv3D" path="/v1/mints/customizable/batch" method="post" %}
[swagger.json](https://824600799-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3Ln5WTo00HxQnwIT1nSu%2Fuploads%2Fgit-blob-b7eb9a491644b192bf198732c032444b2d93114f%2Fswagger.json?alt=media)
{% endopenapi %}

{% tabs %}
{% tab title="Auth" %}

| Name          | Meaning      | Param Type | Data Type |
| ------------- | ------------ | ---------- | --------- |
| Authorization | Bearer Token | Header     | string    |
| {% endtab %}  |              |            |           |

{% tab title="Parameter" %}

<table><thead><tr><th>Name</th><th>Meaning</th><th>Param Type</th><th>Type</th><th data-type="checkbox">Required</th><th>Default</th></tr></thead><tbody><tr><td>chain</td><td>The chain type. The types include <code>conflux</code> and <code>conflux_test</code></td><td>body</td><td>string</td><td>true</td><td></td></tr><tr><td>contract_address</td><td>The address of the contract</td><td>body</td><td>string</td><td>true</td><td></td></tr><tr><td>mint_items</td><td>The mint tasks</td><td>body</td><td>The array of the MintItemDto</td><td>true</td><td></td></tr></tbody></table>

The MintItemDto construct is presented in the following.

<table><thead><tr><th>Name</th><th>Meaning</th><th>Param Type</th><th>Type</th><th data-type="checkbox">Required</th><th>Default</th></tr></thead><tbody><tr><td>token_id</td><td>The id of the NFT, which will be generated randomly if the field in the request is null.</td><td>body</td><td>string</td><td>false</td><td>The radom value between 1 and 10</td></tr><tr><td>mint_to_address</td><td>The owner of the NFT</td><td>body</td><td>string</td><td>true</td><td></td></tr><tr><td>amount</td><td>The amount of the minted NFTs. For ERC721 contract, this field must be 1. For ERC1155 contract, this field can be greater than 0.</td><td>body</td><td>integer</td><td>false</td><td>1</td></tr><tr><td>metadata_uri</td><td>The uri of the metadata. This uri can be generated through <a href="/pages/IzIpk6d9ffTBspgxxzMG#create-nft-metadata">create metadata</a></td><td>body</td><td>string</td><td>false</td><td>The base_uri in the <a href="/pages/AneZJKQLBpxRqu1aZltg#deploy-contract">deploy contract</a></td></tr></tbody></table>
{% endtab %}

{% tab title="Parameter Example" %}

```
{
    "chain": "conflux_test",
    "contract_address": "cfxtest:aceng286bm0xnu8s4wdf1xzdchgn0zxxapb1jj597t",
    "mint_items": [
        {
            "mint_to_address": "cfxtest:aam1eawbm9pzp0dnwv96tts5shnbdfv9nuwu7zgzz8",
            "metadata_uri": "https://live---metadata-5covpqijaa-uc.a.run.app/metadata/10",
            "token_id":"10",
            "amount": 1
        },
        {
            "mint_to_address": "cfxtest:aam1eawbm9pzp0dnwv96tts5shnbdfv9nuwu7zgzz8",
            "metadata_uri": "https://live---metadata-5covpqijaa-uc.a.run.app/metadata/11",
            "token_id":"11",
            "amount": 1
        },
        {
            "mint_to_address": "cfxtest:aam1eawbm9pzp0dnwv96tts5shnbdfv9nuwu7zgzz8",
            "metadata_uri": "https://live---metadata-5covpqijaa-uc.a.run.app/metadata/12",
            "token_id":"12",
            "amount": 1
        }
    ]
}
```

{% endtab %}

{% tab title="Response" %}
The response is the array of MintTask construct.

The MintTask construct is showed in the following.

| Name           | Meaning                                                                                                                           | Type    |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------- |
| created\_at    | The time of creating the item in the database                                                                                     | string  |
| updated\_at    | The time of updating the item in the database                                                                                     | string  |
| deleted\_at    | The time of deleting the item in the database                                                                                     | string  |
| id             | The id of the item in the database                                                                                                | integer |
| app\_id        | The id of the app                                                                                                                 | integer |
| chain\_type    | The type of the chain. 1-CFX, 2-ETH.                                                                                              | integer |
| chain\_id      | The id of the chain. 1029-mainnet, 1-testnet                                                                                      | integer |
| contract       | The address of the contract                                                                                                       | string  |
| contract\_type | The type of the contract. 1-ERC721, 2-ERC1155                                                                                     | integer |
| mint\_to       | The address of the owner                                                                                                          | string  |
| token\_uri     | The uri of the token                                                                                                              | string  |
| token\_id      | The id of the NFT, which will be generated randomly if the field in the request is null.                                          | string  |
| amount         | The amount of the minted NFTs. For ERC721 contract, this field must be 1. For ERC1155 contract, this field can be greater than 0. | integer |
| status         | The status of the transaction. 0-pending, 1-success, 2-failed                                                                     | integer |
| hash           | The hash of the transaction                                                                                                       | string  |
| tx\_id         | The id of the transaction                                                                                                         | integer |
| error          | The error during executing the transaction                                                                                        | string  |
| mint\_type     | The type of minting. 1-easyMinting 2-customMinting 3-BatchcustomMinting                                                           | integer |
| {% endtab %}   |                                                                                                                                   |         |

{% tab title="Response Example" %}

```
[
    {
        "id": 8372,
        "created_at": "2022-09-28T07:54:53.602Z",
        "updated_at": "2022-09-28T07:54:53.602Z",
        "deleted_at": null,
        "app_id": 2,
        "chain_type": 1,
        "chain_id": 1,
        "contract": "cfxtest:acbf8taf6zzy99kncvu7d81vyavaz2ay5254ca3j7c",
        "contract_type": 1,
        "tx_id": 8474,
        "hash": "",
        "status": 0,
        "error": "",
        "mint_to": "cfxtest:aam1eawbm9pzp0dnwv96tts5shnbdfv9nuwu7zgzz8",
        "token_id": "1",
        "amount": 1,
        "token_uri": "https://live---metadata-5covpqijaa-uc.a.run.app/metadata/10",
        "mint_type": 3
    },
    {
        "id": 8373,
        "created_at": "2022-09-28T07:54:53.602Z",
        "updated_at": "2022-09-28T07:54:53.602Z",
        "deleted_at": null,
        "app_id": 2,
        "chain_type": 1,
        "chain_id": 1,
        "contract": "cfxtest:acbf8taf6zzy99kncvu7d81vyavaz2ay5254ca3j7c",
        "contract_type": 1,
        "tx_id": 8474,
        "hash": "",
        "status": 0,
        "error": "",
        "mint_to": "cfxtest:aam1eawbm9pzp0dnwv96tts5shnbdfv9nuwu7zgzz8",
        "token_id": "22",
        "amount": 1,
        "token_uri": "https://live---metadata-5covpqijaa-uc.a.run.app/metadata/11",
        "mint_type": 3
    },
    {
        "id": 8374,
        "created_at": "2022-09-28T07:54:53.602Z",
        "updated_at": "2022-09-28T07:54:53.602Z",
        "deleted_at": null,
        "app_id": 2,
        "chain_type": 1,
        "chain_id": 1,
        "contract": "cfxtest:acbf8taf6zzy99kncvu7d81vyavaz2ay5254ca3j7c",
        "contract_type": 1,
        "tx_id": 8474,
        "hash": "",
        "status": 0,
        "error": "",
        "mint_to": "cfxtest:aam1eawbm9pzp0dnwv96tts5shnbdfv9nuwu7zgzz8",
        "token_id": "23",
        "amount": 1,
        "token_uri": "https://live---metadata-5covpqijaa-uc.a.run.app/metadata/12",
        "mint_type": 3
    }
]
```

{% endtab %}

{% tab title="Requst Sample" %}

```
curl --request POST \
  --url https://api.nftrainbow.cn/v1/mints/customizable/batch \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json' \ 
  --data-raw '{
    "chain": "conflux_test",
    "contract_address": "cfxtest:aceng286bm0xnu8s4wdf1xzdchgn0zxxapb1jj597t",
    "mint_items": [
        {
            "mint_to_address": "cfxtest:aam1eawbm9pzp0dnwv96tts5shnbdfv9nuwu7zgzz8",
            "metadata_uri": "https://live---metadata-5covpqijaa-uc.a.run.app/metadata/10",
            "token_id":"10",
            "amount": 1
        },
        {
            "mint_to_address": "cfxtest:aam1eawbm9pzp0dnwv96tts5shnbdfv9nuwu7zgzz8",
            "metadata_uri": "https://live---metadata-5covpqijaa-uc.a.run.app/metadata/11",
            "token_id":"11",
            "amount": 1
        },
        {
            "mint_to_address": "cfxtest:aam1eawbm9pzp0dnwv96tts5shnbdfv9nuwu7zgzz8",
            "metadata_uri": "https://live---metadata-5covpqijaa-uc.a.run.app/metadata/12",
            "token_id":"12",
            "amount": 1
        }
    ]
}'
```

{% endtab %}
{% endtabs %}

### Mint NFT with file

The `Mint NFT with file` API provides users with the entry to call the ERC721 or ERC1155 contract to mint the NFT with uploading files. The uploaded files can be images, video and so on.

{% openapi src="/files/9Xn6Obl1bD1nl4G8Wv3D" path="/v1/mints/easy/files" method="post" %}
[swagger.json](https://824600799-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3Ln5WTo00HxQnwIT1nSu%2Fuploads%2Fgit-blob-b7eb9a491644b192bf198732c032444b2d93114f%2Fswagger.json?alt=media)
{% endopenapi %}

{% tabs %}
{% tab title="Auth" %}

| Name          | Meaning      | Param Type | Data Type |
| ------------- | ------------ | ---------- | --------- |
| Authorization | Bearer Token | Header     | string    |
| {% endtab %}  |              |            |           |

{% tab title="Parameter" %}

<table><thead><tr><th>Name</th><th>Meaning</th><th>Param Type</th><th>Type</th><th data-type="checkbox">Required</th></tr></thead><tbody><tr><td>name</td><td>The name of the NFT</td><td>body</td><td>string</td><td>true</td></tr><tr><td>chain</td><td>The chain type. The types include <code>conflux</code> and <code>conflux_test</code></td><td>body</td><td>string</td><td>true</td></tr><tr><td>mint_to_address</td><td>The owner of the NFT</td><td>body</td><td>string</td><td>true</td></tr><tr><td>description</td><td>The description of the NFT</td><td>body</td><td>string</td><td>true</td></tr><tr><td>file</td><td>The uploaded file</td><td>formData</td><td></td><td>true</td></tr></tbody></table>
{% endtab %}

{% tab title="Response" %}

| Name           | Meaning                                                                                                                           | Type    |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------- |
| created\_at    | The time of creating the item in the database                                                                                     | string  |
| updated\_at    | The time of updating the item in the database                                                                                     | string  |
| deleted\_at    | The time of deleting the item in the database                                                                                     | string  |
| id             | The id of the item in the database                                                                                                | integer |
| amount         | The amount of the minted NFTs. For ERC721 contract, this field must be 1. For ERC1155 contract, this field can be greater than 0. | integer |
| app\_id        | The id of the app                                                                                                                 | integer |
| chain\_id      | The id of the chain. 1029-mainnet, 1-testnet                                                                                      | integer |
| chain\_type    | The type of the chain. 1-CFX, 2-ETH                                                                                               | integer |
| contract\_type | The type of the contract. 1-ERC721, 2-ERC1155                                                                                     | integer |
| contract       | The address of the contract.                                                                                                      | string  |
| error          | The error during executing tx                                                                                                     | string  |
| hash           | The hash of the transaction                                                                                                       | string  |
| mint\_to       | The owner of the nft                                                                                                              | string  |
| status         | The status of the transaction. 0-pending, 1-success, 2-failed                                                                     | integer |
| token\_id      | The id of the NFT, which will be generated randomly if the field in the request is null.                                          | string  |
| token\_uri     | The uri of the token                                                                                                              | string  |
| tx\_id         | The id of the transaction                                                                                                         | integer |
| mint\_type     | The type of the mint. 1-easyMint, 2-customMint, 3-customBatchMint                                                                 | integer |
| {% endtab %}   |                                                                                                                                   |         |

{% tab title="Response Example" %}

```
        {
            "id": 8109,
            "created_at": "2022-08-24T04:56:09.841Z",
            "updated_at": "2022-08-24T04:56:52.986Z",
            "deleted_at": null,
            "app_id": 2,
            "chain_type": 1,
            "chain_id": 1,
            "contract": "cfxtest:acgraybn1g1upesed09g96vxev79sdhmxjmz7bxzyy",
            "contract_type": 0,
            "tx_id": 8121,
            "hash": "0x5e8eafa9cf8fc52f3fb0d0810a86b5ac97ef23c3ba057bfa8a9f889907e65209",
            "status": 1,
            "error": "",
            "mint_to": "cfxtest:aar9up0wsbgtw7f0g5tyc4hbwb2wa5wf7emmk94znd",
            "token_id": "123",
            "amount": 1,
            "token_uri": "https://dev.nftrainbow.cn/assets/metadata/0/nft/0b7ba21ca161facbf392e8b275f2d62bbf78eb5302f13564415de85879b7cd7b.json",
            "mint_type": 0
        }
```

{% endtab %}

{% tab title="Request Sample" %}

```
curl --request POST \
  --url https://api.nftrainbow.cn/v1/mints/easy/files \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: multipart/form-data' \
  --header 'content-type: multipart/form-data; boundary=---011000010111000001101001' \
  --form file= \
  --form chain= 'conflux_test' \
  --form description= 'throll description' \ 
  --form mint_to_address= 'cfxtest:aatk708nbb7573bkwumsu00h0r1rtkcdz2chwhttzk' \
  --form name= 'throll'
```

{% endtab %}
{% endtabs %}

### Mint NFT with metadata

The `Mint NFT with metadata` provides users with the entry to call the ERC721 or ERC1155 contract to mint the NFT with creating metadata by providing a file url.

{% openapi src="/files/9Xn6Obl1bD1nl4G8Wv3D" path="/v1/mints/easy/urls" method="post" %}
[swagger.json](https://824600799-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3Ln5WTo00HxQnwIT1nSu%2Fuploads%2Fgit-blob-b7eb9a491644b192bf198732c032444b2d93114f%2Fswagger.json?alt=media)
{% endopenapi %}

{% tabs %}
{% tab title="Auth" %}

| Name          | Meaning      | Param Type | Data Type |
| ------------- | ------------ | ---------- | --------- |
| Authorization | Bearer Token | Header     | string    |
| {% endtab %}  |              |            |           |

{% tab title="Parameter" %}

<table><thead><tr><th>Name</th><th>Meaning</th><th>Param Type</th><th>Type</th><th data-type="checkbox">Required</th></tr></thead><tbody><tr><td>name</td><td>The name of the nft</td><td>body</td><td>string</td><td>true</td></tr><tr><td>chain</td><td>The chain type. The types include <code>conflux</code> and <code>conflux_test</code></td><td>body</td><td>string</td><td>true</td></tr><tr><td>mint_to_address</td><td>The owner of the NFT</td><td>body</td><td>string</td><td>true</td></tr><tr><td>description</td><td>The description of the NFT</td><td>body</td><td>string</td><td>true</td></tr><tr><td>file_url</td><td>The url of the file, which can be generated through <a href="/pages/gVMPdtDSt3Ay1tbY5rX7#upload-file">upload file</a> or <a href="/pages/gVMPdtDSt3Ay1tbY5rX7#upload-file-to-oss">upload file to oss</a></td><td>body</td><td>string</td><td>true</td></tr></tbody></table>
{% endtab %}

{% tab title="Parameter Example" %}

```
{
    "chain": "conflux_test",
    "name": "123",
    "description": "123",
    "mint_to_address": "cfxtest:aasr1hmezez1wepvh8ew8sk9p40khhhj1ymxwmpaf0",
    "file_url": "http://dev.nftrainbow/assets/file/1/nft/67c96aee8ee1293594a4b4ded15c60ea7853e49c0a2eb41a4805a01a70bc3111.jpeg"
}
```

{% endtab %}

{% tab title="Response" %}

| Name           | Meaning                                                                                                                           | Type    |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------- |
| created\_at    | The time of creating the item in the database                                                                                     | string  |
| updated\_at    | The time of updating the item in the database                                                                                     | string  |
| deleted\_at    | The time of deleting the item in the database                                                                                     | string  |
| id             | The id of the item in the database                                                                                                | integer |
| amount         | The amount of the minted NFTs. For ERC721 contract, this field must be 1. For ERC1155 contract, this field can be greater than 0. | integer |
| app\_id        | The id of the app                                                                                                                 | integer |
| chain\_id      | The id of the chain. 1029-mainnet, 1-testnet                                                                                      | integer |
| chain\_type    | The type of the chain. 1-CFX, 2-ETH                                                                                               | integer |
| contract\_type | The type of the contract                                                                                                          | integer |
| contract       | The address of the contract                                                                                                       | string  |
| error          | The error during executing tx                                                                                                     | string  |
| hash           | The hash of the transaction                                                                                                       | string  |
| mint\_to       | The owner of the nft                                                                                                              | string  |
| status         | The status of the transaction. 0-pending, 1-success, 2-failed                                                                     | integer |
| token\_id      | The id of the NFT, which will be generated randomly if the field in the request is null.                                          | string  |
| token\_uri     | The uri of the token                                                                                                              | string  |
| tx\_id         | The id of the transaction                                                                                                         | integer |
| mint\_type     | The type of the mint. 1-easyMint, 2-customMint, 3-customBatchMint                                                                 | integer |
| {% endtab %}   |                                                                                                                                   |         |

{% tab title="Response Example" %}

```
        {
            "id": 8109,
            "created_at": "2022-08-24T04:56:09.841Z",
            "updated_at": "2022-08-24T04:56:52.986Z",
            "deleted_at": null,
            "app_id": 2,
            "chain_type": 1,
            "chain_id": 1,
            "contract": "cfxtest:acgraybn1g1upesed09g96vxev79sdhmxjmz7bxzyy",
            "contract_type": 0,
            "tx_id": 8121,
            "hash": "0x5e8eafa9cf8fc52f3fb0d0810a86b5ac97ef23c3ba057bfa8a9f889907e65209",
            "status": 1,
            "error": "",
            "mint_to": "cfxtest:aar9up0wsbgtw7f0g5tyc4hbwb2wa5wf7emmk94znd",
            "token_id": "123",
            "amount": 1,
            "token_uri": "https://dev.nftrainbow.cn/assets/metadata/0/nft/0b7ba21ca161facbf392e8b275f2d62bbf78eb5302f13564415de85879b7cd7b.json",
            "mint_type": 0
        }
```

{% endtab %}

{% tab title="Request Sample" %}

```
curl --request POST \
  --url https://api.nftrainbow.cn/v1/mints/easy/urls \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "chain": "conflux_test",
    "name": "123",
    "description": "123",
    "mint_to_address": "cfxtest:aasr1hmezez1wepvh8ew8sk9p40khhhj1ymxwmpaf0",
    "file_url": "http://dev.nftrainbow/assets/file/1/nft/67c96aee8ee1293594a4b4ded15c60ea7853e49c0a2eb41a4805a01a70bc3111.jpeg"
}'
```

{% endtab %}
{% endtabs %}

## Obtain Informations

### Obtain NFT list

The `Obtain NFT list` API provides users with the entry to query the NFTs information created on a spcific app.

{% openapi src="/files/9Xn6Obl1bD1nl4G8Wv3D" path="/v1/mints/" method="get" %}
[swagger.json](https://824600799-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3Ln5WTo00HxQnwIT1nSu%2Fuploads%2Fgit-blob-b7eb9a491644b192bf198732c032444b2d93114f%2Fswagger.json?alt=media)
{% endopenapi %}

{% tabs %}
{% tab title="Auth" %}

| Name          | Meaning      | Param Type | Data Type |
| ------------- | ------------ | ---------- | --------- |
| Authorization | Bearer Token | Header     | string    |
| {% endtab %}  |              |            |           |

{% tab title="Parameter" %}

<table><thead><tr><th>Name</th><th>Meaning</th><th>Param Type</th><th>Data Type</th><th data-type="checkbox">Required</th><th>Default</th></tr></thead><tbody><tr><td>page</td><td>Page Query</td><td>query</td><td>integer</td><td>false</td><td>1</td></tr><tr><td>limit</td><td>Page Query</td><td>query</td><td>integer</td><td>false</td><td>10</td></tr><tr><td>contract</td><td>contract address</td><td>query</td><td>string</td><td>true</td><td></td></tr><tr><td>mint_to</td><td>owner of NFTs</td><td>query</td><td>string</td><td>true</td><td></td></tr><tr><td>status</td><td>The status of the transaction. 0-pending, 1-success, 2-failed</td><td>query</td><td>integer</td><td>false</td><td>-1</td></tr><tr><td>chain</td><td>The chain type including <code>conflux</code> and <code>conflux_test</code></td><td>query</td><td>string</td><td>true</td><td></td></tr></tbody></table>
{% endtab %}

{% tab title="Response" %}

| Name  | Meaning                       | Type        |
| ----- | ----------------------------- | ----------- |
| count | The number of the minted NFTs | integer     |
| items | The nfts information          | \[]MintTask |

The **`MintTask Struct`** is listed as follow:

| Name           | Meaning                                                                                                                           | Type    |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------- |
| created\_at    | The time of creating the item in the database                                                                                     | string  |
| updated\_at    | The time of updating the item in the database                                                                                     | string  |
| deleted\_at    | The time of deleting the item in the database                                                                                     | string  |
| id             | The id of the item in the database                                                                                                | integer |
| amount         | The amount of the minted NFTs. For ERC721 contract, this field must be 1. For ERC1155 contract, this field can be greater than 0. | integer |
| app\_id        | The id of the app                                                                                                                 | integer |
| chain\_id      | The id of the chain. 1029-mainnet, 1-testnet                                                                                      | integer |
| chain\_type    | The type of the chain. 1-CFX, 2-ETH                                                                                               | integer |
| contract\_type | The type of the contract. 1-ERC721, 2-ERC1155                                                                                     | integer |
| contract       | The address of the contract                                                                                                       | string  |
| error          | The error during executing tx                                                                                                     | string  |
| hash           | The hash of the transaction                                                                                                       | string  |
| mint\_to       | The owner of the nft                                                                                                              | string  |
| status         | The status of the transaction. 0-pending, 1-success, 2-failed                                                                     | integer |
| token\_id      | The id of the NFT, which will be generated randomly if the field in the request is null.                                          | string  |
| token\_uri     | The uri of the token                                                                                                              | string  |
| tx\_id         | The id of the transaction                                                                                                         | integer |
| mint\_type     | The type of the mint. 1-easyMint, 2-customMint, 3-customBatchMint                                                                 | integer |
| {% endtab %}   |                                                                                                                                   |         |

{% tab title="Response Example" %}

```
 {
        "count": 1,
        "items": [
            {
            "id": 8109,
            "created_at": "2022-08-24T04:56:09.841Z",
            "updated_at": "2022-08-24T04:56:52.986Z",
            "deleted_at": null,
            "app_id": 2,
            "chain_type": 1,
            "chain_id": 1,
            "contract": "cfxtest:acgraybn1g1upesed09g96vxev79sdhmxjmz7bxzyy",
            "contract_type": 0,
            "tx_id": 8121,
            "status": 1,
            "error": "",
            "mint_to": "cfxtest:aar9up0wsbgtw7f0g5tyc4hbwb2wa5wf7emmk94znd",
            "token_id": "",
            "amount": 1,
            "token_uri": "https://dev.nftrainbow.cn/assets/metadata/0/nft/0b7ba21ca161facbf392e8b275f2d62bbf78eb5302f13564415de85879b7cd7b.json",
            "mint_type": 0
            }
]
 
    }
```

{% endtab %}

{% tab title="Request Sample" %}

```
curl --request GET \
  --url https://api.nftrainbow.cn/v1/mints/ \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json'
```

{% endtab %}
{% endtabs %}

### Query detailed NFT

The `Query detailed NFT` API provides users with the entry to query the detailed NFT information created on a specific app according to the NFT's id.

{% openapi src="/files/9Xn6Obl1bD1nl4G8Wv3D" path="/v1/mints/{id}" method="get" %}
[swagger.json](https://824600799-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3Ln5WTo00HxQnwIT1nSu%2Fuploads%2Fgit-blob-b7eb9a491644b192bf198732c032444b2d93114f%2Fswagger.json?alt=media)
{% endopenapi %}

{% tabs %}
{% tab title="Auth" %}

| Name          | Meaning      | Param Type | Data Type |
| ------------- | ------------ | ---------- | --------- |
| Authorization | Bearer Token | Header     | string    |
| {% endtab %}  |              |            |           |

{% tab title="Parameter" %}

<table><thead><tr><th>Name</th><th>Meaning</th><th>Param Type</th><th>Data Type</th><th data-type="checkbox">Required</th></tr></thead><tbody><tr><td>id</td><td>NFT id</td><td>path</td><td>integer</td><td>true</td></tr></tbody></table>
{% endtab %}

{% tab title="Response" %}

| Name           | Meaning                                                                                                                           | Type    |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------- |
| created\_at    | The time of creating the item in the database                                                                                     | string  |
| updated\_at    | The time of updating the item in the database                                                                                     | string  |
| deleted\_at    | The time of deleting the item in the database                                                                                     | string  |
| id             | The id of the item in the database                                                                                                | integer |
| amount         | The amount of the minted NFTs. For ERC721 contract, this field must be 1. For ERC1155 contract, this field can be greater than 0. | integer |
| app\_id        | The id of the app                                                                                                                 | integer |
| chain\_id      | The id of the chain. 1029-mainnet, 1-testnet                                                                                      | integer |
| chain\_type    | The type of the chain. 1-CFX, 2-ETH                                                                                               | integer |
| contract\_type | The type of the contract. 1-ERC721, 2-ERC1155                                                                                     | integer |
| contract       | The address of the contract                                                                                                       | string  |
| error          | The error during executing tx                                                                                                     | string  |
| hash           | The hash of the transaction                                                                                                       | string  |
| mint\_to       | The owner of the nft                                                                                                              | string  |
| status         | The status of the transaction. 0-pending, 1-success, 2-failed                                                                     | integer |
| token\_id      | The id of the NFT, which will be generated randomly if the field in the request is null.                                          | string  |
| token\_uri     | The uri of the token                                                                                                              | string  |
| tx\_id         | The id of the transaction                                                                                                         | integer |
| mint\_type     | The type of the mint. 1-easyMint, 2-customMint, 3-customBatchMint                                                                 | integer |
| {% endtab %}   |                                                                                                                                   |         |

{% tab title="Response Example" %}

```
{
    "id": 22,
    "created_at": "2022-08-16T15:14:04.737+08:00",
    "updated_at": "2022-08-16T15:14:40.78+08:00",
    "deleted_at": null,
    "app_id": 4,
    "chain_type": 1,
    "chain_id": 1,
    "contract": "cfxtest:acgraybn1g1upesed09g96vxev79sdhmxjmz7bxzyy",
    "contract_type": 0,
    "tx_id": 14,
    "hash": "0xb060076e19fc4c69fb5399faa2f8c63c0bb3179f54f069b164b84b7c312fef62",
    "status": 1,
    "error": "",
    "mint_to": "cfxtest:aajb342mw5kzad6pjjkdz0wxx0tr54nfwpbu6yaj49",
    "token_id": "14448",
    "amount": 1,
    "token_uri": "http://localhost:8080/assets/metadata/0/nft/2a4dc76844247c2ae927a1a67877e76b4f02f627a5b84667549fbad3d6f57250.json",
    "mint_type": 0
}
```

{% endtab %}

{% tab title="Request Sample" %}

```
curl --request GET \
  --url https://api.nftrainbow.cn/v1/mints/{id} \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json'
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.nftrainbow.xyz/api-reference/open-api/mints.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.