Metadata

The metadata APIs provide users to make preparations for creating NFTs including creating NFT metadata and the corresponding query functions.

Create NFT Metadata

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.

Create NFT metadata

post

http://api.nftrainbow.cnhttps://api.nftrainbow.cn

/v1/metadata/

Create NFT metadata by providing the info including name, description and so on

Authorizations

ApiKeyAuth

Header parameters

AuthorizationstringRequired

Bearer openapi_token

Body

application/json

animation_urlstringOptional

descriptionstringRequired

external_linkstringOptional

imagestringRequired

namestringRequired

Responses

200

OK

application/json

400

Invalid request

application/json

500

Internal Server error

application/json

post

/v1/metadata/

HTTPcURLJavaScriptPython

POST /v1/metadata/ HTTP/1.1
Host: api.nftrainbow.cn
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "animation_url": "text",
  "attributes": [
    {
      "attribute_name": "text",
      "display_type": "text",
      "trait_type": "text",
      "value": "text"
    }
  ],
  "description": "text",
  "external_link": "text",
  "image": "text",
  "name": "text"
}

{
  "animation_url": "text",
  "app_id": 1,
  "attributes": [
    {
      "attribute_name": "text",
      "display_type": "text",
      "trait_type": "text",
      "value": "text"
    }
  ],
  "created_at": "text",
  "deleted_at": {
    "time": "text",
    "valid": true
  },
  "description": "text",
  "external_link": "text",
  "id": 1,
  "image": "text",
  "metadata_id": "text",
  "name": "text",
  "updated_at": "text",
  "uri": "text"
}

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameters

Parameter Example

Responses

Response Example

Request Sample

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.

Query metadata

get

http://api.nftrainbow.cnhttps://api.nftrainbow.cn

/v1/metadata/{metadata_id}

Query the metadata according to metadata_id

Authorizations

ApiKeyAuth

Path parameters

metadata_idstringRequired

metadata_id

Header parameters

AuthorizationstringRequired

Bearer openapi_token

Responses

200

OK

application/json

400

Invalid request

application/json

500

Internal Server error

application/json

get

/v1/metadata/{metadata_id}

HTTPcURLJavaScriptPython

GET /v1/metadata/{metadata_id} HTTP/1.1
Host: api.nftrainbow.cn
Authorization: text
Accept: */*

{
  "animation_url": "text",
  "app_id": 1,
  "attributes": [
    {
      "attribute_name": "text",
      "display_type": "text",
      "trait_type": "text",
      "value": "text"
    }
  ],
  "created_at": "text",
  "deleted_at": {
    "time": "text",
    "valid": true
  },
  "description": "text",
  "external_link": "text",
  "id": 1,
  "image": "text",
  "metadata_id": "text",
  "name": "text",
  "updated_at": "text",
  "uri": "text"
}

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameters

Response

Response Example

Request Sample

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.

Obtain metadata list

get

http://api.nftrainbow.cnhttps://api.nftrainbow.cn

/v1/metadata/

Get the metadata list containing the info of the metadata created in the specified app

Authorizations

ApiKeyAuth

Query parameters

pagestringOptional

page

limitstringOptional

limit

Header parameters

AuthorizationstringRequired

Bearer openapi_token

Responses

200

OK

application/json

500

Internal Server error

application/json

get

/v1/metadata/

HTTPcURLJavaScriptPython

GET /v1/metadata/ HTTP/1.1
Host: api.nftrainbow.cn
Authorization: text
Accept: */*

{
  "count": 1,
  "items": [
    {
      "animation_url": "text",
      "app_id": 1,
      "attributes": [
        {
          "attribute_name": "text",
          "display_type": "text",
          "trait_type": "text",
          "value": "text"
        }
      ],
      "created_at": "text",
      "deleted_at": {
        "time": "text",
        "valid": true
      },
      "description": "text",
      "external_link": "text",
      "id": 1,
      "image": "text",
      "metadata_id": "text",
      "name": "text",
      "updated_at": "text",
      "uri": "text"
    }
  ]
}

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameters

Response

Response Example

Request Sample