Etherscan 的 API使用

标签:区块链接口
发布时间:2018年12月27日 价值:20000.00 / 共识:22

虽然以太坊提供了 Web3Json Rpc 这 2 种 API,geth 也额外提供了一些 API,但是对于开发以太坊应用来说还是显得有些不足,比如说获取交易记录的时间,需要先通过交易的 hash 找到该交易对应的区块 id,然后才能找到对应的时间,查询起来相当不方便。

好在Etherscan对外提供了一些公共的 API,给我们提供了额外的能力来处理更多的业务场景。

Etherscan api

为了方便开发人员更好地使用ethersacn.io,网站提供了一系列 API 供开发人员使用。

使用方法

API 的使用非常简单,基本上都是 get 方法,通过 http 请求就可以直接调用,在每个 Api 的说明文档都有对应的例子可以查看。

模块介绍

API 主要包含以下模块:账号、智能合约、交易、区块、事件日志、代币及工具等。

账号 API

账号相关的 API,有获取账号金额,获取交易记录等,该模块提供的 API 最多。

获取单个账号金额

API 示例

https://api.etherscan.io/api?module=account&action=balance&address=0xddbd2b932c763ba5b1b7ae3b362eac3e8d40121a&tag=latest&apikey=YourApiKeyToken

参数说明

  • module:对应的模块名称,这里是账户模块,所以是moudle=account
  • action:对应的操作,这里是balance,即获取金额。
  • address:要查询金额的账号地址。
  • tag:之前在介绍 geth 的 API 时讲过获取账号金额需要 2 个参数,一个是账号地址,另外一个就是 tag,一般写latest就可以了。
  • apikey:你在Etherscan上创建的 apikey,带上没有请求的限制,也可以不带,下面会介绍 API 的请求限制。

其中module、action、apikey是每个 API 都有的参数,其他的参数则因不同 API 而不同。

返回结果

  1. {"status":"1","message":"OK","result":"670456215218885498951364"}

获取多个账号金额

API 示例

https://api.etherscan.io/api?module=account&action=balancemulti&address=0xddbd2b932c763ba5b1b7ae3b362eac3e8d40121a,0x63a9975ba31b0b9626b34300f7f627147df1f526,0x198ef1ec325a96cc354c7266a038be8b5c558f67&tag=latest&apikey=YourApiKeyToken

参数说明

(前面有讲过的参数就不讲了,下同)

与单个账号金额 API 相比,参数address,号分隔多个账号,最多可支持 20 个账号的金额查询。

返回结果

  1. {
  2. "message": "OK",
  3. "result": [
  4. {
  5. "account": "0xddbd2b932c763ba5b1b7ae3b362eac3e8d40121a",
  6. "balance": "40807168564070000000000"
  7. },
  8. {
  9. "account": "0x63a9975ba31b0b9626b34300f7f627147df1f526",
  10. "balance": "332567136222827062478"
  11. },
  12. {
  13. "account": "0x198ef1ec325a96cc354c7266a038be8b5c558f67",
  14. "balance": "0"
  15. }
  16. ],
  17. "status": "1"
  18. }

获取”正常”交易记录

API 示例

https://api.etherscan.io/api?module=account&action=txlist&address=0xddbd2b932c763ba5b1b7ae3b362eac3e8d40121a&startblock=0&endblock=99999999&page=1&offset=10&sort=asc&apikey=YourApiKeyToken

参数说明

  • action:为txlist,表示列出交易记录。
  • address:要查询交易记录的账号地址。
  • startblock:起始查询块 id,可选,默认值为 0。
  • endblock:结束查询块 id,可选,默认值为最后一个区块。
  • page: 页数(没错,这个 API 还支持分页),可选。
  • offset: 查询到记录数,可选,默认是查询 10000 条记录。
  • sort: 排序规则,可以正序asc和倒序desc

返回结果

  1. {
  2. "message": "OK",
  3. "result": [
  4. {
  5. "blockHash": "0x2d0a9228f22fe85596d246040d4fd7dc6b1a55920bae02b68e731d55a890b315",
  6. "blockNumber": "47894",
  7. "confirmations": "5435815",
  8. "contractAddress": "",
  9. "cumulativeGasUsed": "21612",
  10. "from": "0xddbd2b932c763ba5b1b7ae3b362eac3e8d40121a",
  11. "gas": "23000",
  12. "gasPrice": "400000000000",
  13. "gasUsed": "21612",
  14. "hash": "0x7e1503d2001cab2f432b56a62a3ee874782c8e33cbd79a664d155a758c1784a2",
  15. "input": "0x454e34354139455138",
  16. "isError": "0",
  17. "nonce": "1",
  18. "timeStamp": "1438948043",
  19. "to": "0x2910543af39aba0cd09dbb2d50200b3e800a63d2",
  20. "transactionIndex": "0",
  21. "txreceipt_status": "",
  22. "value": "9001000000000000000000"
  23. },
  24. ],
  25. "status": "1"
  26. }

获取”内部”交易记录

API 示例

https://api.etherscan.io/api?module=account&action=txlistinternal&address=0x2c1ba59d6f58433fb1eaee7d20b26ed83bda51a3&startblock=0&endblock=2702578&page=1&offset=10&sort=asc&apikey=YourApiKeyToken

参数说明

参数与上一个 API 基本相同,只有actiontxlistinternal这一点不同,这 2 种交易的区别是什么呢?简单的理解就是“正常”的交易是会记录到区块链上的,而“内部”交易是指不会记录到区块链上的记录,比如交易失败的记录。

另外这个 API 还可以通过交易 hash 查看交易的详情。

https://api.etherscan.io/api?module=account&action=txlistinternal&txhash=0x40eb908387324f2b575b4879cd9d7188f69c8fc9d87c901b9e2daaea4b442170&apikey=YourApiKeyToken

返回结果

  1. {
  2. "message": "OK",
  3. "result": [
  4. {
  5. "blockNumber": "2547619",
  6. "contractAddress": "",
  7. "errCode": "Bad jump destination",
  8. "from": "0x2c1ba59d6f58433fb1eaee7d20b26ed83bda51a3",
  9. "gas": "346878",
  10. "gasUsed": "0",
  11. "hash": "0x2896441f9d1f167b4a3f987d82233e7d238e6a50a227c4b612dbc82f34bb533d",
  12. "input": "",
  13. "isError": "1",
  14. "timeStamp": "1478013203",
  15. "to": "0x20d42f2e99a421147acf198d775395cac2e8b03d",
  16. "traceId": "0",
  17. "type": "call",
  18. "value": "71000000000000000000"
  19. },
  20. ],
  21. "status": "1"
  22. }

获取 ERC20 代币交易事件记录

API 示例
https://api.etherscan.io/api?module=account&action=tokentx&contractaddress=0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2&address=0x4e83362442b8d1bec281594cea3050c8eb01311c&page=1&offset=100&sort=asc&apikey=YourApiKeyToken

参数说明

  • action: 值为tokentx,表示查询代币交易记录。
  • contractaddress: 代币的智能合约地址。
  • address: 只查询和该账户地址相关的记录,可选。

返回结果

  1. {
  2. "message": "OK",
  3. "result": [
  4. {
  5. "blockHash": "0xb3ff25909ae9ae5b65baecab1114dff885fbd5a1607081229ea50b6a2db13ae8",
  6. "blockNumber": "5278009",
  7. "confirmations": "205861",
  8. "contractAddress": "0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2",
  9. "cumulativeGasUsed": "1050219",
  10. "from": "0x4e83362442b8d1bec281594cea3050c8eb01311c",
  11. "gas": "191157",
  12. "gasPrice": "4000000000",
  13. "gasUsed": "97646",
  14. "hash": "0x497f15095877bc06b9e0f422673c1e0f13a2b4224b615ef29ce8c46e249364d1",
  15. "input": "0x73b38101000000000000000000000000000000000000000000000000000000000000003d0000000000000000000000000000000000000000000046aefaa28844d7d839d7",
  16. "nonce": "730",
  17. "timeStamp": "1521386734",
  18. "to": "0x69076e44a9c70a67d5b79d95795aba299083c275",
  19. "tokenDecimal": "18",
  20. "tokenName": "Maker",
  21. "tokenSymbol": "MKR",
  22. "transactionIndex": "28",
  23. "value": "553365126770755906"
  24. },
  25. ],
  26. "status": "1"
  27. }

获取已开采的区块列表

API 示例
https://api.etherscan.io/api?module=account&action=getminedblocks&address=0x9dd134d14d1e65f84b706d6f205cd5b1cd03a46b&blocktype=blocks&page=1&offset=10&apikey=YourApiKeyToken

参数说明

  • action: 值为getminedblocks
  • blocktype:区块类型,可以选区块blocks和叔块uncles,不了解叔块的可以查看这里

返回结果

  1. {
  2. "message": "OK",
  3. "result": [
  4. {
  5. "blockNumber": "3462296",
  6. "blockReward": "5194770940000000000",
  7. "timeStamp": "1491118514"
  8. },
  9. ],
  10. "status": "1"
  11. }

合同 API

智能合约相关的 API,其实只有一个获取智能合约接口的 API,但是这个 API 非常有用。

获取智能合约接口

API 示例

https://api.etherscan.io/api?module=contract&action=getabi&address=0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413&apikey=YourApiKeyToken

参数说明

  • module: 值为contract
  • action: 值为getabi
  • address: 智能合约地址。

智能合约的 abi 就是一个 json 对象,通过这个对象我们可以调用其接口方法,后面会写一篇文章介绍如何操作 abi 对象,敬请期待。

返回结果

返回结果内容比较长,这里省略,就是一个 json 对象,感兴趣的可以自行调用该 API 看结果。

使用限制

账号和智能合约的 API 已经能满足大部分的业务需求了,其他模块的 API 感觉没什么太大的作用,这里就不介绍了,感兴趣的读者可以自行查阅。

这里再说下 API 的使用限制,刚才提到每个 API 都有一个apikey参数,如果 API 没加上这个参数的话,每个 API 的请求次数不能超过 5 次每秒。

总结

Etherscan提供的这些 API 有些是和以太坊提供的 API 有重复的,比如说获取账号金额,获取事件日志记录等,但有一些 API 给我们带来了很大的便利性,比如获取账号交易记录,有了这个 API 就不用使用几个原生 API 进行各种数据拼接了。

另外Etherscan的这套 API 在 Rinkeby 测试网络也有一套一模一样的,区别只是前面的 url 不同,Rinkeby 的是:api-rinkeby.etherscan.io,感兴趣的同学可以去试试。

  • 分享 收藏
0 条评论
  • 这篇文章暂无评论,赶紧评论一下吧~