Returns the IRC27 metadata as JSON.

GET 
/api/irc-metadata/v1/nfts/:nftId

Load the IRC27 metadata of an NFT by its id.

Request

Path Parameters

nftId stringrequired
Unique identifier of the nft.
Example: 0x19c82b32761fd8729a1a6c77f7c17597e4b9b01759794e52381f6a0050b0c11f

Responses

200

Successful operation.

application/json

Schema

Schema

standard stringrequired

Possible values: Value must match regular expression ^IRC27$

identifier for the metadata standard used

version stringrequired

Possible values: Value must match regular expression ^v\d+.\d+$

version of the metadata standard used

name stringrequired

A descriptive name of the token

description string

some information about the NFT project

type stringrequired

MIME type of the asset

uri stringrequired

URI pointing to the resource where the file with type MIME type is hosted

collectionName string

A human readable name for the NFT collection

royalties object

object containing the payout addresses mapped to their percentage share

issuerName string

name of the artist

attributes array

array containing any additional data as objects.

Example (from schema)

{
  "standard": "string",
  "version": "string",
  "name": "string",
  "description": "string",
  "type": "string",
  "uri": "string",
  "collectionName": "string",
  "royalties": {},
  "issuerName": "string",
  "attributes": [
    null
  ]
}

400

Unsuccessful operation: indicates that the provided data is invalid.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 400,
    "message": "invalid data provided"
  }
}

403

Unsuccessful operation: indicates that the endpoint is not available for public use.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 403,
    "message": "not available for public use"
  }
}

404

Unsuccessful operation: indicates that the requested data was not found.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 404,
    "message": "could not find data"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

Loading...