In at present’s tutorial, we’ll present you methods to get ERC-721 on-chain metadata utilizing the Moralis NFT API. Because of the accessibility of this industry-leading interface, all it requires is a single name to the getNFTMetadata() endpoint. Right here’s an instance of what it’d seem like:
const Moralis = require("moralis").default;
const { EvmChain } = require("@moralisweb3/common-evm-utils");
const runApp = async () => {
await Moralis.begin({
apiKey: "YOUR_API_KEY",
// ...and some other configuration
});
const handle = "0xb47e3cd837dDF8e4c57F05d70Ab865de6e193BBB";
const chain = EvmChain.ETHEREUM;
const tokenId = "3931";
const response = await Moralis.EvmApi.nft.getNFTMetadata({
handle,
chain,
tokenId,
});
console.log(response.toJSON());
};
runApp();
All it’s important to do is add your Moralis API key, customise the handle and tokenId parameters, and run the script. In return, you’ll get a response containing the NFT metadata wanting one thing like this:
{
"token_address": "0xb47e3cd837ddf8e4c57f05d70ab865de6e193bbb",
"token_id": "3931",
"transfer_index": [13868997, 30, 36, 0],
"owner_of": "0x1cf2b8c64aed32bff2ae80e701681316d3212afd",
"block_number": "13868997",
"block_number_minted": "5754322",
"token_hash": "3c86855c82470edd82df190019e83f16",
"quantity": "1",
"contract_type": null,
"identify": "CRYPTOPUNKS",
"image": "Ͼ",
"token_uri": "https://www.larvalabs.com/cryptopunks/particulars/3931",
"metadata": "{"picture":"https://www.larvalabs.com/cryptopunks/cryptopunk3931.webp","identify":"CryptoPunk 3931","attributes":["Vampire Hair","Goat"],"description":"Male"}",
"last_token_uri_sync": null,
"last_metadata_sync": "2022-05-12T18:00:22.340Z",
"minter_address": "0xc352b534e8b987e036a93539fd6897f53488e56a"
}
When working with Moralis, it doesn’t must be extra sophisticated than that to get blockchain knowledge. If you happen to’d prefer to study extra about how the above works, please take a look at Moralis’ official documentation on methods to get NFT metadata. Or, be a part of us on this article as we break down the method in additional element! Earlier than we get going, nonetheless, be sure to enroll with Moralis so you can begin constructing your subsequent NFT mission shortly and simply!
Overview
Non-fungible tokens (NFTs) have revolutionized the online by introducing distinctive digital tokens completely match for representing bodily and digital property. A significant a part of most NFTs is their metadata, which incorporates details about every token’s identify, description, transaction historical past, photos, and many others. Accessing this data is, as you’ll be able to think about, a vital a part of creating NFT-related platforms. Nevertheless, querying a blockchain community for the info with out the correct instruments is less complicated stated than carried out. Consequently, we’ll take this text to point out you methods to effortlessly get ERC-721 on-chain metadata utilizing the Moralis NFT API!
Nevertheless, earlier than we get into the tutorial, we’ll kickstart at present’s article by exploring the intricacies of ERC-721 on-chain metadata. From there, we’re going to introduce the Moralis NFT API and clarify why that is the most effective and best approach to get ahold of the data. We’ll then bounce into the tutorial and present you methods to get ERC-721 on-chain metadata in three easy steps:
- Step 1: Set Up a Moralis Account
- Step 2: Create a Script
- Step 3: Run the Script
If you happen to’re already acquainted with the ins and outs of ERC-721 on-chain metadata, then be happy to skip straight into the ”3-Step Tutorial: Get ERC-721 On-Chain Metadata with Moralis” part!
Following the tutorial, we’ll additionally discover some outstanding use circumstances through which NFT metadata is required. Lastly, to high issues off, we’re going to take a look at the Moralis Token API, which gives the identical ease of use and a lot of the performance however for ERC-20 tokens as an alternative!
Nonetheless, with no additional ado, let’s kick issues off by what ERC-721 metadata is!
What’s ERC-721 On-Chain Metadata?
To grasp what ERC-721 on-chain metadata entails, we should first discover the intricacies of ERC-721, probably the most widespread token requirements on Ethereum.
So, what’s the ERC-721 token customary?
ERC-721 is an Ethereum-based customary for non-fungible tokens (NFTs), and it’s primarily a template or format builders conform to comply with when creating NFTs. Utilizing a typical like this makes the developer’s work considerably extra accessible as writing the code turns into simpler and extra predictable. The ERC-721 customary additionally ensures that tokens are appropriate with the remainder of the Web3 ecosystem, together with exchanges, crypto wallets, and many others.
So, now that we’ve familiarized ourselves with the usual, let’s dive into the main points of ERC-721 on-chain metadata!
NFT metadata is the dataset making up the content material of a non-fungible token. This knowledge sometimes describes an NFT’s properties and traits, together with its identify, description, traits, hyperlink to photographs, transaction historical past, and many others. Moreover, ERC-721 on-chain metadata is normally laid out in a JavaScript Object Notation (JSON) format.
As you’ll be able to think about, it’s important to have easy accessibility to ERC-721 on-chain metadata when constructing NFT-based Web3 tasks. Consequently, within the following part, we’ll introduce Moralis’ industry-leading NFT API, as that is the simplest approach to get NFT metadata!
Get ERC-721 Metadata?
If you happen to’re seeking to construct a Web3 mission integrating ERC-721 on-chain metadata in any capability, then you definately’ll want a fast and simple approach to question the blockchain for this data. And the best choice is to leverage Moralis’ industry-leading NFT API!
The NFT API from Moralis is the {industry}’s strongest software for creating NFT tasks. It helps over three million NFT collections throughout ten-plus EVM chains, together with every part from established NFT tasks like CryptoPunks to tokens that dropped just some seconds in the past.
The Moralis NFT API does a number of issues to make your work as a developer considerably extra accessible. Beneath, yow will discover 5 outstanding examples:
- Enriched Metadata: Get entry to normalized and absolutely enriched metadata for each particular person tokens and NFT collections.
- Actual-Time NFT Switch Knowledge: Entry the newest NFT switch knowledge for sure NFTs or wallets in actual time with a single API name.
- Superior Spam Detection: Defend your tasks from undesirable NFTs utilizing spam indicators.
- On-Chain Pricing Knowledge: Entry and incorporate on-chain pricing knowledge in your Web3 tasks, together with the bottom and final sale costs.
- Alerts: Use the Moralis Steams API to get real-time notifications on NFT trades, mints, and market orders.
To study extra about how this works in apply, be a part of us within the subsequent part as we demo the NFT API by displaying you methods to get ERC-721 on-chain metadata in three easy steps!
With the Moralis NFT API, you’ll be able to seamlessly question ERC-721 on-chain metadata with just a few strains of code and a single API name. If this sounds intriguing and also you need to know extra, then be a part of us on this part as we present you methods to get ERC-721 on-chain metadata in three steps:
- Step 1: Set Up a Moralis Account
- Step 2: Create a Script
- Step 3: Run the Script
Nevertheless, earlier than we dive into the preliminary step of this tutorial, you’ll must take care of just a few conditions!
Conditions
Earlier than you should use the NFT API, it’s essential handle just a few conditions. So, when you haven’t already, you can begin by putting in and establishing the next:
You additionally must arrange a mission and run the next command within the root folder to put in the Moralis SDK:
npm set up moralis @moralisweb3/common-evm-utils
That’s it; you’re now prepared to start out utilizing the Moralis NFT API. So be a part of us within the tutorial’s first step as we briefly present you methods to arrange a Moralis account!
Step 1: Set Up a Moralis Account
In an effort to make calls to the Moralis NFT API, you want a Moralis API key. For this, you first want a Moralis account, which you’ll be able to create fully without spending a dime. To take action, merely click on on the ”Begin for Free” button on the high proper of Moralis’ homepage and comply with the directions:
After you have an account at your disposal, you’ll discover your API key by navigating to the ”Web3 APIs” tab and clicking on the ”Get your API keys” button:
This takes you to the next web page, the place you’ll be able to copy your API key:
Now that you’ve got an API key at your disposal, you’re able to make a name to the NFT API!
Step 2: Create a Script
On this tutorial, we’ll be utilizing JavaScript. As such, you’ll be able to proceed by creating a brand new ”index.js” file in your mission’s folder and including the next code:
const Moralis = require("moralis").default;
const { EvmChain } = require("@moralisweb3/common-evm-utils");
const runApp = async () => {
await Moralis.begin({
apiKey: "YOUR_API_KEY",
// ...and some other configuration
});
const handle = "0xb47e3cd837dDF8e4c57F05d70Ab865de6e193BBB";
const chain = EvmChain.ETHEREUM;
const tokenId = "3931";
const response = await Moralis.EvmApi.nft.getNFTMetadata({
handle,
chain,
tokenId,
});
console.log(response.toJSON());
};
runApp();
From right here, you initially want to switch YOUR_API_KEY with the important thing you copied in step one:
Subsequent, add the handle and ID of the NFT you need details about by configuring the handle and tokenId parameters:
We then move the handle, chain, and tokenId parameters when calling the getNFTMetadata() endpoint:
That’s it! Because of the accessibility of Moralis, all we want is a single name to the NFT API to get the ERC-721 on-chain metadata of a token!
All that is still now’s working the script!
Step 3: Run the Script
To execute the script, open a brand new terminal and run the next command within the root folder of your mission:
node index.js
When you run the command, you’ll get a response containing the ERC-721 on-chain metadata. It should look one thing like this:
{
"token_address": "0xb47e3cd837ddf8e4c57f05d70ab865de6e193bbb",
"token_id": "3931",
"transfer_index": [13868997, 30, 36, 0],
"owner_of": "0x1cf2b8c64aed32bff2ae80e701681316d3212afd",
"block_number": "13868997",
"block_number_minted": "5754322",
"token_hash": "3c86855c82470edd82df190019e83f16",
"quantity": "1",
"contract_type": null,
"identify": "CRYPTOPUNKS",
"image": "Ͼ",
"token_uri": "https://www.larvalabs.com/cryptopunks/particulars/3931",
"metadata": "{"picture":"https://www.larvalabs.com/cryptopunks/cryptopunk3931.webp","identify":"CryptoPunk 3931","attributes":["Vampire Hair","Goat"],"description":"Male"}",
"last_token_uri_sync": null,
"last_metadata_sync": "2022-05-12T18:00:22.340Z",
"minter_address": "0xc352b534e8b987e036a93539fd6897f53488e56a"
}
Congratulations! You now know methods to get the NFT metadata of any ERC-721 token with just some strains of code!
Use Instances Requiring ERC-721 Metadata
At this level, you may be questioning why you want simple and quick entry to ERC-721 on-chain metadata. As such, within the following sections, we’ll discover three outstanding ERC-721 metadata use circumstances. Particularly, we’re going to look nearer on the following three examples:
- NFT Marketplaces
- Web3 Wallets
- Web3 Gaming Platforms
So, with out additional ado, let’s bounce into the primary use case and have a look at why you want ERC-721 on-chain metadata when constructing an NFT market!
NFT Marketplaces
An NFT market is a digital platform or web site for storing, displaying, promoting, shopping for, and, typically, even minting NFTs. Some outstanding examples of present NFT marketplaces are OpenSea, Rarible, and SuperRare.
To construct an NFT market with a compelling person expertise, you want a seamless approach to fetch and show the metadata of NFTs. The ERC-721 on-chain metadata incorporates numerous very important data, together with the token’s identify, description, creator, photos, and many others. That is knowledge potential patrons want with the intention to make knowledgeable buying choices.
Web3 Wallets
Web3 wallets are software program applications storing digital property like fungible and non-fungible tokens. Some outstanding examples of crypto wallets embrace MetaMask, Coinbase Pockets, and Belief Pockets.
As you’ll be able to think about, when constructing a Web3 pockets, it’s important to entry the ERC-721 on-chain metadata of the tokens saved in it. This considerably improves the person expertise as you’ll be able to show the token’s properties and traits, together with the identify, description, photos, and many others., straight within the pockets’s person interface.
Web3 Gaming Platforms
Web3 gaming platforms are blockchain-based video games leveraging distributed ledger expertise to supply improved safety, transparency, democratization, and person management over in-game property. Some examples of outstanding Web3 gaming platforms embrace Axie Infinity, CryptoKitties, and The Sandbox.
NFTs play important roles within the Web3 gaming {industry} as they’re excellent for representing in-game characters and gadgets. The metadata of those NFTs normally incorporates crucial details about in-game aesthetics and conduct. As you’ll be able to think about, it’s very important that NFT platforms can entry this knowledge and incorporate the data into recreation dynamics.
Get ERC-20 Metadata?
Do you know that the NFT API solely scratches the floor of what’s attainable with Moralis? Along with the NFT API, Moralis additionally gives different industry-leading APIs, offering the identical accessibility and ease of use for different token sorts!
For example, with the Token API, you’ll be able to effortlessly add real-time token costs, pockets balances, transfers, metadata, and extra for ERC-20 tokens to your dapps and Web3 tasks. With this software, it has by no means been simpler to construct decentralized exchanges, portfolio trackers, Web3 analytics instruments, and Web3 wallets.
If you wish to get the metadata of an ERC-20 token, you’ll be able to merely comply with the identical three steps from the ”Three-Step Tutorial:…” part. Nevertheless, as an alternative of calling the getNFTMetadata() endpoint, you name getTokenMetadata(). Right here’s an instance of what the code ought to seem like:
const Moralis = require("moralis").default;
const { EvmChain } = require("@moralisweb3/common-evm-utils");
const runApp = async () => {
await Moralis.begin({
apiKey: "YOUR_API_KEY",
// ...and some other configuration
});
const addresses = ["0x1f9840a85d5af5bf1d1762f925bdaddc4201f984"];
const chain = EvmChain.ETHEREUM;
const response = await Moralis.EvmApi.token.getTokenMetadata({
addresses,
chain,
});
console.log(response.toJSON());
};
runApp();
To study extra about fetching this, take a look at the official get ERC-20 metadata by contract documentation!
Abstract: Get ERC-721 On-Chain Metadata
In the present day’s article demonstrated methods to get ERC-721 on-chain metadata in three easy steps utilizing the Moralis NFT API:
- Step 1: Set Up a Moralis Account
- Step 2: Create a Script
- Step 3: Run the Script
As such, you now know methods to combine NFT metadata into your tasks!
If you happen to’re now wanting to make use of your abilities and construct extra subtle tasks, take into account trying out extra content material right here on the Web3 weblog. For example, take a look at our tutorial on methods to construct a cryptocurrency portfolio dashboard or learn to construct a decentralized cryptocurrency alternate.
You too can discover extra instruments provided by Moralis. For instance, examine our free crypto Value API or take a look at the testnet taps web page the place you’ll be able to, amongst different issues, discover a Linea Goerli faucet, MATIC faucet, and Optimism Goerli faucet.
Additionally, bear in mind to enroll with Moralis if you need entry to industry-leading instruments just like the NFT API. You possibly can create your account utterly without spending a dime and begin constructing your subsequent Web3 mission instantly!
