TokenResp
tokenAddress代币合约地址。主链币使用 sentinel 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee(40 个 e)。
tokenName代币名称。
tokenSymbol代币符号。
tokenAmount人类可读的代币数量(非最小单位)。
tokenPrice当前代币价格(美元)。
tokenValue代币价值(美元),即数量 × 价格。
tokenDecimals代币精度(字符串)。
PositionResp
positionId仓位唯一标识(64 位 hex,无 0x 前缀)。
underlyingAssetName底层资产显示名称(如 USDT-USDC、lisUSD)。
underlyingAssetId底层资产标识(64 位 hex,无 0x 前缀)。由池和底层代币地址哈希生成。
assetType资产结构类型。取值:null(普通仓位)、locked(锁定仓位,如锁仓质押,解锁时间见 positionDetail 的 unlockTime)、farming(MasterChef 类挖矿仓位,奖励累积在 farming_reward 代币分组下)。
investmentIds关联的投资品 ID 列表(64 位 hex,无 0x 前缀)。用于 POST /api/v1/defi/data/investment/detail。通常只有一个;当一个池在产品之上叠加产品时会出现多个 (如 farming 仓位 = 底层 LP 投资品 + 激励投资品,或质押金库在基础存入之上叠加凭证 token)。 有多个时,逐个调 investment/detail 查询,按你要执行的操作选择——赎回本金用基础投资品, 领取挖矿激励用激励投资品。
positionDetail仓位级别元数据。集中流动性 / 锁定 / 挖矿仓位才有值,否则为 null。各字段在不适用于该仓位类型时为 null。
positionValue仓位总价值(美元,所有代币价值之和;借贷仓位可能为负数)。
按角色分组的代币明细。key 为:supply(已投入资产)、borrow(借入资产,借贷仓位)、 reward(可领取奖励)、farming_reward(MasterChef 挖矿激励)。某角色无代币时该 key 缺省。
PositionCollectionResp
positionCollectionId集合唯一标识(64 位 hex,无 0x 前缀)。
positionCollectionDetail集合元数据。无元数据时为 null。各字段在不适用时为 null。
positionCollectionTotalValue该集合内所有仓位的总价值(美元)。
该集合内的仓位列表。
PoolResp
bnPoolId池标识(0x + 64 位 hex)。
poolCa池合约地址。
poolType池类型。完整取值:Lending(借贷市场)、Staked(原生质押)、Yield(收益金库 / 凭证)、Deposit(定期存入)、Rewards(奖励领取,如 PancakeSwap Infinity)、 Liquidity Pool(AMM / 集中流动性)、Farming(MasterChef 挖矿)、Locked (锁仓质押,有解锁时间)、Vesting(线性释放)。未知取值按通用展示处理。
poolDetail池级别元数据。各字段在不适用于该池类型时为 null(如 tickSpacing/hooks 仅集中流动性池有值)。
ProtocolResp
binanceChainIdBinance 链 ID(如 "56"=BSC)。
defiProtocolId与 POST /api/v1/defi/data/protocol/list 一致的协议标识。 调用 investment/list、交易构建等接口时使用此值。
protocolName协议显示名称。
protocolTotalValue该协议中的总持仓价值(美元)。
该协议中有持仓的池列表。
AddressResp
address钱包地址。
addressTotalValue该地址所有链上 DeFi 持仓总价值(美元)。与持仓明细同原始精度。
该地址的协议级持仓汇总列表。
PositionListResp
totalValue所有查询地址的 DeFi 持仓总价值(美元)。与 addressTotalValue 同原始精度。
地址级持仓汇总列表。
DefiProtocolDto
defiProtocolIdDeFi 协议标识。
protocolName协议显示名称。
protocolLogo协议 Logo 图片 URL(完整 URL,直接使用)。
tvl协议锁仓总价值(美元)。字符串,保留数据源原始精度。
apyBps该协议下最高 APY,以基点表示(1 bps = 0.01%)。整数值——用于排序 / 比较 / 筛选,不要使用裸小数。
apyDisplay预格式化的 APY 展示字符串(如 "12.35%")。直接原样引用,禁止二次计算或转换。
investType该协议支持的投资类型——此处为数组(一个协议可支持多种)。注意:投资品维度的 investType(投资品列表 / 详情中)是单个字符串。已知取值:Earn、LiquidityPool。
supportedChains支持的 Binance 链 ID 列表。
DefiProtocolSocialLinksDto
xX(Twitter)主页 URL。无时为 null。
discordDiscord 邀请链接。无时为 null。
githubGitHub 组织 URL。无时为 null。
linkedinLinkedIn 公司主页 URL。无时为 null。
telegramTelegram 频道 URL。无时为 null。
gitbookGitBook 文档 URL。无时为空字符串或 null。
website官网 URL。
DefiProtocolTeamMemberDto
name成员姓名。
role成员角色 / 职位。
twitter成员 X(Twitter)主页 URL。无时为 null。
linkedin成员 LinkedIn 主页 URL。无时为 null。
bio成员简介。无时为 null。
DefiProtocolFundRaisingDto
round轮次名称(如 Strategic)。
amount融资金额。未披露时为 null。
date轮次日期。
investors投资方列表。
DefiProtocolDimensionScoresDto
codeSecurity代码安全评分。
fundamentalHealth基本面健康度评分。
operationalResilience运营韧性评分。
communityTrust社区信任评分。
governanceStrength治理强度评分。
marketStability市场稳定性评分。
DefiProtocolFaqDto
titleFAQ 问题文本(已翻译,直接展示)。
answerFAQ 答案文本(已翻译,直接引用)。可能包含换行标记 <Br/> 和段落间距标记 <Gap/>, 解析时按换行 / 段落处理。
DefiProtocolInfoDto
defiProtocolIdDeFi 协议标识。
protocolName协议显示名称。
protocolLogo协议 Logo 图片 URL(https://bin.bnbstatic.com 下的完整 URL)。
description协议描述(已翻译,直接展示)。
websiteUrl官网 URL。
investType该协议支持的投资类型——此处为数组(一个协议可支持多种)。注意:投资品维度的 investType(投资品列表 / 详情中)是单个字符串。已知取值:Earn、LiquidityPool。
supportedChains支持的 Binance 链 ID 列表。
tvl锁仓总价值(美元)。字符串,保留数据源原始精度。
tags协议标签 / 分类。
founded成立年份(YYYY)。
fdv完全稀释估值(FDV)。
totalFunding累计融资金额。未披露时为 null。
协议社交媒体链接。
团队成员列表。
融资历史。
securityScoreCertiK 综合安全评分。
CertiK 六维度安全评分。
highlights协议亮点(已翻译,直接展示)。
FAQ 条目列表(问答文本,已翻译)。
DefiInvestmentDto
binanceChainIdBinance 链 ID。
defiProtocolId所属 DeFi 协议标识。
protocolName协议显示名称。
investmentId投资品标识(64 位 hex,无 0x 前缀)。与 POST /api/v1/defi/data/position/list 返回的 investmentIds、交易构建接口接收的格式一致。
investmentName投资品显示名称。
investType该投资品的投资类型——此处为单个字符串(每个投资品只有一种)。注意:协议维度的 investType(协议列表 / 详情中)是数组。已知取值:Earn、LiquidityPool。
apyType收益率类型。已知取值:APY、APR。
apyBps年化收益率,以基点表示(1 bps = 0.01%)。整数值——用于排序 / 比较 / 筛选,不要使用裸小数。
apyDisplay预格式化的 APY 展示字符串(如 "1,562.65%")。直接原样引用,禁止二次计算或转换。
tvl该投资品锁仓总价值(美元)。字符串,保留数据源原始精度。
DefiInvestmentTokenDto
tokenAddress代币合约地址。主链币使用 sentinel 地址。
tokenName代币名称。
tokenSymbol代币符号。
DefiInvestmentInfoDto
binanceChainIdBinance 链 ID。
defiProtocolId所属 DeFi 协议标识。
protocolName协议显示名称。
protocolLogo协议 Logo 图片 URL(完整 URL,直接使用)。
investmentId投资品标识(64 位 hex,无 0x 前缀)。与 POST /api/v1/defi/data/position/list 返回的 investmentIds、交易构建接口接收的格式一致。
investmentName投资品显示名称。
investType该投资品的投资类型——此处为单个字符串(每个投资品只有一种)。注意:协议维度的 investType(协议列表 / 详情中)是数组。已知取值:Earn、LiquidityPool。
investable该投资品当前是否可投。
apyBps年化收益率,以基点表示(1 bps = 0.01%)。整数值——用于排序 / 比较 / 筛选,不要使用裸小数。
apyDisplay预格式化的 APY 展示字符串(如 "1,562.65%")。直接原样引用,禁止二次计算或转换。
apyType收益率类型。已知取值:APY、APR。
tvl锁仓总价值(美元)。字符串,保留数据源原始精度。
poolAddress池 / 策略合约地址。
feeRate费率字符串(如 "0.001" = 0.1%)。
需投入的代币列表。
奖励代币列表。
LP 代币列表(流动性仓位)。
借入代币列表(借贷借入仓位)。
ProtocolPageResult
page当前页码(从 1 开始)。
size每页条数。
total总记录数。
当前页的协议列表。
InvestmentPageResult
page当前页码(从 1 开始)。
size每页条数。
total总记录数。
当前页的投资品列表。
DefiTokenItem
tokenAddress代币合约地址;主链币使用 sentinel 地址。
amount人类可读数量(十进制字符串),如 "1.5"、"100"。
DefiClaimType
领取类型,决定必填字段:
REWARD_PROTOCOL:协议全局奖励(如 Aave incentive、Radiant),需defiProtocolId+binanceChainIdREWARD_INVESTMENT:单个 investment 维度奖励,需investmentIdLP_FEE:Uniswap V3/V4 LP 手续费,需investmentId+nftIdREDEMPTION:赎回本金(Lista / Aster / Solv 等),需investmentId+redemptionId
协议限制——并非每种 claimType 都适用于所有协议,不匹配的组合会被拒(40453 或 40454):
REWARD_PROTOCOL本期不支持 LP(流动性池)协议。REWARD_INVESTMENT不支持 PancakeSwap V3 farming 仓位;领取挖矿激励请改用LP_FEE。LP_FEE仅适用于集中流动性(V3/V4)LP 仓位。REDEMPTION仅适用于带赎回 / 锁仓流程的协议(Lista、Aster、Solv)。
某仓位可用的 claimType 由该仓位的 positionDetail.claimTypes 返回(见持仓列表)——请据此分支,
不要硬编码映射。注意:错误信息里的协议 ID 可能带链前缀(如 bsc_pancakeswap4),
而接口字段中的规范 ID 是无前缀形态(如 pancakeswap4)。
DefiCallDataItem
callDataType本条目的操作类型:
APPROVE:ERC-20 授权,须在主交易前签名广播并确认DEPOSIT/REDEEM/LP_ADD/LP_REMOVE/CLAIM:主交易。LP_ADD/LP_REMOVE为 LP 加 / 减流动性段(与流动性池投资品的 deposit / redeem 同一构建路径;此字段反映链上动作,而非调用入口)。
from用户钱包地址(签名 / 发送方)。EIP-55 校验和格式——若签名库要求,签名前请用 to_checksum_address 规范化。
to目标合约地址。EIP-55 校验和格式,与 from 一致。BSC 上每个主交易项均非空。
value原生币金额(0x 前缀的 hex 字符串)。BSC 上主交易项均非空。
data序列化交易数据,0x 前缀的 hex calldata。
gasLimit建议 gas limit(十进制字符串),估算失败为 null。
gasPriceLegacy gas price(十进制字符串)。BSC 等 EIP-1559 链为 null(改用 maxFeePerGas / maxPriorityFeePerGas)。
maxPriorityFeePerGasEIP-1559 优先费(wei,十进制字符串);非 1559 链为 null。
maxFeePerGasEIP-1559 单笔最大 gas 费(wei,十进制字符串);非 1559 链为 null。
DefiPreview
success模拟交易是否会在链上执行成功。
模拟得到的签名代币余额变动列表。每项含 tokenType、tokenSymbol、tokenAddress、 tokenDecimals、amount(正=收到,负=支出)、valueUsd、可选 tokenId。
预估网络费用与交互对手合约。含 estimatedNetworkFee 与 interactWith。
借贷协议 health factor 变化。借贷类协议(如 Aave / Venus)返回 before / after 变化前后的值;非借贷协议或健康因子不可用时为 null。
非阻断式风险提示,无风险时为空数组。
errorMessage模拟交易失败时的错误信息。
DefiTxResponse
有序的未签名交易列表,APPROVE 在前、主交易在后。
当 simulate=true 时构建接口返回的预览结果。包含操作是否预期成功、预估余额变动、预估网络费用, 以及借贷协议的 health factor 变化。balanceChange、feeAndContract、healthFactor、warnings 均有固定结构(见下);条目数量与部分内部取值因协议而异。
redeemDelayDays赎回等待天数,[min, max] 十进制字符串对。仅 /transaction/redeem 填充,其余构建接口或不支持时为 null。含义: [](空数组)= 即时到账,无等待期; ["7","7"] = 固定 7 天; ["7","10"] = 7–10 天。 等待期自赎回交易链上确认后起算。
LpAddCalculateResponse
inputTokenAmount输入 token 数量(人类可读)。
pairedTokenAddress根据投资品推导出的配对 token 合约地址。
pairedTokenAmount计算得到的配对 token 数量(人类可读)。
B402ApiErrorEnvelope
statustypecodeerrorDatadatasubDataparamsB402PaymentKindExtraV2
nameversionassetTransferMethodsignerAddressspenderAddressB402PaymentKindV2
x402VersionschemenetworkB402SupportedDataV2
extensionsB402SupportedResponseV2
statustypecodeerrorDatasubDataparamsB402ResourceInfoV2
urldescriptionmimeTypeB402PaymentRequirementsExtraV2
nameversionassetTransferMethodsignerAddressspenderAddressB402PaymentRequirementsV2
schemenetworkamount^[0-9]+$ · 必须assetpayTomaxTimeoutSecondsB402Eip3009Authorization
fromtovaluevalidAftervalidBeforenonceB402Permit2Permitted
tokenamountB402Permit2Witness
tovalidAfterfacilitatorB402Permit2Authorization
fromspendernoncedeadlineB402BazaarExtension
routeTemplatedescriptionB402PaymentPayloadV2
x402VersionB402VerifyDataV2
isValidpayerinvalidReasoninvalidMessageB402VerifyResponseV2
statustypecodeerrorDatasubDataparamsB402SettleRequestV2
x402VersionsettleAmount^[0-9]+$B402SettleDataV2
successtransactionnetworkpayeramounterrorReasonerrorMessageB402SettleResponseV2
statustypecodeerrorDatasubDataparamsB402PaymentKindExtraV1
nameversionassetTransferMethodfacilitatorAddressB402PaymentKindV1
x402VersionschemenetworkB402SupportedDataV1
extensionsB402SupportedResponseV1
statustypecodeerrorDatasubDataparamsB402PaymentRequirementsV1
schemenetworkamountpayToassetmaxTimeoutSecondsresourcedescriptionmimeTypeB402PaymentPayloadV1
x402VersionschemenetworkB402VerifyResponseV1
statustypecodeerrorDatasubDataparamsB402SettleRequestV1
x402VersionsettleAmount^[0-9]+$B402SettleDataV1
successtransactionpayernetworkamountconfirmationserrorReasonerrorMessage