Skip to main content

Interface: Nft

NFT record.

Hierarchy​

Properties​

approved​

• approved: boolean

NFT has been approved

auction​

• Optional auction: string

The build5 id of the auction this nft belongs to

auctionFloorPrice​

• Optional auctionFloorPrice: number

Auction minimum price.

auctionFrom​

• Optional auctionFrom: Timestamp

NFT Auction from date/time

auctionHighestBid​

• Optional auctionHighestBid: number

NFT Auction current highest bid

auctionHighestBidder​

• Optional auctionHighestBidder: string

NFT Auction current highest bidder Member

auctionLength​

• Optional auctionLength: number

Auction length.

auctionTo​

• Optional auctionTo: Timestamp

NFT Auction to date/time

available​

• available: NftAvailable

NFTs Availability.

availableFrom​

• availableFrom: Timestamp

NFT is available from (initial sale only)

availablePrice​

• Optional availablePrice: number

If on sale, available price for this NFT.

collection​

• collection: string

NFT Collection Collection

createdBy​

• Optional createdBy: string

Member UID Member

Inherited from​

BaseRecord.createdBy

createdOn​

• Optional createdOn: Timestamp

Date/time it was created on.

Inherited from​

BaseRecord.createdOn

depositData​

• Optional depositData: NftMintingData

NFT deposit data

description​

• description: string

NFT Description

extendAuctionWithin​

• Optional extendAuctionWithin: number

Auction will be extended if a bid happens this many milliseconds before auction ends

extendedAuctionLength​

• Optional extendedAuctionLength: number

Extended auction length.

extendedAuctionTo​

• Optional extendedAuctionTo: Timestamp

NFT Auction extended to date/time

ipfsMedia​

• ipfsMedia: string

IPFS CID for media link.

ipfsMetadata​

• ipfsMetadata: string

IPFS CID for metadata link.

ipfsRoot​

• Optional ipfsRoot: string

IPFS Root directory for all IPFS files.

isOwned​

• Optional isOwned: boolean

NFT Is NFT owned. This field is used to simplify filtering.

lastTradedOn​

• lastTradedOn: Timestamp

Last traded on.

locked​

• Optional locked: boolean

NFT locked for sale.

lockedBy​

• Optional lockedBy: string

NFT is locked by member Member

media​

• media: string

URL to the NFT image.

mediaStatus​

• Optional mediaStatus: MediaStatus

NFT Media status

mintingData​

• Optional mintingData: NftMintingData

NFT Minting data

name​

• name: string

NFT Name

owner​

• Optional owner: string

NFT current owner Member

placeholderNft​

• placeholderNft: boolean

Is this NFT placeholder

price​

• price: number

NFT current price based on previous sales

properties​

• properties: PropStats

NFTs properties

rejected​

• rejected: boolean

NFT has been rejected

saleAccess​

• Optional saleAccess: NftAccess

See NftAccess for options

saleAccessMembers​

• Optional saleAccessMembers: string[]

Sales access Members saleAccess

setAsAvatar​

• Optional setAsAvatar: boolean

NFT is set as avatar.

sold​

• Optional sold: boolean

Is NFT sold (always true after intial sale)

soldOn​

• Optional soldOn: Timestamp

NFT Sold on

space​

• space: string

Link to space Space

stats​

• stats: PropStats

NFTs stats

status​

• Optional status: NftStatus

NFT status.

totalTrades​

• totalTrades: number

Total number of trades for this NFT

type​

• type: CollectionType

Collection Type. Inherited from the Collection. It's hear for filtering purposes.

updatedOn​

• Optional updatedOn: Timestamp

Date/time it was updated on.

Inherited from​

BaseRecord.updatedOn

url​

• url: string

URL to NFT