forked from t4n6a1ka/etherscan-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathReadme.
More file actions
85 lines (65 loc) · 2.63 KB
/
Readme.
File metadata and controls
85 lines (65 loc) · 2.63 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# Etherscan API
[](https://www.npmjs.com/package/etherscan-api)<<<<<<< patch-5
=======
<<<<<<< patch-4
>>>>>>> master
[](https://github.com/sebs/etherscan-api/blob/master/LICENSE.md)
[](https://github.com/sebs/etherscan-api)
[](https://travis-ci.org/sebs/etherscan-api)
[](https://github.com/sebs/etherscan-api/issues)
<<<<<<< patch-5
=======
=======
[](https://github.com/t4n6a1ka/etherscan-api/blob/master/LICENSE.md)
[](https://github.com/t4n6a1ka/etherscan-api)
[](https://travis-ci.org/t4n6a1ka/etherscan-api)
[](https://github.com/t4n6a1ka/etherscan-api/issues)
>>>>>>> master
>>>>>>> master
A way to access the [etherscan.io api](https://etherscan.io/apis) using promises. Fetch a diverse set of information about the blockchain.
Mainnet
```javascript
var api = require('etherscan-api').init('YourApiKey');
var balance = api.account.balance('0xde0b295669a9fd93d5f28d9ec85e40f4cb697bae');
balance.then(function(balanceData){
console.log(balanceData);
});
```
## Example in the wild
* [Polymer3 based example](https://github.com/hiherto-elements/test-app)
## For testnet usage
Supported:
* morden
* ropsten
* rinkeby
Latest
```javascript
// apikey, network, timeout
var api = require('etherscan-api').init('YourApiKey','rinkeby'. '3000');
```
## Install
```bash
npm install etherscan-api --save
```
## API Documentation
<<<<<<< patch-5
[Full Api Docs](https://sebs.github.io/etherscan-api/)
=======
<<<<<<< patch-4
[Full Api Docs](https://sebs.github.io/etherscan-api/)
=======
[Full Api Docs](https://t4n6a1ka.github.io/etherscan-api/)
>>>>>>> master
>>>>>>> master
## Development workflow
* npm test - runs tests
* npm run posttest - starts the linter
* npm run lint - preconfigured linter
* npm run docs - generates the apidocs
* npm run bundle - builds a new bundle
* npm run preversion - Steps before we create a new Tag
* lint
* changelog
* npm run pages - pushes generated apidocs to the server
* postversion - after generating a new version, push the tag to the server
* npm run changelog - generates a changelog and pushes it