Returns the IRC30 metadata as JSON.

GET 
/api/irc-metadata/v1/tokens/:tokenId

Load the IRC30 metadata of a native token foundry by its id.

Request

Path Parameters

tokenId stringrequired
Unique identifier of the token.
Example: 0x081505ec099896ab05d9e08fbc7101ae4dff0093b3943b28f789ed2ca728bcc8d60100000000

Responses

200

Successful operation.

application/json

Schema

Schema

standard stringrequired

Possible values: Value must match regular expression ^IRC30$

The IRC standard of the token metadata

name stringrequired

The human-readable name of the native token

description string

The human-readable description of the token

symbol stringrequired

The symbol/ticker of the token

decimals integerrequired

Number of decimals the token uses (divide the token amount by decimals to get its user representation)

url string

URL pointing to more resources about the token

logoUrl string

URL pointing to an image resource of the token logo

logo string

The logo of the token encoded as a byte string

Example (from schema)

{
  "standard": "string",
  "name": "string",
  "description": "string",
  "symbol": "string",
  "decimals": 0,
  "url": "string",
  "logoUrl": "string",
  "logo": "string"
}

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...