nftscan-api
Advanced tools
The NFTScan API SDK is a JavaScript / TypeScript library which provides convenience and quick access to the NFTScan's APIs, it helps developers build new experiences retrieving NFTs and data analysis. We provide a set of endpoints that enable you to fetch ERC721 and ERC1155 NFT assets as well as transactions, collections, marketplace statistics and more.
To use our APIs, You need to register an account on NFTScan open platform OpenAPI Platform and get your API-KEY for making calls to API services.
The daily request limit for a single account is 10,000 general calls. If you have more needs, please upgrade your API plans to OpenAPI Pricing to enhance the number of calls and obtain access to the PRO interfaces.
The SDK currently supports the following chains:
| Blockchain | Domain name | Short name |
|---|---|---|
| Ethereum | restapi.nftscan.com | eth |
| BNB chain | bnbapi.nftscan.com | bnb |
| Polygon | polygonapi.nftscan.com | polygon |
| Moonbeam | moonbeamapi.nftscan.com | moonbeam |
| Arbitrum | arbitrumapi.nftscan.com | arbitrum |
| Optimism | optimismapi.nftscan.com | optimism |
| PlatON | platonapi.nftscan.com | platon |
| Avalanche | avaxapi.nftscan.com | avalanche |
| Solana | solanaapi.nftscan.com | solana |
| Cronos | cronosapi.nftscan.com | cronos |
The value of Short name is used in the SDK as an initialization configuration parameter.
via npm:
npm install nftscan-api
or yarn:
yarn add nftscan-api
Then you can import and use the SDK:
import { ErcType, EvmChain, NftscanEvm } from "nftscan-api";
const config = {
apiKey: "<YOUR_API_KEY>", // Replace with your NFTScan API key.
chain: EvmChain.ETH, // Replace with your chain.
};
const evm = new NftscanEvm(config);
The new NftscanEvm() returns an object that can query the EVM-like chain, for here it is EvmChain.ETH, which stand for the Ethereum blockchain.
The complete enumeration value of EvmChain includes the following:
export enum EvmChain {
ETH = 'eth',
BNB = 'bnb',
ARBITRUM = 'arbitrum',
MOONBEAM = 'moonbeam',
POLYGON = 'polygon',
OPTIMISM = 'optimism',
PLATON = 'platon',
AVALANCHE = 'avalanche',
CRONOS = 'cronos',
}
And then you can use the object evm to access to the NFTScan API, form example getAssetsByAccount, which can retrieve the assets owned by an account.
const accountAddress = "<ACCOUNT_ADDRESS>"; // Replace with the account address you want to query.
// Access asset-related APIs
evm.asset
// Retrieve assets owned by an account.
.getAssetsByAccount(accountAddress, {
erc_type: ErcType.ERC_721, // Can be erc721 or erc1155
})
.then((res) => console.log(res));
// Access transaction-related APIs
evm.transaction
// Retrieve transactions by an account
.getTransactionsByAccount(accountAddress)
.then((res) => console.log(res));
Not only asset and transaction, but the NftscanEvm also provides several other objects, for example collection \ statistic \ other, these objects provide different types of APIs.
To query the other EVM-like chain's asset, for example 'Arbitrum', changing the config param chain to EvmChain.ARBITRUM:
const evm = new NftscanEvm({
apiKey: "<YOUR_API_KEY>",
chain: EvmChain.ARBITRUM,
});
We also support the Solana blockchain, to access the API, you just need to use new NftscanSolana() to get an object.
const sol = new NftscanSolana({ apiKey: "<YOUR_API_KEY>" });
sol.asset
.getAssetsByAccount("<ACCOUNT_ADDRESS>")
.then((res) => console.log(res));
In general, NFTScan's API that supports pagination will uses the query params cursor as the paging parameter, The return data of the API call will contain the attribute next, you can pass in the next value to the next call.
For example:
let nextCursor = "";
const { content, next } = await evm.asset.getAccountMinted("<ACCOUNT_ADDRESS>", {
cursor: nextCursor, // A cursor to retrieve the next page
limit: 20, // Page size
});
// update the nextCursor
nextCursor = next;
The SDK currently supports all of the NFTScan API endpoints, The distribution of the API is consistent with the NFTScan API.
As follows:
new NftscanEvm().asset.*)getAssetsByAccount(): Retrieve assets owned by an account.getAllAssets(): Retrieve all assets owned by an account group by contract address.getAccountMinted(): Retrieve assets minted by an account.getAssetsByContract(): Retrieve assets by contract address.getAssetsByContractAndTokenId(): Retrieve an asset by contract address and token ID.getMultiChainAssets(): Retrieve multi-chain assets owned by an account.queryAssetsInBatches: Retrieve assets by list of contract address and token ID.queryAssetsByFilters(): Retrieve assets with filters.queryAssetsByAttributes(): Retrieve assets by contract address with attributes.new NftscanEvm().transaction.*)getTransactionsByAccount(): Retrieve transactions by an account.getTransactionsByContract(): Retrieve transactions by contract address.getTransactionsByContractAndTokenId(): Retrieve transactions by contract address and token ID.getTransactionsByToAddress(): Retrieve transactions by to address.queryTransactionsByFilters(): Retrieve transactions with filters.queryTransactionsByTxHashList(): Retrieve transactions by the list of transaction hash.new NftscanEvm().collection.*)getCollectionsByContract(): Retrieve a collection by contract address.getCollectionsByRanking(): Retrieve collections by ranking.queryCollectionsByFilters(): Retrieve collections with filters.queryCollectionsByAccountAddress(): Retrieve collections by account address.new NftscanEvm().statistic.*)getTradeRanking(): Obtain trade ranking statistics.getCollectionRanking(): Obtain collection ranking statistics.getCollectionTrade(): Obtain collection trade distribution.getCollectionTrending(): Obtain collection trending statistics.getAccountOverview(): Obtain account overview statistics.getBlueChipStatistics(): Obtain blue chip statistics.getMarketplaceRanking(): Obtain marketplace ranking statistics.getMarketCapRanking(): Obtain market cap ranking statisticsgetCollectionStatistics(): Obtain collection statistics.getMintRanking(): Obtain mint ranking statistics.getMintAmount(): Obtain mint amount statistics.getTradersRanking(): Obtain traders ranking statistics.getGasRanking(): Obtain traders ranking statistics.getVolumeIn24h(): Obtain 24h volume statistics.new NftscanEvm().other.*)getBlockNumber(): Obtain the latest block number.queryAssestAmountByAccounts(): Obtain asset amount owned by accounts.getAssetOwnerByContract(): Obtain asset owner amount by contract address.getAssetOwnerByContractAndTokenId(): Obtain asset owner's amount by contract address and token ID.refreshMetadata(): Submit a task for refreshing NFT metadata.new NftscanSolana().asset.*)getAssetsByAccount(): Retrieve assets owned by an account.getAllAssets(): Retrieve all assets owned by an account group by collection.getAccountMinted(): Retrieve assets minted by an account.getAssetsByCollection(): Retrieve assets by collection.getAssetsByTokenAddress(): Retrieve an asset by token address.new NftscanSolana().transaction.*)getTransactionsByAccount(): Retrieve transactions by an account.getTransactionsByCollection(): Retrieve transactions by collection.getTransactionsByTokenAddress(): Retrieve transactions by token address.new NftscanSolana().collection.*)getCollection(): Retrieve a collection.queryCollectionsByFilters(): Retrieve collections with filters.new NftscanSolana().statistic.*)getTradeRanking(): Obtain trade ranking statistics.FAQs
js/ts SDK for NFTScan APIs
The npm package nftscan-api receives a total of 70 weekly downloads. As such, nftscan-api popularity was classified as not popular.
We found that nftscan-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.