nftscan-api - npm Package Compare versions

Comparing version 1.6.1 to 1.7.0

dist/src/api/evm/asset/index.d.ts

@@ -10,3 +10,3 @@ import { AccountMintParams, AssetParams, BatchQueryAssetsListItemParams, CommonAssetParams, QueryAssetsByAttributesParams, QueryAssetsByFiltersParams } from '../../../types/evm/asset/request-params';
     /**
-     * Retrieve assets owned by an account.
+     * Retrieve assets for account.
      * - This endpoint returns a set of NFTs owned by an account address.
@@ -20,3 +20,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getAccountNftAssetsUsingGET}
     /**
-     * Retrieve all assets owned by an account group by contract address.
+     * Retrieve all assets for account.
      * - This endpoint returns all NFTs owned by an account address. And the NFTs are grouped according to contract address.
@@ -31,3 +31,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getAccountNftAssetsGroupByContractAddressUsingGET}
     /**
-     * Retrieve assets minted by an account.
+     * Retrieve assets minted for account.
      * - This endpoint returns a set of NFTs minted by an account address.
@@ -44,3 +44,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getAccountMintedUsingGET}
      * *****
-     * Retrieve assets by contract address.
+     * Retrieve assets for contract
      * - This endpoint returns a set of NFTs that belong to an NFT contract address. The NFTs are sorted by token_id with ascending direction.
@@ -54,3 +54,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getAssetsByContractAddressUsingGET}
     /**
-     * Retrieve an asset by contract address and token ID.
+     * Retrieve an asset
      * - This endpoint returns a single NFT.
@@ -68,3 +68,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getAssetByContractAddressAndTokenIdUsingGET}
      * *****
-     * Retrieve multi-chain assets owned by an account.
+     * Retrieve multi-chain assets for account
      * - This endpoint returns all multi-chain NFTs owned by an account address. And the NFTs are grouped according to contract address.
@@ -82,3 +82,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getAssetsByMultiChainUsingGET}
      * *****
-     * Retrieve assets by list of contract address and token ID.
+     * Retrieve multiple assets
      * - This endpoint returns a set of NFTs according to the search list in the request body.
@@ -106,3 +106,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getAssetsByListUsingPOST_1}
      * *****
-     * Retrieve assets by contract address with attributes.
+     * Retrieve assets with attributes
      * - This endpoint returns a set of NFTs those belong to an NFT contract address with attributes. The NFTs are sorted by token_id with ascending direction.
@@ -109,0 +109,0 @@ * - details: {@link https://docs.nftscan.com/nftscan/getAssetsByContractAddressWithAttributesUsingPOST}

dist/src/api/evm/collection/index.d.ts

@@ -13,3 +13,3 @@ import { QueryCollectionsByAccountAddressParams, QueryCollectionsByFiltersParams, QueryCollectionsByRankingParams } from '../../../types/evm/collection/request-params';
      * *****
-     * Retrieve a collection by contract address.
+     * Retrieve a collection
      * - This endpoint returns information for a collection with the given NFT contract address.
@@ -47,3 +47,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getCollectionUsingGET}
      * *****
-     * Retrieve collections by account address.
+     * Retrieve collections for account
      * - This endpoint returns information for a list of collections by the account address. The collections are sorted by floor_price with descending direction.
@@ -50,0 +50,0 @@ * - details: {@link https://docs.nftscan.com/nftscan/getCollectionsOwnByAccountAddressUsingGET}

dist/src/api/evm/nftscan-evm.d.ts

@@ -6,2 +6,3 @@ import { NftscanConfig } from '../../types/nftscan-type';
 import NftscanEvmOther from './other';
+import NftscanEvmRefresh from './refresh';
 import NftscanEvmStatistic from './statistic';
@@ -36,2 +37,6 @@ import NftscanEvmTransaction from './transaction';
     /**
+     * The `refresh` object contains NFTScan's EVM-like chain refresh metadata API.
+     */
+    get refresh(): NftscanEvmRefresh;
+    /**
      * The `other` object contains NFTScan's EVM-like chain useful extension methods.
@@ -38,0 +43,0 @@ */

dist/src/api/evm/other/index.d.ts

 import { QueryAssetOwnerByContractParams, QueryAssetOwnerParams } from '../../../types/evm/other/request-params';
-import { QueryAssestAmountResponse, QueryAssetOwnerByContractAndTokenIdResponse, QueryAssetOwnerResponse, QueryBlockNumberResponse, RefreshMetadataResponse } from '../../../types/evm/other/response-data';
+import { QueryAssestAmountResponse, QueryAssetOwnerByContractAndTokenIdResponse, QueryAssetOwnerResponse, QueryBlockNumberResponse } from '../../../types/evm/other/response-data';
 import { NftscanConfig } from '../../../types/nftscan-type';
@@ -10,3 +10,3 @@ import BaseApi from '../../base-api';
     /**
-     * Obtain latest block number.
+     * Latest block number
      * - This endpoint returns the latest block number NFTScan has reached to.
@@ -21,3 +21,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getBlockNumberUsingGET}
      * *****
-     * Obtain asset amount owned by accounts.
+     * Asset amount for accounts
      * - This endpoint returns information for ERC721 and ERC1155 NFT amount owned by an account address according to the search list in the request body.
@@ -33,3 +33,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getAssetAmountByAccountsUsingPOST}
      * *****
-     * Obtain asset owner amount by contract address.
+     * Asset owners for contract
      * - This endpoint returns a list of owners for  ERC721 NFT asset.
@@ -45,3 +45,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getAssetOwnerAmountByContractUsingGET}
      * *****
-     * Obtain asset owner amount by contract address and token ID.
+     * Asset owner amount for an asset
      * - This endpoint returns information for owner amount of NFTs that belong to an NFT contract address. The NFTs are sorted by token_id with ascending direction.
@@ -53,14 +53,2 @@ * - details: {@link https://docs.nftscan.com/nftscan/getAssetOwnersUsingGET}
     getAssetOwnerByContractAndTokenId(params: QueryAssetOwnerParams): Promise<QueryAssetOwnerByContractAndTokenIdResponse>;
-    /**
-     * *****
-     * [PRO]
-     * *****
-     * Submit a task for refreshing NFT metadata.
-     * - This endpoint enables you to submit a background task. The task will refresh the metadata for a contract_address or a specified NFT asset.
-     * - details: {@link https://docs.nftscan.com/nftscan/refreshAssetMetadataUsingPOST}
-     * @param contractAddress The NFT contract address
-     * @param tokenId The NFT token ID. Can be in Hex or in Number
-     * @returns Promise<{@link RefreshMetadataResponse}>
-     */
-    refreshMetadata(contractAddress: string, tokenId: string): Promise<RefreshMetadataResponse>;
 }

dist/src/api/evm/statistic/index.d.ts

 import { QueryCollectionRankingParams, QueryMarketplaceRankingParams, QueryTradeRankingParams } from '../../../types/evm/statistic/request-params';
-import { QueryAccountOverviewResponse, QueryBlueChipStatisticsResponse, QueryCollectionRankingResponse, QueryCollectionStatisticsResponse, QueryCollectionTradeResponse, QueryCollectionTrendingResponse, QueryGasRankingResponse, QueryMarketCapRankingResponse, QueryMarketplaceRankingResponse, QueryMintAmountResponse, QueryMintRankingResponse, QueryTradeRankingResponse, QueryTradersRankingResponse, QueryVolumeIn24hResponse } from '../../../types/evm/statistic/response-data';
+import { QueryAccountOverviewResponse, QueryBlueChipStatisticsResponse, QueryCollectionRankingResponse, QueryCollectionStatisticsResponse, QueryCollectionTradeResponse, QueryCollectionTrendingResponse, QueryGasRankingResponse, QueryMarketCapRankingResponse, QueryMarketplaceRankingResponse, QueryMintAmountResponse, QueryMintRankingResponse, QueryTradeRankingResponse, QueryTradersRankingResponse, CollectionOverviewResponse } from '../../../types/evm/statistic/response-data';
 import { NftscanConfig, RangeType, TradeType } from '../../../types/nftscan-type';
@@ -10,3 +10,3 @@ import BaseApi from '../../base-api';
     /**
-     * Obtain trade ranking statistics.
+     * Trade ranking
      * - This endpoint returns NFT trade ranking statistics referring to NFTScan Ranking({@link https://www.nftscan.com/ranking})
@@ -22,3 +22,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getTradeUsingGET_1}
      * *****
-     * Obtain collection ranking statistics.
+     * Collection ranking
      * - This endpoint returns NFT collection ranking statistics.
@@ -34,3 +34,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/collectionRankingUsingGET}
      * *****
-     * Obtain collection trade distribution.
+     * Collection trade distribution
      * - This endpoint returns NFT collection trade distribution referring to NFTScan Traded Distribution({@link https://www.nftscan.com/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d?module=Analytics}).
@@ -47,5 +47,5 @@ * - details: {@link https://docs.nftscan.com/nftscan/tradeDistributionUsingGET}
      * *****
-     * Obtain collection trending statistics.
+     * Collection trending statistics
      * - This endpoint returns NFT collection trending statistics referring to NFTScan Trending({@link https://www.nftscan.com/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d?module=Analytics}).
-     * - details: {@link https://docs.nftscan.com/nftscan/trendingUsingGET_1}
+     * - details: {@link https://docs.nftscan.com/nftscan/trendingUsingGET}
      * @param contractAddress The NFT contract address
@@ -60,3 +60,3 @@ * @param time Can be 1h, 4h, 12h, 1d, 3d, 7d, 30d and 90d. 1d for default
      * *****
-     * Obtain account overview statistics.
+     * Account overview
      * - This endpoint returns overview statistics for an account address referring to NFTScan Overview({@link https://www.nftscan.com/0xea7a0f1434084b2e99b42f045896e7326fed9dc1}).
@@ -72,3 +72,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/accountOverviewUsingGET}
      * *****
-     * Obtain blue chip statistics.
+     * Blue chip
      * - This endpoint returns blue chip statistics referring to({@link https://www.nftscan.com/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d?module=Analytics}).
@@ -81,3 +81,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/blueChipUsingGET}
     /**
-     * Obtain marketplace ranking statistics.
+     * Marketplace ranking
      * - This endpoint returns NFT marketplace ranking statistics referring to NFTScan Marketplace({@link https://www.nftscan.com/marketplace}).
@@ -90,3 +90,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getMarketplaceUsingGET}
     /**
-     * Obtain market cap ranking statistics
+     * Market cap ranking
      * - This endpoint returns NFT market cap ranking statistics.
@@ -101,3 +101,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getMarketCapUsingGET}
      * *****
-     * Obtain collection statistics.
+     * Collection statistics
      * - This endpoint returns statistics for a collection referring to NFTScan Collection({@link https://www.nftscan.com/search/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d}).
@@ -110,3 +110,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getCollectionUsingGET_2}
     /**
-     * Obtain mint ranking statistics.
+     * Mint ranking
      * - This endpoint returns NFT mint ranking statistics referring to NFTScan Discover({@link https://www.nftscan.com/analytics/discover}) for the section of 'Top Mints'.
@@ -119,3 +119,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getMintUsingGET}
     /**
-     * Obtain mint amount statistics.
+     * Mint amount
      * - This endpoint returns NFT mint amount statistics referring to NFTScan Discover({@link https://www.nftscan.com/analytics/discover}) for the section of 'Amount of New NFTs'.
@@ -128,3 +128,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getAmountUsingGET}
     /**
-     * Obtain traders ranking statistics.
+     * Traders ranking
      * - This endpoint returns NFT traders ranking statistics referring to NFTScan Discover({@link https://www.nftscan.com/analytics/discover}) for the section of 'Top Traders'.
@@ -138,3 +138,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getTradersUsingGET}
     /**
-     * Obtain traders ranking statistics.
+     * Gas ranking
      * - This endpoint returns NFT gas ranking statistics referring to NFTScan Gas Tracker({@link https://www.nftscan.com/analytics/tracker}).
@@ -146,8 +146,8 @@ * - details: {@link https://docs.nftscan.com/nftscan/getGasUsingGET}
     /**
-     * Obtain 24h volume statistics.
-     * - This endpoint returns NFT volume statistics for 24h.
-     * - details: {@link https://docs.nftscan.com/nftscan/get24hUsingGET}
-     * @returns Promise<{@link QueryVolumeIn24hResponse}>
+     * Collection overview
+     * - This endpoint returns collection overview data.
+     * - details: {@link https://docs.nftscan.com/nftscan/getPlatformOverviewUsingGET}
+     * @returns Promise<{@link CollectionOverviewResponse}>
      */
-    getVolumeIn24h(): Promise<QueryVolumeIn24hResponse>;
+    getCollectionOverview(): Promise<CollectionOverviewResponse>;
 }

dist/src/api/evm/transaction/index.d.ts

@@ -13,3 +13,3 @@ import { CommonTransactionParams, QueryTransactionsByFiltersParams, TransactionParams } from '../../../types/evm/transaction/request-params';
      * *****
-     * Retrieve transactions by an account.
+     * Retrieve transactions for account
      * - This endpoint returns a list of NFT transactions for an account address. The transactions are sorted by timestamp with descending direction.
@@ -26,3 +26,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getAccountTransactionsUsingGET_1}
      * *****
-     * Retrieve transactions by contract address.
+     * Retrieve transactions for contract
      * - This endpoint returns a list of NFT transactions for an NFT contract address. The transactions are sorted by timestamp with descending direction.
@@ -39,3 +39,3 @@ * - details: {@link https://docs.nftscan.com/nftscan/getTransactionsByContractAddressUsingGET}
      * *****
-     * Retrieve transactions by contract address and token ID.
+     * Retrieve transactions for an asset
      * - This endpoint returns a list of NFT transactions for a single NFT. The transactions are sorted by timestamp with descending direction.
@@ -76,5 +76,5 @@ * - details: {@link https://docs.nftscan.com/nftscan/getTransactionByContractAddressAndTokenIdUsingGET}
      * *****
-     * Retrieve transactions by the list of transaction hash.
+     * Retrieve transactions by hash
      * - This endpoint returns the transaction records queried based on the list of transaction hash.
-     * - details: {@link https://docs.nftscan.com/nftscan/getAssetsByListUsingPOST_3}
+     * - details: {@link https://docs.nftscan.com/nftscan/getTransactionRecordsByTxHashListUsingPOST}
      * @param txHashList The string Array of transaction hash. Maximum size is 50.
@@ -81,0 +81,0 @@ * @param eventType The NFT event type Array<{@link EventType}> of the transaction.

dist/src/api/solana/asset/index.d.ts

@@ -10,3 +10,3 @@ import { Asset, CommonAssetResponse, QueryAllAssetsResponse } from '../../../types/solana/asset/response-data';
     /**
-     * Retrieve assets owned by an account.
+     * Retrieve assets for account
      * - This endpoint returns a set of NFTs owned by an account address.
@@ -20,3 +20,3 @@ * - details: {@link https://docs.nftscan.com/solana/getAccountNftAssetsUsingGET_1}
     /**
-     * Retrieve all assets owned by an account group by collection.
+     * Retrieve all assets for account
      * - This endpoint returns all NFTs owned by an account address. And the NFTs are grouped according to collection.
@@ -29,3 +29,3 @@ * - details: {@link https://docs.nftscan.com/solana/getAccountNftAssetsGroupByCollectionUsingGET}
     /**
-     * Retrieve assets minted by an account.
+     * Retrieve assets minted for account
      * - This endpoint returns a set of NFTs minted by an account address.
@@ -42,3 +42,3 @@ * - details: {@link https://docs.nftscan.com/solana/getAccountMintedUsingGET_1}
      * *****
-     * Retrieve assets by collection.
+     * Retrieve assets by collection
      * - This endpoint returns a set of NFTs that belong to an NFT collection. The NFTs are sorted by token address with ascending direction.
@@ -52,3 +52,3 @@ * - details: {@link https://docs.nftscan.com/solana/getAssetsByCollectionUsingGET}
     /**
-     * Retrieve an asset by token address.
+     * Retrieve an asset
      * - This endpoint returns a single NFT.
@@ -55,0 +55,0 @@ * - details: {@link https://docs.nftscan.com/solana/getAssetByTokenAddressUsingGET}

dist/src/api/solana/nftscan-solana.d.ts

@@ -5,2 +5,3 @@ import { NftscanConfig, NftscanSolanaConfig } from '../../types/nftscan-type';
 import NftscanSolanaCollection from './collection';
+import NftscanSolanaRefresh from './refresh';
 import NftscanSolanaStatistic from './statistic';
@@ -37,2 +38,6 @@ import NftscanSolanaTransaction from './transaction';
     get statistic(): NftscanSolanaStatistic;
+    /**
+     * The `refresh` object contains methods for NFTScan's Solana refresh metadata API.
+     */
+    get refresh(): NftscanSolanaRefresh;
 }

dist/src/api/solana/statistic/index.d.ts

@@ -10,3 +10,3 @@ import { NftscanConfig } from '../../../types/nftscan-type';
     /**
-     * Obtain trade ranking statistics.
+     * Trade ranking
      * - This endpoint returns NFT trade ranking statistics referring to NFTScan Ranking({@link https://solana.nftscan.com/analytics/ranking})
@@ -13,0 +13,0 @@ * - details: {@link https://docs.nftscan.com/solana/getTradeUsingGET}

dist/src/api/solana/transaction/index.d.ts

@@ -10,3 +10,3 @@ import { BaseNsPaginationReqParam, NftscanConfig } from '../../../types/nftscan-type';
     /**
-     * Retrieve transactions by an account.
+     * Retrieve transactions for account
      * - This endpoint returns a list of NFT transactions for an account address. The transactions are sorted by timestamp with descending direction.
@@ -20,3 +20,3 @@ * - details: {@link https://docs.nftscan.com/solana/getAccountTransactionsUsingGET}
     /**
-     * Retrieve transactions by collection.
+     * Retrieve transactions by collection
      * - This endpoint returns a list of NFT transactions for an NFT collection. The transactions are sorted by timestamp with descending direction.
@@ -30,3 +30,3 @@ * - details: {@link https://docs.nftscan.com/solana/getTransactionsByCollectionUsingGET}
     /**
-     * Retrieve transactions by token address.
+     * Retrieve transactions for an asset
      * - This endpoint returns a list of NFT transactions for a single NFT. The transactions are sorted by timestamp with descending direction.
@@ -33,0 +33,0 @@ * - details: {@link https://docs.nftscan.com/solana/getTransactionByTokenAddressUsingGET}

dist/src/types/evm/asset/response-data.d.ts

@@ -123,3 +123,3 @@ import { BaseNsPaginationResData } from '../../nftscan-type';
 /**
- * The common response parameters of EVM asset related API
+ * The common response data of EVM asset related API
  */
@@ -130,3 +130,3 @@ export interface CommonAssetResponse extends BaseNsPaginationResData {
 /**
- * The response parameters of EVM API 'getAllAssets'
+ * The response data of EVM API 'getAllAssets'
  */
@@ -168,3 +168,3 @@ export interface QueryAllAssetsResponse {
 /**
- * The response parameters of EVM API 'getMultiChainAssets'
+ * The response data of EVM API 'getMultiChainAssets'
  */
@@ -171,0 +171,0 @@ export interface QueryMultiChainAssets {

dist/src/types/evm/other/response-data.d.ts

 import { BaseNsPaginationResData } from '../../nftscan-type';
 /**
- * The response parameters of EVM API 'getBlockNumber'
+ * The response data of EVM API 'getBlockNumber'
  */
@@ -12,3 +12,3 @@ export interface QueryBlockNumberResponse {
 /**
- * The response parameters of EVM API 'queryAssestAmountByAccounts'
+ * The response data of EVM API 'queryAssestAmountByAccounts'
  */
@@ -48,3 +48,3 @@ export interface QueryAssestAmountResponse {
 /**
- * The response parameters of EVM API 'getAssetOwnerByContract'
+ * The response data of EVM API 'getAssetOwnerByContract'
  */
@@ -65,3 +65,3 @@ export interface QueryAssetOwnerResponse extends BaseNsPaginationResData {
 /**
- * The response parameters of EVM API 'getAssetOwnerByContractAndTokenId'
+ * The response data of EVM API 'getAssetOwnerByContractAndTokenId'
  */
@@ -71,15 +71,2 @@ export interface QueryAssetOwnerByContractAndTokenIdResponse extends BaseNsPaginationResData {
 }
-/**
- * The response parameters of EVM API 'refreshMetadata'
- */
-export interface RefreshMetadataResponse {
-    /**
-     * The reason for the FAIL status
-     */
-    reason: string;
-    /**
-     * Task status. SUCCESS means the task was successfully submitted, FAIL means the task was not submitted due to some reason
-     */
-    status: string;
-}
 export {};

dist/src/types/evm/statistic/response-data.d.ts

@@ -30,3 +30,3 @@ interface Price7d {
 /**
- * The response parameters of EVM API 'getTradeRanking'
+ * The response data of EVM API 'getTradeRanking'
  */
@@ -128,3 +128,3 @@ export interface QueryTradeRankingResponse {
 /**
- * The response parameters of EVM API 'getCollectionRanking'
+ * The response data of EVM API 'getCollectionRanking'
  */
@@ -218,3 +218,3 @@ export interface QueryCollectionRankingResponse {
 /**
- * The response parameters of EVM API 'getCollectionTrade'
+ * The response data of EVM API 'getCollectionTrade'
  */
@@ -240,3 +240,3 @@ export interface QueryCollectionTradeResponse {
 /**
- * The response parameters of EVM API 'getCollectionTrending'
+ * The response data of EVM API 'getCollectionTrending'
  */
@@ -262,3 +262,3 @@ export interface QueryCollectionTrendingResponse {
 /**
- * The response parameters of EVM API 'getAccountOverview'
+ * The response data of EVM API 'getAccountOverview'
  */
@@ -328,3 +328,3 @@ export interface QueryAccountOverviewResponse {
 /**
- * The response parameters of EVM API 'getMarketplaceRanking'
+ * The response data of EVM API 'getMarketplaceRanking'
  */
@@ -378,3 +378,3 @@ export interface QueryMarketplaceRankingResponse {
 /**
- * The response parameters of EVM API 'getMarketCapRanking'
+ * The response data of EVM API 'getMarketCapRanking'
  */
@@ -408,3 +408,3 @@ export interface QueryMarketCapRankingResponse {
 /**
- * The response parameters of EVM API 'getCollectionStatistics'
+ * The response data of EVM API 'getCollectionStatistics'
  */
@@ -478,3 +478,3 @@ export interface QueryCollectionStatisticsResponse {
 /**
- * The response parameters of EVM API 'getBlueChipStatistics'
+ * The response data of EVM API 'getBlueChipStatistics'
  */
@@ -496,3 +496,3 @@ export interface QueryBlueChipStatisticsResponse {
 /**
- * The response parameters of EVM API 'getMintRanking'
+ * The response data of EVM API 'getMintRanking'
  */
@@ -518,3 +518,3 @@ export interface QueryMintRankingResponse {
 /**
- * The response parameters of EVM API 'getMintAmount'
+ * The response data of EVM API 'getMintAmount'
  */
@@ -528,3 +528,3 @@ export interface QueryMintAmountResponse {
 /**
- * The response parameters of EVM API 'getTradersRanking'
+ * The response data of EVM API 'getTradersRanking'
  */
@@ -546,3 +546,3 @@ export interface QueryTradersRankingResponse {
 /**
- * The response parameters of EVM API 'getGasRanking'
+ * The response data of EVM API 'getGasRanking'
  */
@@ -576,14 +576,18 @@ export interface QueryGasRankingResponse {
 /**
- * The response parameters of EVM API 'getVolumeIn24h'
+ * The response data of EVM API 'getCollectionOverview'
  */
-export interface QueryVolumeIn24hResponse {
+export interface CollectionOverviewResponse {
     /**
-     * The total volume
+     * The contract address
      */
-    total_volume: number;
+    contract_address: string;
     /**
-     * The growth rate of the total volume in the last 24h
+     * The contract name
      */
-    volume_growth_rate_24h: string;
+    contract_name: string;
+    /**
+     * The floor price of the collection
+     */
+    floor_price: number;
 }
 export {};

dist/src/types/evm/transaction/response-data.d.ts

@@ -8,2 +8,6 @@ import { BaseNsPaginationResData } from '../../nftscan-type';
     /**
+     * The NFT aggregate trading exchange name (Only for Sale)
+     */
+    aggregate_exchange_name: string;
+    /**
      * The amount of the NFT (Default 1 for the ERC-721 NFT)
@@ -102,3 +106,3 @@ */
 /**
- * The common response parameters of EVM transaction related API
+ * The common response data of EVM transaction related API
  */
@@ -105,0 +109,0 @@ export interface CommonTransactionResponse extends BaseNsPaginationResData {

dist/src/types/nftscan-type.d.ts

@@ -13,3 +13,4 @@ /**
     AVALANCHE = "avalanche",
-    CRONOS = "cronos"
+    CRONOS = "cronos",
+    FANTOM = "fantom"
 }
@@ -130,1 +131,14 @@ /**
 }
+/**
+ * The response data of refresh metadata api
+ */
+export interface RefreshMetadataResponse {
+    /**
+     * The reason for the FAIL status
+     */
+    reason: string;
+    /**
+     * Task status. SUCCESS means the task was successfully submitted, FAIL means the task was not submitted due to some reason
+     */
+    status: string;
+}

dist/src/types/solana/asset/response-data.d.ts

@@ -85,3 +85,3 @@ import { BaseNsPaginationResData } from '../../nftscan-type';
 /**
- * The common response parameters of Solana asset related API
+ * The common response data of Solana asset related API
  */
@@ -88,0 +88,0 @@ export interface CommonAssetResponse extends BaseNsPaginationResData {

dist/src/types/solana/statistic/response-data.d.ts

 /**
- * The response parameters of Solana API 'getTradeRanking'
+ * The response data of Solana API 'getTradeRanking'
  */
@@ -4,0 +4,0 @@ export interface QueryTradeRankingResponse {

dist/src/types/solana/transaction/response-data.d.ts

@@ -61,3 +61,3 @@ import { BaseNsPaginationResData } from '../../nftscan-type';
 /**
- * The common response parameters of Solana transaction related API
+ * The common response data of Solana transaction related API
  */
@@ -64,0 +64,0 @@ export interface CommonTransactionResponse extends BaseNsPaginationResData {

dist/src/util/nftscan.const.d.ts

@@ -16,2 +16,3 @@ export default class NftscanConst {
         cronos: string;
+        fantom: string;
     };
@@ -60,4 +61,8 @@ /**
                 getGasRanking: string;
-                getVolumeIn24h: string;
+                getCollectionOverview: string;
             };
+            refresh: {
+                refreshAsset: string;
+                refreshContract: string;
+            };
             other: {
@@ -68,3 +73,2 @@ getBlockNumber: string;
                 getAssetOwnerByContractAndTokenId: string;
-                refreshMetadata: string;
             };
@@ -92,4 +96,7 @@ };
             };
+            refresh: {
+                refreshAsset: string;
+            };
         };
     };
 }

package.json

 {
   "name": "nftscan-api",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "description": "js/ts SDK for NFTScan APIs",
@@ -5,0 +5,0 @@ "main": "dist/cjs/index.js",

README.md

@@ -20,4 +20,5 @@ # NFTScan API SDK (JavaScript / TypeScript)
 | Avalanche  | avaxapi.nftscan.com     | avalanche    |
+| Cronos     | cronosapi.nftscan.com   | cronos       |
+| Fantom     | fantomapi.nftscan.com   | fantom       |
 | Solana     | solanaapi.nftscan.com   | solana       |
-| Cronos     | cronosapi.nftscan.com   | cronos       |
 
@@ -66,2 +67,3 @@ *The value of **Short name** is used in the SDK as an initialization configuration parameter.*
   CRONOS = 'cronos',
+  FANTOM = 'fantom',
 }
@@ -128,61 +130,64 @@ ```
   - ##### Retrieve Assets (`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.
-    - ***[PRO]*** `getAssetsByContract()`: Retrieve assets by contract address.
-    - `getAssetsByContractAndTokenId()`: Retrieve an asset by contract address and token ID.
-    - ***[PRO]*** `getMultiChainAssets()`: Retrieve multi-chain assets owned by an account.
-    - ***[PRO]*** `queryAssetsInBatches`: Retrieve assets by list of contract address and token ID.
-    - ***[PRO]*** `queryAssetsByFilters()`: Retrieve assets with filters.
-    - ***[PRO]*** `queryAssetsByAttributes()`: Retrieve assets by contract address with attributes.
+    - `getAssetsByAccount()`: [Retrieve assets for account](https://docs.nftscan.com/nftscan/getAccountNftAssetsUsingGET)
+    - `getAllAssets()`: [Retrieve all assets for account](https://docs.nftscan.com/nftscan/getAccountNftAssetsGroupByContractAddressUsingGET)
+    - `getAccountMinted()`: [Retrieve assets minted for account](https://docs.nftscan.com/nftscan/getAccountMintedUsingGET)
+    - ***[PRO]*** `getAssetsByContract()`: [Retrieve assets for contract](https://docs.nftscan.com/nftscan/getAssetsByContractAddressUsingGET)
+    - `getAssetsByContractAndTokenId()`: [Retrieve an asset](https://docs.nftscan.com/nftscan/getAssetByContractAddressAndTokenIdUsingGET)
+    - ***[PRO]*** `queryAssetsInBatches`: [Retrieve multiple assets](https://docs.nftscan.com/nftscan/getAssetsByListUsingPOST_1)
+    - ***[PRO]*** `queryAssetsByFilters()`: [Retrieve assets with filters](https://docs.nftscan.com/nftscan/getAssetsByListUsingPOST).
+    - ***[PRO]*** `queryAssetsByAttributes()`: [Retrieve assets with attributes](https://docs.nftscan.com/nftscan/getAssetsByContractAddressWithAttributesUsingPOST)
+    - ***[PRO]*** `getMultiChainAssets()`: [Retrieve multi-chain assets for account](https://docs.nftscan.com/nftscan/getAssetsByMultiChainUsingGET)
   - ##### Retrieve Transactions (`new NftscanEvm().transaction.*`)
-    - ***[PRO]*** `getTransactionsByAccount()`: Retrieve transactions by an account.
-    - ***[PRO]*** `getTransactionsByContract()`: Retrieve transactions by contract address.
-    - ***[PRO]*** `getTransactionsByContractAndTokenId()`: Retrieve transactions by contract address and token ID.
-    - ***[PRO]*** `getTransactionsByToAddress()`: Retrieve transactions by to address.
-    - ***[PRO]*** `queryTransactionsByFilters()`: Retrieve transactions with filters.
-    - ***[PRO]*** `queryTransactionsByTxHashList()`: Retrieve transactions by the list of transaction hash.
+    - ***[PRO]*** `getTransactionsByAccount()`: [Retrieve transactions for account](https://docs.nftscan.com/nftscan/getAccountTransactionsUsingGET_1)
+    - ***[PRO]*** `getTransactionsByContract()`: [Retrieve transactions for contract](https://docs.nftscan.com/nftscan/getTransactionsByContractAddressUsingGET)
+    - ***[PRO]*** `getTransactionsByContractAndTokenId()`: [Retrieve transactions for an asset](https://docs.nftscan.com/nftscan/getTransactionByContractAddressAndTokenIdUsingGET)
+    - ***[PRO]*** `queryTransactionsByFilters()`: [Retrieve transactions with filters](https://docs.nftscan.com/nftscan/getAssetsByListUsingPOST_2)
+    - ***[PRO]*** `getTransactionsByToAddress()`: [Retrieve transactions by to address](https://docs.nftscan.com/nftscan/getTransactionByTxToUsingGET)
+    - ***[PRO]*** `queryTransactionsByTxHashList()`: [Retrieve transactions by hash](https://docs.nftscan.com/nftscan/getTransactionRecordsByTxHashListUsingPOST)
   - ##### Retrieve Collections (`new NftscanEvm().collection.*`)
-    - ***[PRO]*** `getCollectionsByContract()`: Retrieve a collection by contract address.
-    - ***[PRO]*** `getCollectionsByRanking()`: Retrieve collections by ranking.
-    - ***[PRO]*** `queryCollectionsByFilters()`: Retrieve collections with filters.
-    - ***[PRO]*** `queryCollectionsByAccountAddress()`: Retrieve collections by account address.
+    - ***[PRO]*** `getCollectionsByContract()`: [Retrieve a collection](https://docs.nftscan.com/nftscan/getCollectionUsingGET)
+    - ***[PRO]*** `queryCollectionsByFilters()`: [Retrieve collections with filters](https://docs.nftscan.com/nftscan/getCollectionsUsingPOST)
+    - ***[PRO]*** `queryCollectionsByAccountAddress()`: [Retrieve collections for account](https://docs.nftscan.com/nftscan/getCollectionsOwnByAccountAddressUsingGET)
+    - ***[PRO]*** `getCollectionsByRanking()`: [Retrieve collections by ranking](https://docs.nftscan.com/nftscan/getRankingsUsingGET)
   - ##### Statistics (`new NftscanEvm().statistic.*`)
-    - `getTradeRanking()`: Obtain trade ranking statistics.
-    - ***[PRO]*** `getCollectionRanking()`: Obtain collection ranking statistics.
-    - ***[PRO]*** `getCollectionTrade()`: Obtain collection trade distribution.
-    - ***[PRO]*** `getCollectionTrending()`: Obtain collection trending statistics.
-    - ***[PRO]*** `getAccountOverview()`: Obtain account overview statistics.
-    - ***[PRO]*** `getBlueChipStatistics()`: Obtain blue chip statistics.
-    - `getMarketplaceRanking()`: Obtain marketplace ranking statistics.
-    - `getMarketCapRanking()`: Obtain market cap ranking statistics
-    - ***[PRO]*** `getCollectionStatistics()`: 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.
+    - `getTradeRanking()`: [Trade ranking](https://docs.nftscan.com/nftscan/getTradeUsingGET_1)
+    - `getMintRanking()`: [mint ranking](https://docs.nftscan.com/nftscan/getMintUsingGET)
+    - `getMintAmount()`: [Mint amount](https://docs.nftscan.com/nftscan/getAmountUsingGET)
+    - `getTradersRanking()`: [Traders ranking](https://docs.nftscan.com/nftscan/getTradersUsingGET)
+    - `getGasRanking()`: [Gas ranking](https://docs.nftscan.com/nftscan/getGasUsingGET)
+    - ***[PRO]*** `getCollectionRanking()`: [Collection ranking](https://docs.nftscan.com/nftscan/collectionRankingUsingGET)
+    - `getMarketplaceRanking()`: [Marketplace ranking](https://docs.nftscan.com/nftscan/getMarketplaceUsingGET)
+    - `getMarketCapRanking()`: [Market cap ranking](https://docs.nftscan.com/nftscan/getMarketCapUsingGET)
+    - ***[PRO]*** `getCollectionStatistics()`: [Collection statistics](https://docs.nftscan.com/nftscan/getCollectionUsingGET_2)
+    - ***[PRO]*** `getCollectionTrade()`: [Collection trade distribution](https://docs.nftscan.com/nftscan/tradeDistributionUsingGET)
+    - ***[PRO]*** `getCollectionTrending()`: [Collection trending statistics](https://docs.nftscan.com/nftscan/trendingUsingGET)
+    - ***[PRO]*** `getBlueChipStatistics()`: [Blue chip](https://docs.nftscan.com/nftscan/blueChipUsingGET)
+    - ***[PRO]*** `getAccountOverview()`: [Account overview](https://docs.nftscan.com/nftscan/accountOverviewUsingGET)
+    - `getCollectionOverview()`: [Collection overview](https://docs.nftscan.com/nftscan/getPlatformOverviewUsingGET)
+  - ##### Refresh (`new NftscanEvm().refresh.*`)
+     - ***[PRO]*** `refreshAsset()`: [Refresh an asset](https://docs.nftscan.com/nftscan/refreshAssetMetadataUsingPOST)
+     - ***[PRO]*** `refreshContract()`:[Refresh a contract](https://docs.nftscan.com/nftscan/refreshAssetMetadataByContractAddressUsingPOST)
    - ##### Other (`new NftscanEvm().other.*`)
-     - `getBlockNumber()`: Obtain the latest block number.
-     - ***[PRO]*** `queryAssestAmountByAccounts()`: Obtain asset amount owned by accounts.
-     - ***[PRO]*** `getAssetOwnerByContract()`: Obtain asset owner amount by contract address.
-     - ***[PRO]*** `getAssetOwnerByContractAndTokenId()`: Obtain asset owner's amount by contract address and token ID.
-     - ***[PRO]*** `refreshMetadata()`: Submit a task for refreshing NFT metadata.
-  
+     - `getBlockNumber()`: [Latest block number](https://docs.nftscan.com/nftscan/getBlockNumberUsingGET)
+     - ***[PRO]*** `queryAssestAmountByAccounts()`: [Asset amount for accounts](https://docs.nftscan.com/nftscan/getAssetAmountByAccountsUsingPOST)
+     - ***[PRO]*** `getAssetOwnerByContract()`: [Asset owners for contract](https://docs.nftscan.com/nftscan/getAssetOwnerAmountByContractUsingGET)
+     - ***[PRO]*** `getAssetOwnerByContractAndTokenId()`: [Asset owner amount for an asset](https://docs.nftscan.com/nftscan/getAssetOwnersUsingGET)
 - #### NFTScan API of Solana
   - ##### Retrieve Assets (`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.
-    - ***[PRO]*** `getAssetsByCollection()`: Retrieve assets by collection.
-    - `getAssetsByTokenAddress()`: Retrieve an asset by token address.
+    - `getAssetsByAccount()`: [Retrieve assets for account](https://docs.nftscan.com/solana/getAccountNftAssetsUsingGET_1)
+    - `getAllAssets()`: [Retrieve all assets for account](https://docs.nftscan.com/solana/getAccountNftAssetsGroupByCollectionUsingGET)
+    - `getAccountMinted()`: [Retrieve assets minted for account](https://docs.nftscan.com/solana/getAccountMintedUsingGET_1)
+    - ***[PRO]*** `getAssetsByCollection()`: [Retrieve assets by collection](https://docs.nftscan.com/solana/getAssetsByCollectionUsingGET)
+    - `getAssetsByTokenAddress()`: [Retrieve an asset](https://docs.nftscan.com/solana/getAssetByTokenAddressUsingGET)
   - ##### Retrieve Transactions (`new NftscanSolana().transaction.*`)
-    - `getTransactionsByAccount()`: Retrieve transactions by an account.
-    - `getTransactionsByCollection()`: Retrieve transactions by collection.
-    - `getTransactionsByTokenAddress()`: Retrieve transactions by token address.
+    - `getTransactionsByAccount()`: [Retrieve transactions for account](https://docs.nftscan.com/solana/getAccountTransactionsUsingGET)
+    - `getTransactionsByCollection()`: [Retrieve transactions by collection](https://docs.nftscan.com/solana/getTransactionsByCollectionUsingGET)
+    - `getTransactionsByTokenAddress()`: [Retrieve transactions for an asset](https://docs.nftscan.com/solana/getTransactionByTokenAddressUsingGET)
   - ##### Retrieve Collections (`new NftscanSolana().collection.*`)
-    - ***[PRO]*** `getCollection()`: Retrieve a collection.
-    - ***[PRO]*** `queryCollectionsByFilters()`: Retrieve collections with filters.
+    - ***[PRO]*** `getCollection()`: [Retrieve a collection](https://docs.nftscan.com/solana/getCollectionUsingGET_1)
+    - ***[PRO]*** `queryCollectionsByFilters()`: [Retrieve collections with filters](https://docs.nftscan.com/solana/getCollectionsUsingPOST_1)
   - ##### Statistics (`new NftscanSolana().statistic.*`)
-    - `getTradeRanking()`: Obtain trade ranking statistics.
+    - `getTradeRanking()`: [Trade ranking](https://docs.nftscan.com/solana/getTradeUsingGET)
+  - ##### Refresh (`new NftscanSolana().refresh.*`)
+     - ***[PRO]*** `refreshAsset()`: [Refresh an asset](https://docs.nftscan.com/solana/refreshAssetMetadataByTokenAddressUsingPOST)
 
@@ -189,0 +194,0 @@ ## More

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

397891

increased by4.19%

Number of package files

53

increased by3.92%

Lines of code

9119

increased by4.85%

Number of lines in readme file

194

increased by2.65%

No dependency changes