Skip to content

Commit 1cb2e79

Browse files
committed
Merge pull request #424 from bitcoinsSG/master
updated README api lnks to insight-api
2 parents 22f3ba9 + 931d295 commit 1cb2e79

File tree

1 file changed

+31
-31
lines changed

1 file changed

+31
-31
lines changed

README.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This is a backend-only service. If you're looking for the web frontend applicati
1010
npm install -g bitcore-node@latest
1111
bitcore-node create mynode
1212
cd mynode
13-
bitcore-node add insight-api
13+
bitcore-node install insight-api
1414
bitcore-node start
1515
```
1616

@@ -49,15 +49,15 @@ Caching support has not yet been added in the v0.3 upgrade.
4949

5050
### Block
5151
```
52-
/api/block/[:hash]
53-
/api/block/00000000a967199a2fad0877433c93df785a8d8ce062e5f9b451cd1397bdbf62
52+
/insight-api/block/[:hash]
53+
/insight-api/block/00000000a967199a2fad0877433c93df785a8d8ce062e5f9b451cd1397bdbf62
5454
```
5555

5656
### Block Index
5757
Get block hash by height
5858
```
59-
/api/block-index/[:height]
60-
/api/block-index/0
59+
/insight-api/block-index/[:height]
60+
/insight-api/block-index/0
6161
```
6262
This would return:
6363
```
@@ -67,30 +67,30 @@ which is the hash of the Genesis block (0 height)
6767

6868
### Transaction
6969
```
70-
/api/tx/[:txid]
71-
/api/tx/525de308971eabd941b139f46c7198b5af9479325c2395db7f2fb5ae8562556c
72-
/api/rawtx/[:rawid]
73-
/api/rawtx/525de308971eabd941b139f46c7198b5af9479325c2395db7f2fb5ae8562556c
70+
/insight-api/tx/[:txid]
71+
/insight-api/tx/525de308971eabd941b139f46c7198b5af9479325c2395db7f2fb5ae8562556c
72+
/insight-api/rawtx/[:rawid]
73+
/insight-api/rawtx/525de308971eabd941b139f46c7198b5af9479325c2395db7f2fb5ae8562556c
7474
```
7575

7676
### Address
7777
```
78-
/api/addr/[:addr][?noTxList=1&noCache=1]
79-
/api/addr/mmvP3mTe53qxHdPqXEvdu8WdC7GfQ2vmx5?noTxList=1
78+
/insight-api/addr/[:addr][?noTxList=1&noCache=1]
79+
/insight-api/addr/mmvP3mTe53qxHdPqXEvdu8WdC7GfQ2vmx5?noTxList=1
8080
```
8181

8282
### Address Properties
8383
```
84-
/api/addr/[:addr]/balance
85-
/api/addr/[:addr]/totalReceived
86-
/api/addr/[:addr]/totalSent
87-
/api/addr/[:addr]/unconfirmedBalance
84+
/insight-api/addr/[:addr]/balance
85+
/insight-api/addr/[:addr]/totalReceived
86+
/insight-api/addr/[:addr]/totalSent
87+
/insight-api/addr/[:addr]/unconfirmedBalance
8888
```
8989
The response contains the value in Satoshis.
9090

9191
### Unspent Outputs
9292
```
93-
/api/addr/[:addr]/utxo[?noCache=1]
93+
/insight-api/addr/[:addr]/utxo[?noCache=1]
9494
```
9595
Sample return:
9696
``` json
@@ -120,13 +120,13 @@ Sample return:
120120
### Unspent Outputs for Multiple Addresses
121121
GET method:
122122
```
123-
/api/addrs/[:addrs]/utxo
124-
/api/addrs/2NF2baYuJAkCKo5onjUKEPdARQkZ6SYyKd5,2NAre8sX2povnjy4aeiHKeEh97Qhn97tB1f/utxo
123+
/insight-api/addrs/[:addrs]/utxo
124+
/insight-api/addrs/2NF2baYuJAkCKo5onjUKEPdARQkZ6SYyKd5,2NAre8sX2povnjy4aeiHKeEh97Qhn97tB1f/utxo
125125
```
126126

127127
POST method:
128128
```
129-
/api/addrs/utxo
129+
/insight-api/addrs/utxo
130130
```
131131

132132
POST params:
@@ -136,25 +136,25 @@ addrs: 2NF2baYuJAkCKo5onjUKEPdARQkZ6SYyKd5,2NAre8sX2povnjy4aeiHKeEh97Qhn97tB1f
136136

137137
### Transactions by Block
138138
```
139-
/api/txs/?block=HASH
140-
/api/txs/?block=00000000fa6cf7367e50ad14eb0ca4737131f256fc4c5841fd3c3f140140e6b6
139+
/insight-api/txs/?block=HASH
140+
/insight-api/txs/?block=00000000fa6cf7367e50ad14eb0ca4737131f256fc4c5841fd3c3f140140e6b6
141141
```
142142
### Transactions by Address
143143
```
144-
/api/txs/?address=ADDR
145-
/api/txs/?address=mmhmMNfBiZZ37g1tgg2t8DDbNoEdqKVxAL
144+
/insight-api/txs/?address=ADDR
145+
/insight-api/txs/?address=mmhmMNfBiZZ37g1tgg2t8DDbNoEdqKVxAL
146146
```
147147

148148
### Transactions for Multiple Addresses
149149
GET method:
150150
```
151-
/api/addrs/[:addrs]/txs[?from=&to=]
152-
/api/addrs/2NF2baYuJAkCKo5onjUKEPdARQkZ6SYyKd5,2NAre8sX2povnjy4aeiHKeEh97Qhn97tB1f/txs?from=0&to=20
151+
/insight-api/addrs/[:addrs]/txs[?from=&to=]
152+
/insight-api/addrs/2NF2baYuJAkCKo5onjUKEPdARQkZ6SYyKd5,2NAre8sX2povnjy4aeiHKeEh97Qhn97tB1f/txs?from=0&to=20
153153
```
154154

155155
POST method:
156156
```
157-
/api/addrs/txs
157+
/insight-api/addrs/txs
158158
```
159159

160160
POST params:
@@ -197,7 +197,7 @@ Note: if pagination params are not specified, the result is an array of transact
197197
### Transaction Broadcasting
198198
POST method:
199199
```
200-
/api/tx/send
200+
/insight-api/tx/send
201201
```
202202
POST params:
203203
```
@@ -223,17 +223,17 @@ POST response:
223223

224224
### Historic Blockchain Data Sync Status
225225
```
226-
/api/sync
226+
/insight-api/sync
227227
```
228228

229229
### Live Network P2P Data Sync Status (Bitcoind runs in the same process)
230230
```
231-
/api/peer
231+
/insight-api/peer
232232
```
233233

234234
### Status of the Bitcoin Network
235235
```
236-
/api/status?q=xxx
236+
/insight-api/status?q=xxx
237237
```
238238

239239
Where "xxx" can be:
@@ -246,7 +246,7 @@ Where "xxx" can be:
246246

247247
### Utility Methods
248248
```
249-
/api/utils/estimatefee[?nbBlocks=2]
249+
/insight-api/utils/estimatefee[?nbBlocks=2]
250250
```
251251

252252

0 commit comments

Comments
 (0)