nftscan-api

NFTScan API SDK (JavaScript / TypeScript)

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 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 One	arbitrumapi.nftscan.com	arbitrum
OP Mainnet	optimismapi.nftscan.com	optimism
zkSync Era	zksyncapi.nftscan.com	zksync
Linea	lineaapi.nftscan.com	linea
Base	baseapi.nftscan.com	base
PlatON	platonapi.nftscan.com	platon
Avalanche-C	avaxapi.nftscan.com	avalanche
Cronos	cronosapi.nftscan.com	cronos
Fantom	fantomapi.nftscan.com	fantom
Gnosis	gnosisapi.nftscan.com	gnosis
Viction	victionapi.nftscan.com	viction
Starknet	starknetapi.nftscan.com	starknet
Mantle	mantleapi.nftscan.com	mantle
Blast	blastapi.nftscan.com	blast
Solana	solanaapi.nftscan.com	solana

The value of Short name is used in the SDK as an initialization configuration parameter.

Getting started

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);

or

import { ErcType, NftscanEvm } from "nftscan-api";

const config = {
  apiKey: "<YOUR_API_KEY>", // Replace with your NFTScan API key.
  baseUrl: "<HTTPS_URL>" + "/api", // Or replace with a valid https URL.
};

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. It must be ensured that one of the chain or baseUrl attribute is valid. A valid baseUrl supported by NFTSCAN can be found here: EVM chains.

The complete enumeration value of EvmChain includes the following:

export enum EvmChain {
  ETH = 'eth',
  BNB = 'bnb',
  POLYGON = 'polygon',
  ARBITRUM = 'arbitrum',
  OPTIMISM = 'optimism',
  ZKSYNC = 'zksync',
  LINEA = 'linea',
  Base = 'base',
  AVALANCHE = 'avalanche',
  MOONBEAM = 'moonbeam',
  PLATON = 'platon',
  CRONOS = 'cronos',
  FANTOM = 'fantom',
  GNOSIS = 'gnosis',
  VICTION = 'viction',
  STARKNET = 'starknet',
}

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));

Pagination

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;

API

The SDK currently supports all of the NFTScan API endpoints, The distribution of the API is consistent with the NFTScan API.

As follows:

• NFTScan API of EVM

  • Retrieve Assets (new NftscanEvm().asset.*)

    • getAssetsByAccount(): Get NFTs by account
    • getAllAssets(): Get all NFTs by account
    • getAccountMinted(): Get minted NFTs by account
    • getAssetsByContract(): Get NFTs by contract
    • getAssetsByContractAndTokenId(): Get single NFT
    • queryAssetsInBatches: Get multiple NFTs
    • queryAssetsByFilters(): Search NFTs.
    • queryAssetsByAttributes(): Get NFTs by attributes
    • getMultiChainAssets(): Get all multi-chain NFTs by account

  • Retrieve Transactions (new NftscanEvm().transaction.*)

    • getTransactionsByAccount(): Get transactions by account
    • getTransactionsByContract(): Get transactions by contract
    • getTransactionsByContractAndTokenId(): Get transactions by NFT
    • queryTransactionsByFilters(): Search transactions
    • getTransactionsByToAddress(): Get transactions by to address
    • queryTransactionsByTxHashList(): Get transactions by hash

  • Retrieve Collections (new NftscanEvm().collection.*)

    • getCollectionsByContract(): Get an NFT collection
    • queryCollectionsByFilters(): Search NFT collections
    • queryCollectionsByAccountAddress(): Get NFT collections by account
    • getCollectionsByRanking(): Get NFT collections by ranking

  • Statistics (new NftscanEvm().statistic.*)

    • getTradeRanking(): Trade ranking
    • getMintRanking(): mint ranking
    • getMintAmount(): Mint amount
    • getTradersRanking(): Traders ranking
    • getGasRanking(): Gas ranking
    • getCollectionRanking(): Collection ranking
    • getMarketplaceRanking(): Marketplace ranking
    • getMarketCapRanking(): Market cap ranking
    • getCollectionStatistics(): Collection statistics
    • getCollectionTrade(): Collection trade distribution
    • getCollectionTrending(): Collection trending statistics
    • getBlueChipStatistics(): Blue chip
    • getAccountOverview(): Account overview
    • getCollectionOverview(): Collection overview
    • getWalletRanking(): Wallet Ranking
    • getTradeWalletRanking(): Wallet Trade Ranking
    • getCollectionHoldingAmountDistribution(): Collection Holding Amount Distribution
    • getCollectionHoldingPeriodDistribution(): Collection Holding Period Distribution
    • getCollectionBlueChipList(): Collection Blue Chip List
    • getAccountHoldingDistribution(): Account Holding Distribution
    • getCollectionTopHolder(): Collection Top Holder

  • Refresh (new NftscanEvm().refresh.*)

    • refreshAsset(): Refresh an asset
    • refreshContract():Refresh a contract

  • Other (new NftscanEvm().other.*)

    • getBlockNumber(): Get latest block number
    • queryAssestAmountByAccounts(): Get NFT amount by account
    • getAssetOwnerByContract(): Get NFT owners by contract
    • getAssetOwnerByContractAndTokenId(): Asset owner amount for an asset

• NFTScan API of Solana

  • Retrieve Assets (new NftscanSolana().asset.*)

    • getAssetsByAccount(): Get NFTs by account
    • getAllAssets(): Get all NFTs by account
    • getAccountMinted(): Get minted NFTs by account
    • getAssetsByCollection(): Get NFTs by collection
    • getAssetsByTokenAddress(): Get single NFT
    • queryAssetsInBatches: Get multiple NFTs

  • Retrieve Transactions (new NftscanSolana().transaction.*)

    • getTransactionsByAccount(): Get transactions by account
    • getTransactionsByCollection(): Get transactions by collection
    • getTransactionsByTokenAddress(): Get transactions by NFT

  • Retrieve Collections (new NftscanSolana().collection.*)

    • getCollection(): Get an NFT collection
    • queryCollectionsByFilters(): Search NFT collections

  • Statistics (new NftscanSolana().statistic.*)

    • getTradeRanking(): Trade ranking
    • getCollectionStatistics(): Collection Statistics

  • Refresh (new NftscanSolana().refresh.*)

    • refreshAsset(): Refresh an asset

More

• NFTScan API
• NFTScan API Docs
• NFTScan NFT Explorer

Changelog

1.13.1 (2024-04-15)

✨ Features | 新功能

• Modify the limit of the getCollectionRanking interface (02c5234)