开发者平台
主题

使用指南#

链上基础数据 API 提供公链概览、区块、交易、事件日志和地址数据。推荐先查询目标接口的支持链,再调用业务接口;不要因为某条链被一个模块支持,就假设其他模块也支持该链。

API 参考#

快速开始#

调用约定#

  • Base URL:https://web3.okx.com
  • chainIndex 是数字字符串,例如 Ethereum 为 1、Bitcoin 为 0,不能传链名。
  • 时间参数使用 Unix 毫秒时间戳字符串,例如 1597026383085
  • 每次请求都需要 OK-ACCESS-KEYOK-ACCESS-SIGNOK-ACCESS-TIMESTAMPOK-ACCESS-PASSPHRASE
  • 签名必须按本次请求的 method、path、query、body 和 timestamp 生成,不能在不同 URL 或翻页请求之间复用。
  • 成功响应使用 codemsgdata 包络,code 是字符串。

推荐调用流程#

  1. 把输入的链名转换为 chainIndex
  2. 调用目标模块的 supported-chains 接口。
  3. 同时匹配响应中的 apiNamechainIndex
  4. 匹配成功后调用目标接口;否则返回“该接口暂不支持此链”。
  5. 按接口上限拆分批量参数和区块范围。
  6. 分页时原样回传 cursor,直到响应中的 cursor 为空字符串。

组合场景#

目标按顺序调用关键处理
多链概览看板1. info/supported-chains
2. 并行调用 info/summaryinfo/blockinfo/transactioninfo/address
3. info/stats 获取趋势
apiName + chainIndex 分别校验;单个卡片失败不影响其他结果;统计区间不超过 1 年
按时间查区块和交易1. block/supported-chains
2. block/block-height-by-time
3. 将返回高度传给 block/block-fillsblock/transaction-list
closest=before 查目标时间之前的最近区块,after 查之后的最近区块
交易全景1. 分别查询 transaction 和 log 的支持链
2. transaction/transaction-multi
3. 并行调用 internal-transaction-multitoken-transfer-multilog/by-transaction
每批最多 20 个交易哈希;日志不支持时仍返回基础交易并标记日志为 unsupported
地址画像1. address/address-active-chain
2. 分模块校验支持链
3. 调用 address/information-evm、两个地址交易接口和 block/address-balance-history
每批最多 50 个地址;区块范围每段最多 10,000;非 EVM 地址不要调用 information-evm
合约事件监控1. log/supported-chains
2. log/by-address-and-topic
3. 按 cursor 翻页
cursor 非空就继续;按 chainIndex + txId + logIndex 幂等去重
多地址资金流1. 地址按 50 个切片
2. 区块按 10,000 切片
3. 对每个切片调用两个地址交易接口
4. 合并去重
切片内按 cursor 串行,独立切片按限流预算并行;用 isFromOrTo 筛选方向

支持链映射#

按模块发现实际支持范围#

模块支持链接口验证的目标接口
公链信息/api/v6/explorer/info/supported-chains/info/*
区块/api/v6/explorer/block/supported-chains/block/*
交易/api/v6/explorer/transaction/supported-chains/transaction/*
事件日志/api/v6/explorer/log/supported-chains/log/*
地址/api/v6/explorer/address/supported-chains/address/*

建议把响应保存为 supported[(module, apiName, chainIndex)] = true 集合。例如,调用 /api/v6/explorer/transaction/transaction-multi 前,应检查 supported[("transaction", "transaction-multi", "1")]

apiName 与接口映射#

模块apiName接口路径
infodetail/api/v6/explorer/info/detail
infosummary/api/v6/explorer/info/summary
infotransaction/api/v6/explorer/info/transaction
infoblock/api/v6/explorer/info/block
infoaddress/api/v6/explorer/info/address
infostats/api/v6/explorer/info/stats
infohashes/api/v6/explorer/info/hashes
blockblock-list/api/v6/explorer/block/block-list
blockblock-fills/api/v6/explorer/block/block-fills
blocktransaction-list/api/v6/explorer/block/transaction-list
blockblock-height-by-time/api/v6/explorer/block/block-height-by-time
blockblock-stats/api/v6/explorer/block/block-stats
blockaddress-balance-history/api/v6/explorer/block/address-balance-history
transactiontransaction-multi/api/v6/explorer/transaction/transaction-multi
transactioninternal-transaction-multi/api/v6/explorer/transaction/internal-transaction-multi
transactiontoken-transfer-multi/api/v6/explorer/transaction/token-transfer-multi
transactionnormal-transaction-list-multi/api/v6/explorer/transaction/normal-transaction-list-multi
transactiontoken-transaction-list-multi/api/v6/explorer/transaction/token-transaction-list-multi
logby-block-and-address/api/v6/explorer/log/by-block-and-address
logby-address-and-topic/api/v6/explorer/log/by-address-and-topic
logby-address/api/v6/explorer/log/by-address
logby-transaction/api/v6/explorer/log/by-transaction
addressaddress-active-chain/api/v6/explorer/address/address-active-chain
addressinformation-evm/api/v6/explorer/address/information-evm

address/information-evm、事件日志接口及标注“仅支持 EVM”的接口,只能在对应支持链接口确认后用于 EVM 链。收到 50038 时应刷新当前模块的支持链缓存,不能把该链永久标记为全局不支持。完整名称映射见文末附录。

分页、批量和范围限制#

cursor 分页#

  1. 首次请求不传 cursor
  2. 下一次请求原样传回响应中的 cursor,不要转换成页码。
  3. cursor 为空字符串时停止。
  4. 日志接口即使返回空 logList,只要 cursor 非空仍需继续请求。
  5. 同一条 cursor 链必须串行翻页;不同查询可在限流预算内并行。

调用限制#

参数或场景限制
transaction-multi.txId逗号分隔,最多 20 个,重复值自动去重
internal-transaction-multi.txId逗号分隔,最多 20 个
token-transfer-multi.txId逗号分隔,最多 20 个
地址交易查询 address逗号分隔,最多 50 个
tokenContractAddress 批量过滤最多 50 个
startBlockHeightendBlockHeight最大跨度 10,000 个区块
普通 cursor 分页 limit默认 20,最大 100
日志扫描分页 limit默认 100,最大 1,000
info/stats 时间范围最长 1 年

超过限制时应先在客户端切片;合并结果时按交易哈希、日志索引或业务唯一键去重。

附录:chainName 与 chainIndex 完整映射#

此表用于将链名或别名转换为候选 chainIndex,包含主网、测试网和历史名称。它不是接口支持清单;调用前仍需通过对应模块的 supported-chains 接口同时确认 apiNamechainIndex

部分名称代表不同网络或历史登记项,例如 CORE=70000025CORE_EVM=1116CRO=25CRO_COSMOS=394CFX=1030Conflux=503。遇到重名时应结合网络类型确认,不要仅按显示名称猜测。

chainNamechainIndexchainNamechainIndex
ACT666ADA1815
ALGO283ARB_ETH42161
ARDR16754ARK111
ASP70000008ASTR_DOT70000090
ATOM118AURORA_ETH1313161554
AVAX43114AXL718
BCH145BITCI70000006
BNB56BOBA_ETH288
BRISE32520BSV236
BTC0BTS308
CELO42220CFX1030
CHZ2182CRO25
CUBE1818DASH5
DOT354ECH70000005
ECOC70000009EGLD70000003
ELA20EOS194
ETC61ETH1
ETL70000010EVER396
EVMOS710FLOW539
FSN32659FTM250
FUSE122GLMR1284
GO60GT86
GXC2303HIVE70000004
HOO70HT128
HTML172ICX74
INT70000007IOST291
IOTX4689JUNO709
KAI70000002KAR686
KAVA459KCS321
Kaia(KLAY)8217KSM434
LTC2LUNC70000001
MAN318MATIC137
METIS1088MOVR1285
MTR82NAS2718
NBT12NEAR397
NULS8964NXT29
OKT66ONE1666600000
ONT1024OP_ETH10
OSMO706QTUM2301
RON2020ROSE474
SCRT529SDN336
SGB19SOL501
STARKNET9004STARS563
STX5757THETA361
TLOS40TOMO88
TRC83TRX195
UBQ8VET818
VITE666666VLX106
WAN5718350WAVES5741564
WAX708XCP9
XDAI100XDC50
XEM43XHB3030
XLM70000088XOR617
XRP144XTZ1729
ZEC133ZIL313
APT637KUJI70000011
AKT70000012ABT260
ACA787AERGO441
ALPHA622AR472
BAND494BCD999
BHP547BNT483
BTG156BTM153
CFG747CMT1122
CSPR506CTC583
DCR42DMD152
DOGE3EFI1155
ELF1616HC(HSR)171
HYC1397ICP70000048
IOTA4218KDA626
LAMB364LAT210425
LET518LSK(KLY)134
LUNA330MINA12586
RVN175SC1991
SRM573TON607
TRUE2049VSYS360
XCH8444XEC899
XMR70000013XNO165
YEE4096YOU534
ZEN121NRG39797
FCTID281KMD141
JEWEL53935mADA2001
XIN2365CANTO70000014
HYDRA609ARB_NOVA42170
SYS57CET52
FRA2152STRAT105
SX416ETP2302
RUNE931TT108
POLIS333999smartBCH10000
ETHW10001ENQ70000016
YOC70000017CELR70000018
SKL70000019ETHF513100
IRIS566IMX1761886
ERA_ETH324SUI784
DEV_SUI783FITFI1234
pCKB71402SERO569
CTXC70000021FLR14
PHA_KHA70000022CLV70000023
EM70000024CORE70000025
CORE_EVM1116YOYOW70000026
WTC70000027AAC512
ZKS13LITE_ETH805
FIL314UMEE70000028
CRO_COSMOS394POM18159
X1_TEST19500OKT_TEST65
GON_ETH1101SEI70000029
KAVA_EVM2222Conflux503
GOERLI_ETH70000030SEI_TEST70000031
BMTC4321ZETA_MAINNET7000
OMN408WEMIX1111
ROSE_EVM42262OAS70000033
XETA70000034BNC788
HASH505POKT635
DNA515DGB70000035
CKB309AVAX_X9000
WICC(WGRT)70000036FAN99999
PLS369ACE648
TIA70000037MNT5000
LINEA59144Base8453
BTC_TestNet70000038OP_BNB204
Sepolia11155111enj70000039
Beacon70000040scroll534352
injective70000041DYDX70000042
Kaspa111111Venom70000043
MANTA_ETH169HAQQ11235
NOSTR1237FacetVM70000044
hnt904gas_n3888
astr_evm592FIL_EVM461
IMX_ZKEVM13371MXC18686
CHZ_V288888Mumbai_Testnet80001
PolygonzkEVM_Testnet1442ETHS70000045
BTC_src2070000046Amoy_Testnet80002
BTC_Signet70000047DYM1100
Rangers2025Blast_Sepolia168587773
WEMIX3_Testnet1112Avocado634
zkSync_Sepolia300Shardeum_Sphinx8082
Mode34443MerLin4200
XION70000051XION_TEST70000052
DYM_TEST70000053Blast81457
Arbitrum_Sepolia421614LUMI94168
BBNylon_TEST70000054B2Network_TEST1102
BEVM_Canary1501TunaChain_TEST10123
XLayer_TEST196BITLAYER_BTC200901
B2Network223ZKLINK_ETH810180
Avail70000055ZETA_COSMOS70000050
STC70000056BOB_ETH60808
BounceBit_BTC6001TAIKO_ETH167000
SOL_Testnet70000057ZORA_ETH7777777
ONCHAIN_ETH27563OVER54176
BEVM_BTC11501frxETH252
MAT698KARAK_ETH2410
KROMA_ETH255Lisk1135
Sonic_Testnet70000058Sonic_Devnet70000059
EVM_SEI1329PLUME_ETH_TEST161221135
MOVEMENT_TestNet70000060B3_ETH8333
G1625FB70000061
APE33139WORLD480
RBTC30Sonic_Testnet_v170000062
TESTNET_IP1516Reya70000063
Zircuit48900CTK70000064
DORA_FACTORY70000065DuckChain_TON5545
HSK177MOVE70000066
SOON_testnet70000067Eclipse70000068
MINT_ETH185S146
PLUME_ETH98865XTERIO_BNB112358
SOON_mainnet70000069tbaby70000070
XYM70000071assetHub70000072
Abstract2741Soneium1868
Unite88899TESTNET_MON10143
SONIC_SOL70000130TESTNET_SAHARA313313
SOON_BNB70000075Plume98866
TAKER1125Endless70000076
BABY70000077ZKCANDY_ETH320
INIT70000078NERO1689
MEZO_BTC31612Noble70000079
BTT199HYPE_TEST998
assethub_ksm70000081FX530
VC207FLOW_EVM70000082
BOTANIX3637XLayer_testnet21952
GOAT_BTC2345USTC70000001
SOPH50104Mind228
Silicon2355Metadium11
AlephZero_EVM41455Ink57073
lens232redstone690
Etherlink42793Superposition55244
Swell1923Vana1480
Corn21000000Fuse122
Degen666666666Glue1300
Hemi43111Lightlink1890
Nibiru6900Peaq3338
RariChain1380012617Hedera295
Shibarium109RadixDLT70000083
MAYA70000084WITNESS1702448187
LUMIA994873017WIREX31415
HAUST938TERNOA752025
PENTAGON3344FORKNET838
ENI173MANTRA70000085
IOTA_MOVE70000086KATANA_ETH747474
MORPH_ETH2818XPL_Plasma9745
EVM_HYPE700000800G16661
FOGO70000087MemeCore4352
ShimmerEVM148MON143
CANTON70000089BITTENSOR964
STABLE988Mega_ETH4326
BRIDGE13441ZANO70000091
Gate_Layer10088PROS1672
Tempo4217Edge3343
Jovay5734951TradeZone70000196
TradeZoneTestNet70000195orbit70000092
KITE2366BittensorDot70000093
Gensyn685689xlayertest1952
HyperCore70000094MMPTestnet70000095
RobinhoodChain4663HPP190415