如何使用 NFTScan NFT API 在 PlatON 网络上开发 Web3 应用-编程知识

PlatON 是由万向区块链和矩阵元主导开发的面向下一代的全球计算架构，创新性的采用元计算框架 Monad 和基于 Reload 覆盖网络的同构多链架构，其愿景是成为全球首个提供完备隐私保护能力的运营服务网络。它提供计算、存储、通讯服务，并提供算力、算法、数据等众多基础资源以及公共基础设施软件开发、咨询及运营服务等。

就 NFTScan 数据来看，截至 1 月 5 日，PlatON 网络上已累计发行 NFT 资产 2,710,774 枚，NFT Collection 2,261 个，产生交互记录 6,865,324 条，有过交互的钱包地址 1,180,646 个，总交易额 190,295.2 LAT。

PlatON NFTScan：

创建 NFTScan 开发者账号

在开始使用 NFTScan API 之前，首先需要访问开发者网站并创建一个账户。前往 NFTScan 官方网站点击 NFTScan API “Sign Up”按钮进行注册。

https://developer.nftscan.com/user/signup

登录后在 Dashboard（面板）上找到自己独有的 API KAY，将其复制。访问 API 文档，将自己的 API KEY 输进 API 文档的相应位置。根据文档的指引，就可以开始使用 API 服务了。在 API 文档中，开发者可以找到多种可供选择的接口模式，根据需求来选择最合适的接口。

在 Dashboard 中，开发人员还可以查看自己 API 使用情况的统计数据，帮助记录历史使用数据。不仅如此，NFTScan 还为每位注册开发者提供 1M CU 的 API 调用服务，用于请求所有的 NFT API 接口，并且 CU 永不过期，用完为止！

查看 PlatON NFT API 文档

在成功注册开发者账号获取 API Key 后，需要查看 NFTScan API 文档。API 文档包含了所有可以使用的 API 端点和参数，以及如何构建请求和处理响应的详细信息。请认真阅读 API 文档，并确保理解如何使用 API 来获取您需要的数据。NFTScan API 服务致力于帮助开发者改善获取 NFT 数据分析体验。

NFTScan 目前拥有全网最大最全的 NFT Collection 库，已支持 Ethereum、Solana、BNBChain、Bitcoin、TON、Polygon、zkSync、Aptos、Linea、Base、Avalanche、Arbitrum、OP Mainnet、Starknet、Scroll、Viction、Fantom、Moonbeam、PlatON、Cronos、Gnosis 21 条区块链的 NFT 全量数据，所涵盖的 NFT 数据全、种类丰富，提供一整套的接口来获得 ERC721 和 ERC1155 资产以及交易、项目、市场统计等信息，现在支持 60 多个针对 EVM 兼容链的公共接口，以及针对 Solana、Aptos、Bitcoin、TON 的一批相同模型的接口，很大程度上满足了开发者索引多种类型的 NFT 数据的需求。

PlatON NFT API 模型

主要包括了以下三个模型接口，包括里面一些 API 核心的字段的整体介绍和说明，方便开发者知道怎么去获取数据利用这些信息服务于自己正在构建的 Dapp 服务。

Assets API："Assets"是 NFT 中最关键的数据字段，用于唯一标识和描述数字资产。开发者可以通过提取 PlatON 区块链上 NFT 的"Assets"数据来获取全面的了解，并构建相关应用。"Assets"对象提供了数字资产的唯一标识以及其整个生命周期的数据，为开发者理解和应用 NFT 提供了基础。

Transactions API：交易模型代表了区块链上一个 NFT 资产的全量交易数据，为开发者提供 NFT 的完整生命周期交易信息。包括 NFT 的 mint、转移、销售、和其他交易活动，为开发者提供了深入了解 NFT 资产在 PlatON 生态系统中的流动和演变过程的机会。NFTScan 不断地汇总来自各个区块链网络的 NFT 交易市场和相关交易合约信息，目前 NFTScan 已收录用于追踪和了解 NFT 市场的动态，同时也有助于开发者构建基于 NFT 的应用程序和工具。

Collections API：NFTScan 获取与 NFT Collections 相关的描述、社交媒体及其他基本信息等链下数据。NFTScan 通过各个区块链网络中最主流的 NFT 市场提供的 API 获取这些信息。此外当前地板价信息是基于 NFT 市场的订单信息的集中式数据，也是通过 API 可获取的。

PlatON NFT API 检索

1/Retrieve Assets 系列

Get NFTs by account（通过钱包地址检索 NFT）
Get all NFTs by account（检索钱包地址的所有 NFT，并根据合约地址对 NFT 进行分组，如果账户地址拥有的 NFT 总数超过 2000 个，则返回的 NFT 将限制在 2000 个以下。在这种情况下，开发者和用户可以通过分页查询请求按账户获取该账户地址拥有的所有 NFT）
Get minted NFTs by account（检索该钱包地址的 Mint 过的 NFT）
Get NFTs by contract（通过合约地址检索 NFT，并按 token_id 升序排序）
Get single NFT（检索单个 NFT）
Get multiple NFTs（同时检索多个合约地址的 NFT）
Search NFTs（该接口通过在请求正文中应用搜索筛选器来返回 NFT 资产列表。资产按 nftscan_id 升序排序）
Get NFTs by attributes（该接口返回一组属于具有属性的 NFT 合约地址的 NFT，NFT 按 token_id 升序排序）
Get all multi-chain NFTs by account（该接口返回账户地址拥有的所有多链 NFT，NFT 根据合约地址进行分组）

这里我们通过接口 Get all NFTs by account "/v2/account/own/all/{account_address}" 来检索某个 PlatON 钱包地址内持有的全量 NFT，查询参数包括协议标准：erc721/erc1155；排序字段：mint_time/own_time/last_trade_price（仅适用于 erc721）。我们这里请求的是地址：lat1cghxn3j8j4h7sxw0rey9jzc9388tp7aede4870 PlatON 链上所有的 erc721 协议的 NFT。

点击 Try it 数据响应结果：该地址下一共持有 3 个 NFT Collections，分别是 PlatON Ecosystem Rabbit Red Packets、SA NFT、HashKey DID，按 floor_price 降序排序，返回数据包括每个 NFT contract 地址以及 name，持有数量及该 contract 地址下 item 数量，地板价以及一些的基础细节信息描述等等。

2/ Retrieve Transactions 系列

Get transactions by account（该接口返回钱包地址的 NFT 交易列表）
Get transactions by contract（该接口返回 NFT 合约地址的 NFT 交易列表）
Get transactions by NFT（该接口返回单个 NFT 的 NFT 交易列表）
Search transactions（该接口返回在请求正文中应用搜索过滤器来返回 NFT 交易列表）
Get transactions by to address（该接口返回按交易参数过滤的 NFT 交易列表）
Get transactions by hash（该接口返回根据交易哈希列表查询到的交易记录）

这里我们通过 Get transactions by account "/v2/transactions/account/{account_address}" 这个接口，检索某钱包地址在 PlatON 网络上 NFT 交易记录，查询参数可选择交易的 NFT 事件类型（Mint/Transfer/Sale/Burn），使用 ';' 分隔多个事件。

同样这里我们检索 lat1cghxn3j8j4h7sxw0rey9jzc9388tp7aede4870 地址下的 NFT 交易记录。按照 Mint 的事件类型，结果响应数据包含该地址所有的 Items Mint 的所有关键数据，如交易哈希值、From 和 To 地址、区块信息、消耗 Gas、交易时间戳等基础数据等 NFT 交易的特征信息。

3/ Retrieve Collections 系列

Get an NFT collection（根据 Collection 的合约地址查询详情，包括概览及按照描述对 Item 进行分类，持有者分布、平均价格、地板价等基本概括信息）
Search NFT collections（此接口通过在请求正文中应用搜索过滤器来返回 Collection 列表的信息，Collection 按部署块编号升序排序）
Get NFT collections by account（该接口返回具有给定账户地址的项目列表信息，Collection 按地板价从高到低排序）
Get NFT collections by ranking（该接口返回具有给定排序字段的项目列表信息，Collection 按给定的排序字段和给定的排序方向排序）

这里我们通过接口 Get an NFT collection“/v2/collections/{contract_address}”检索合约地址为 lat1qjwjv237chk0nhv7xevumjf0g3wtcm73hqv9al Name 为 Plato_World 的 NFT Collection 详情信息，返回的每条数据包含 32 个 data：

4/ Collection Statistics：Collection 统计分析系列

Collection Statistics（该接口提供 NFT Collection 的分析统计概览数据）
Collection Trade Distribution（该接口主要提供项目交易分布）
Collection Trending Statistics（主要返回一个项目的 Trading 统计排序）
Collection Holding Amount Distribution（该接口可返回 NFT 项目持有量的分布信息）
Collection Holding Period Distribution（数据返回 NFT 项目持有期分布信息）
Collection Blue Chip Statistics（蓝筹项目统计概览数据）
Collection Blue Chip List（该项目涉及的蓝筹项目清单，可参考 NFTScan Blue Chip Collection）
Collection Top Holder（该 Collection 的顶级持有者分布）

这里我们通过接口 Collection Holding Period Distribution "/v2/statistics/period/distribution/{contract_address}"主要返回一个 NFT Collection 的持有期分布信息，可参考 PlatON 链上 NFTScan Holding Period Distribution：

5/ Account Statistics 系列

Account Overview Statistics（该接口返回账户地址的概览统计信息，参考 NFTScan Overview）
Account Holding Distribution（该接口返回账户地址的 NFT 持有分布统计信息，参考 NFTScan Portfolio）
Account Holding NFT Trending（该接口返回账户地址的 NFT 持有量（或数量）统计信息，参考 NFTScan Portfolio）

6/ Analytic Statistics 系列

该系列接口通常用于获取 NFTScan PlatON 上各与数据分析和统计有关的信息，如 Trade Ranking、Mint Amount、Gas Ranking 等这类接口允许开发者或用户查询、分析、和检索与特定数据集或指标相关的统计数据。可以用于各种用途，包括市场分析、趋势追踪、投资决策、以及了解特定数据的性质。

参考：

7/ Refresh Metadata

Refresh NFT metadata
Refresh NFT metadata by contract

Refresh Metadata 这类接口可以帮助开发者或用户提交后台刷新元数据任务，该任务审核后会刷新提交的指定 Item 或整个合约元数据。

8/ Other

Get latest block number（返回 NFTScan 已到达的最新块号）
Get NFT amount by account（根据请求体中的搜索列表返回账户地址拥有的 ERC721 和 ERC1155 NFT 数量信息）
Get NFT owners by contract（返回 ERC721 NFT 合约地址的所有者列表，NFT 按 token_id 升序排序）
Get owners by an NFT（返回 ERC1155 NFT 的所有者列表， NFT 按 account_address 升序排序）

构建相关 NFT API 请求

当开发者在 NFTScan 的 API 文档中找到所需的 PlatON API 接口和参数后，可以使用他们选择的编程语言（例如 Python、Java、JavaScript 等）来编写 API 请求代码。以下是一个示例，演示如何使用 Python 来请求一个钱包地址持有的 NFT。

例如，我们请求 lat1cghxn3j8j4h7sxw0rey9jzc9388tp7aede4870 持有的 NFT 详情信息，HTTP GET 请求接口“v2/account/own/{account_address}”，使用 Python 的 requests 库，可以这样构建请求：

import requests# Define NFTScan API endpoint and account address
api_endpoint = "https://api.nftscan.com/v2/account/own"
account_address = "lat1cghxn3j8j4h7sxw0rey9jzc9388tp7aede4870"# Construct API request URL
url = f"{api_endpoint}/{account_address}"# Make an HTTP GET request
response = requests.get(url)# Check if the request was successful
if response.status_code == 200:# Get the returned JSON datadata = response.json()# Process the returned NFT detailsprint("Owner's NFT details:")print(data)  # This will print the retrieved NFT details; you can further process or extract information as needed
else:print("Request failed:", response.status_code)

运行代码后，开发者将获得该地址持有的 NFT 详情信息，并可以根据需要进一步处理或提取信息。

About NFTScan

NFTScan 成立于 2021 年初，总部位于香港，是全球领先的 NFT 数据基础设施服务商，目前已支持 Bitcoin、Ethereum、BNBChain、Polygon、Solana、TON、Arbitrum、Optimism、zkSync、Aptos 等在内的 21 条主流区块链网络。NFTScan 团队致力于为数以亿计的 Web3 用户提供简洁高效的 NFT 检索服务，为新一代金融科技公司提供安全稳定的多链 NFT 索引服务，用数据来推动 NFT 生态的繁荣发展！目前，NFTScan 在为包括 CMC、Binance NFT、Bybit、KuCoin、HashKey Group 、Mask Network、imToken、Enjin、Coin98 等在内的 5000+ 开发者提供多链 NFT 数据支持！