LogoLogo
  • DFK Developer Docs
  • Contracts
    • Exchanges
      • The Trader
      • The Bazaar
    • Sales & Rentals
      • Hero Auction
      • Hero Rental
      • Equipment Auction
      • Pet Auction
      • Land Auction
    • Summoning
      • Hero Summoning
        • Dark Summoning
      • Pet Hatching
    • Meditation Circle
    • Quests
      • Quest Core
      • Historical Contracts
        • Quest Core
        • Profession Quests
        • Training Quests
    • Void Hunts
    • Patrols
    • PVP Combat
    • Influence System
    • Gardens
      • Master Gardener
    • Jeweler 2.0
      • Power-Ups
      • Jeweler 1.0
    • Profiles
    • DFK Duel
      • Previous Seasons
      • Raffle Master
    • Events
      • Gen0 Reroll
      • Gene Reroll
      • Perilous Journey
    • Bridging
      • Hero Bridge (Synapse)
      • Hero Bridge (LayerZero)
      • Equipment Bridge (Synapse)
      • Equipment Bridge (LayerZero)
      • Item Bridge V2
        • Item Bridge V1 (Deprecated)
      • Gaia's Tear Bridge
    • Miscellaneous
      • Airdrops
      • Charity
      • Flag Storage
      • Gen0 Airdrop (Harmony)
      • Gen0 Sale (Harmony)
      • Graveyard
      • Locked Token Claim
      • Locked Token Raffle
      • Token Disburse
  • NFTs
    • Heroes
      • HeroV4 (Metis)
    • Equipment
      • Weapons
      • Armor
      • Accessories
      • Shared Equipment Mappings
      • CacheCore
      • Equipment Shop
      • Visage Shop
    • Pets
      • Pet Exchange
    • Lands
  • Tokens
    • Ecosystem Token
    • Power Tokens
    • Governance Tokens
    • Currencies
      • DFK Gold
      • Gaia's Tears
    • Inventory Items
    • Gold Crops
    • Combat Items
    • Miscellaneous Tokens
      • Collectible Items
      • Raffle Tickets
  • Crafting
    • Alchemist
    • Nutritionist
    • Stone Carver
    • Vendor (Item Gold Trader)
  • Collections
    • Runes
    • Pet Eggs
    • Pet Treats
    • Potions & Consumables
      • Item Consumer
      • Potion Migrator
    • Enhancement Stones
    • Attunement Crystals
      • Atonement Crystals
    • Pages of the Eternal Story
  • API
    • Community GraphQL API
      • Getting Started
      • Auctions
      • Bazaar
      • Heroes
      • Pets
      • Profiles
    • Hero Metadata & Image API
    • Pet Metadata & Image API
    • Token Supply API
  • Community Builders
    • Kingdom Building Program
    • Developer Resources
    • Community Projects
  • DFK CHain
    • Getting Started
    • Nodes & Validators
    • Bridged Tokens
    • Ecosystem Partners
      • Covalent API
      • SupraOracles Price Feeds
      • SupraOracles VRF
    • Miscellaneous Contracts
Powered by GitBook
On this page
  • Returns metadata about the requested Pet
  • Returns a static, transparent png image of the requested Pet
  1. API

Pet Metadata & Image API

PreviousHero Metadata & Image APINextToken Supply API

Last updated 1 year ago

You can use the following endpoints to access Pet metadata and static images of DFK Pets by Pet ID.

Pet Metadata

Returns metadata about the requested Pet

GET https://pets.defikingdoms.com/token/{id}

Example -

Path Parameters

Name
Type
Description

*

integer

The ID of the requested Pet.

E.g.: 1234, 1000000001234, 2000000001234

Note: Pets native to Crystalvale have IDs that are padded by 1000000000000 (one trillion), and those native to Serendale 2.0 are padded by 2000000000000 (two trillion).

Pet Static Image

Returns a static, transparent png image of the requested Pet

GET https://pets.defikingdoms.com/image/{id}?{queryParams}

Examples

Full Image -

No Frame -

Path Parameters

Name
Type
Description

id*

integer

The ID of the requested Pet.

E.g.: 1234, 1000000001234, 2000000001234

Note: Pets native to Crystalvale have IDs that are padded by 1000000000000 (one trillion), and those native to Serendale 2.0 are padded by 2000000000000 (two trillion).

Query Parameters

Name
Type
Description

frame

Boolean

Default: true

Includes the Pet frame in the image response.

background

Boolean

Default: true

Includes the Pet background in the image response.

https://pets.defikingdoms.com/token/1
https://pets.defikingdoms.com/image/1
https://pets.defikingdoms.com/image/1?frame=false