NFT Lore Object Model
Lores are the primary object in Hyype API
Every post someone makes via Hyy.pe about their NFT, is called a "Lore". Hyy.pe API allows builders to integrate these stories directly into their apps and experiences. Below is an example of a Lore posted on Hyy.pe.
Only NFT owners can post lore. Once the NFT is sold - previous owner looses access to contribute lore to the sold NFT.
Here's an overview of some of the fields contained in a Lore:
Field Name | Description |
|---|---|
createdAt | Shows when this lore was added. This is shared as a unix timestamp |
taggedToken | Tagged token shares the details of the NFT for which this Lore was written. see taggedToken section below. |
loreDetails | loreDetails is the Object array of lore blocks which when combined together represent the entire lore. Lore can be made up of several text blocks, images, videos, embeds among different things. see loreDetails section below. |
previewText | This shares the text blurb which is displayed as a peek text on a Lore card if you are designing a feed. |
previewImageUrl | This shares a preview image of the Lore (defined by the author) which is displayed as a peek image on a Lore card if you are designing a feed. Optional. |
type | Two types of lore are shared on hyype , either a collector statement or a backstory. More will be added soon. |
ipfsHash | This shares the unique id of a lore object pinned on ipfs. |
author | |
commentCount | This shares how many times the lore was commented on Hyy.pe. |
reactionLooksRareCount | This shares how many times the lore was reacted on Hyy.pe. |
viewCount | This shares how many times the lore was viewed on Hyy.pe. |
taggedToken is the NFT object in the hyype API. NFT objects will include name, collection info, metadata & traits, media among other things as part of the response. Below are a few fields contained in a NFT object:
Field Name | Description |
|---|---|
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. |
address | Smart Contract Address of the NFT. |
tokenId | Token id of the NFT. |
metadata | metadata is an Object of multiple fields which contain attributes/traits as well as media associated with an NFT. |
Individual Lores can be formed by combining many building blocks sequenced together. Building blocks can come in many forms - paragraphs, quotes, links, embeds, and much more.
loreDetails is an array of block objects which together to form the whole lore. Field name | Type | Description |
|---|---|---|
blocks | Object Array | blocks come in a variety of types - paragraph, embeds, images, videos & quotes being few of the more commonly used ones. |
A few examples of blocks are included below:
paragraph
image
video
quote
embed
{
"id": "tbqvAKSuyg",
"type": "paragraph",
"data": {
"text": "<b>There has always been a bit of mystery surrounding this one. </b>"
}
}
{
"id": "IfOVQ2AeDW",
"type": "image",
"data": {
"file": {
"url": "https://media.hyy.pe/700xAUTO/61561912f084510012274814-1635403828014.jpeg"
},
"caption": "Year 2133: Citizen #10082 looking at the vast emptiness of planet Laran",
"withBorder": false,
"stretched": false,
"withBackground": false
}
}
{
"id": "VYvoLmuo0X",
"type": "video",
"data": {
"url": "https://videos.ctfassets.net/znxnw90vc5ew/7uAidRmq7VC7bvTq1Zd8Rx/c821009212f9fcfb1e5052cf0051392a/cover28-timelapse2_1.mp4",
"caption": "",
"autoplay": true,
"controls": true,
"muted": true,
"stretched": false
}
}
{
"id": "_jwh8Miavq",
"type": "quote",
"data": {
"text": "How did it all come to this",
"caption": "- Alien king says to himself",
"alignment": "left"
}
}
{
"id": "TVJQ2E5vmU",
"type": "embed",
"data": {
"service": "youtube",
"source": "https://youtu.be/5GaJOnwTHw8",
"embed": "https://www.youtube.com/embed/5GaJOnwTHw8",
"width": 580,
"height": 320,
"caption": ""
}
}
Author is a hyy.pe user writing this Lore. Here's an overview of some of the fields contained in a author object:Field Name | Description |
|---|---|
followersCount | Number of followers the user has on hyy.pe |
followingsCount | Number of people this user follows on hyy.pe |
wallets | All Wallet address associated with this user on hyy.pe |
primaryWallet | Primary wallet address associated with this user on hyy.pe |
createdAt | The timestamp of when this user was created on hyy.pe platform |
userName | Unique username string of this user on hyy.pe platform. |
displayName | Full name or display name of this user on hyy.pe platform. |
bio | Short text blurb defined by the user for their introduction/profile. |
verifiedProfileImage | If the user has an NFT as a profile image then this object is returned. Object structure is the same as taggedToken / NFT object. |
profilePhotoUrl | If the user uploaded a custom image then this returns a static image file as the user profile picture. |
Last modified 1yr ago