Insight API
Table of Contents
Statistics
A Flux blockchain REST and web socket API service for bitcore Node.
This is a backend-only service. If you're looking for the web frontend application, take a look at https://github.com/runonflux/insight-ui.
The API endpoints will be available by default at: http://localhost:3001/insight-api/
Prerequisites
Note: You can use an existing Flux data directory, however txindex
, addressindex
, timestampindex
and spentindex
needs to be set to true in flux.conf
, as well as a few other additional fields.
Query Rate Limit
To protect the server, insight-api has a built it query rate limiter. It can be configurable in bitcore-node.json
with:
"servicesConfig": {
"insight-api": {
"rateLimiterOptions": {
"whitelist": ["::ffff:127.0.0.1"]
}
}
}
With all the configuration options available: https://github.com/runonflux/insight-api/blob/master/lib/ratelimiter.js#L10-17
Or disabled entirely with:
"servicesConfig": {
"insight-api": {
"disableRateLimiter": true
}
}
Note: routePrefix
can be configurable in bitcore-node.json
with:
"servicesConfig": {
"insight-api": {
"routePrefix": "insight-api",
}
}
API HTTP Endpoints
Statistics
Total 24h Statistic
`GET` /insight-api/statistics/total
This would return:
{
n_blocks_mined: 1268,
time_between_blocks: 86301,
mined_currency_amount: 1268000000000000,
transaction_fees: 633992859997,
number_of_transactions: 2547,
outputs_volume: 46920965480,
difficulty: 981808167.7687966,
}
Transactions Statistic
`GET` /insight-api/statistics/transactions?days=14
This would return:
[
{
date: "2017-05-30",
transaction_count: 1087,
block_count: 541
},
...
]
Fees Statistic
`GET` /insight-api/statistics/fees?days=14
This would return:
[
{
date: "2017-06-06",
fee: 500000000
},
...
]
Outputs Statistic
`GET` /insight-api/statistics/outputs?days=14
This would return:
[
{
date: "2017-06-06",
sum: 0
},
...
]
Difficulty Statistic
`GET` /insight-api/statistics/difficulty?days=14
This would return:
[
{
date: "2017-06-06",
sum: 0
},
...
]
Pools Statistic
`GET` /insight-api/statistics/pools?date=2018-05-14
This would return:
[
{
date: "2018-05-14",
...
}
]
Nethash Statistic
`GET` /insight-api/statistics/network-hash?days=14
This would return:
[
{
date: "2017-06-06",
sum: 0
},
...
]
Total Supply Statistic
`GET` /insight-api/supply
or
`GET` /insight-api/supply?format=object
This would return:
100091264
or
{
"supply": "100091264"
}
Block
/insight-api/block/[:hash]
/insight-api/block/00000000a967199a2fad0877433c93df785a8d8ce062e5f9b451cd1397bdbf62
Block Index
Get block hash by height
/insight-api/block-index/[:height]
/insight-api/block-index/0
This would return:
{
"blockHash":"000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f"
}
which is the hash of the Genesis block (0 height)
Raw Block
/insight-api/rawblock/[:blockHash]
/insight-api/rawblock/[:blockHeight]
This would return:
{
"rawblock":"blockhexstring..."
}
Block Summaries
Get block summaries by date:
/insight-api/blocks?limit=3&blockDate=2016-04-22
Example response:
{
"blocks": [
{
"height": 408495,
"size": 989237,
"hash": "00000000000000000108a1f4d4db839702d72f16561b1154600a26c453ecb378",
"time": 1461360083,
"txlength": 1695,
"poolInfo": {
"poolName": "BTCC Pool",
"url": "https://pool.btcc.com/"
}
}
],
"length": 1,
"pagination": {
"next": "2016-04-23",
"prev": "2016-04-21",
"currentTs": 1461369599,
"current": "2016-04-22",
"isToday": true,
"more": true,
"moreTs": 1461369600
}
}
Transaction
/insight-api/tx/[:txid]
/insight-api/tx/525de308971eabd941b139f46c7198b5af9479325c2395db7f2fb5ae8562556c
/insight-api/rawtx/[:rawid]
/insight-api/rawtx/525de308971eabd941b139f46c7198b5af9479325c2395db7f2fb5ae8562556c
Address
/insight-api/addr/[:addr][?noTxList=1][&from=&to=]
/insight-api/addr/mmvP3mTe53qxHdPqXEvdu8WdC7GfQ2vmx5?noTxList=1
/insight-api/addr/mmvP3mTe53qxHdPqXEvdu8WdC7GfQ2vmx5?from=1000&to=2000
Address Properties
/insight-api/addr/[:addr]/balance
/insight-api/addr/[:addr]/totalReceived
/insight-api/addr/[:addr]/totalSent
/insight-api/addr/[:addr]/unconfirmedBalance
The response contains the value in Satoshis.
Unspent Outputs
/insight-api/addr/[:addr]/utxo
Sample return:
[
{
"address":"mo9ncXisMeAoXwqcV5EWuyncbmCcQN4rVs",
"txid":"d5f8a96faccf79d4c087fa217627bb1120e83f8ea1a7d84b1de4277ead9bbac1",
"vout":0,
"scriptPubKey":"76a91453c0307d6851aa0ce7825ba883c6bd9ad242b48688ac",
"amount":0.000006,
"satoshis":600,
"confirmations":0,
"ts":1461349425
},
{
"address": "mo9ncXisMeAoXwqcV5EWuyncbmCcQN4rVs",
"txid": "bc9df3b92120feaee4edc80963d8ed59d6a78ea0defef3ec3cb374f2015bfc6e",
"vout": 1,
"scriptPubKey": "76a91453c0307d6851aa0ce7825ba883c6bd9ad242b48688ac",
"amount": 0.12345678,
"satoshis: 12345678,
"confirmations": 1,
"height": 300001
}
]
Unspent Outputs for Multiple Addresses
GET method:
/insight-api/addrs/[:addrs]/utxo
/insight-api/addrs/2NF2baYuJAkCKo5onjUKEPdARQkZ6SYyKd5,2NAre8sX2povnjy4aeiHKeEh97Qhn97tB1f/utxo
POST method:
/insight-api/addrs/utxo
POST params:
addrs: 2NF2baYuJAkCKo5onjUKEPdARQkZ6SYyKd5,2NAre8sX2povnjy4aeiHKeEh97Qhn97tB1f
Transactions by Block
/insight-api/txs/?block=HASH
/insight-api/txs/?block=00000000fa6cf7367e50ad14eb0ca4737131f256fc4c5841fd3c3f140140e6b6
Transactions by Address
/insight-api/txs/?address=ADDR
/insight-api/txs/?address=mmhmMNfBiZZ37g1tgg2t8DDbNoEdqKVxAL
Transactions for Multiple Addresses
GET method:
/insight-api/addrs/[:addrs]/txs[?from=&to=]
/insight-api/addrs/2NF2baYuJAkCKo5onjUKEPdARQkZ6SYyKd5,2NAre8sX2povnjy4aeiHKeEh97Qhn97tB1f/txs?from=0&to=20
POST method:
/insight-api/addrs/txs
POST params:
addrs: 2NF2baYuJAkCKo5onjUKEPdARQkZ6SYyKd5,2NAre8sX2povnjy4aeiHKeEh97Qhn97tB1f
from (optional): 0
to (optional): 20
noAsm (optional): 1 (will omit script asm from results)
noScriptSig (optional): 1 (will omit the scriptSig from all inputs)
noSpent (option): 1 (will omit spent information per output)
Sample output:
{ totalItems: 100,
from: 0,
to: 20,
items:
[ { txid: '3e81723d069b12983b2ef694c9782d32fca26cc978de744acbc32c3d3496e915',
version: 1,
locktime: 0,
vin: [Object],
vout: [Object],
blockhash: '00000000011a135e5277f5493c52c66829792392632b8b65429cf07ad3c47a6c',
confirmations: 109367,
time: 1393659685,
blocktime: 1393659685,
valueOut: 0.3453,
size: 225,
firstSeenTs: undefined,
valueIn: 0.3454,
fees: 0.0001 },
{ ... },
{ ... },
...
{ ... }
]
}
Note: if pagination params are not specified, the result is an array of transactions.
Transaction Broadcasting
POST method:
/insight-api/tx/send
POST params:
rawtx: "signed transaction as hex string"
eg
rawtx: 01000000017b1eabe0209b1fe794124575ef807057c77ada2138ae4fa8d6c4de0398a14f3f00000000494830450221008949f0cb400094ad2b5eb399d59d01c14d73d8fe6e96df1a7150deb388ab8935022079656090d7f6bac4c9a94e0aad311a4268e082a725f8aeae0573fb12ff866a5f01ffffffff01f0ca052a010000001976a914cbc20a7664f2f69e5355aa427045bc15e7c6c77288ac00000000
POST response:
{
txid: [:txid]
}
eg
{
txid: "c7736a0a0046d5a8cc61c8c3c2821d4d7517f5de2bc66a966011aaa79965ffba"
}
Historic Blockchain Data Sync Status
/insight-api/sync
Live Network P2P Data Sync Status
/insight-api/peer
Status of the Flux Network
/insight-api/status?q=xxx
Where "xxx" can be:
- getInfo
- getDifficulty
- getBestBlockHash
- getLastBlockHash
- getMiningInfo
- getPeerInfo
- getFluxNodes
Utility Methods
/insight-api/utils/estimatefee[?nbBlocks=6]
Sample output:
{
"6":0.00001047
}
Web Socket API
The web socket API is served using socket.io.
inv
room:
The following are the events published by insight in the inv
room:
tx
: new transaction received from network. This event is published in the 'inv' room. Data will be a app/models/Transaction object.
Sample output:
{
"txid":"00c1b1acb310b87085c7deaaeba478cef5dc9519fab87a4d943ecbb39bd5b053",
"processed":false
...
}
block
: new block received from network. This event is published in the inv
room. Data will be a app/models/Block object.
Sample output:
{
"hash":"000000004a3d187c430cd6a5e988aca3b19e1f1d1727a50dead6c8ac26899b96",
"time":1389789343,
...
}
info
: General Statistics Info
Sample output:
{
info:
{
balance: 0
blocks: 245823
connections: 123
difficulty: 18231.18159436285
errors: ""
keypoololdest: 1528311725
keypoolsize: 2000
network: "livenet"
paytxfee: 0
protocolversion: 70015
proxy: ""
relayfee: 0.00001
reward: 500000000000
testnet: false
timeoffset: 0
version: 152000
walletversion: 10000
}
miningInfo:
{
blocks: 245823
difficulty: 18231.18159436285
networkhashps: 1311616809584.154
chain: "main"
}
supply: "1229115000"
markets_info
: General Price and Market data
Sample output:
{
24h_volume_usd: "280378.0"
available_supply: "1223775205.0"
market_cap_usd: "36072365.0"
percent_change_24h: "-0.25"
price_btc: "0.00000383"
price: "0.0294763"
}
flux
room:
flux/tx
: Returns a transformed tx as a json element detailing the transaction
Sample output:
{
txid: "4aef2faba5add0a467b4bc636024c7ed2501215a171df7cb7ed7376fe6bfeeca"
valueOut: 5000
vin:(0)
[]
length: 0
vout: (1)
[
{
value: 500000000000
address: "RKbh4QopviguAWveJgjmoFKNMxewRFyvAb"
}
]
isRBF: true
}
flux/block
: Returns a transformed block as a json element detailing the block
Sample output:
{
block:
{
bits: "1b03983c"
chainwork: "000000000000000000000000000000000000000000000000a28c9a9e0fbcac74"
confirmations: 1
difficulty: 18231.18159436
hash: "0000000000031522362b3b0d4579ed4bbee206fb7397383e835134ee1c394c2d"
height: 245845
isMainChain: true
merkleroot: "7e036837f82cb526cc44db73504ab9c051c6f37eeb7e64aa543757b4405b0d1b"
minedBy: "RVG96MbaKEDFzzj9NzbAuxkDt86KAm2Qj5"
nonce: 1578377516
poolInfo: {poolName: "f2pool", url: "http://f2pool.com/"}
previousblockhash: "0000000000037953f3d835fb94e168520b2a7edbb1268ef987048dfa916cd25f"
reward: 5000
size: 26990
time: 1528388943
tx:(7)
[
"ea4f02a17146117e5961cfe01e7e00067f59b2167d17a415717fadb8a823456e"
"d9ec249e1a2297610b5af03238f2de34bd1ba739188fd1ea33c464fe77a07ce1"
"062c951f32f60937c58f009e5c7eaf19db93148e9b677651fe83f6ebfded195e"
"4d7853c1aa1c9b7722ab7ec34bf053a4661eb82f68075603f69006ece4f21f1c"
"63b0219ee6d3204dc604660d2aa6eed6fd05dea912777e14322a3ed56886a102"
"c5e302e3d9b7be5dfab1a219052fb8424071407e978cb57e1a9a0986e9c7f96d"
"01ee0c906791f9c3e613a4c4b8d87c45b50b9e12058dd69ce5a647e028710b6d"
]
version: 536870912
}
transactions: (7)
[
{
blockhash: "0000000000031522362b3b0d4579ed4bbee206fb7397383e835134ee1c394c2d"
blockheight: 245845
blocktime: 1528388943
confirmations: 1
isCoinBase: true
locktime: 703249321
size: 250
time: 1528388943
txid: "ea4f02a17146117e5961cfe01e7e00067f59b2167d17a415717fadb8a823456e"
valueOut:5000.0003294
version:1
vin: (1)
[
{
coinbase: "0355c0032cfabe6d6d0000000000000000000000000000...0000000000000000000"
n: 0
sequence: 3
}
]
vout: (2)
[
{
n: 0
scriptPubKey:
{
hex: "76a914db2f9b86eb5eae8dae8dfb1da75440584be36daa88ac"
asm: "OP_DUP OP_HASH160 db2f9b86eb5eae8dae8dfb1da75440584be36daa OP_EQUALVERIFY OP_CHECKSIG"
addresses: (1)
[
"RVG96MbaKEDFzzj9NzbAuxkDt86KAm2Qj5"
]
type: "pubkeyhash"
}
spentHeight: null
spentIndex: null
spentTxId: null
value: "5000.00032940"
}
...
]
}
...
]
}
Example Usage
The following html page connects to the socket.io insight API and listens for new transactions.
html
<html>
<body>
<script src="http://<insight-server>:<port>/socket.io/socket.io.js"></script>
<script>
eventToListenTo = 'tx'
room = 'inv'
var socket = io("http://<insight-server>:<port>/");
socket.on('connect', function() {
// Join the room.
socket.emit('subscribe', room);
})
socket.on(eventToListenTo, function(data) {
console.log("New transaction received: " + data.txid)
})
</script>
</body>
</html>
License
(The MIT License)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.