Search Assets
The method allows users to query and retrieve information about specific NFT assets based on certain criteria (custom-query). This query provides filters such as asset name, owner address, collection ID, or other relevant attributes to narrow down your search. Using this method, users can programmatically explore the Metaplex ecosystem, retrieve information about specific NFT assets, and perform various operations related to those assets, such as transferring ownership or displaying asset metadata.
Parameters (Source)
negate
Indicates whether the search criteria should be inverted or not.
conditionType
Indicates whether to retrieve all ("all"
) or any ("any"
) asset that matches the search criteria.
interface
The interface value (one of ["V1_NFT", "V1_PRINT" "LEGACY_NFT", "V2_NFT", "FungibleAsset", "Custom", "Identity", "Executable"]
).
ownerAddress
The address of the owner.
ownerType
Type of ownership ["single", "token"]
.
creatorAddress
The address of the creator.
creatorVerified
Indicates whether the creator must be verified or not.
authorityAddress
The address of the authority.
grouping
The grouping ["key", "value"]
pair.
delegateAddress
The address of the delegate.
frozen
Indicates whether the asset is frozen or not.
supply
The supply of the asset.
supplyMint
The address of the supply mint.
compressed
Indicates whether the asset is compressed or not.
compressible
Indicates whether the asset is compressible or not.
royaltyTargetType
Type of royalty ["creators", "fanout", "single"]
.
royaltyTarget
The target address for royalties.
royaltyAmount
The royalties amount.
burnt
Indicates whether the asset is burnt or not.
sortBy
Sorting criteria. This is specified as an object { sortBy: <value>, sortDirection: <value> }
, where sortBy
is one of ["created", "updated", "recentAction", "none"]
and sortDirection
is one of ["asc", "desc"]
.
limit
The maximum number of assets to retrieve.
page
The index of the "page" to retrieve.
before
Retrieve assets before the specified ID.
after
Retrieve assets after the specified ID.
jsonUri
The value for the JSON URI.
Last updated