Hyype - Docs
AppTwitterBlog
Search…
Introduction to Hyy.pe
Getting Started
⚙
API Reference
API Introduction
NFT Object Model
NFT Lore Object Model
Canon Lore Object Model
GET Methods
POST Methods
✏
Collection Tools
Tools Introduction
Admin management
Set up a discord Lore bot
Set up a Writing Prompt
Custom Lore Tags
🔗
Useful Links
Supported Chains
App and Social
Brand Kit
Powered By GitBook
NFT Object Model
NFT Details showing traits, descriptions, and ownership details
Every NFT is identified with a combination of <smart-contract-address> and the <token-id>
Example of NFT Details information
Only NFTs supported today are on mainnet Ethereum. See other chains in consideration under Supported Chains​

Overview

Here's an overview of some of the fields contained in a NFT:
Field Name
Description
type
String. Contains the type of the token i.e. erc721 or erc1155
creator
String. creator contains the address of the minting entity
owner
String. owner contains the address of the owner of the token
tokenId
Token Id of the NFT
address
address contains the Smart Contract Address of the specific collection the token belongs to
name
String. name contains the name of the collection
symbol
String. symbol contains the symbol of the NFT collection e.g. DOODLE
recentOwnershipTx
String. recentOwnershipTx contains the last relevant txHash associated with the token. e.g. Sales, Transfer, etc
owners
Number. owners contains the number of unique owners in case of an erc1155 token
slug
slug is the friendly URL string of the NFT collection on hyy.pe platform. If the slug value says "vogu" then it translates to https://hyy.pe/collection/vogu
searchKey
searchKey is a string type which is a combination of address and tokenId. You use searchKey to query all the lore associated with that NFT.
metadata
metadata is an Object of multiple fields which contain attributes/traits as well as media associated with an NFT.

metaData

Below is an example of what fields you can find inside metadata object:
Field Name
Description
name
Name of the NFT if available.
imageUrl
Image URL of the NFT if available.
videoUrl
If its a video NFT type then video file URL of the NFT.
audioUrl
If its a audio NFT type then audio file URL of the NFT.
description
Description of the NFT token as shared by by the tokenURL and Smart contract of that NFT collection.
attributes
Array of all attributes of that NFT.
cachedMedia
Links of cached media available for that NFT on hyy.pe. e.g. images or videos.
API Reference - Previous
API Introduction
Next - API Reference
NFT Lore Object Model
Last modified 19d ago
Export as PDF
Copy link
Contents
Overview
metaData