1 of 11

Protocol Related Methods

hmy_isLastBlock

Is block epoch last block

Parameters

Number - block height

Returns

Bool - true if block epoch last block

Sample Curl Request

curl -d '{
    "jsonrpc":"2.0",
    "method":"hmy_isLastBlock",
    "params":["10"],
    "id":1
}' -H 'Content-Type:application/json' -X POST 'https://api.s0.b.hmny.io'

Sample Curl Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": true
}

hmy_epochLastBlock

Epoch last block

Parameters

Number - epoch

Returns

Number - epoch last block height

Sample Curl Request

Sample Curl Response

hmy_latestHeader

Parameters

None

Returns

blockHash - String - block hash
blockNumber - Number - block number
shardID - Number - shard id
leader - String - leader address
viewID - Number - current blockchain view of validators
epoch - Number - blockchain epoch
timestamp - Date - block generation timestamp date
unixtime - Number - block generation time in Unix time
lastCommitSig - String - BLS validators signature for the block
lastCommitBitmap - String - last commit bitmap for block signers

Sample Curl Request

curl --location --request POST 'https://api.s0.b.hmny.io/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "hmy_latestHeader",
    "params": [],
    "id": 1
}'

Same Curl Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "blockHash": "0x4d5acd18f95ed1527a530c6427b518c4cf469912bfcc6df830efc36879c25170",
        "blockNumber": 80455,
        "shardID": 0,
        "leader": "one1yc06ghr2p8xnl2380kpfayweguuhxdtupkhqzw",
        "viewID": 80452,
        "epoch": 178,
        "timestamp": "2020-01-30 20:08:32 +0000 UTC",
        "unixtime": 1580414912,
        "lastCommitSig": "7e8cf8c683bf6433fb7da19ff0597e3b2fc631bc350b5fe805401cb3133cc466b991a0b91a898abb5bfb566f5607fb18064be8916d4e1d8217ad3880b7b7b0f79fdac4cd9dd8e9f82c438fb4e2025aee75beaeeb19b96ae0f63f6f9d63475289",
        "lastCommitBitmap": "ff03"
    }
}

hmy_getShardingStructure

GetShardingStructure

Returns the current shard of the node and lists API and WebSocket endpoints for each shard.

Returns

current - bool - If the current node is on this shard.
http - String - API endpoint for the shard.
shardID - Integer - Shard ID.
ws - String - WebSocket endpoint

Sample Curl Request

curl -d '{
    "jsonrpc": "2.0",
    "method": "hmy_getShardingStructure",
    "params": [],
    "id": 1
}' -H "Content-Type:application/json" -X POST "https://api.s0.b.hmny.io"

Sample Curl Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": [
        {
            "current": true,
            "http": "https://api.s0.b.hmny.io",
            "shardID": 0,
            "ws": "wss://ws.s0.b.hmny.io"
        },
        {
            "current": false,
            "http": "https://api.s1.b.hmny.io",
            "shardID": 1,
            "ws": "wss://ws.s1.b.hmny.io"
        }
    ]
}

hmy_blockNumber

BlockNumber

Get number of the most recent block.

API v1

Returns

String - Index of the most recent block in the chain.

Sample Curl Request

Sample Curl Response

API v2

Returns

uint64 - Index of the most recent block in the chain.

Sample Curl Request

Sample Curl Response

hmy_syncing

Syncing

Tests whether or not the node is syncing.

Returns

Object - Whether or not the node is syncing. false when it isn't.

Sample Curl Request

curl -d '{
    "jsonrpc":"2.0",
    "method":"hmy_syncing",
    "params":[],
    "id":1
}' -H 'Content-Type:application/json' -X POST 'https://api.s0.b.hmny.io'

Sample Curl Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": false
}

hmy_gasPrice

GasPrice

Returns the current gas price.

API v1

Returns

String - Number string of the current gas price.

Sample Curl Request

curl -d '{
  "jsonrpc":"2.0",
  "method":"hmy_gasPrice",
  "params":[],
  "id":1
}' -H 'Content-Type:application/json' -X POST 'https://api.s0.b.hmny.io'

Sample Curl Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "0x1"
}

API v2

Returns

String - Decimal big.Int string of the current gas price.

Sample Curl Request

curl -d '{
  "jsonrpc":"2.0",
  "method":"hmyv2_gasPrice",
  "params":[],
  "id":1
}' -H 'Content-Type:application/json' localhost:9500

Sample Curl Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "1"
}

net_peerCount

Net_PeerCount

Gets the number of peers on the network.

Sample Curl Request

curl -d '{
    "jsonrpc":"2.0",
    "method":"net_peerCount",
    "params":[],
    "id":1
}' -H 'Content-Type:application/json' -X POST 'https://api.s0.b.hmny.io'

Sample Curl Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "0xbf"
}

hmy_getEpoch

Description

hmy_getEpoch returns current epoch of shard

Parameters

API v1

Returns

String - Current requested node shard epoch 0x format

Sample Curl Request

Sample Curl Response

API v2

Returns

uint64 - Current requested node shard epoch decimal format

Sample Curl Request

Sample Curl Response

If Node.js is installed on your system, one easy way to convert hexadecimal balances into a more readable decimal format is to run node -e "console.log(<balance>)"

hmy_getLeader

Description

hmy_getLeader returns one address of current shard leader node

Returns

String - returns one address of current shard leader node

Sample Curl Request

Sample Curl Response

hmy_latestHeader

Parameters

None

Returns

blockHash - String - block hash
blockNumber - Number - block number
shardID - Number - shard id
leader - String - leader address
viewID - Number - current blockchain view of validators
epoch - Number - blockchain epoch
timestamp - Date - block generation timestamp date
unixtime - Number - block generation time in Unix time
lastCommitSig - String - BLS validators signature for the block
lastCommitBitmap - String - last commit bitmap for block signers

Sample Curl Request

curl --location --request POST 'https://api.s0.b.hmny.io/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "hmy_latestHeader",
    "params": [],
    "id": 1
}'

Same Curl Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "blockHash": "0x4d5acd18f95ed1527a530c6427b518c4cf469912bfcc6df830efc36879c25170",
        "blockNumber": 80455,
        "shardID": 0,
        "leader": "one1yc06ghr2p8xnl2380kpfayweguuhxdtupkhqzw",
        "viewID": 80452,
        "epoch": 178,
        "timestamp": "2020-01-30 20:08:32 +0000 UTC",
        "unixtime": 1580414912,
        "lastCommitSig": "7e8cf8c683bf6433fb7da19ff0597e3b2fc631bc350b5fe805401cb3133cc466b991a0b91a898abb5bfb566f5607fb18064be8916d4e1d8217ad3880b7b7b0f79fdac4cd9dd8e9f82c438fb4e2025aee75beaeeb19b96ae0f63f6f9d63475289",
        "lastCommitBitmap": "ff03"
    }
}