Skip to main content

Search Assets

Search for assets using a variety of parameters.

Parameters​

  • negate boolean
    Indicates whether the search criteria should be inverted or not.

  • conditionType string
    Indicates whether to retrieve all ("all") or any ("any") asset that matches the search criteria.

  • interface string
    The interface value (one of ["V1_NFT", "V1_PRINT", "LEGACY_NFT", "V2_NFT", "FungibleAsset", "Custom", "Identity", "Executable", "MplCoreCollection", "MplCoreAsset"]).

  • ownerAddress string
    The address of the owner.

  • ownerType string
    Type of ownership ["single", "token"].

  • creatorAddress string, required
    The address of the creator.

  • creatorVerified boolean
    Indicates whether the creator must be verified or not.

  • authorityAddress string
    The address of the authority.

  • grouping object
    The grouping ["key", "value"] pair.

  • delegateAddress string
    The address of the delegate.

  • frozen boolean
    Indicates whether the asset is frozen or not.

  • supply number
    The supply of the asset.

  • supplyMint string
    The address of the supply mint.

  • compressed boolean
    Indicates whether the asset is compressed or not.

  • compressible boolean
    Indicates whether the asset is compressible or not.

  • royaltyTargetType string
    Type of royalty ["creators", "fanout", "single"].

  • royaltyTarget string
    The target address for royalties.

  • royaltyAmount number
    The royalties amount.

  • burnt boolean
    Indicates whether the asset is burnt or not.

  • sortBy object
    Sorting criteria. This is specified as an object { sortBy: <value>, sortDirection: <vlaue> }, where sortBy is one of ["created", "updated", "recentAction", "none"] and sortDirection is one of ["asc", "desc"].

  • limit number
    The maximum number of assets to retrieve.

  • page number
    The index of the "page" to retrieve.

  • before string
    Retrieve assets before the specified ID.

  • after string
    Retrieve assets after the specified ID.

  • jsonUri string
    The value for the JSON URI.

Example Request​

curl --request POST --url "<ENDPOINT>" --header 'Content-Type: application/json' --data '{
    "jsonrpc": "2.0",
    "method": "searchAssets",
    "params": {
        "ownerAddress": "N4f6zftYsuu4yT7icsjLwh4i6pB1zvvKbseHj2NmSQw",
        "jsonUri": "https://arweave.net/c9aGs5fOk7gD4wWnSvmzeqgtfxAGRgtI1jYzvl8-IVs/chiaki-violet-azure-common.json",
        "page": 1
    },
    "id": 0
}'

The Mpl-Core feature has expanded the range of options available for the interface field, introducing two new variants: MplCoreCollection and MplCoreAsset. These additions enable the querying of corresponding assets.