v1

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-107095124.5 KB

Badge endpoints

Generates a badge based on a provided marketplace link

Creates a badge based on a provided marketplace link, such as OpenSea, Zuse.market, etc. The badge must be purchased to be activated before it can be claimed by other domains.

post/badges/claim

Request body

linkstring

Marketplace link to the NFT collection you want to claim a badge (e.g. OpenSea, MagicEden, Zuse.market, etc)

Example request

{
  "link": "https://opensea.io/collection/unstoppable-domains-polygon"
}

Response

Badge pending payment

namestring

Name of the Badge

codestring

Unique badge code

activeboolean

Indicates that the badge is active

logostring

Badge logo, could be url or emoji

linkUrlstring

Link to external website

videoUrlstring

Link to video

coverImagestring

Link to cover image

typestring

Type of badge

countnumber

Number of items associated with the badge

descriptionstring

Description of the badge

Example response

{
  "name": "World of Women",
  "code": "WoWHolder",
  "active": true,
  "logo": "https://storage.googleapis.com/unstoppable-client-assets/images/badges/ud-logo.svg",
  "linkUrl": "https://badge.io/info",
  "videoUrl": "https://storage.googleapis.com/unstoppable-client-assets/images/badges/unstoppabledomains.mp4",
  "coverImage": "https://storage.googleapis.com/unstoppable-client-assets/images/badges/bayc-cover-image.png",
  "type": "default",
  "count": 3,
  "description": "Holds World of Women NFT.",
  "gallery": {
    "enabled": true,
    "featured": [
      "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d/6776"
    ],
    "tier": 1
  },
  "marketplace": {
    "listings": [
      {
        "name": "My NFT",
        "mint": "a9a6a3626993d487d2dbda3173cf58ca1a9d9e9f",
        "link": "https://opensea.io/your/nft",
        "public": true,
        "image_url": "https://ipfs.io/ipfs/path/to/image",
        "pfp_uri": "137/erc721:0xa429b85fD3458E8d89b0181A6AF93b577AE040DB/181",
        "collection": "Bored Ape Yaught Club",
        "collectionLink": "https://opensea.io/your/collection",
        "collectionOwners": 562,
        "collectionImageUrl": "https://path/to/collection/image",
        "description": "NFT collection description",
        "createdDate": "2023-12-06T13:43:33",
        "acquiredDate": "2023-12-06T13:43:33",
        "video_url": "https://ipfs.io/ipfs/path/to/video",
        "supply": 999,
        "floorPrice": {
          "currency": "ETH",
          "price": 0.25
        },
        "saleDetails": {
          "primary": {
            "type": "purchase",
            "date": "2024-01-03T08:37:00.000Z",
            "cost": 25,
            "payment": {
              "collected": 20,
              "promoCredits": 5,
              "method": "stripe"
            }
          },
          "secondary": [
            {
              "date": "2024-01-03T08:37:00.000Z",
              "marketPlace": "Magic Eden",
              "payment": {
                "symbol": "ETH",
                "valueUsd": 100,
                "valueNative": 0.1
              }
            }
          ]
        },
        "traits": {
          "key": "value"
        },
        "rarity": {
          "rank": 1,
          "score": 1.05
        }
      }
    ],
    "avgPrice": {
      "currency": "ETH",
      "price": 0.25
    },
    "floorPrice": {
      "currency": "ETH",
      "price": 0.25
    },
    "supply": 10000,
    "holders": 1000,
    "sales": 3,
    "volume": 3
  }
}