# Retrieves badges associated with a domain

Retrieves badge data associated with requested domain.

Endpoint: GET /public/{domain}/badges
Version: 1.0.0

## Path parameters:

  - `domain` (string, required)
    The domain name to query profile data

## Query parameters:

  - `partners` (boolean)
    Include available partner badges in response

## Response 200 fields (application/json):

  - `badges` (array)
    List of badges held by the domain

  - `badges.name` (string)
    Name of the Badge
    Example: "World of Women"

  - `badges.code` (string)
    Unique badge code
    Example: "WoWHolder"

  - `badges.active` (boolean)
    Indicates that the badge is active
    Example: true

  - `badges.logo` (string)
    Badge logo, could be url or emoji
    Example: "https://storage.googleapis.com/unstoppable-client-assets/images/badges/ud-logo.svg"

  - `badges.linkUrl` (string)
    Link to external website
    Example: "https://badge.io/info"

  - `badges.videoUrl` (string)
    Link to video
    Example: "https://storage.googleapis.com/unstoppable-client-assets/images/badges/unstoppabledomains.mp4"

  - `badges.coverImage` (string)
    Link to cover image
    Example: "https://storage.googleapis.com/unstoppable-client-assets/images/badges/bayc-cover-image.png"

  - `badges.type` (string)
    Type of badge
    Example: "default"

  - `badges.count` (number)
    Number of items associated with the badge
    Example: 3

  - `badges.description` (string)
    Description of the badge
    Example: "Holds World of Women NFT."

  - `badges.gallery` (object)

  - `badges.gallery.enabled` (boolean)
    Indicates whether the partner token gallery is enabled for this badge
    Example: true

  - `badges.gallery.featured` (array)
    A list of featured token IDs
    Example: ["0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d/6776"]

  - `badges.gallery.tier` (number)
    Indicates the badge feature tier
    Example: 1

  - `badges.marketplace` (object)

  - `badges.marketplace.listings` (array)

  - `badges.marketplace.listings.name` (string)
    Name of the NFT
    Example: "My NFT"

  - `badges.marketplace.listings.mint` (string)
    Unique address of the NFT
    Example: "a9a6a3626993d487d2dbda3173cf58ca1a9d9e9f"

  - `badges.marketplace.listings.link` (string)
    URL to marketplace entry for NFT
    Example: "https://opensea.io/your/nft"

  - `badges.marketplace.listings.public` (boolean)
    Indicates if the NFT is shown on public gallery
    Example: true

  - `badges.marketplace.listings.image_url` (string)
    URL to an image associated with the NFT
    Example: "https://ipfs.io/ipfs/path/to/image"

  - `badges.marketplace.listings.pfp_uri` (string)
    URI that can be used to specify a UD domain avatar if the NFT type is supported
    Example: "137/erc721:0xa429b85fD3458E8d89b0181A6AF93b577AE040DB/181"

  - `badges.marketplace.listings.tags` (array)
    Keywords to describe the NFT

  - `badges.marketplace.listings.collection` (string)
    Name of the collection the NFT belongs to
    Example: "Bored Ape Yaught Club"

  - `badges.marketplace.listings.collectionLink` (string)
    URL to marketplace landing page for this NFT collection
    Example: "https://opensea.io/your/collection"

  - `badges.marketplace.listings.collectionOwners` (number)
    Total number of distinct wallets holding this collection
    Example: 562

  - `badges.marketplace.listings.collectionImageUrl` (string)
    The NFT collection image URL (if available)
    Example: "https://path/to/collection/image"

  - `badges.marketplace.listings.description` (string)
    Descriptive text from the NFT's metadata
    Example: "NFT collection description"

  - `badges.marketplace.listings.createdDate` (string)
    The date this NFT was minted
    Example: "2023-12-06T13:43:33"

  - `badges.marketplace.listings.acquiredDate` (string)
    The date this NFT was acquired by the current owner
    Example: "2023-12-06T13:43:33"

  - `badges.marketplace.listings.video_url` (string)
    URL to a video associated with the NFT
    Example: "https://ipfs.io/ipfs/path/to/video"

  - `badges.marketplace.listings.supply` (number)
    Total number of NFTs in the collection
    Example: 999

  - `badges.marketplace.listings.floorPrice` (object)

  - `badges.marketplace.listings.floorPrice.currency` (string)
    The currency associated with NFT price
    Example: "ETH"

  - `badges.marketplace.listings.floorPrice.price` (number)
    The price of the NFT
    Example: 0.25

  - `badges.marketplace.listings.saleDetails` (object)

  - `badges.marketplace.listings.saleDetails.primary` (object)

  - `badges.marketplace.listings.saleDetails.primary.type` (string)
    Describes the type of mint (e.g. purchase or distribution)
    Example: "purchase"

  - `badges.marketplace.listings.saleDetails.primary.date` (string)
    Transaction date of initial domain purchase
    Example: "2024-01-03T08:37:00.000Z"

  - `badges.marketplace.listings.saleDetails.primary.cost` (number)
    Cost of the domain in USD
    Example: 25

  - `badges.marketplace.listings.saleDetails.primary.payment` (object)

  - `badges.marketplace.listings.saleDetails.primary.payment.collected` (number)
    Value of payment collected in USD equivalent (e.g. credit card, crypto, etc)
    Example: 20

  - `badges.marketplace.listings.saleDetails.primary.payment.promoCredits` (number)
    Amount of Unstoppable Domains promo credits used for domain purchase
    Example: 5

  - `badges.marketplace.listings.saleDetails.primary.payment.method` (string)
    Identifies form of payment
    Example: "stripe"

  - `badges.marketplace.listings.saleDetails.secondary` (array)

  - `badges.marketplace.listings.saleDetails.secondary.date` (string)
    Transaction date of secondary activity
    Example: "2024-01-03T08:37:00.000Z"

  - `badges.marketplace.listings.saleDetails.secondary.txHash` (string)
    Transaction hash related to secondary sale of the domain
    Example: 4660

  - `badges.marketplace.listings.saleDetails.secondary.marketPlace` (string)
    Marketplace location of the secondary sale
    Example: "Magic Eden"

  - `badges.marketplace.listings.traits` (object)
    NFT specific traits

  - `badges.marketplace.listings.traits.key` (string)
    NFT trait key/value pair
    Example: "value"

  - `badges.marketplace.listings.rarity` (object)
    NFT rarity attributes

  - `badges.marketplace.listings.rarity.rank` (number)
    NFT ranking within the collection
    Example: 1

  - `badges.marketplace.listings.rarity.score` (number)
    Score value used to determine rank
    Example: 1.05

  - `badges.marketplace.avgPrice` (object)

  - `badges.marketplace.supply` (number)
    Total number of NFTs available
    Example: 10000

  - `badges.marketplace.holders` (number)
    Total number of holders
    Example: 1000

  - `badges.marketplace.sales` (number)
    Total number of sale transactions
    Example: 3

  - `badges.marketplace.volume` (number)
    Total sales volume
    Example: 3

  - `partners` (array)
    List of featured badges available from partners

  - `refresh` (object)

  - `refresh.last` (string)
    Timestamp of last badge refresh
    Example: "2022-11-28 00:00:00"

  - `refresh.next` (string)
    Timestamp of next badge refresh
    Example: "2022-12-01 00:00:00"


## Response 404 fields