A HTMLCOIN blockchain REST and web socket API service for HTMLCOINCORE Node.
npm install htmlcoin-apiA HTMLCOIN blockchain REST and web socket API service for HTMLCOINCORE Node.
This is a backend-only service. If you're looking for the web frontend application, take a look at https://github.com/HTMLCOIN/htmlcoin-explorer.
``bashl`
npm install -g htmlcoincore-node@latest
htmlcoincore-node create mynode
cd mynode
htmlcoincore-node install htmlcoin-api
htmlcoincore-node start
The API endpoints will be available by default at: http://localhost:3001/htmlcoin-api/
Note: You can use an existing HTMLCOIN data directory, however txindex, addressindex, timestampindex and spentindex needs to be set to true in htmlcoin.conf, as well as a few other additional fields.
To protect the server, htmlcoin-api has a built it query rate limiter. It can be configurable in htmlcoincore-node.json with:` json`
"servicesConfig": {
"htmlcoin-api": {
"rateLimiterOptions": {
"whitelist": ["::ffff:127.0.0.1"]
}
}
}
Or disabled entirely with:
` json`
"servicesConfig": {
"htmlcoin-api": {
"disableRateLimiter": true
}
}
`
/htmlcoin-api/tokens/{:tokenAddressBase}/addresses/{:addressBase}/balance`
or
/htmlcoin-api/tokens/{:tokenAddressBase}/addresses/{:addressBase}/balance?format=object`
* Query Params
* Optional:
format=object
This would return:
`
1000000000000000000
`
{
"balance": "1000000000000000000"
}
/htmlcoin-api/tokens/{:tokenAddressBase}/total-supply
`
or
/htmlcoin-api/tokens/{:tokenAddressBase}/total-supply?format=object
`* Query Params
* Optional:
This would return:
"1000000000000000000"
or
{
"total_supply": "1000000000000000000"
}
$3
/htmlcoin-api/tokens/{:tokenAddressBase}/transactions
`* Query Params
* Optional:
> MAX_LIMIT === 100
Eg:
/htmlcoin-api/tokens/HNdW79juyJNJ89h99D9vfo5QhCZpmavJNX/transactions?limit=20&offset=1&from_block=34101&to_block=34378&from_date_time=2017-10-27T01:23:10.000Z&to_date_time=2018-10-27T01:24:10.000Z&addresses[]=HbmrFnBhyMKUhrabXfaAWZTncSWbJA8FsG&addresses[]=HarHW2HjV8Z3njxiTuvUZU3hmqahKNZ49y
`This would return:
{
"limit": 20,
"offset": 1,
"addresses": [
"HbmrFnBhyMKUhrabXfaAWZTncSWbJA8FsG",
"HarHW2HjV8Z3njxiTuvUZU3hmqahKNZ49y"
],
"from_block": 34101,
"to_block": 34378,
"from_date_time": "2017-10-27T01:23:10.000Z",
"to_date_time": "2018-10-27T01:24:10.000Z",
"count": 2,
"items": [
{
"contract_address_base": "HNdW79juyJNJ89h99D9vfo5QhCZpmavJNX",
"block_height": 34377,
"tx_hash": "e5c16ea5785fed909957100c3721a62f5f5dfe427af1c926ba11e64c3f905fab",
"from": "HNvEBPtXwezdJjkUUy2JF6pirGn1vtkaNt",
"to": "HarHW2HjV8Z3njxiTuvUZU3hmqahKNZ49y",
"value": "100000000000",
"block_date_time": "2017-10-27T12:28:48.000Z"
}
]
}
API HTTP Endpoints
$3
/htmlcoin-api/contracts/{:contractHash}/info
`
This would return:
{
address: "f8fe26582d6ce7f0233aee0477de5be606cca653",
balance: 0,
storage: {
03: "6f",
00: "5374616e64617264000000000000000000000000000000000000000000000010",
02: "5354440000000000000000000000000000000000000000000000000000000006",
03c2cc9c95da7ca004141242c8b36d98e928596f771044fd5552d3ee8b47438f: "2710",
04: "2710",
01: "5374616e64617264200000000000000000000000000000000000000000000012"
},
code: "606060405236156100b8576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff16806306fdde03146100ce578063095ea7b31461016757806318160ddd146101be57806323b872dd146101e4578063313ce5671461025a5780633867ed23146102865780635a3b7e421461029857806370a082311461033157806395d89b411461037b578063a9059cbb14610414578063cae9ca5114610453578063dd62ed3e146104ed575b34156100c057fe5b6100cc5b60006000fd5b565b005b34156100d657fe5b6100de610556565b604051808060200182810382528381815181526020019150805190602001908083836000831461012d575b80518252602083111561012d57602082019150602081019050602083039250610109565b505050905090810190601f1680156101595780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b341561016f57fe5b6101a4600480803573ffffffffffffffffffffffffffffffffffffffff169060200190919080359060200190919050506105f4565b604051808215151515815260200191505060405180910390f35b34156101c657fe5b6101ce610682565b6040518082815260200191505060405180910390f35b34156101ec57fe5b610240600480803573ffffffffffffffffffffffffffffffffffffffff1690602001909190803573ffffffffffffffffffffffffffffffffffffffff16906020019091908035906020019091905050610688565b604051808215151515815260200191505060405180910390f35b341561026257fe5b61026a610984565b604051808260ff1660ff16815260200191505060405180910390f35b341561028e57fe5b610296610997565b005b34156102a057fe5b6102a86109ab565b60405180806020018281038252838181518152602001915080519060200190808383600083146102f7575b8051825260208311156102f7576020820191506020810190506020830392506102d3565b505050905090810190601f1680156103235780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b341561033957fe5b610365600480803573ffffffffffffffffffffffffffffffffffffffff16906020019091905050610a49565b6040518082815260200191505060405180910390f35b341561038357fe5b61038b610a61565b60405180806020018281038252838181518152602001915080519060200190808383600083146103da575b8051825260208311156103da576020820191506020810190506020830392506103b6565b505050905090810190601f1680156104065780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b341561041c57fe5b610451600480803573ffffffffffffffffffffffffffffffffffffffff16906020019091908035906020019091905050610aff565b005b341561045b57fe5b6104d3600480803573ffffffffffffffffffffffffffffffffffffffff1690602001909190803590602001909190803590602001908201803590602001908080601f01602080910402602001604051908101604052809392919081815260200183838082843782019150505050505091905050610cde565b604051808215151515815260200191505060405180910390f35b34156104f557fe5b610540600480803573ffffffffffffffffffffffffffffffffffffffff1690602001909190803573ffffffffffffffffffffffffffffffffffffffff16906020019091905050610e65565b6040518082815260200191505060405180910390f35b60018054600181600116156101000203166002900480601f0160208091040260200160405190810160405280929190818152602001828054600181600116156101000203166002900480156105ec5780601f106105c1576101008083540402835291602001916105ec565b820191906000526020600020905b8154815290600101906020018083116105cf57829003601f168201915b505050505081565b600081600660003373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200190815260200160002060008573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200190815260200160002081905550600190505b92915050565b60045481565b600081600560008673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020016000205410156106d75760006000fd5b600560008473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020016000205482600560008673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff168152602001908152602001600020540110156107655760006000fd5b600660008573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200190815260200160002060003373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff168152602001908152602001600020548211156107ef5760006000fd5b81600560008673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020016000206000828254039250508190555081600560008573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020016000206000828254019250508190555081600660008673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200190815260200160002060003373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff168152602001908152602001600020600082825403925050819055508273ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef846040518082815260200191505060405180910390a3600190505b9392505050565b600360009054906101000a900460ff1681565b60646004600082825401925050819055505b565b60008054600181600116156101000203166002900480601f016020809104026020016040519081016040528092919081815260200182805460018160011615610100020316600290048015610a415780601f10610a1657610100808354040283529160200191610a41565b820191906000526020600020905b815481529060010190602001808311610a2457829003601f168201915b505050505081565b60056020528060005260406000206000915090505481565b60028054600181600116156101000203166002900480601f016020809104026020016040519081016040528092919081815260200182805460018160011615610100020316600290048015610af75780601f10610acc57610100808354040283529160200191610af7565b820191906000526020600020905b815481529060010190602001808311610ada57829003601f168201915b505050505081565b80600560003373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff168152602001908152602001600020541015610b4c5760006000fd5b600560008373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020016000205481600560008573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200190815260200160002054011015610bda5760006000fd5b80600560003373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020016000206000828254039250508190555080600560008473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff168152602001908152602001600020600082825401925050819055508173ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef836040518082815260200191505060405180910390a35b5050565b60006000849050610cef85856105f4565b15610e5c578073ffffffffffffffffffffffffffffffffffffffff16638f4ffcb1338630876040518563ffffffff167c0100000000000000000000000000000000000000000000000000000000028152600401808573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020018481526020018373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200180602001828103825283818151815260200191508051906020019080838360008314610df8575b805182526020831115610df857602082019150602081019050602083039250610dd4565b505050905090810190601f168015610e245780820380516001836020036101000a031916815260200191505b5095505050505050600060405180830381600087803b1515610e4257fe5b6102c65a03f11515610e5057fe5b50505060019150610e5d565b5b509392505050565b60066020528160005260406000206020528060005260406000206000915091505054815600a165627a7a72305820ad65da1f64921dfd4eebad40d0b4c8f4a800ccd86080446b7ea98cbc56f244f80029",
vins: [
{
hash: "2c329c6793f21b1655be8940bf46b0fae6af303e142b39d1c813796970321124",
vout: 0,
amount: 0
}
]
}
Statistics
$3
/htmlcoin-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,
stake: 0.17279912782774598
}
$3
/htmlcoin-api/statistics/transactions?days=14
`
This would return:
[
{
date: "2017-05-30",
transaction_count: 1087,
block_count: 541
},
...
]
$3
/htmlcoin-api/statistics/fees?days=14
`
This would return:
[
{
date: "2017-06-06",
fee: 500000000
},
...
]
$3
/htmlcoin-api/statistics/outputs?days=14
`
This would return:
[
{
date: "2017-06-06",
sum: 0
},
...
]
$3
/htmlcoin-api/statistics/difficulty?days=14
`
This would return:
[
{
date: "2017-06-06",
sum: 0
},
...
]
$3
/htmlcoin-api/statistics/stake?days=14
`
This would return:
[
{
date: "2017-06-06",
sum: 0
},
...
]
$3
/htmlcoin-api/circulating-supply
`
or
/htmlcoin-api/circulating-supply/?format=object
`
This would return:
88410384
or
{
"circulatingSupply": "88410384"
}
/htmlcoin-api/supply
`
or
/htmlcoin-api/supply?format=object
`
This would return:
100091264
or
{
"supply": "100091264"
}
$3
/htmlcoin-api/block/[:hash]
/htmlcoin-api/block/00000000a967199a2fad0877433c93df785a8d8ce062e5f9b451cd1397bdbf62
$3
Get block hash by height
/htmlcoin-api/block-index/[:height]
/htmlcoin-api/block-index/0
This would return:
{
"blockHash":"000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f"
}
which is the hash of the Genesis block (0 height)
$3
/htmlcoin-api/rawblock/[:blockHash]
/htmlcoin-api/rawblock/[:blockHeight]
This would return:
{
"rawblock":"blockhexstring..."
}
$3
Get block summaries by date:
/htmlcoin-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
}
}
$3
/htmlcoin-api/tx/[:txid]
/htmlcoin-api/tx/525de308971eabd941b139f46c7198b5af9479325c2395db7f2fb5ae8562556c
/htmlcoin-api/rawtx/[:rawid]
/htmlcoin-api/rawtx/525de308971eabd941b139f46c7198b5af9479325c2395db7f2fb5ae8562556c
$3
/htmlcoin-api/addr/[:addr][?noTxList=1][&from=&to=]
/htmlcoin-api/addr/mmvP3mTe53qxHdPqXEvdu8WdC7GfQ2vmx5?noTxList=1
/htmlcoin-api/addr/mmvP3mTe53qxHdPqXEvdu8WdC7GfQ2vmx5?from=1000&to=2000
$3
/htmlcoin-api/addr/[:addr]/balance
/htmlcoin-api/addr/[:addr]/totalReceived
/htmlcoin-api/addr/[:addr]/totalSent
/htmlcoin-api/addr/[:addr]/unconfirmedBalance
The response contains the value in Satoshis.$3
/htmlcoin-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
}
]
$3
GET method:
/htmlcoin-api/addrs/[:addrs]/utxo
/htmlcoin-api/addrs/2NF2baYuJAkCKo5onjUKEPdARQkZ6SYyKd5,2NAre8sX2povnjy4aeiHKeEh97Qhn97tB1f/utxo
POST method:
/htmlcoin-api/addrs/utxo
POST params:
addrs: 2NF2baYuJAkCKo5onjUKEPdARQkZ6SYyKd5,2NAre8sX2povnjy4aeiHKeEh97Qhn97tB1f
$3
/htmlcoin-api/txs/?block=HASH
/htmlcoin-api/txs/?block=00000000fa6cf7367e50ad14eb0ca4737131f256fc4c5841fd3c3f140140e6b6
$3
/htmlcoin-api/txs/?address=ADDR
/htmlcoin-api/txs/?address=mmhmMNfBiZZ37g1tgg2t8DDbNoEdqKVxAL
$3
/htmlcoin-api/txs/[:tx_id]/receipt
$3
GET method:
/htmlcoin-api/addrs/[:addrs]/txs[?from=&to=]
/htmlcoin-api/addrs/2NF2baYuJAkCKo5onjUKEPdARQkZ6SYyKd5,2NAre8sX2povnjy4aeiHKeEh97Qhn97tB1f/txs?from=0&to=20
POST method:
/htmlcoin-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.
$3
POST method:
/htmlcoin-api/tx/send
POST params:
rawtx: "signed transaction as hex string" eg
rawtx: 01000000017b1eabe0209b1fe794124575ef807057c77ada2138ae4fa8d6c4de0398a14f3f00000000494830450221008949f0cb400094ad2b5eb399d59d01c14d73d8fe6e96df1a7150deb388ab8935022079656090d7f6bac4c9a94e0aad311a4268e082a725f8aeae0573fb12ff866a5f01ffffffff01f0ca052a010000001976a914cbc20a7664f2f69e5355aa427045bc15e7c6c77288ac00000000
POST response:
{
txid: [:txid]
} eg
{
txid: "c7736a0a0046d5a8cc61c8c3c2821d4d7517f5de2bc66a966011aaa79965ffba"
}
$3
/htmlcoin-api/sync
$3
/htmlcoin-api/peer
$3
/htmlcoin-api/status?q=xxx
$3
/htmlcoin-api/dgpinfo
Where "xxx" can be:
* getInfo
* getDifficulty
* getBestBlockHash
* getLastBlockHash
$3
/htmlcoin-api/utils/estimatefee[?nbBlocks=2]
$3
/htmlcoin-api/utils/minestimatefee[?nbBlocks=2]
resp:
{
fee_per_kb: 0.00001
}
$3
/htmlcoin-api/erc20/:contractAddress
$3
/htmlcoin-api/erc20/:contractAddress/transfers
$3
/htmlcoin-api/erc20/:contractAddress/balances
$3
/htmlcoin-api/contracts/:contractaddress/hash/:contracthash/call
Web Socket API
The web socket API is served using socket.io.The following are the events published by insight:
: 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
...
}
: 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,
...
}
: every 1% increment on the sync task, this event will be triggered. This event is published in the sync room.Sample output:
`
{
blocksToSync: 164141,
syncedBlocks: 475,
upToExisting: true,
scanningBackward: true,
isEndGenesis: true,
end: "000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943",
isStartGenesis: false,
start: "000000009f929800556a8f3cfdbe57c187f2f679e351b12f7011bfc276c41b6d"
}
$3
The following html page connects to the socket.io insight API and listens for new transactions.
html
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.