---
updatedAt: 2025-09-24T23:46:17.000Z
agentTools:
  projectIndex: https://docs.zettablock.com/llms.txt
---

# get token metadata

get token metadata by contract_address, name or symbol, at least one of the them is not empty

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Zetta Block API",
    "description": "This is zetta block api specification.",
    "contact": {},
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.zettablock.com/api/v2/"
    }
  ],
  "paths": {
    "/token_metadata": {
      "get": {
        "tags": [
          "prebuilt",
          "v0.0.1"
        ],
        "summary": "get token metadata",
        "description": "get token metadata by contract_address, name or symbol, at least one of the them is not empty",
        "parameters": [
          {
            "name": "X-API-KEY",
            "in": "header",
            "description": "api key",
            "required": true,
            "schema": {
              "type": "string",
              "default": "882bd487-7b87-4f39-a881-4bde5a7eecd5"
            }
          },
          {
            "name": "page_number",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 1
            }
          },
          {
            "name": "results_per_page",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 20
            }
          },
          {
            "name": "chain_id",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 1
            }
          },
          {
            "name": "contract_address",
            "in": "query",
            "description": "contract_address of the token_metadata",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "name",
            "in": "query",
            "description": "name of the token_metadata",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "symbol",
            "in": "query",
            "description": "symbol of the token_metadata",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "order_by",
            "in": "query",
            "description": "the order by fields of results",
            "style": "form",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "name",
                  "symbol"
                ]
              }
            }
          },
          {
            "name": "order_direction",
            "in": "query",
            "description": "the order by direction of results",
            "schema": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/model.PrebuiltApiPaginatedResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "model.Pagination": {
        "type": "object",
        "properties": {
          "page_number": {
            "type": "integer"
          },
          "results_per_page": {
            "type": "integer"
          }
        }
      },
      "model.PrebuiltApiPaginatedResponse": {
        "type": "object",
        "properties": {
          "data": {
            "$ref": "#/components/schemas/model.PrebuiltApiPaginatedResultData"
          },
          "status": {
            "$ref": "#/components/schemas/model.PrebuiltApiResponseStatus"
          }
        }
      },
      "model.PrebuiltApiPaginatedResultData": {
        "type": "object",
        "properties": {
          "pagination": {
            "$ref": "#/components/schemas/model.Pagination"
          },
          "result": {
            "type": "object"
          }
        }
      },
      "model.PrebuiltApiResponseStatus": {
        "type": "object",
        "properties": {
          "error_message": {
            "type": "string"
          },
          "timesatmp": {
            "type": "integer"
          }
        }
      }
    }
  },
  "x-original-swagger-version": "2.0",
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```