# Metadata ## Create NFT Metadata `Create NFT metadata` API helps users to create their own metadata after calling[ Upload File](https://docs.nftrainbow.xyz/api-reference/files#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. {% openapi src="" path="/v1/metadata/" 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="Parameters" %}
NameMeaningParam TypeData TypeRequired
nameThe name of the metadatabodystringtrue
imageThe file url of the metadatabodystringtrue
external_linkThe externanl link of the metadatabodystringfalse
descriptionThe description of the metadatabodystringtrue
animation_urlA 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.bodystringfalse
attributesThe attributes of the metadataarrayattributefalse
The struct of the MetadataAttribute is listed as bellow.
NameMeaningParam TypeTypeRequired
attribute_nameThe name of the attributebodystringfalse
display_typeThe display type of the attributebodystringfalse
trait_typeThe trait type of the attributebodystringfalse
valueThe value of the attributebodystringfalse
{% endtab %} {% 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 `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. {% openapi src="" path="/v1/metadata/{metadata\_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="Parameters" %}
NameMeaningParam TypeData TypeRequired
metadata_idThe id of the metadataPathIntegertrue
{% endtab %} {% 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 %} ## Obtain Metadata List `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](#metadata-metadata_id). {% openapi src="" path="/v1/metadata/" 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="Parameters" %}
NameMeaningParam TypeData TypeRequiredDefault
pagePage Queryqueryintegerfalse1
limitPage Queryqueryintegerfalse10
{% endtab %} {% 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 %}