Metadata (1.0.0)

Unstoppable Domains (Partner Engineering): partnerengineering@unstoppabledomains.com

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.

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.

Get Domain metadata

Request
path Parameters
domainOrToken
required
string[^\/#\?]+?

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

Responses
200
get/{domainOrToken}
Request samples 
Get Domain image
Get the domain image SVG data


Request 
path Parameters
domainOrToken
required
string[^\/#\?]+?
A domain name or the eip137 namehash of a domain registered by Unstoppable Domains


 
query Parameters
withOverlay
boolean
 
theme
string
 Enum: "light" "dark"  
Responses 
200
get/image/{domainOrToken}
Request samples 
Get Domain image source
URL to use as the src when rendering the domain image on a UI.


Request 
path Parameters
domainOrToken
required
string[^\/#\?]+?
A domain name or the eip137 namehash of a domain registered by Unstoppable Domains


 
query Parameters
withOverlay
boolean
 
theme
string
 Enum: "light" "dark"  
Responses 
200
Successful response


get/image-src/{domainOrToken}
Request samples 
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.


Get Badge Collection metadata
Request 
path Parameters
contractAddress
required
string  <= 100 characters 
 
 Example:  0x8E618876B960E5e2BC76ADb38155251877A2c5d1
Responses 
200
get/badges/c/{contractAddress}
Request samples 
Response samples 
application/json
{
  • "address": "string",
  • "name": "string",
  • "description": "string",
  • "image": "string",
  • "external_link": "string"
}
Get Badge metadata
Request 
path Parameters
contractAddress
required
string  <= 100 characters 
 
 Example:  0x8E618876B960E5e2BC76ADb38155251877A2c5d1
tokenId
required
string  <= 250 characters 
 
 Example:  78819804847991891929675112938372578562447166123909758354093252150865352382960
Responses 
200
get/badges/c/{contractAddress}/b/{tokenId}
Request samples 
Response samples 
application/json
{
  • "tokenId": "string",
  • "name": "string",
  • "description": "string",
  • "external_url": "string",
  • "attributes": [
    ],
  • "image": "string",
  • "background_color": "string"
}