getAssetsByGroup
The items of one collection.
Details
- Endpoint
- POST getAssetsByGroup (JSON-RPC)
- Credits
- 5
- Rate class
- Heavy. Counts against your heavy requests per second.
Lists the items of a collection. groupKey is collection; groupValue is the Move struct type of the items (0x...::module::Name) or the collection slug. Items come with traits, listing price and rarity. Sort with sortBy price, rarity or listed. Returns not_found when no collection matches.
Parameters
| Name | Type | Description |
|---|---|---|
| groupKeyrequired | string | Only collection is supported on Sui.One of "collection". |
| groupValuerequired | string | The collection's Move struct type or its slug. |
| limit | integer | Items per page, 1 to 100 (each item carries its full traits).Default 50. From 1 to 100. |
| cursor | string | Cursor from the previous response. Preferred over page. |
| page | integer | Page number, 1 to 10. tide maps it to a cursor. Use cursor for anything deeper.From 1 to 10. |
| sortBy | string or object | An object { sortBy, sortDirection }. sortBy: created, updated, recent_action, none (default order), or tide's price, rarity, listed, floor. sortDirection: asc or desc. |
| options | object | Optional flags. |
| options.showCollectionMetadata | boolean | Add collection_metadata (name, image, slug) to grouping. |
Request
Send your key in the x-api-key header, or leave it out to use the keyless tier.
curl
curl -X POST "https://api.tide.ad/" \
-H "x-api-key: YOUR_API_KEY" \
-H "content-type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "getAssetsByGroup",
"params": {
"groupKey": "collection",
"groupValue": "0xb908f3c6fea6865d32e2048c520cdfe3b5c5bbcebb658117c41bad70f52b7ccc::popkins_nft::Popkins",
"limit": 5
}
}'TypeScript
const res = await fetch("https://api.tide.ad/", {
method: "POST",
headers: {
"x-api-key": process.env.TIDE_API_KEY!,
"content-type": "application/json",
},
body: JSON.stringify({
"jsonrpc": "2.0",
"id": 1,
"method": "getAssetsByGroup",
"params": {
"groupKey": "collection",
"groupValue": "0xb908f3c6fea6865d32e2048c520cdfe3b5c5bbcebb658117c41bad70f52b7ccc::popkins_nft::Popkins",
"limit": 5
}
}),
});
const data = await res.json();Response
JSON
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"total": 25000,
"limit": 5,
"cursor": "eyJwIjoibCIsImlkIjoiMHhmNDM3YmU1OWIyNWU4MDkwMjU3MDAzM2NhOTY3YjhkMDJmNDAwMTAwMjk3MTA0NzUzYjI2MjQ3MGUxYjViN2UzIiwiaSI6NX0",
"items": [
{
"interface": "KioskItem",
"id": "0x6434c652adbe461105bb78b692c3af70d40d29c2ef1b91a59040f9eac4153501",
"content": {
"metadata": {
"name": "Popkins #19909",
"symbol": "",
"description": "Who knew so much chaos could come in such a small package? Popkins are an expansive collection of 25,000 joyful, mischievous critters inhabiting the Claynosaurz Universe—all gas, no brakes!",
"attributes": [
{
"trait_type": "Species",
"value": "Gobblejaw"
}
]
},
"links": {
"image": "https://storage.claynosaurz.com/popkins/images/0x6434c652adbe461105bb78b692c3af70d40d29c2ef1b91a59040f9eac4153501",
"external_url": "https://popkins.com/explorer/19909"
},
"files": [
{
"uri": "https://storage.claynosaurz.com/popkins/images/0x6434c652adbe461105bb78b692c3af70d40d29c2ef1b91a59040f9eac4153501",
"cdn_uri": "https://tide.ad/tide-api/v1/img?u=https%3A%2F%2Fstorage.claynosaurz.com%2Fpopkins%2Fimages%2F0x6434c652adbe461105bb78b692c3af70d40d29c2ef1b91a59040f9eac4153501",
"mime": "image/*"
}
]
},
"grouping": [
{
"group_key": "collection",
"group_value": "0xb908f3c6fea6865d32e2048c520cdfe3b5c5bbcebb658117c41bad70f52b7ccc::popkins_nft::Popkins"
}
],
"royalty": {
"basis_points": 500,
"percent": 5,
"primary_sale_happened": null,
"locked": true
},
"creators": [],
"ownership": {
"owner": "0xa7b32af76de025a0080904a498071d64548581f15b20be3e1ec052dc4908cc13",
"ownership_model": "kiosk",
"kiosk": {
"id": "0x560ba1209042066770fa1b70a8e7016ea1ba7da91271ccc2be3768bfbe8394dd",
"listed": true,
"price": {
"amountRaw": "37907784000",
"amount": 37.907784,
"symbol": "SUI",
"usd": 32.371461,
"priceAsOf": "2026-11-06T04:18:09.561Z"
},
"venue": "tradeport"
},
"frozen": false,
"delegated": false
},
"supply": null,
"mutable": true,
"burnt": false,
"sui": {
"type": "0xb908f3c6fea6865d32e2048c520cdfe3b5c5bbcebb658117c41bad70f52b7ccc::popkins_nft::Popkins",
"version": "1072022230",
"digest": "7svpPsTFq9XTupWQn2Pz8tpeT8PCEMbmbiRcT7SiEH2g",
"previousTransaction": "ws95yRGh8q2ewCjabFFkeAU6myy6QkPfFexgTAL79Vi",
"display": {
"attributes": {
"contents": [
{
"key": "Species",
"value": "Gobblejaw"
}
]
},
"avatar_thumb_url": "https://storage.claynosaurz.com/popkins/avatars-thumb/0x6434c652adbe461105bb78b692c3af70d40d29c2ef1b91a59040f9eac4153501",
"avatar_url": "https://storage.claynosaurz.com/popkins/avatars/0x6434c652adbe461105bb78b692c3af70d40d29c2ef1b91a59040f9eac4153501",
"creator": "Claynosaurz",
"description": "Who knew so much chaos could come in such a small package? Popkins are an expansive collection of 25,000 joyful, mischievous critters inhabiting the Claynosaurz Universe—all gas, no brakes!",
"image_url": "https://storage.claynosaurz.com/popkins/images/0x6434c652adbe461105bb78b692c3af70d40d29c2ef1b91a59040f9eac4153501",
"link": "https://popkins.com/explorer/https://popkins.com/explorer/19909",
"name": "Popkins #19909",
"project_url": "https://claynosaurz.com"
},
"rarity": {
"rank": 17551,
"tier": "common"
}
}
},
{
"interface": "KioskItem",
"id": "0x6adecd4f8f4fad1a3803f3cbfe5b44a305ca8f05cc102a06e3dfee95b9e41a43",
"content": {
"metadata": {
"name": "Popkins #22281",
"symbol": "",
"description": "Who knew so much chaos could come in such a small package? Popkins are an expansive collection of 25,000 joyful, mischievous critters inhabiting the Claynosaurz Universe—all gas, no brakes!",
"attributes": [
{
"trait_type": "Species",
"value": "Diplox"
}
]
},
"links": {
"image": "https://storage.claynosaurz.com/popkins/images/0x6adecd4f8f4fad1a3803f3cbfe5b44a305ca8f05cc102a06e3dfee95b9e41a43",
"external_url": "https://popkins.com/explorer/22281"
},
"files": [
{
"uri": "https://storage.claynosaurz.com/popkins/images/0x6adecd4f8f4fad1a3803f3cbfe5b44a305ca8f05cc102a06e3dfee95b9e41a43",
"cdn_uri": "https://tide.ad/tide-api/v1/img?u=https%3A%2F%2Fstorage.claynosaurz.com%2Fpopkins%2Fimages%2F0x6adecd4f8f4fad1a3803f3cbfe5b44a305ca8f05cc102a06e3dfee95b9e41a43",
"mime": "image/*"
}
]
},
"grouping": [
{
"group_key": "collection",
"group_value": "0xb908f3c6fea6865d32e2048c520cdfe3b5c5bbcebb658117c41bad70f52b7ccc::popkins_nft::Popkins"
}
],
"royalty": {
"basis_points": 500,
"percent": 5,
"primary_sale_happened": null,
"locked": true
},
"creators": [],
"ownership": {
"owner": "0xc595fd1272e04593b8930e0316c58b6310b073d594310d6a1fd8335836e5be61",
"ownership_model": "kiosk",
"kiosk": {
"id": "0xfd136b853722ecb1d49b2f053e145fbeb018947318748c365769d217bb3a5b9f",
"listed": true,
"price": {
"amountRaw": "37907892000",
"amount": 37.907892,
"symbol": "SUI",
"usd": 32.371553,
"priceAsOf": "2026-11-06T04:18:09.561Z"
},
"venue": "tradeport"
},
"frozen": false,
"delegated": false
},
"supply": null,
"mutable": true,
"burnt": false,
"sui": {
"type": "0xb908f3c6fea6865d32e2048c520cdfe3b5c5bbcebb658117c41bad70f52b7ccc::popkins_nft::Popkins",
"version": "1071381983",
"digest": "BdYvKm6GnLN16o5tk2TjVN9ZxpZEjMgN78vsjaoK8KQi",
"previousTransaction": "9hb71VKqFHHUPDavsSNSD8PW47a9EqidfU4yn4kc522R",
"display": {
"attributes": {
"contents": [
{
"key": "Species",
"value": "Diplox"
}
]
},
"avatar_thumb_url": "https://storage.claynosaurz.com/popkins/avatars-thumb/0x6adecd4f8f4fad1a3803f3cbfe5b44a305ca8f05cc102a06e3dfee95b9e41a43",
"avatar_url": "https://storage.claynosaurz.com/popkins/avatars/0x6adecd4f8f4fad1a3803f3cbfe5b44a305ca8f05cc102a06e3dfee95b9e41a43",
"creator": "Claynosaurz",
"description": "Who knew so much chaos could come in such a small package? Popkins are an expansive collection of 25,000 joyful, mischievous critters inhabiting the Claynosaurz Universe—all gas, no brakes!",
"image_url": "https://storage.claynosaurz.com/popkins/images/0x6adecd4f8f4fad1a3803f3cbfe5b44a305ca8f05cc102a06e3dfee95b9e41a43",
"link": "https://popkins.com/explorer/https://popkins.com/explorer/22281",
"name": "Popkins #22281",
"project_url": "https://claynosaurz.com"
},
"rarity": {
"rank": 20684,
"tier": "common"
}
}
}
],
"asOf": {
"checkpoint": 342151146,
"timestamp": "2026-11-06T04:18:07.103Z",
"lagMs": 2540
}
}
}Long lists are cut to a few items here.