| description |
|---|
The metadata APIs provide users to make preparations for creating NFTs including creating NFT metadata and the corresponding query functions. |
Create NFT metadata API helps users to create their own metadata after calling Upload File to get the corresponding file url. To call Create NFT metadata , users have to provide the metadata information including name, file, external_link and so on.
{% swagger src="../../.gitbook/assets/swagger.json" path="/v1/metadata/" method="post" %} swagger.json {% endswagger %}
{% tabs %} {% tab title="Auth" %}
| Name | Meaning | Param Type | Data Type |
|---|---|---|---|
| Authorization | Bearer Token | Header | string |
| {% endtab %} |
{% tab title="Parameters" %}
| Name | Meaning | Param Type | Data Type | Required |
|---|---|---|---|---|
| name | The name of the metadata | body | string | true |
| image | The file url of the metadata | body | string | true |
| external_link | The externanl link of the metadata | body | string | false |
| description | The description of the metadata | body | string | true |
| animation_url | A URL to a multi-media attachment for the item. The file extensions GLTF, GLB, WEBM, MP4, M4V, OGV, and OGG are supported, along with the audio-only extensions MP3, WAV, and OGA. | body | string | false |
| attributes | The attributes of the metadata | array | attribute | false |
The struct of the MetadataAttribute is listed as bellow.
| Name | Meaning | Param Type | Type | Required |
|---|---|---|---|---|
| attribute_name | The name of the attribute | body | string | false |
| display_type | The display type of the attribute | body | string | false |
| trait_type | The trait type of the attribute | body | string | false |
| value | The value of the attribute | body | string | false |
{% tab title="Parameter Example" %}
{
"attributes": [
{
"attribute_name": "mouse",
"display_type": "test hey hey",
"trait_type": "big",
"value": "big"
}
],
"description": "this is a test metadata",
"image": "http://dev.nftrainbow/assets/file/1/nft/67c96aee8ee1293594a4b4ded15c60ea7853e49c0a2eb41a4805a01a70bc3111.jpeg",
"name": "test",
"external_link": "https://www.google.com/search",
"animation_url": "https://www.google.com/search"
}
{% endtab %}
{% tab title="Responses" %}
| Name | Meaning | Type |
|---|---|---|
| uri | The uri of the metadata | string |
| metadata_id | The id of the metadata | string |
| description | The description of the metadata | string |
| external_link | The external link of the metadata | string |
| image | The file url of the metadata | string |
| metadata_id | The id of the metadata | string |
| name | The name of the metadata | string |
| animation_url | A URL to a multi-media attachment for the item. The file extensions GLTF, GLB, WEBM, MP4, M4V, OGV, and OGG are supported, along with the audio-only extensions MP3, WAV, and OGA. | string |
| attributes | The attribute of the metadata | []ExposedMetadataAttribute |
The ExposedMetadataAttribute struct is listed as follow:
| Name | Meaning | Type |
|---|---|---|
| attribute_name | The name of the attribute | string |
| display_type | The display type of the attribut | string |
| trait_type | The trait type of the attribute | string |
| value | The value of the attribute | string |
| {% endtab %} |
{% tab title="Response Example" %}
{
"attributes": [
{
"attribute_name": "mouse",
"display_type": "test hey hey",
"trait_type": "big",
"value": "big"
}
],
"description": "this is a test metadata",
"metadata_id": "f35c25ced3f537e8850a377c01d22aa7507069270054d12587ddbe5fc47ec490",
"image": "http://dev.nftrainbow/assets/file/1/nft/67c96aee8ee1293594a4b4ded15c60ea7853e49c0a2eb41a4805a01a70bc3111.jpeg",
"name": "test",
"external_link": "https://www.google.com/search",
"animation_url": "https://www.google.com/search",
"uri": "https://dev.nftrainbow.cn/assets/metadata/2/nft/db2078aed6187e487a46a19624ba1559faddeb096849c4688347302023c40f6b.json"
}
{% endtab %}
{% tab title="Request Sample" %}
curl --request POST
--url https://api.nftrainbow.cn/v1/metadata/ \
--header 'Authorization: Bearer {JWT}' \
--header 'Content-Type: application/json' \
--data-raw '{
"attributes": [
{
"attribute_name": "mouse",
"display_type": "test hey hey",
"trait_type": "big",
"value": "big"
}
],
"description": "this is a test metadata",
"image": "https://www.google.com/search",
"external_link": "https://www.google.com/search",
"animation_url": "https://www.google.com/search",
"name": "test"
}
{% endtab %} {% endtabs %}
Query metadata API helps users to query the detailed information of the specified metadata according to metadata_id. This api returns the name, description, external link, file and attributes of the queried metada.
{% swagger src="../../.gitbook/assets/swagger.json" path="/v1/metadata/{metadata_id}" method="get" %} swagger.json {% endswagger %}
{% tabs %} {% tab title="Auth" %}
| Name | Meaning | Param Type | Data Type |
|---|---|---|---|
| Authorization | Bearer Token | Header | string |
| {% endtab %} |
{% tab title="Parameters" %}
| Name | Meaning | Param Type | Data Type | Required |
|---|---|---|---|---|
| metadata_id | The id of the metadata | Path | Integer | true |
{% tab title="Response" %}
| Name | Meaning | Data Type |
|---|---|---|
| attributes | The attribute of the metadata | []ExposedMetadataAttribute |
| description | The description of the metadata | string |
| external_link | The external link of the metadata | string |
| animation_url | A URL to a multi-media attachment for the item. The file extensions GLTF, GLB, WEBM, MP4, M4V, OGV, and OGG are supported, along with the audio-only extensions MP3, WAV, and OGA. | string |
| image | The file url of the metadata | string |
| metadata_id | The id of the metadata | string |
| name | The name of the metadata | string |
The ExposedMetadataAttribute struct is listed as follow:
| Name | Meaning | Type |
|---|---|---|
| attribute_name | The name of the attribute | string |
| display_type | The display type of the attribut | string |
| trait_type | The trait type of the attribute | string |
| value | The value of the attribute | string |
| {% endtab %} |
{% tab title="Response Example" %}
{
"attributes": [
{
"attribute_name": "mouse",
"display_type": "test hey hey",
"trait_type": "big",
"value": "big"
}
],
"description": "this is a test metadata",
"external_link": "https://www.google.com/search",
"animation_url": "https://www.google.com/search",
"metadata_id": "f35c25ced3f537e8850a377c01d22aa7507069270054d12587ddbe5fc47ec490",
"image": "http://dev.nftrainbow/assets/file/1/nft/67c96aee8ee1293594a4b4ded15c60ea7853e49c0a2eb41a4805a01a70bc3111.jpeg",
"name": "test",
"uri": "https://dev.nftrainbow.cn/assets/metadata/2/nft/db2078aed6187e487a46a19624ba1559faddeb096849c4688347302023c40f6b.json"
}
{% endtab %}
{% tab title="Request Sample" %}
curl --request GET \
--url https://dev.nftrainbow/v1/metadata/:metadata_id \
--header 'Authorization: 'Bearer {JWT}' \
--header 'Content-Type: application/json'
{% endtab %} {% endtabs %}
Query metadata list API helps users to obain the metadata list including the information of the metadata created in the specified app. This API returns the array of the result from calling Query matadata.
{% swagger src="../../.gitbook/assets/swagger.json" path="/v1/metadata/" method="get" %} swagger.json {% endswagger %}
{% tabs %} {% tab title="Auth" %}
| Name | Meaning | Param Type | Data Type |
|---|---|---|---|
| Authorization | Bearer Token | Header | string |
| {% endtab %} |
{% tab title="Parameters" %}
| Name | Meaning | Param Type | Data Type | Required | Default |
|---|---|---|---|---|---|
| page | Page Query | query | integer | false | 1 |
| limit | Page Query | query | integer | false | 10 |
{% tab title="Response" %}
| Name | Meaning | Type |
|---|---|---|
| count | The number of the uploaded files | integer |
| items | The files information | []QueryMetadataRsponse |
The QueryMetadataResponse struct is listed as follow:
| Name | Meaning | Data Type |
|---|---|---|
| attributes | The attribute of the | []attributes |
| description | The description of the metadata | string |
| external_link | The external link of the metadata | string |
| animation_url | A URL to a multi-media attachment for the item. The file extensions GLTF, GLB, WEBM, MP4, M4V, OGV, and OGG are supported, along with the audio-only extensions MP3, WAV, and OGA. | string |
| image | The file url of the metadata | string |
| metadata_id | The id of the metadata | string |
| name | The name of the metadata | string |
The attributes struct is listed as follow:
| Name | Meaning | Type |
|---|---|---|
| attribute_name | The name of the attribute | string |
| display_type | The display type of the attribut | string |
| trait_type | The trait type of the attribute | string |
| value | The value of the attribute | string |
| {% endtab %} |
{% tab title="Response Example" %}
{
"count": 1,
"items": [
{
"metadata": {
"name": "test",
"description": "this is a test metadata",
"metadata_id": "f35c25ced3f537e8850a377c01d22aa7507069270054d12587ddbe5fc47ec490",
"image": "http://dev.nftrainbow/assets/file/1/nft/67c96aee8ee1293594a4b4ded15c60ea7853e49c0a2eb41a4805a01a70bc3111.jpeg",
"external_link": "https://www.google.com/search",
"animation_url": "https://www.google.com/search",
"attributes": [
{
"attribute_name": "eyes",
"trait_type": "test trait",
"display_type": "",
"value": "big"
},
{
"attribute_name": "mouse",
"trait_type": "test hey hey",
"display_type": "",
"value": "big"
}
]
},
"uri": "http://dev.nftrainbow/assets/metadata/1/nft/46708cf66a806743cfc27b110a41a2ea2e1b7a47fbcfb2efc9cac8fd3bf29cd1.json"
}
]
}
{% endtab %}
{% tab title="Request Sample" %}
curl --request GET \
--url https://api.nftrainbow.cn/v1/metadata/ \
--header 'Authorization: Bearer {JWT}' \
--header 'Content-Type: application/json'
{% endtab %} {% endtabs %}