Explore NFT API, its use cases and how to utilize it
Background
The NFT API is a solution designed to fulfill diverse on-chain data requirements concerning NFTs. It consolidates all the relevant data on NFTs into one convenient location, which allows users to quickly and efficiently access the specific NFT data they require without sifting through extraneous information.
Supported standards
| NFT Standard | Available |
|---|---|
| ERC-721 | ✅ |
| ERC-1155 | ✅ |
Use cases
The NFT API is suitable for any Web3 project, including the NFT marketplace, NFT games, NFT renting platform, Portfolio tracker, NFT event tickets, and more.
| Endpoint | Description | Order |
|---|---|---|
| Address Inventory | Provides all the NFTs currently held by a specific address | descending |
| Address Inventory History | Provides all the NFTs ever held by a specific address | descending |
| Token Ownership History | Provides all the addresses where a specific NFT has been held | ascending |
| Token Metadata | Provides the metadata for a specific token | — |
| Contract Metadata | Provides the metadata for a specific contract | — |
| Current Collection Holders | Provides all holders who currently possess NFTs from a specific collection | — |
Available blockchain platforms:
PARSIQ strives to bring as many valuable blockchain platforms into our ecosystem as possible. The following table shows the platforms and their chain IDs applicable to the NFT API endpoints. Please note that chainId is a required path parameter to be specified in every request.
| Name | Chain ID |
|---|---|
| Ethereum Mainnet | eip155-1 |
| Polygon PoS | eip155-137 |
| BNB Smart Chain Mainnet | eip155-56 |
| Avalanche C-Chain | eip155-43114 |
| Arbitrum One | eip155-42161 |
Refresh metadata
The constant and simultaneous resynchronization of metadata for all NFTs takes plenty of time. However, there is a method that helps to ensure the metadata remains actual. This involves considering the following points:
- requests for unsynchronized NFTs or entire collections are automatically added to a resynchronization queue
- the NFT collections in high demand are given a higher priority
- the more requests made for a specific item, the higher its position in the queue
Please note that only one request from each user will affect the item's position in the queue.
The Refresh Metadata Endpoint
To save time and processing power, users can resynchronize the metadata of a particular NFT instead of the entire collection. After the resync, a notification is sent, indicating that the updated NFT metadata can be retrieved using the Token Metadata endpoint.