在数字资产和 NFT 市场快速发展的今天,高效管理铭文数据成为开发者和项目方的核心需求。本文详细介绍如何通过 API 接口获取与钱包地址关联的有效铭文信息,并支持创建 NFT 挂单操作,助力开发者无缝集成市场功能。
接口概述
本接口主要用于获取指定钱包地址下的有效铭文数据,适用于比特币 NFT 和 BRC-20 代币的挂单查询。通过此接口,用户可以灵活检索铭文列表,并基于多种排序规则进行数据筛选,为市场交易和资产管理提供数据支持。
请求地址与方法
- 请求方法:POST
- 端点地址:
https://web3.okx.com/api/v5/mktplace/nft/ordinals/get-valid-inscriptions
请求参数详解
以下为调用接口时需传递的参数列表:
| 参数名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| slug | String | 是 | 集合的唯一标识符(slug) |
| cursor | String | 否 | 分页游标,用于获取下一页数据 |
| limit | String | 是 | 每页返回数据条数,默认值为 10,最大支持 100 |
| sort | String | 否 | 排序规则:支持按挂单时间降序(listing_time_desc)、升序(listing_time_asc),价格从高到低(price_desc)、从低到高(price_asc),单价从低到高(unitprice_desc)或从高到低(unitprice_asc) |
| isBrc20 | Boolean | 否 | 是否检索 BRC-20 挂单列表,默认为“是” |
| walletAddress | String | 是 | 要查询铭文数据的钱包地址 |
返回参数说明
接口返回一个铭文信息数组,包含以下字段:
| 字段名称 | 类型 | 说明 |
|---|---|---|
| inscriptionId | String | 铭文 ID |
| cursor | String | 下一页数据的查询游标 |
| nftId | String | 对应铭文的 NFT ID |
| ticker | String | BRC-20 代币代号 |
| tickerId | String | 代币 ID |
| amount | String | 订单中的铭文数量 |
请求与响应示例
请求示例
{
"slug": "example-collection",
"walletAddress": "0x...",
"limit": "20",
"sort": "price_desc"
}响应示例
{
"code": "0",
"data": [
{
"inscriptionId": "abc123...",
"cursor": "next-page-cursor",
"nftId": "nft-001",
"ticker": "OKT",
"tickerId": "ticker-001",
"amount": "5"
}
]
}常见问题
1. 什么是铭文(Inscription)?
铭文是写入比特币区块链的数字资产记录,可代表 NFT 或 BRC-20 代币。通过此接口可查询与钱包关联的有效铭文数据。
2. 如何实现分页查询?
使用 cursor 参数。首次请求可不传,响应中返回下一页游标,填入后续请求即可获取更多数据。
3. 是否支持非 BRC-20 代币查询?
是的。设置 isBrc20 为 false 可检索比特币 NFT 铭文;默认为 true,即查询 BRC-20 代币。
4. 排序规则有哪些选择?
支持按时间、价格和单价排序,共六种方式,可根据列表、更新或交易需求灵活选择。
5. 单次最多可获取多少条数据?
limit 参数最大值为 100,超过将截断。建议根据实际场景合理设置以避免超时或性能问题。
6. 如何快速集成市场功能?
调用本接口可获取铭文列表,结合创建挂单等功能,👉 探索更多市场集成策略,实现完整交易流程。
通过本文,您应已掌握获取有效铭文数据的 API 使用方法。合理运用参数与分页机制,可高效管理数字资产,提升市场操作体验。