# Retrieve badge rankings Generates a list of badges ordered by number of holders Endpoint: GET /badges/rankings Version: 1.0.0 ## Path parameters: - `count` (number) The number of rankings to retrieve - `communityOnly` (boolean) Include only community sponsored badges ## Response 200 fields (application/json): - `badge` (object) - `badge.name` (string) Name of the Badge Example: "World of Women" - `badge.code` (string) Unique badge code Example: "WoWHolder" - `badge.active` (boolean) Indicates that the badge is active Example: true - `badge.logo` (string) Badge logo, could be url or emoji Example: "https://storage.googleapis.com/unstoppable-client-assets/images/badges/ud-logo.svg" - `badge.linkUrl` (string) Link to external website Example: "https://badge.io/info" - `badge.videoUrl` (string) Link to video Example: "https://storage.googleapis.com/unstoppable-client-assets/images/badges/unstoppabledomains.mp4" - `badge.coverImage` (string) Link to cover image Example: "https://storage.googleapis.com/unstoppable-client-assets/images/badges/bayc-cover-image.png" - `badge.type` (string) Type of badge Example: "default" - `badge.count` (number) Number of items associated with the badge Example: 3 - `badge.description` (string) Description of the badge Example: "Holds World of Women NFT." - `badge.gallery` (object) - `badge.gallery.enabled` (boolean) Indicates whether the partner token gallery is enabled for this badge Example: true - `badge.gallery.featured` (array) A list of featured token IDs Example: ["0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d/6776"] - `badge.gallery.tier` (number) Indicates the badge feature tier Example: 1 - `badge.marketplace` (object) - `badge.marketplace.listings` (array) - `badge.marketplace.listings.name` (string) Name of the NFT Example: "My NFT" - `badge.marketplace.listings.mint` (string) Unique address of the NFT Example: "a9a6a3626993d487d2dbda3173cf58ca1a9d9e9f" - `badge.marketplace.listings.link` (string) URL to marketplace entry for NFT Example: "https://opensea.io/your/nft" - `badge.marketplace.listings.public` (boolean) Indicates if the NFT is shown on public gallery Example: true - `badge.marketplace.listings.image_url` (string) URL to an image associated with the NFT Example: "https://ipfs.io/ipfs/path/to/image" - `badge.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" - `badge.marketplace.listings.tags` (array) Keywords to describe the NFT - `badge.marketplace.listings.collection` (string) Name of the collection the NFT belongs to Example: "Bored Ape Yaught Club" - `badge.marketplace.listings.collectionLink` (string) URL to marketplace landing page for this NFT collection Example: "https://opensea.io/your/collection" - `badge.marketplace.listings.collectionOwners` (number) Total number of distinct wallets holding this collection Example: 562 - `badge.marketplace.listings.collectionImageUrl` (string) The NFT collection image URL (if available) Example: "https://path/to/collection/image" - `badge.marketplace.listings.description` (string) Descriptive text from the NFT's metadata Example: "NFT collection description" - `badge.marketplace.listings.createdDate` (string) The date this NFT was minted Example: "2023-12-06T13:43:33" - `badge.marketplace.listings.acquiredDate` (string) The date this NFT was acquired by the current owner Example: "2023-12-06T13:43:33" - `badge.marketplace.listings.video_url` (string) URL to a video associated with the NFT Example: "https://ipfs.io/ipfs/path/to/video" - `badge.marketplace.listings.supply` (number) Total number of NFTs in the collection Example: 999 - `badge.marketplace.listings.floorPrice` (object) - `badge.marketplace.listings.floorPrice.currency` (string) The currency associated with NFT price Example: "ETH" - `badge.marketplace.listings.floorPrice.price` (number) The price of the NFT Example: 0.25 - `badge.marketplace.listings.saleDetails` (object) - `badge.marketplace.listings.saleDetails.primary` (object) - `badge.marketplace.listings.saleDetails.primary.type` (string) Describes the type of mint (e.g. purchase or distribution) Example: "purchase" - `badge.marketplace.listings.saleDetails.primary.date` (string) Transaction date of initial domain purchase Example: "2024-01-03T08:37:00.000Z" - `badge.marketplace.listings.saleDetails.primary.cost` (number) Cost of the domain in USD Example: 25 - `badge.marketplace.listings.saleDetails.primary.payment` (object) - `badge.marketplace.listings.saleDetails.primary.payment.collected` (number) Value of payment collected in USD equivalent (e.g. credit card, crypto, etc) Example: 20 - `badge.marketplace.listings.saleDetails.primary.payment.promoCredits` (number) Amount of Unstoppable Domains promo credits used for domain purchase Example: 5 - `badge.marketplace.listings.saleDetails.primary.payment.method` (string) Identifies form of payment Example: "stripe" - `badge.marketplace.listings.saleDetails.secondary` (array) - `badge.marketplace.listings.saleDetails.secondary.date` (string) Transaction date of secondary activity Example: "2024-01-03T08:37:00.000Z" - `badge.marketplace.listings.saleDetails.secondary.txHash` (string) Transaction hash related to secondary sale of the domain Example: 4660 - `badge.marketplace.listings.saleDetails.secondary.marketPlace` (string) Marketplace location of the secondary sale Example: "Magic Eden" - `badge.marketplace.listings.traits` (object) NFT specific traits - `badge.marketplace.listings.traits.key` (string) NFT trait key/value pair Example: "value" - `badge.marketplace.listings.rarity` (object) NFT rarity attributes - `badge.marketplace.listings.rarity.rank` (number) NFT ranking within the collection Example: 1 - `badge.marketplace.listings.rarity.score` (number) Score value used to determine rank Example: 1.05 - `badge.marketplace.avgPrice` (object) - `badge.marketplace.supply` (number) Total number of NFTs available Example: 10000 - `badge.marketplace.holders` (number) Total number of holders Example: 1000 - `badge.marketplace.sales` (number) Total number of sale transactions Example: 3 - `badge.marketplace.volume` (number) Total sales volume Example: 3 - `sponsorship` (object) - `sponsorship.max` (number) Maximum number of sponsorships available Example: 10 - `sponsorship.count` (number) Number of current sponsorships Example: 5 - `sponsorship.latest` (string) Domain name of the most recent sponsor Example: "latest.crypto" - `sponsorship.authorizedAddresses` (array) List of wallet addresses authorized to interact with badge - `sponsorship.domains` (array) - `sponsorship.domains.name` (string) Domain name of sponsor Example: "sponsor.crypto" - `sponsorship.domains.count` (number) Number of sponsorships Example: 1 - `usage` (object) High level usage details about a specific badge - `usage.holders` (number) Number of unique wallets holding the badge Example: 10000 - `usage.domains` (number) Number of domains associated with the badge Example: 10000 - `usage.featured` (array) List of highlighted domains holding the badge Example: ["matt.crypto"] - `usage.rank` (number) Ranking when compared to other badges by number of holders. Lower is better. Example: 1