---
updatedAt: 2025-11-12T01:01:36.000Z
agentTools:
  projectIndex: https://docs.blockberry.one/llms.txt
---

# getObjectMetadata

Get the metadata (type, name, image, project name and image, etc.) of the queried object: NFT, package, domain NFT, pool, or coin.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Iota mainnet API",
    "description": "This is the new API Module implementation. The IOTA Blockchain API is used to retrieve IOTA Blockchain data. In order to execute queries you need to get API Key and use it in header 'x-api-key'. However, before that you need to sign up on the explorer or company website. If an account is created on the website <strong>https://staketab.com/</strong> or <strong>https://iotascan.com/</strong>, the user will be granted the <strong>ROLE_USER</strong> role. After that you may fetch API KEY.",
    "termsOfService": "terms-of-service",
    "contact": {
      "name": "Staketab tech support",
      "url": "https://staketab.com/",
      "email": "support@staketab.com"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.blockberry.one/iota-mainnet",
      "description": "Production"
    }
  ],
  "security": [
    {
      "x-api-key": []
    }
  ],
  "paths": {
    "/v1/metadata/objects": {
      "post": {
        "tags": [
          "Objects"
        ],
        "summary": "getObjectMetadata",
        "description": "Get the metadata (type, name, image, project name and image, etc.) of the queried object: NFT, package, domain NFT, pool, or coin.",
        "operationId": "getObjectMetadata",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ObjectMetadataSearchParams"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "$ref": "#/components/schemas/MetadataDtoAPI"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "MetadataDtoAPI": {
        "type": "object",
        "properties": {
          "objectType": {
            "type": "string",
            "enum": [
              "ACCOUNT",
              "COIN",
              "OBJECT",
              "DOMAIN_NFT",
              "NFT",
              "COLLECTION",
              "OTHER_OBJECT",
              "PACKAGE",
              "TRANSACTION",
              "TRANSACTION_FUNCTION",
              "TRANSACTION_MODULE",
              "POOL",
              "UNKNOWN"
            ]
          },
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "imgUrl": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          },
          "poolCoins": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PoolCoinMetadataAPI"
            }
          },
          "projectName": {
            "type": "string"
          },
          "projectImg": {
            "type": "string"
          },
          "isIndexed": {
            "type": "boolean"
          },
          "securityMessage": {
            "type": "string"
          }
        }
      },
      "PoolCoinMetadataAPI": {
        "type": "object",
        "properties": {
          "coinType": {
            "type": "string"
          },
          "coinSymbol": {
            "type": "string"
          },
          "imgUrl": {
            "type": "string"
          },
          "coinSeq": {
            "type": "integer",
            "format": "int32"
          },
          "securityMessage": {
            "type": "string"
          },
          "hasNoMetadata": {
            "type": "boolean"
          }
        }
      },
      "ObjectMetadataSearchParams": {
        "required": [
          "hashes"
        ],
        "type": "object",
        "properties": {
          "hashes": {
            "type": "array",
            "description": "Enter part or full object digest (hash) to get its metadata.",
            "example": "0x16c5d6b410a2aeaaa3ba3a8c6ae7398300147bd5d9c54f425a2c74cdb205b1ff",
            "items": {
              "type": "string",
              "description": "Enter part or full object digest (hash) to get its metadata.",
              "example": "0x16c5d6b410a2aeaaa3ba3a8c6ae7398300147bd5d9c54f425a2c74cdb205b1ff"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "x-api-key": {
        "type": "apiKey",
        "name": "x-api-key",
        "in": "header"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```