Post
Share your knowledge.
How to query more than 50 NFTs using getObjects API?
I'm trying to retrieve a large number of NFTs from a blockchain address but ran into a limit in the getObjects API, which restricts the number of objects I can fetch at a time to 50. What's the correct way to handle this limitation and obtain more results? Is there any specific method or example code for handling pagination?
- Sui
- Architecture
Answers
7To overcome the 50-object limit in the getObjects API, you should utilize pagination. This involves using the cursor provided by the API to fetch the next set of results. Start by making an initial API call, then check the response for pagination details like 'nextCursor' and 'hasNextPage'. Use the 'nextCursor' as a parameter in your subsequent API calls until 'hasNextPage' is false, indicating there are no more objects to fetch.
For implementation, refer to the Sui API documentation about pagination and querying objects. This typically involves making a series of requests using the cursor until you have retrieved all desired data. Each response will provide a cursor for the next set of objects, allowing you to handle larger datasets effectively .
You're right, getObjects
is limited and usually used when you already have the specific object IDs. For retrieving objects owned by an address, especially when you need more than 50, you should use the queryObjects
API instead. This API supports pagination using a cursor
. You'll make an initial call, and if hasNextPage
is true, you'll receive a nextCursor
which you then pass into your subsequent calls to fetch the next batch of results. You keep doing this in a loop until hasNextPage
is false, indicating you've retrieved all available objects for that address. You can also filter by object type to specifically target your NFTs.
To query more than 50 NFTs using the getObjects
API, you'll need to use pagination. Here's a step-by-step approach to handle this limitation:
Pagination with getObjects
API
- Initial Request: Make an initial request to the
getObjects
API with the desired filter and limit (up to 50 objects). - Check for Next Page: Check if the response contains a
nextCursor
field. If it does, it means there are more objects available. - Fetch Next Page: Use the
nextCursor
value as thecursor
parameter in the next request to fetch the next page of objects. - Repeat Until No Next Page: Continue fetching pages until the response no longer contains a
nextCursor
field, indicating that you've retrieved all available objects.
Example Code Snippet
Here's an example code snippet demonstrating pagination with the getObjects
API:
import { SuiClient } from '@mysten/sui.js/client';
const suiClient = new SuiClient(); const ownerAddress = '0x...'; // Replace with the owner's address const typeFilter = { Type: '0x2::devnet_nft::DevNetNFT' }; // Replace with the desired type filter
async function getNFTs() { let hasNextPage = true; let cursor = null; const nfts = [];
while (hasNextPage) { const response = await suiClient.getOwnedObjects({ owner: ownerAddress, filter: typeFilter, options: { showType: true, showContent: true, }, limit: 50, cursor, });
nfts.push(...response.data);
if (response.hasNextPage) {
cursor = response.nextCursor;
} else {
hasNextPage = false;
}
}
return nfts; }
getNFTs().then((nfts) => console.log(nfts)); Additional Resources
- Sui Documentation: Refer to the official Sui documentation for more information on pagination and using the
getObjects
API. - Sui Client: Explore the Sui Client documentation for details on implementing pagination and handling large datasets [1].
By using pagination, you can efficiently retrieve a large number of NFTs from a blockchain address while handling the getObjects
API's limit.
When you want to fetch more than 50 NFTs using the getObjects
API in Sui, you need to handle pagination manually since the API limits each request to 50 objects. To work around this, you can use the cursor
parameter to keep track of where you left off and make multiple requests until you've retrieved all the data. Each response includes a nextCursor
value, which you pass into the next request to continue fetching from that point. This way, you can loop through all the NFTs in batches of 50 until there are no more pages left. Here's a basic example in JavaScript using the Sui SDK:
import { SuiClient } from '@mysten/sui.js/client';
const client = new SuiClient({ url: 'https://fullnode.mainnet.sui.io' });
async function fetchAllNFTs(address) {
let hasNextPage = true;
let cursor = null;
const allObjects = [];
while (hasNextPage) {
const response = await client.getOwnedObjects({
owner: address,
cursor: cursor,
limit: 50,
});
allObjects.push(...response.data);
cursor = response.nextCursor;
hasNextPage = response.hasNextPage;
}
return allObjects;
}
This loop keeps calling the API until all NFTs are collected. You can read more about how pagination works in the Sui API documentation.
Do you know the answer?
Please log in and share it.
Sui is a Layer 1 protocol blockchain designed as the first internet-scale programmable blockchain platform.
- Why does BCS require exact field order for deserialization when Move structs have named fields?65
- How to Maximize Profit Holding SUI: Sui Staking vs Liquid Staking514
- Multiple Source Verification Errors" in Sui Move Module Publications - Automated Error Resolution55
- Sui Move Error - Unable to process transaction No valid gas coins found for the transaction419
- Sui Transaction Failing: Objects Reserved for Another Transaction49