---
title: "Generates a badge based on a provided marketplace link"
method: POST
path: "/badges/claim"
tags: ["Badge endpoints"]
---

# Generates a badge based on a provided marketplace link

`POST /badges/claim`

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.

## Request body

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

## Response `200`

Badge pending payment

- SerializedBadge
  - `name` string — Name of the Badge
  - `code` string — Unique badge code
  - `active` boolean — Indicates that the badge is active
  - `logo` string — Badge logo, could be url or emoji
  - `linkUrl` string — Link to external website
  - `videoUrl` string — Link to video
  - `coverImage` string — Link to cover image
  - `type` string — Type of badge
  - `count` number — Number of items associated with the badge
  - `description` string — Description of the badge
  - `gallery` SerializedPartnerTokenGallery
    - `enabled` boolean — Indicates whether the partner token gallery is enabled for this badge
    - `featured` string[] — A list of featured token IDs
    - `tier` number — Indicates the badge feature tier
  - `marketplace` SerializedMarketplaceData
    - `listings` SerializedNft[]
      - `name` string — Name of the NFT
      - `mint` string — Unique address of the NFT
      - `link` string — URL to marketplace entry for NFT
      - `public` boolean — Indicates if the NFT is shown on public gallery
      - `image_url` string — URL to an image associated with the NFT
      - `pfp_uri` string — URI that can be used to specify a UD domain avatar if the NFT type is supported
      - `tags` string[] — Keywords to describe the NFT
      - `collection` string — Name of the collection the NFT belongs to
      - `collectionLink` string — URL to marketplace landing page for this NFT collection
      - `collectionOwners` number — Total number of distinct wallets holding this collection
      - `collectionImageUrl` string — The NFT collection image URL (if available)
      - `description` string — Descriptive text from the NFT's metadata
      - `createdDate` string — The date this NFT was minted
      - `acquiredDate` string — The date this NFT was acquired by the current owner
      - `video_url` string — URL to a video associated with the NFT
      - `supply` number — Total number of NFTs in the collection
      - `floorPrice` SerializedNftPrice
        - `currency` string — The currency associated with NFT price
        - `price` number — The price of the NFT
      - `saleDetails` SerializedSaleDetails
        - `primary` object
          - `type` string — Describes the type of mint (e.g. purchase or distribution)
          - `date` string — Transaction date of initial domain purchase
          - `cost` number — Cost of the domain in USD
          - `payment` object
            - `collected` number — Value of payment collected in USD equivalent (e.g. credit card, crypto, etc)
            - `promoCredits` number — Amount of Unstoppable Domains promo credits used for domain purchase
            - `method` string — Identifies form of payment
        - `secondary` SerializedSecondarySale[]
          - `date` string — Transaction date of secondary activity
          - `txHash` string — Transaction hash related to secondary sale of the domain
          - `marketPlace` string — Marketplace location of the secondary sale
          - `payment` object
            - `symbol` string — Currency used for purchase
            - `valueUsd` number — Purchase amount in USD
            - `valueNative` number — Purchase amount in native currency
      - `traits` object — NFT specific traits
        - `key` string — NFT trait key/value pair
      - `rarity` object — NFT rarity attributes
        - `rank` number — NFT ranking within the collection
        - `score` number — Score value used to determine rank
    - `avgPrice` SerializedNftPrice
      - `currency` string — The currency associated with NFT price
      - `price` number — The price of the NFT
    - `floorPrice` SerializedNftPrice
      - `currency` string — The currency associated with NFT price
      - `price` number — The price of the NFT
    - `supply` number — Total number of NFTs available
    - `holders` number — Total number of holders
    - `sales` number — Total number of sale transactions
    - `volume` number — Total sales volume

## Other responses

- `400` — Invalid marketplace link
- `404` — Collection not found
- `409` — Badge already claimed

---

[API](https://skmtc.net/unstoppabledomains/apis/profile-api.md) · [All operations](https://skmtc.net/unstoppabledomains/apis/profile-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unstoppabledomains/profile-api/versions/10f8400cb1c1/schema)