Skip to content
Metadata/
/
Get Domain metadata

Metadata (1.0.0)

The Unstoppable Domains Metadata APIs provide standard NFT metadata routes for our various onchain assets. This includes ERC721, ERC1155 and ERC7572 metadata endpoints for various collections and tokens.

Note: While this API is public, endpoints are rate limited. While the default rate limit should be sufficient for client applications, if you would like a higher limit rate for a backend system, please send a request to UD Partner Engineering to acquire an API key.

Overview
Unstoppable Domains (Partner Engineering)
partnerengineering@unstoppabledomains.com
Languages
Servers
Production
https://api.unstoppabledomains.com/metadata/
Sandbox
https://api.ud-sandbox.com/metadata/

Domains

Metadata for our Web3 and tokenized Web2 Domains, available at unstoppabledomains.com.

Metadata is returned for all UD domains, regardless of the underlying blockchain or smart contract it is associated with. All endpoints accept either the domain name (example.x) or the the numeric token ID as the path parameter.

Operations

Get Domain metadata

Request

Path
domainOrTokenstring[^\/#\?]+?required

A domain name or the eip137 namehash of a domain registered by Unstoppable Domains

curl -i -X GET \
  'https://api.unstoppabledomains.com/metadata/{domainOrToken}'

Responses

Bodytext/html; charset=utf-8
external_linkstring
image_urlstring
attributesArray of objectsrequired
background_colorstring
animation_urlstring
youtube_urlstring
namestringrequired
tokenIdstringrequired
namehashstringrequired
descriptionstringrequired
imagestringrequired
external_urlstringrequired

Get Domain image

Request

Get the domain image SVG data

Path
domainOrTokenstring[^\/#\?]+?required

A domain name or the eip137 namehash of a domain registered by Unstoppable Domains

Query
withOverlayboolean
themestring
Enum"light""dark"
curl -i -X GET \
  'https://api.unstoppabledomains.com/metadata/image/{domainOrToken}?withOverlay=true&theme=light'

Responses

Bodytext/html; charset=utf-8
imagestring
image_datastringrequired

Get Domain image source

Request

URL to use as the src when rendering the domain image on a UI.

Path
domainOrTokenstring[^\/#\?]+?required

A domain name or the eip137 namehash of a domain registered by Unstoppable Domains

Query
withOverlayboolean
themestring
Enum"light""dark"
curl -i -X GET \
  'https://api.unstoppabledomains.com/metadata/image-src/{domainOrToken}?withOverlay=true&theme=light'

Responses

Successful response

Bodytext/html; charset=utf-8

Onchain Badges

Metadata for our NFT Badge and NFT Badge collection service. Both the collections and badges are dynamically created, so the collection address must be included as a path parameter for all requests.

Operations