{"id":28702119,"url":"https://github.com/ensdomains/ens-metadata-service","last_synced_at":"2025-06-14T12:10:26.496Z","repository":{"id":37674380,"uuid":"378184274","full_name":"ensdomains/ens-metadata-service","owner":"ensdomains","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-25T15:19:50.000Z","size":11997,"stargazers_count":72,"open_issues_count":12,"forks_count":62,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-02-25T16:24:02.270Z","etag":null,"topics":["ens","erc-1155","erc-721","image-rendering","nft","svg"],"latest_commit_sha":null,"homepage":"https://metadata.ens.domains","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ensdomains.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-18T14:57:09.000Z","updated_at":"2025-02-25T15:19:52.000Z","dependencies_parsed_at":"2023-02-16T12:31:29.192Z","dependency_job_id":"f39c206f-faa8-4909-8aa6-1ba877ff3282","html_url":"https://github.com/ensdomains/ens-metadata-service","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ensdomains/ens-metadata-service","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ensdomains%2Fens-metadata-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ensdomains%2Fens-metadata-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ensdomains%2Fens-metadata-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ensdomains%2Fens-metadata-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ensdomains","download_url":"https://codeload.github.com/ensdomains/ens-metadata-service/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ensdomains%2Fens-metadata-service/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259813029,"owners_count":22915204,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ens","erc-1155","erc-721","image-rendering","nft","svg"],"created_at":"2025-06-14T12:10:17.572Z","updated_at":"2025-06-14T12:10:26.483Z","avatar_url":"https://github.com/ensdomains.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ens-metadata-service\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![License][license-shield]][license-url]\n[![Travis][travis-shield]][travis-url]\n\n## API\n\n\n### Request\n- __network:__ Name of the chain to query for. (mainnet | sepolia ...)\n- __contactAddress:__ accepts contractAddress of the NFT which represented by the tokenId\n- __NFT v1 - tokenId:__ accepts ENS name or labelhash of ENS name in both hex and int format\n- __NFT v2 - tokenId:__ accepts ENS name or namehash of ENS name in both hex and int format\n\n```\n/{network}/{contractAddress}/{tokenId}\n```\n\nRequest (example)\n\nhttps://metadata.ens.domains/mainnet/0x57f1887a8BF19b14fC0dF6Fd9B2acc9Af147eA85/42219085255511335250589442208301538195142221433306354426240614732612795430543/\n\n### Response (example)\n\n```json\n{\n  \"is_normalized\": true,\n  \"name\": \"nick.eth\",\n  \"description\": \"nick.eth, an ENS name.\",\n  \"attributes\": [\n    {\n      \"trait_type\": \"Created Date\",\n      \"display_type\": \"date\",\n      \"value\": 1571924851000\n    },\n    {\n      \"trait_type\": \"Length\",\n      \"display_type\": \"number\",\n      \"value\": 4\n    },\n    {\n      \"trait_type\": \"Segment Length\",\n      \"display_type\": \"number\",\n      \"value\": 4\n    },\n    {\n      \"trait_type\": \"Character Set\",\n      \"display_type\": \"string\",\n      \"value\": \"letter\"\n    },\n    {\n      \"trait_type\": \"Registration Date\",\n      \"display_type\": \"date\",\n      \"value\": 1580803395000\n    },\n    {\n      \"trait_type\": \"Expiration Date\",\n      \"display_type\": \"date\",\n      \"value\": 1699709554000\n    }\n  ],\n  \"name_length\": 4,\n  \"segment_length\": 4,\n  \"url\": \"https://app.ens.domains/name/nick.eth\",\n  \"version\": 0,\n  \"background_image\": \"https://metadata.ens.domains/mainnet/avatar/nick.eth\",\n  \"image\": \"https://metadata.ens.domains/mainnet/0x57f1887a8BF19b14fC0dF6Fd9B2acc9Af147eA85/0x5d5727cb0fb76e4944eafb88ec9a3cf0b3c9025a4b2f947729137c5d7f84f68f/image\",\n  \"image_url\": \"https://metadata.ens.domains/mainnet/0x57f1887a8BF19b14fC0dF6Fd9B2acc9Af147eA85/0x5d5727cb0fb76e4944eafb88ec9a3cf0b3c9025a4b2f947729137c5d7f84f68f/image\"\n}\n\n```\n\nMore info and list of all endpoints: https://metadata.ens.domains/docs\n\n\n## How to setup\n\n```\ngit clone https://github.com/ensdomains/ens-metadata-service.git\ncd ens-metadata-service\ncp .env.org .env // Fill in Vars\nyarn\nyarn dev\n```\n\n\n## How to deploy (Google App Engine)\n\nModify the app_template.yaml according to your needs. Then run;\n\n```\nyarn deploy\n```\n\n\n## How to test\n\nRegular unit test;\n```\nyarn test\n```\n\nUnit test + coverage;\n```\nyarn test:cov\n```\n\n\n## Environment Variables\n\n| Name | Description | Default value | Options |\n| ---- | ----------- | ------------- | ------- |\n| HOST | Host (ip/domain) address of the running service | localhost | - | No |\n| ENV | Project scope | local | local/prod |\n| REDIS_URL | (Optional) Redis connection if you want to enable rate limiter | - | - |\n| INAMEWRAPPER | InterfaceId of NameWrapper Contract | 0xe89c48dc | - |\n| ADDRESS_ETH_REGISTRAR | Ethereum address of ENSBaseRegistrar Contract | 0x57f1887a8BF19b14fC0dF6Fd9B2acc9Af147eA85 | - |\n| ADDRESS_NAME_WRAPPER | Ethereum address of NameWrapper Contract | 0x582224b8d4534F4749EFA4f22eF7241E0C56D4B8 | - |\n| WEB3_NODE_URL | Ethereum Node Provider API | - | - |\n| NODE_PROVIDER | Ethereum Node Provider | Cloudflare | Cloudflare/Google/Infura/Local |\n| NODE_PROVIDER_URL | Ethereum Node Provider API Endpoint | - | - |\n| VPC_ACCESS_CONNECTOR | (Optional) Needed if you will setup Memorystore for GAE | - | - |\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/ensdomains/ens-metadata-service.svg?style=for-the-badge\n[contributors-url]: https://github.com/ensdomains/ens-metadata-service/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/ensdomains/ens-metadata-service.svg?style=for-the-badge\n[forks-url]: https://github.com/mdtanrikulu/ensdomains/ens-metadata-service/members\n[stars-shield]: https://img.shields.io/github/stars/ensdomains/ens-metadata-service.svg?style=for-the-badge\n[stars-url]: https://github.com/ensdomains/ens-metadata-service/stargazers\n[issues-shield]: https://img.shields.io/github/issues/ensdomains/ens-metadata-service.svg?style=for-the-badge\n[issues-url]: https://github.com/ensdomains/ens-metadata-service/issues\n[license-shield]: https://img.shields.io/github/license/ensdomains/ens-metadata-service.svg?style=for-the-badge\n[license-url]: https://github.com/ensdomains/ens-metadata-service/blob/master/LICENSE\n[travis-shield]: https://img.shields.io/travis/com/ensdomains/ens-metadata-service/master?style=for-the-badge\n[travis-url]: https://travis-ci.com/github/ensdomains/ens-metadata-service\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fensdomains%2Fens-metadata-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fensdomains%2Fens-metadata-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fensdomains%2Fens-metadata-service/lists"}