Skip to main content

Entities

Lock

Description: get specific details of the lock

FieldTypeDescription
idID!Unique ID for the Lock object (uses the lock address)
addressBytes!Address of the lock
nameStringA descriptive name for a collection of NFTs in this contract
symbolStringToken symbol
expirationDurationBigInt!Duration is set the on the lock when you deploy and the expiration which is set on each key when they are minted
tokenAddressBytes!Address of the 'currency' ERC20 contract if the keys are priced using an ERC20
priceBigInt!Price of the keys sold the lock
lockManagers[Bytes!]!An assigned role set on a Lock contract which gives the highest level of permissions to the wallet address set to that role
versionBigInt!Unlock Protocol version of a "minting contract".
totalKeysBigInt!number of keys owned by keyOwner (expired or not)
maxNumberOfKeysBigInt!Maximum number of keys for sale
mayKeyPerAddressBigInt!The maximum number of keys allowed for a single address
keysKey!Refer to key entity
createdAtBlockBigIntWhich block the lock was created
lastKeyMintedAtBigIntThe timestamp of the block in which the last key was minted

Key

Description: get specific details of the Key

FieldTypeDescription
idID!Unique identifier for a key (combination of lock address and token id)
lockLock!In the Unlock ecosystem, a “Lock” is a smart contract that creates (or “mints”) NFTs
tokenIdBigInt!TokenId for a given key
ownerBytes!The address of the key owner
managerBytesAn assigned title set on an Unlock key which gives a specific wallet address authorization to transfer, share or cancel
expirationBigInt!Time the key expires
tokenURIStringThe tokenURI on an NFT is a unique identifier
createdAtBlockBigInt!Block key was created
cancelledBooleanInvoked by a Lock manager to expire the user's key and perform a refund and cancellation of the keyThrows

UnlockDailyData

Description: get specific details of the Daily Data Unlock

FieldTypeDescription
idID!Day Identifier
lockDeployedBigInt!Number of locks deployed on that day
keysSoldBigInt!Daily number of keys sold
activeLocks[Bytes!]Daily number of active locks
grossNetworkProductBigInt!Total value exchanged on the network

LockStats

Description: get specific details of LockStats

FieldTypeDescription
idID!Transaction hash
totalLocksDeployedBigInt!Total locks deployed
totalKeysSoldBigInt!Total keys sold