Parameters
- groupKeystringREQUIRED
The key of the group (e.g., "collection")
- groupValuestringREQUIRED
The value of the group
- optionsobject
Optional flags which can be used to return additional information about an asset
- showFungibleboolean
Whether to return token_info object about an asset
- showCollectionMetadataboolean
Whether to return the collection metadata
- sortByobject
Sorting Criteria.
- sortBystring
The criteria to sort by - can be one of "created", "updated", "recentAction", "none"
- sortDirectionstring
Can be one of "asc", "desc"
- limitinteger
The maximum number of assets to retrieve
- cursorstring
The cursor from which to continue returning paginated results
- pageinteger
The index of the page to retrieve. The page parameter starts at 1
- beforestring
Retrieve assets before the specified id
- afterstring
Retrieve assets after the specified id
Returns
- assetListobject
The information about the list of assets:
- totalinteger
The number of assets returned
- limitinteger
The limit specified in the request
- pageinteger
The page number of the results
- cursorstring
The cursor used for pagination. If no page number is included with request, a pagination cursor will be returned in the reponse if there are additional results. Returns null if no additional results.
- itemsarray of objects
An array of objects containing information about the specified assets:
- assetobject
The information about the specified asset:
- interfacestring
The asset interface. "V1_NFT", "V1_PRINT", "LEGACY_NFT", "V2_NFT", "FungibleAsset", "FungibleToken", "Custom", "Identity", "Executable", "ProgrammableNFT", "MplCoreAsset", "MplCoreCollection"
- idstring
The asset id
- contentobject
An object containting the asset content:
- $schemastring
The schema of the asset
- json_uristring
The json uri of the asset
- filesarray of objects
The files related to the asset
- uristring
The uri of the file
- mimestring
The mime type of the file
- qualityobject
The quality of the file
- contextsarray of strings
The contexts of the file
- metadataobject
The metadata of the asset
- namestring
The name of the asset
- descriptionstring
The description of the asset
- symbolstring
The symbol of the asset
- token_standardstring
The token standard of the asset
- attributesarray of objects
The attributes of the asset
- valueinteger/string
The value of the attribute
- trait_typestring
The type of attribute
- linksobject
Links related to the asset
- external_urlstring
The external url
- imagestring
The url of the image
- authoritiesarray of objects
The list of authorities
- addressstring
The address of the authority
- scopesarray of strings
The scopes of the authority - "full", "royalty", "metadata", "extension"
- compressionobject
The compression information for this asset
- asset_hashstring
The asset hash of this asset
- compressedboolean
The compression status of this asset
- creator_hashstring
The creator hash of this asset
- data_hashstring
The data hash of this asset
- eligibleboolean
Whether this asset is eligible
- leaf_idinteger
The leaf id of this asset
- seqinteger
The seq of this asset
- treestring
The tree associated with this asset
- groupingarray of objects
The grouping information for this asset
- group_keystring
The group key for this asset. "collection"
- group_valuestring
The group value for this asset
- royaltystring
Royalty information about this asset
- basis_pointsinteger
The royalty basis points
- lockedboolean
The locked status of the royalty
- percentinteger
The royalty percent
- primary_sale_happenedboolean
The primary sale status
- royalty_modelstring
The royalty model for this asset. "creators", "fanout", "single"
- targetstring
The royalty target
- creatorsarray of objects
The list of creators for this asset
- addressstring
The address of the creator
- shareinteger
The share of the creator
- verifiedboolean
Whether the creator is verified
- ownershipobject
The ownership information of the asset
- delegatestring
The delegate of the asset
- delegatedboolean
Whether the asset is delegated
- frozenboolean
Whether the asset is frozen
- ownerstring
The owner of the asset
- ownership_modelstring
The ownership model of the asset. "single","token"
- usesobject
The uses information of the asset
- remaininginteger
The remaining uses
- totalinteger
The total uses
- use_methodstring
The use method. "burn","multiple","single"
- supplyobject
The supply information of the asset
- edition_nonceinteger
The edition nonce
- print_current_supplyinteger
The current supply
- print_max_supplyinteger
The max supply
- mutableboolean
Whether the asset's metadata is mutable
- burntboolean
Whether the asset is burnt
- mint_extensionsobject
Mint extensions of the asset
1{2"jsonrpc": "2.0",3"result": {4"total": 1,5"limit": 1,6"page": 1,7"items": [8{9"interface": "ProgrammableNFT",10"id": "JEGruwYE13mhX2wi2MGrPmeLiVyZtbBptmVy9vG3pXRC",11"authorities": [12{13"address": "2RtGg6fsFiiF1EQzHqbd66AhW7R5bWeQGpTbv2UMkCdW",14"scopes": [15"full"16]17}18],19"compression": {20"eligible": false,21"compressed": false,22"data_hash": "",23"creator_hash": "",24"asset_hash": "",25"tree": "",26"seq": 0,27"leaf_id": 028},29"grouping": [30{31"group_key": "collection",32"group_value": "J1S9H3QjnRtBbbuD4HjPV6RpRhwuk4zKbxsnCHuTgh9w"33}34],35"royalty": {36"royalty_model": "creators",37"target": null,38"percent": 0.042,39"basis_points": 420,40"primary_sale_happened": true,41"locked": false42},43"creators": [44{45"address": "5XvhfmRjwXkGp3jHGmaKpqeerNYjkuZZBYLVQYdeVcRv",46"share": 0,47"verified": true48}49],50"ownership": {51"frozen": true,52"delegated": false,53"delegate": null,54"ownership_model": "single",55"owner": "3F21SJs4FMpsakrxmd8GjgfQZG6BN6MVsvXcm5Yc6Jcf"56},57"supply": {58"print_max_supply": 0,59"print_current_supply": 0,60"edition_nonce": 25461},62"mutable": true,63"burnt": false64}65]66}67}
1{2"jsonrpc": "2.0",3"result": {4"total": 1,5"limit": 1,6"page": 1,7"items": [8{9"interface": "ProgrammableNFT",10"id": "JEGruwYE13mhX2wi2MGrPmeLiVyZtbBptmVy9vG3pXRC",11"authorities": [12{13"address": "2RtGg6fsFiiF1EQzHqbd66AhW7R5bWeQGpTbv2UMkCdW",14"scopes": [15"full"16]17}18],19"compression": {20"eligible": false,21"compressed": false,22"data_hash": "",23"creator_hash": "",24"asset_hash": "",25"tree": "",26"seq": 0,27"leaf_id": 028},29"grouping": [30{31"group_key": "collection",32"group_value": "J1S9H3QjnRtBbbuD4HjPV6RpRhwuk4zKbxsnCHuTgh9w"33}34],35"royalty": {36"royalty_model": "creators",37"target": null,38"percent": 0.042,39"basis_points": 420,40"primary_sale_happened": true,41"locked": false42},43"creators": [44{45"address": "5XvhfmRjwXkGp3jHGmaKpqeerNYjkuZZBYLVQYdeVcRv",46"share": 0,47"verified": true48}49],50"ownership": {51"frozen": true,52"delegated": false,53"delegate": null,54"ownership_model": "single",55"owner": "3F21SJs4FMpsakrxmd8GjgfQZG6BN6MVsvXcm5Yc6Jcf"56},57"supply": {58"print_max_supply": 0,59"print_current_supply": 0,60"edition_nonce": 25461},62"mutable": true,63"burnt": false64}65]66}67}