Skip to content
Metadata/
/
Get Badge Collection meta...

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

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

Get Badge Collection metadata

Request

Path
contractAddressstring<= 100 charactersrequired
Example: 0x8E618876B960E5e2BC76ADb38155251877A2c5d1
curl -i -X GET \
  https://api.unstoppabledomains.com/metadata/badges/c/0x8E618876B960E5e2BC76ADb38155251877A2c5d1

Responses

Bodyapplication/json
addressstring
namestring
descriptionstring
imagestring
external_linkstring
Response
application/json
{
  "address": "string",
  "name": "string",
  "description": "string",
  "image": "string",
  "external_link": "string"
}

Get Badge metadata

Request

Path
contractAddressstring<= 100 charactersrequired
Example: 0x8E618876B960E5e2BC76ADb38155251877A2c5d1
tokenIdstring<= 250 charactersrequired
Example: 78819804847991891929675112938372578562447166123909758354093252150865352382960
curl -i -X GET \
  https://api.unstoppabledomains.com/metadata/badges/c/0x8E618876B960E5e2BC76ADb38155251877A2c5d1/b/78819804847991891929675112938372578562447166123909758354093252150865352382960

Responses

Bodyapplication/json
tokenIdstringrequired
namestring
descriptionstring
external_urlstring
attributesArray of objects
imagestring
background_colorstring
Response
application/json
{
  "tokenId": "string",
  "name": "string",
  "description": "string",
  "external_url": "string",
  "attributes": [
    {}
  ],
  "image": "string",
  "background_color": "string"
}