1 of 74

API

Please note that right now we have two API versions v1 and v2, see the description below

Complete documentation for Harmony's API's production API's can be found including sample code and curl commands and code.

Development Environments

is a remote procedure call protocol encoded in JSON. You can use this API to access data from the Harmony nodes. The JSON-RPC API server runs on:

Chains

URLs

Web sockets can also be used

Chains

URLs

All requests follow the standard JSON-RPC format and include 4 variables in the data object:

Key Differences between Harmony and Ethereum

The prefix of RPC calls is different - 'hmy' for API v1 or 'hmyv2' for API v2 is used instead of 'eth'. Note that, Harmony also fully supports most eth_ rpcs defined in .
Address format: Harmony uses address format with one1 prefix, however Ethereum style hex address can also be used. For example: one1pdv9lrdwl0rg5vglh4xtyrv3wjk3wsqket7zxy bech32 address is equivalent to 0x0B585F8DaEfBC68a311FbD4cB20d9174aD174016 hex address. Quick way to convert between formats is using explorer: , at the top you will find "Address Format" ONE | ETH options.
Harmony transactions are encoded using RLP, with two additional fields to represent from and to shard ids (shardID and toShardID), which is where it differs from Ethereum v1.

API v1 and v2

Harmony API has two versions: v1 with prefix 'hmy', which returns hex numbers in API json response and v2 with prefix 'hmyv2' which mostly returns decimal numbers in API json response.
For each method which curl and response are different for API v1 and API v2: there are two sections in description for API v1 and API v2 with examples. If there are no sections then examples are the same for v1 and v2 and can be quired both with 'hmy' prefix and 'hmyv2' prefix same way.
You can see in API response examples which variables correspond to 0x format and which to decimal format

Methods

Account Methods

hmy_getBalanceByBlockNumber

Get the balance of an address at a given block.

API v1

Parameters

String - The address to get the balance of
String - Block to get query for balance

Returns

String - The current balance for the given address in ATTO.

Sample Curl Request

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

Sample Curl Response

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

API v2

Parameters

String - The address to get the balance of
Number - Block to get query for balance

Returns

String - The big.Int balance for the given address on a particular block.

Sample Curl Request

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

Sample Curl Response

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

hmy_getTransactionCount

GetTransactionCount

Given an account address, returns the number of transactions the account has made.

API v1

Parameters

String - Account address
String - Block number to query for transaction count. Usually latest, which uses the most recent block.

Returns

String - Number of transactions the account has made.

Sample Curl Request

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

Sample Curl Response

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

API v2

Parameters

String - Account address
Number - Block number to query for transaction count.

Returns

Number - Number of transactions the account has made.

Sample Curl Request

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

Sample Curl Response

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

hmy_getBalance

GetBalance

Get latest balance of an address.

API v1

Parameters

String - The address to get the balance of.
String - Block to get query for balance

Returns

String - The current balance for the given address in ATTO.

Sample Curl Request

Sample Curl Response

API v2

Parameters

String - The address to get the balance of

Returns

String - The current big.Int balance for the given address.

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> / 1e18)"

Filter Methods

hmy_getFilterLogs

Returns an array of all logs matching filter with given id.

Parameters

QUANTITY - The filter id.

Example Parameters

Returns

See hmy_getFilterChanges

Example

Result see hmy_getFilterChanges

hmy_newFilter

Creates a filter object, based on filter options, to notify when the state changes (logs). To check if the state has changed, call hmy_getFilterChanges

A note on specifying topic filters:

Topics are order-dependent. A transaction with a log with topics [A, B] will be matched by the following topic filters:

[] "anything"
[A] "A in first position (and anything after)"
[null, B] "anything in first position AND B in second position (and anything after)"
[A, B] "A in first position AND B in second position (and anything after)"
[[A, B], [A, B]] "(A OR B) in first position AND (A OR B) in second position (and anything after)"

Parameters

Object - The filter options:
fromBlock: QUANTITY|TAG - (optional, default: "latest") Integer block number, or "latest" for the last mined block or "pending", "earliest" for not yet mined transactions.
toBlock: QUANTITY|TAG - (optional, default: "latest") Integer block number, or "latest" for the last mined block or "pending", "earliest" for not yet mined transactions.
address: DATA|Array, 20 Bytes - (optional) Contract address or a list of addresses from which logs should originate.
topics: Array of DATA, - (optional) Array of 32 Bytes DATA topics. Topics are order-dependent. Each topic can also be an array of DATA with "or" options.

Example Parameters

Returns

QUANTITY - A filter id.

Example

hmy_newPendingTransactionFilter

Parameters

None

Returns

QUANTITY - A filter id.

Example

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

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

hmy_newBlockFilter

Parameters

None

Returns

QUANTITY - A filter id.

Example

hmy_getFilterChanges

Parameters

QUANTITY - the filter id.

Returns

Array - Array of log objects, or an empty array if nothing has changed since last poll.

For filters created with eth_newBlockFilter the return are block hashes (DATA, 32 Bytes), e.g. ["0x3454645634534..."].
For filters created with eth_newPendingTransactionFilter the return are transaction hashes (DATA, 32 Bytes), e.g. ["0x6345343454645..."].
For filters created with eth_newFilter logs are objects with following params:
- removed: TAG - true when the log was removed, due to a chain reorganization. false if its a valid log.
- logIndex: QUANTITY - integer of the log index position in the block. null when its pending log.
- transactionIndex: QUANTITY - integer of the transactions index position log was created from. null when its pending log.
- transactionHash: DATA, 32 Bytes - hash of the transactions this log was created from. null when its pending log.
- blockHash: DATA, 32 Bytes - hash of the block where this log was in. null when its pending. null when its pending log.
- blockNumber: QUANTITY - the block number where this log was in. null when its pending. null when its pending log.
- address: DATA, 20 Bytes - address from which this log originated.
- data: DATA - contains the non-indexed arguments of the log.
- topics: Array of DATA - Array of 0 to 4 32 Bytes DATA of indexed log arguments. (In solidity: The first topic is the hash of the signature of the event (e.g. Deposit(address,bytes32,uint256)), except you declared the event with the anonymous specifier.)

Sample Curl Request

Sample Curl Response

hmy_getLogs

Get harmony logs for smart contracts or transactions

Parameters

Object - The filter options:
fromBlock: QUANTITY|TAG - (optional, default: "latest") Integer block number, or "latest" for the last mined block or "pending", "earliest" for not yet mined transactions.
toBlock: QUANTITY|TAG - (optional, default: "latest") Integer block number, or "latest" for the last mined block or "pending", "earliest" for not yet mined transactions.
address: DATA|Array, 20 Bytes - (optional) Contract address or a list of addresses from which logs should originate.
topics: Array of DATA, - (optional) Array of 32 Bytes DATA topics. Topics are order-dependent. Each topic can also be an array of DATA with "or" options.
blockhash: DATA, 32 Bytes - (optional) , blockHash is a new filter option which restricts the logs returned to the single block with the 32-byte hash blockHash. Using blockHash is equivalent to fromBlock = toBlock = the block number with hash blockHash. If blockHash is present in the filter criteria, then neither fromBlock nor toBlock are allowed.

Returns

For filters created with hmy_newBlockFilter the return are block hashes (DATA, 32 Bytes), e.g. ["0x3454645634534..."].

For filters created with hmy_newPendingTransactionFilter the return are transaction hashes (DATA, 32 Bytes), e.g. ["0x6345343454645..."].

For filters created with hmy_newFilter logs are objects with following params:

removed: TAG - true when the log was removed, due to a chain reorganization. false if its a valid log.
logIndex: QUANTITY - integer of the log index position in the block. null when its pending log.
transactionIndex: QUANTITY - integer of the transactions index position log was created from. null when its pending log.
transactionHash: DATA, 32 Bytes - hash of the transactions this log was created from. null when its pending log.
blockHash: DATA, 32 Bytes - hash of the block where this log was in. null when its pending. null when its pending log.
blockNumber: QUANTITY - the block number where this log was in. null when its pending. null when its pending log.
address: DATA, 20 Bytes - address from which this log originated.
data: DATA - contains the non-indexed arguments of the log.
topics: Array of DATA - Array of 0 to 4 32 Bytes DATA of indexed log arguments. (In solidity: The first topic is the hash of the signature of the event (e.g. Deposit(address,bytes32,uint256)), except you declared the event with the anonymous specifier.)

Sample Curl Request

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

Sample Curl Response

{
  "id":1,
  "jsonrpc":"2.0",
  "result": [{
    "logIndex": "0x1", // 1
    "blockNumber":"0x1b4", // 436
    "blockHash": "0x8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcfdf829c5a142f1fccd7d",
    "transactionHash":  "0xdf829c5a142f1fccd7d8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcf",
    "transactionIndex": "0x0", // 0
    "address": "0x16c5785ac562ff41e2dcfdf829c5a142f1fccd7d",
    "data":"0x0000000000000000000000000000000000000000000000000000000000000000",
    "topics": ["0x59ebeb90bc63057b6515673c3ecf9438e5058bca0f92585014eced636878c9a5"]
    },{
      ...
    }]
}

Transaction Related Methods

hmy_getStakingTransactionByBlockHashAndIndex

Get staking transaction at an index from a given block, specified by block hash.

API v1

Parameters

String - The block hash.
Number - The staking transaction index position.

Returns

hash - String: Hash of the transaction.
nonce - Number: The number of transactions made by the sender prior to this one.
blockHash - String: Hash of the block where this transaction was in. null when its pending.
blockNumber - Number: Block number where this transaction was in. null when its pending.
transactionIndex - Number: Integer of the transactions index position in the block. null when its pending.
timestamp - Number: transaction timestamp
from - String: Address of the sender.
value - String: Value transferred in ATTO.
gasPrice - String: Gas price provided by the sender.
gas - Number: Gas provided by the sender.
v - String: signature V
r - String: signature R
s - String: signature S
type - String: staking transaction type ("CreateValidator", "EditValidator", "CollectRewards", "Undelegate", "Delegate")
msg - StakingMsg:
- CreateValidator:
  - validatorAddress - String: validator address
  - name - String: validator name
  - commissionRate - Number: validator commission rate
  - maxCommissionRate - Number: validator commission rate
  - maxChangeRate - Number: validator max commission rate change
  - minSelfDelegation - Number: min how much validator self delegates
  - maxTotalDelegation - Number: max total delegation to validator
  - amount - Number: stake amount for validator
  - website - String: validator website
  - identity - String: validator kyc identity
  - securityContact - String: validator security contact
  - details - String: additional validator info
  - slotPubKeys - []String: validator bls pub keys
- EditValidator:
  - validatorAddress - String: validator address
  - name - String: validator name
  - commissionRate - Number: validator commission rate
  - minSelfDelegation - Number: min how much validator self delegates
  - maxTotalDelegation - Number: max total delegation to validator
  - website - String: validator website
  - identity - String: validator kyc identity
  - securityContact - String: validator security contact
  - details - String: additional validator info
  - slotPubKeyToAdd - String: validator bls pub key to add
  - slotPubKeyToRemove - String: validator bls pub key to remove
- CollectRewards:
  - delegatorAddress - String: address to send rewards
- Delegate:
  - delegatorAddress - String: delegation delegator address
  - validatorAddress - String: delegation validator address
  - amount - Number: big.Int amount for delegation to validator
- Undelegate:
  - delegatorAddress - String: undelegation delegator address
  - validatorAddress - String: undelegation validator address
  - amount - Number: big.Int amount for undelegation to delegator

Sample Curl Request

Sample Curl Response

API v2

Parameters

String - The block hash.
Number - The staking transaction index position.

Returns

hash - String: Hash of the transaction.
nonce - Number: The number of transactions made by the sender prior to this one.
blockHash - String: Hash of the block where this transaction was in. null when its pending.
blockNumber - Number: Block number where this transaction was in. null when its pending.
transactionIndex - Number: Integer of the transactions index position in the block. null when its pending.
timestamp - Number: transaction timestamp
from - String: Address of the sender.
value - String: Value transferred in ATTO.
gasPrice - String: Gas price provided by the sender.
gas - Number: Gas provided by the sender.
v - String: signature V
r - String: signature R
s - String: signature S
type - String: staking transaction type ("CreateValidator", "EditValidator", "CollectRewards", "Undelegate", "Delegate")
msg - StakingMsg:
- CreateValidator:
  - validatorAddress - String: validator address
  - name - String: validator name
  - commissionRate - Number: validator commission rate
  - maxCommissionRate - Number: validator commission rate
  - maxChangeRate - Number: validator max commission rate change
  - minSelfDelegation - Number: min how much validator self delegates
  - maxTotalDelegation - Number: max total delegation to validator
  - amount - Number: stake amount for validator
  - website - String: validator website
  - identity - String: validator kyc identity
  - securityContact - String: validator security contact
  - details - String: additional validator info
  - slotPubKeys - []String: validator bls pub keys
- EditValidator:
  - validatorAddress - String: validator address
  - name - String: validator name
  - commissionRate - Number: validator commission rate
  - minSelfDelegation - Number: min how much validator self delegates
  - maxTotalDelegation - Number: max total delegation to validator
  - website - String: validator website
  - identity - String: validator kyc identity
  - securityContact - String: validator security contact
  - details - String: additional validator info
  - slotPubKeyToAdd - String: validator bls pub key to add
  - slotPubKeyToRemove - String: validator bls pub key to remove
- CollectRewards:
  - delegatorAddress - String: address to send rewards
- Delegate:
  - delegatorAddress - String: delegation delegator address
  - validatorAddress - String: delegation validator address
  - amount - Number: big.Int amount for delegation to validator
- Undelegate:
  - delegatorAddress - String: undelegation delegator address
  - validatorAddress - String: undelegation validator address
  - amount - Number: big.Int amount for undelegation to delegator

Sample Curl Request

Sample Curl Response

hmy_getStakingTransactionByBlockNumberAndIndex

Get staking transaction at an index from a given block, specified by number.

API v1

Parameters

String - The block's index in the chain.
String - The staking transactions index position.

Returns

hash - String: Hash of the transaction.
nonce - Number: The number of transactions made by the sender prior to this one.
blockHash - String: Hash of the block where this transaction was in. null when its pending.
blockNumber - Number: Block number where this transaction was in. null when its pending.
transactionIndex - Number: Integer of the transactions index position in the block. null when its pending.
timestamp - Number: transaction timestamp
from - String: Address of the sender.
value - String: Value transferred in ATTO.
gasPrice - String: Gas price provided by the sender.
gas - Number: Gas provided by the sender.
v - String: signature V
r - String: signature R
s - String: signature S
type - String: staking transaction type ("CreateValidator", "EditValidator", "CollectRewards", "Undelegate", "Delegate")
msg - StakingMsg:
- CreateValidator:
  - validatorAddress - String: validator address
  - name - String: validator name
  - commissionRate - Number: validator commission rate
  - maxCommissionRate - Number: validator commission rate
  - maxChangeRate - Number: validator max commission rate change
  - minSelfDelegation - Number: min how much validator self delegates
  - maxTotalDelegation - Number: max total delegation to validator
  - amount - Number: stake amount for validator
  - website - String: validator website
  - identity - String: validator kyc identity
  - securityContact - String: validator security contact
  - details - String: additional validator info
  - slotPubKeys - []String: validator bls pub keys
- EditValidator:
  - validatorAddress - String: validator address
  - name - String: validator name
  - commissionRate - Number: validator commission rate
  - minSelfDelegation - Number: min how much validator self delegates
  - maxTotalDelegation - Number: max total delegation to validator
  - website - String: validator website
  - identity - String: validator kyc identity
  - securityContact - String: validator security contact
  - details - String: additional validator info
  - slotPubKeyToAdd - String: validator bls pub key to add
  - slotPubKeyToRemove - String: validator bls pub key to remove
- CollectRewards:
  - delegatorAddress - String: address to send rewards
- Delegate:
  - delegatorAddress - String: delegation delegator address
  - validatorAddress - String: delegation validator address
  - amount - Number: big.Int amount for delegation to validator
- Undelegate:
  - delegatorAddress - String: undelegation delegator address
  - validatorAddress - String: undelegation validator address
  - amount - Number: big.Int amount for undelegation to delegator

Sample Curl Request

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

Sample Curl Response

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

API v2

Parameters

Number- The block's index in the chain.
Number - The transactions index position.

Returns

hash - String: Hash of the transaction.
nonce - Number: The number of transactions made by the sender prior to this one.
blockHash - String: Hash of the block where this transaction was in. null when its pending.
blockNumber - Number: Block number where this transaction was in. null when its pending.
transactionIndex - Number: Integer of the transactions index position in the block. null when its pending.
timestamp - Number: transaction timestamp
from - String: Address of the sender.
value - String: Value transferred in ATTO.
gasPrice - String: Gas price provided by the sender.
gas - Number: Gas provided by the sender.
v - String: signature V
r - String: signature R
s - String: signature S
type - String: staking transaction type ("CreateValidator", "EditValidator", "CollectRewards", "Undelegate", "Delegate")
msg - StakingMsg:
- CreateValidator:
  - validatorAddress - String: validator address
  - name - String: validator name
  - commissionRate - Number: validator commission rate
  - maxCommissionRate - Number: validator commission rate
  - maxChangeRate - Number: validator max commission rate change
  - minSelfDelegation - Number: min how much validator self delegates
  - maxTotalDelegation - Number: max total delegation to validator
  - amount - Number: stake amount for validator
  - website - String: validator website
  - identity - String: validator kyc identity
  - securityContact - String: validator security contact
  - details - String: additional validator info
  - slotPubKeys - []String: validator bls pub keys
- EditValidator:
  - validatorAddress - String: validator address
  - name - String: validator name
  - commissionRate - Number: validator commission rate
  - minSelfDelegation - Number: min how much validator self delegates
  - maxTotalDelegation - Number: max total delegation to validator
  - website - String: validator website
  - identity - String: validator kyc identity
  - securityContact - String: validator security contact
  - details - String: additional validator info
  - slotPubKeyToAdd - String: validator bls pub key to add
  - slotPubKeyToRemove - String: validator bls pub key to remove
- CollectRewards:
  - delegatorAddress - String: address to send rewards
- Delegate:
  - delegatorAddress - String: delegation delegator address
  - validatorAddress - String: delegation validator address
  - amount - Number: big.Int amount for delegation to validator
- Undelegate:
  - delegatorAddress - String: undelegation delegator address
  - validatorAddress - String: undelegation validator address
  - amount - Number: big.Int amount for undelegation to delegator

Sample Curl Request

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

Sample Curl Response

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

hmy_getStakingTransactionByHash

Get staking transaction by its hash.

API v1

Parameters

String - The staking transaction hash.

Returns

hash - String: Hash of the transaction.
nonce - Number: The number of transactions made by the sender prior to this one.
blockHash - String: Hash of the block where this transaction was in. null when its pending.
blockNumber - Number: Block number where this transaction was in. null when its pending.
transactionIndex - Number: Integer of the transactions index position in the block. null when its pending.
timestamp - Number: transaction timestamp
from - String: Address of the sender.
value - String: Value transferred in ATTO.
gasPrice - String: Gas price provided by the sender.
gas - Number: Gas provided by the sender.
v - String: signature V
r - String: signature R
s - String: signature S
type - String: staking transaction type ("CreateValidator", "EditValidator", "CollectRewards", "Undelegate", "Delegate")
msg - StakingMsg:
- CreateValidator:
  - validatorAddress - String: validator address
  - name - String: validator name
  - commissionRate - Number: validator commission rate
  - maxCommissionRate - Number: validator commission rate
  - maxChangeRate - Number: validator max commission rate change
  - minSelfDelegation - Number: min how much validator self delegates
  - maxTotalDelegation - Number: max total delegation to validator
  - amount - Number: stake amount for validator
  - website - String: validator website
  - identity - String: validator kyc identity
  - securityContact - String: validator security contact
  - details - String: additional validator info
  - slotPubKeys - []String: validator bls pub keys
- EditValidator:
  - validatorAddress - String: validator address
  - name - String: validator name
  - commissionRate - Number: validator commission rate
  - minSelfDelegation - Number: min how much validator self delegates
  - maxTotalDelegation - Number: max total delegation to validator
  - website - String: validator website
  - identity - String: validator kyc identity
  - securityContact - String: validator security contact
  - details - String: additional validator info
  - slotPubKeyToAdd - String: validator bls pub key to add
  - slotPubKeyToRemove - String: validator bls pub key to remove
- CollectRewards:
  - delegatorAddress - String: address to send rewards
- Delegate:
  - delegatorAddress - String: delegation delegator address
  - validatorAddress - String: delegation validator address
  - amount - Number: big.Int amount for delegation to validator
- Undelegate:
  - delegatorAddress - String: undelegation delegator address
  - validatorAddress - String: undelegation validator address
  - amount - Number: big.Int amount for undelegation to delegator

Sample Curl Request

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

Sample Curl Response

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

API v2

Parameters

String- The staking transaction hash.

Returns

hash - String: Hash of the transaction.
nonce - Number: The number of transactions made by the sender prior to this one.
blockHash - String: Hash of the block where this transaction was in. null when its pending.
blockNumber - Number: Block number where this transaction was in. null when its pending.
transactionIndex - Number: Integer of the transactions index position in the block. null when its pending.
timestamp - Number: transaction timestamp
from - String: Address of the sender.
value - String: Value transferred in ATTO.
gasPrice - String: Gas price provided by the sender.
gas - Number: Gas provided by the sender.
v - String: signature V
r - String: signature R
s - String: signature S
type - String: staking transaction type ("CreateValidator", "EditValidator", "CollectRewards", "Undelegate", "Delegate")
msg - StakingMsg:
- CreateValidator:
  - validatorAddress - String: validator address
  - name - String: validator name
  - commissionRate - Number: validator commission rate
  - maxCommissionRate - Number: validator commission rate
  - maxChangeRate - Number: validator max commission rate change
  - minSelfDelegation - Number: min how much validator self delegates
  - maxTotalDelegation - Number: max total delegation to validator
  - amount - Number: stake amount for validator
  - website - String: validator website
  - identity - String: validator kyc identity
  - securityContact - String: validator security contact
  - details - String: additional validator info
  - slotPubKeys - []String: validator bls pub keys
- EditValidator:
  - validatorAddress - String: validator address
  - name - String: validator name
  - commissionRate - Number: validator commission rate
  - minSelfDelegation - Number: min how much validator self delegates
  - maxTotalDelegation - Number: max total delegation to validator
  - website - String: validator website
  - identity - String: validator kyc identity
  - securityContact - String: validator security contact
  - details - String: additional validator info
  - slotPubKeyToAdd - String: validator bls pub key to add
  - slotPubKeyToRemove - String: validator bls pub key to remove
- CollectRewards:
  - delegatorAddress - String: address to send rewards
- Delegate:
  - delegatorAddress - String: delegation delegator address
  - validatorAddress - String: delegation validator address
  - amount - Number: big.Int amount for delegation to validator
- Undelegate:
  - delegatorAddress - String: undelegation delegator address
  - validatorAddress - String: undelegation validator address
  - amount - Number: big.Int amount for undelegation to delegator

Sample Curl Request

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

Sample Curl Response

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

hmy_getCurrentTransactionErrorSink

API v1

Returns

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_getCurrentTransactionErrorSink",
    "params": [],
    "id": 1
}'

Sample Curl Response

API v2

Returns

Sample Curl Request

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

Sample Curl Response

hmy_getPendingCrossLinks

API v1

Returns

See latest header and blocks format

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_getPendingCrossLinks",
    "params": [],
    "id": 1
}'

Sample Curl Response

See latest header and blocks response

API v2

Returns

See latest header and blocks format

Sample Curl Request

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

Sample Curl Response

See latest header and blocks response

hmy_getPendingCXReceipts

API v1

Returns

Array of pending cx receipts in tx pool. See hmy_getCXReceiptByHash for format

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_getPendingCXReceipts",
    "params": [],
    "id": 1
}'

Sample Curl Response

See hmy_getCXReceiptByHash response

API v2

Returns

Array of pending cx receipts in tx pool. See hmy_getCXReceiptByHash for format

Sample Curl Request

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

Sample Curl Response

See hmy_getCXReceiptByHash response

hmy_getCXReceiptByHash

API v1

Parameters

String - transactions hash for cx receipt

Returns

blockHash - String - block hash
blockNumber - Number - block number
hash - String - transaction hash
from - String - from one address
to - String - to one address
shardID - Number - shard id from where transaction sent
toShardID - Number - shard id to where transaction sent
value - Number - transaction sent value

Sample Curl Request

Sample Curl Response

API v2

Parameters

String - transactions hash for cx receipt

Returns

blockHash - String - block hash
blockNumber - Number - block number
hash - String - transaction hash
from - String - from one address
to - String - to one address
shardID - Number - shard id from where transaction sent
toShardID - Number - shard id to where transaction sent
value - Number - transaction sent value

Sample Curl Request

Sample Curl Response

hmy_pendingTransactions

API v1

Returns list of pending transactions object. See for result format.

Sample Curl Request

API v2

Returns list of pending transactions object. See for result format.

Sample Curl Request

hmy_sendRawStakingTransaction

SendRawStakingTransaction

Overview

A staking transaction is like a plain sharded transaction, , but with a single field that is not known ahead of time. This field is the staking message itself, which in the harmony go code base, we refer to as StakeMsg

Input

The input is a single RLP encoded version of a StakingTransaction

Parameters

String - Transaction encoded in bytes.

Returns

String - Raw transaction's hash.

Sample Curl Request

Sample Curl Response

hmy_getTransactionsHistory

Description

hmy_getTransactionsHistory get transactions history for an address

Parameters

String - one address ("one1...")
txHistoryArgs - json args
- txType - String : optional, Received or Sent, shows all transactions by default
- fullTx - Bool : optional, shows full transaction or just its hash, default is false
- pageSize - Number : optional, pagination page size, how much tx to show in single page, default is 100
- pageIndex - Number : optional, pagination which page to show, default is 0
- txType - String: optional, "ALL", "RECEIVED", "SENT", default is "ALL"
- order - String: optional, "ASC", "DESC", default is "ASC", order by timestamp

API v1

Returns

Array - either returns list of transactions
- hash - String: Hash of the transaction.
- nonce - Number: The number of transactions made by the sender prior to this one.
- blockHash - String: Hash of the block where this transaction was in. null when it's pending.
- blockNumber - Number: Block number where this transaction was in. null when it's pending.
- transactionIndex - Number: Integer of the transaction's index position in the block. null when its pending.
- from - String: Address of the sender.
- to - String: Address of the receiver.
- value - String: Value transferred in ATTO.
- gasPrice - String: Gas price provided by the sender.
- gas - Number: Gas provided by the sender.
- input - String: The data sent along with the transaction.
Array of String - or list of transactions hashes

Sample Curl Request 0

Sample Curl Response 0

Sample Curl Request 1

Sample Curl Response 1

API v2

Returns

Array - either returns list of transactions
- hash - String: Hash of the transaction.
- nonce - Number: The number of transactions made by the sender prior to this one.
- blockHash - String: Hash of the block where this transaction was in. null when it's pending.
- blockNumber - Number: Block number where this transaction was in. null when it's pending.
- transactionIndex - Number: Integer of the transaction's index position in the block. null when its pending.
- from - String: Address of the sender.
- to - String: Address of the receiver.
- value - Number: Value transferred in ATTO.
- gasPrice - Number: Gas price provided by the sender.
- gas - Number: Gas provided by the sender.
- input - String: The data sent along with the transaction.
Array of String - or list of transactions hashes

Sample Curl Request 0

Sample Curl Response 0

Sample Curl Request 1

Sample Curl Response 1

hmy_sendRawTransaction

SendRawTransaction

Send a raw transaction encoded in bytes.

Parameters

String - Transaction encoded in bytes.

Returns

String - Raw transaction's hash.

Sample Curl Request

Sample Curl Response

hmy_getTransactionReceipt

GetTransactionReceipt

Get transaction receipt from transaction hash.

API v1

Parameters

String - The transaction hash.

Returns

blockHash 32 Bytes - String: Hash of the block where this transaction was in.
blockNumber - Number: Block number where this transaction was in.
transactionHash 32 Bytes - String: Hash of the transaction.
transactionIndex- Number: Integer of the transactions index position in the block.
from - String: Address of the sender.
to - String: Address of the receiver. null when its a contract creation transaction.
contractAddress - String: The contract address created, if the transaction was a contract creation, otherwise null.
cumulativeGasUsed - Number: The total amount of gas used when this transaction was executed in the block.
gasUsed- Number: The amount of gas used by this specific transaction alone.
logs - Array: Array of log objects, which this transaction generated.

Sample Curl Request

Sample Curl Response

API v2

Parameters

String - The transaction hash.

Returns

blockHash 32 Bytes - String: Hash of the block where this transaction was in.
blockNumber - Number: Block number where this transaction was in.
transactionHash 32 Bytes - String: Hash of the transaction.
transactionIndex- Number: Integer of the transactions index position in the block.
from - String: Address of the sender.
to - String: Address of the receiver. null when its a contract creation transaction.
contractAddress - String: The contract address created, if the transaction was a contract creation, otherwise null.
cumulativeGasUsed - Number: The total amount of gas used when this transaction was executed in the block.
gasUsed- Number: The amount of gas used by this specific transaction alone.
logs - Array: Array of log objects, which this transaction generated.

Sample Curl Request

Sample Curl Response

hmy_getBlockTransactionCountByHash

GetBlockTransactionCount

Get the number of transactions in a block by the block's hash.

API v1

Parameters

String - The block hash.

Returns

Number - The number of transactions in the given block.

Sample Curl Request

Sample Curl Response

API v2

Parameters

String - The block hash.

Returns

Number - The number of transactions in the given block.

Sample Curl Request

Sample Curl Response

hmy_getBlockTransactionCountByNumber

GetBlockTransactionCount

Get the number of transactions in a block by the block's index in the chain.

API v1

Parameters

Number - The block number.

Returns

Number - The number of transactions in the given block.

Sample Curl Request

Sample Curl Response

API v2

Parameters

Number - The block number.

Returns

Number - The number of transactions in the given block.

Sample Curl Request

Sample Curl Response

hmy_getTransactionByHash

GetTransaction

Get a transaction by its hash.

API v1

Parameters

String - The transaction hash.

Returns

hash - String: Hash of the transaction.
nonce - Number: The number of transactions made by the sender prior to this one.
blockHash - String: Hash of the block where this transaction was in. null when its pending.
blockNumber - Number: Block number where this transaction was in. null when its pending.
transactionIndex - Number: Integer of the transactions index position in the block. null when its pending.
from - String: Address of the sender.
to - String: Address of the receiver. null when its a contract creation transaction.
value - String: Value transferred in ATTO.
gasPrice - String: Gas price provided by the sender.
gas - Number: Gas provided by the sender.
input - String: The data sent along with the transaction.

Sample Curl Request

Sample Curl Response

API v2

Parameters

String- The transaction hash.

Returns

hash - String: Hash of the transaction.
nonce - Number: The number of transactions made by the sender prior to this one.
blockHash - String: Hash of the block where this transaction was in. null when its pending.
blockNumber - Number: Block number where this transaction was in. null when its pending.
transactionIndex - Number: Integer of the transactions index position in the block. null when its pending.
from - String: Address of the sender.
to - String: Address of the receiver. null when its a contract creation transaction.
value - Number: Value transferred in ATTO.
gasPrice - Number: Gas price provided by the sender.
gas - Number: Gas provided by the sender.
input - String: The data sent along with the transaction.

Sample Curl Request

Sample Curl Response

hmy_getTransactionByBlockNumberAndIndex

GetTransaction

Get transaction at an index from a given block, specified by number.

API v1

Parameters

String - The block's index in the chain.
String - The transactions index position.

Returns

hash - String: Hash of the transaction.
nonce - Number: The number of transactions made by the sender prior to this one.
blockHash - String: Hash of the block where this transaction was in. null when its pending.
blockNumber - Number: Block number where this transaction was in. null when its pending.
transactionIndex - Number: Integer of the transactions index position in the block. null when its pending.
from - String: Address of the sender.
to - String: Address of the receiver. null when its a contract creation transaction.
value - String: Value transferred in ATTO.
gasPrice - String: Gas price provided by the sender.
gas - Number: Gas provided by the sender.
input - String: The data sent along with the transaction.

Sample Curl Request

Sample Curl Response

API v2

Parameters

Number- The block's index in the chain.
Number - The transactions index position.

Returns

hash - String: Hash of the transaction.
nonce - Number: The number of transactions made by the sender prior to this one.
blockHash - String: Hash of the block where this transaction was in. null when its pending.
blockNumber - Number: Block number where this transaction was in. null when its pending.
transactionIndex - Number: Integer of the transactions index position in the block. null when its pending.
from - String: Address of the sender.
to - String: Address of the receiver. null when its a contract creation transaction.
value - Number: Value transferred in ATTO.
gasPrice - Number: Gas price provided by the sender.
gas - Number: Gas provided by the sender.
input - String: The data sent along with the transaction.

Sample Curl Request

Sample Curl Response

hmy_getTransactionByBlockHashAndIndex

GetTransactionByBlockHashAndIndex

Get transaction at an index from a given block, specified by block hash.

API v1

Parameters

String - The block hash.
Number - The transactions index position.

Returns

hash - String: Hash of the transaction.
nonce - Number: The number of transactions made by the sender prior to this one.
blockHash - String: Hash of the block where this transaction was in. null when its pending.
blockNumber - Number: Block number where this transaction was in. null when its pending.
transactionIndex - Number: Integer of the transactions index position in the block. null when its pending.
from - String: Address of the sender.
to - String: Address of the receiver. null when its a contract creation transaction.
value - String: Value transferred in ATTO.
gasPrice - String: Gas price provided by the sender.
gas - Number: Gas provided by the sender.
input - String: The data sent along with the transaction.

Sample Curl Request

Sample Curl Response

API v2

Parameters

String - The block hash.
Number - The transactions index position.

Returns

hash - String: Hash of the transaction.
nonce - Number: The number of transactions made by the sender prior to this one.
blockHash - String: Hash of the block where this transaction was in. null when its pending.
blockNumber - Number: Block number where this transaction was in. null when its pending.
transactionIndex - Number: Integer of the transactions index position in the block. null when its pending.
from - String: Address of the sender.
to - String: Address of the receiver. null when its a contract creation transaction.
value - Number: Value transferred in ATTO.
gasPrice - number: Gas price provided by the sender.
gas - Number: Gas provided by the sender.
input - String: The data sent along with the transaction.

Sample Curl Request

Sample Curl Response

hmy_getBlockByNumber

GetBlockByNumber

Get block by its index in the blockchain.

API v1

Parameters

String - The block number.
Boolean - If true, the returned block will contain all transactions in the block.

Returns

number - Number: The block number. null when its pending block.
hash 32 Bytes - String: Hash of the block. null when its pending block.
parentHash 32 Bytes - String: Hash of the parent block.
nonce 8 Bytes - String: Hash of the generated proof-of-work. null when its pending block.
logsBloom 256 Bytes - String: The bloom filter for the logs of the block. null when its pending block.
transactionsRoot 32 Bytes - String: The root of the transaction trie of the block
stateRoot 32 Bytes - String: The root of the final state trie of the block.
miner - String: The address of the beneficiary to whom the mining rewards were given.
difficulty - String: Integer of the difficulty for this block.
extraData - String: The “extra data” field of this block.
size - Number: Integer the size of this block in bytes.
gasLimit - Number: The maximum gas allowed in this block.
gasUsed - Number: The total used gas by all transactions in this block.
timestamp - Number: The unix timestamp for when the block was collated.
stakingTransactions - Array: Array of staking transactions object; are present by default
transactions - Array: Array of transaction objects; absent if second parameter is false.
uncles - Array: Array of uncle hashes.

Sample Curl Request

Sample Curl Response

API v2

Parameters

Number - The block number.
blockArgs - optional args struct in json format (should be used just with { })
1. fullTx - Bool: To show full tx or not
2. withSigners- Bool: Include block signes in blocks or not
3. inclStaking - Bool: To show staking txs or not

Returns

number - Number: The block number. null when its pending block.
hash 32 Bytes - String: Hash of the block. null when its pending block.
parentHash 32 Bytes - String: Hash of the parent block.
nonce 8 Bytes - String: Hash of the generated proof-of-work. null when its pending block.
logsBloom 256 Bytes - String: The bloom filter for the logs of the block. null when its pending block.
transactionsRoot 32 Bytes - String: The root of the transaction trie of the block
stateRoot 32 Bytes - String: The root of the final state trie of the block.
miner - String: The address of the beneficiary to whom the mining rewards were given.
difficulty - String: Integer of the difficulty for this block.
extraData - String: The “extra data” field of this block.
size - Number: Integer the size of this block in bytes.
gasLimit - Number: The maximum gas allowed in this block.
gasUsed - Number: The total used gas by all transactions in this block.
timestamp - Number: The unix timestamp for when the block was collated.
stakingTransactions - Array: Array of staking transactions object; absent if inclStaking is false, are present by default
transactions - Array: Array of transaction objects; absent if second parameter is false.
uncles - Array: Array of uncle hashes.

Sample Curl Request

Sample Curl Response

hmy_getBlockByHash

GetBlockByHash

Get block by its hash.

API v1

Parameters

String - The block hash.
Boolean - If true, the returned block will contain all transactions in the block.

Returns

number - Number: The block number. null when its pending block.
hash 32 Bytes - String: Hash of the block. null when its pending block.
parentHash 32 Bytes - String: Hash of the parent block.
nonce 8 Bytes - String: Hash of the generated proof-of-work. null when its pending block.
logsBloom 256 Bytes - String: The bloom filter for the logs of the block. null when its pending block.
transactionsRoot 32 Bytes - String: The root of the transaction trie of the block
stateRoot 32 Bytes - String: The root of the final state trie of the block.
miner - String: The address of the beneficiary to whom the mining rewards were given.
difficulty - String: Integer of the difficulty for this block.
extraData - String: The “extra data” field of this block.
size - Number: Integer the size of this block in bytes.
gasLimit - Number: The maximum gas allowed in this block.
gasUsed - Number: The total used gas by all transactions in this block.
timestamp - Number: The unix timestamp for when the block was collated.
stakingTransactions - Array: Array of staking transactions object; are present by default
transactions - Array: Array of transaction objects; absent if second parameter is false.
uncles - Array: Array of uncle hashes.

Sample Curl Request

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

Sample Curl Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "difficulty": 0,
        "extraData": "0x",
        "gasLimit": "0x4f6e2a",
        "gasUsed": "0x0",
        "hash": "0x660fe701f580ffebfcfb4af1836c9929c1fd0014d8d79d60749fecf52df7a90d",
        "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
        "miner": "0x0b585f8daefbc68a311fbd4cb20d9174ad174016",
        "mixHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "nonce": 0,
        "number": "0x66",
        "parentHash": "0xcac989d8ba18e88ab245686e491a171d46b759e85290a3fc6df80553d2ac582f",
        "receiptsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
        "size": "0x25d",
        "stateRoot": "0x830ff6830857f88bdc56141449d0729a663c6413dc0dc909fc1f3715dd576cee",
        "timestamp": "0x5d570a3f",
        "transactions": [],
        "transactionsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
        "uncles": []
    }
}

API v2

Parameters

String - The block hash.
blockArgs - optional args struct in json format (should be used just with { })
1. fullTx - Bool: To show full tx or not
2. withSigners- Bool: Include block signes in blocks or not
3. inclStaking - Bool: To show staking txs or not

Returns

number - Number: The block number. null when its pending block.
hash 32 Bytes - String: Hash of the block. null when its pending block.
parentHash 32 Bytes - String: Hash of the parent block.
nonce 8 Bytes - String: Hash of the generated proof-of-work. null when its pending block.
logsBloom 256 Bytes - String: The bloom filter for the logs of the block. null when its pending block.
transactionsRoot 32 Bytes - String: The root of the transaction trie of the block
stateRoot 32 Bytes - String: The root of the final state trie of the block.
miner - String: The address of the beneficiary to whom the mining rewards were given.
difficulty - String: Integer of the difficulty for this block.
extraData - String: The “extra data” field of this block.
size - Number: Integer the size of this block in bytes.
gasLimit - Number: The maximum gas allowed in this block.
gasUsed - Number: The total used gas by all transactions in this block.
timestamp - Number: The unix timestamp for when the block was collated.
stakingTransactions - Array: Array of staking transactions object; absent if inclStaking is false, are present by default
transactions - Array: Array of transaction objects; absent if second parameter is false.
uncles - Array: Array of uncle hashes.

Sample Curl Request

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

Sample Curl Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "difficulty": 0,
        "extraData": "0x",
        "gasLimit": 4716988,
        "gasUsed": 0,
        "hash": "0xa3b7dd8626bfc6f6037c06401ceaa752bb54f0539535aea9883170e305e3b6c5",
        "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
        "miner": "0x0b585f8daefbc68a311fbd4cb20d9174ad174016",
        "mixHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "nonce": 0,
        "number": 1,
        "parentHash": "0x34a8b155f90b8fc22342fc8b5d1c969ed836a2f666c506e4017b570dc337e88c",
        "receiptsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
        "signers": [
            "one1pdv9lrdwl0rg5vglh4xtyrv3wjk3wsqket7zxy",
            "one12fuf7x9rgtdgqg7vgq0962c556m3p7afsxgvll",
            "one1pf75h0t4am90z8uv3y0dgunfqp4lj8wr3t5rsp",
            "one1spshr72utf6rwxseaz339j09ed8p6f8ke370zj",
            "one1d2rngmem4x2c6zxsjjz29dlah0jzkr0k2n88wc",
            "one1a50tun737ulcvwy0yvve0pvu5skq0kjargvhwe",
            "one103q7qe5t2505lypvltkqtddaef5tzfxwsse4z7"
        ],
        "size": 827,
        "stakingTransactions": [],
        "stateRoot": "0xae22370df046aa8c4470a032ecc88609efc08438abe79fd9e7f134b077a11fb6",
        "timestamp": 1580419937,
        "transactions": [],
        "transactionsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
        "uncles": []
    }
}

hmy_getBlocks

Description

hmy_getBlocks returns blocks in range [from; to]

API v1

Parameters

String - starting block number in 0x format
String - ending block number in 0x format
blockArgs - optional args struct in json format (should be used just with { })
1. fullTx - Bool: To show full tx or not
2. withSigners- Bool: Include block signes in blocks or not

Returns

Array : returns blocks list in json format
- number - Number: The block number. null when its pending block.
- hash 32 Bytes - String: Hash of the block. null when its pending block.
- parentHash 32 Bytes - String: Hash of the parent block.
- nonce 8 Bytes - String: Hash of the generated proof-of-work.null when its pending block.
- logsBloom 256 Bytes - String: The bloom filter for the logs of the block. null when its pending block.
- transactionsRoot 32 Bytes - String: The root of the transaction trie of the block
- stateRoot 32 Bytes - String: The root of the final state trie of the block.
- miner - String: The address of the beneficiary to whom the mining rewards were given.
- difficulty - Number: Integer of the difficulty for this block.
- extraData - String: The “extra data” field of this block.
- size - Number: Integer the size of this block in bytes.
- gasLimit - Number: The maximum gas allowed in this block.
- gasUsed - Number: The total used gas by all transactions in this block.
- timestamp - Number: The unix timestamp for when the block was collated, 0x format.
- stakingTransactions - Array: Array of staking transactions object; absent if inclStaking is false, are present by default.
- transactions - Array: Array of transaction objects; absent if second parameter is false.
- signers - Array: Array of validators one addresses who signed this block
- uncles - Array: Array of uncle hashes.

Sample Curl Request

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

Sample Curl Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": [
        {
            "difficulty": 0,
            "extraData": "0x4861726d6f6e7920666f72204f6e6520616e6420416c6c2e204f70656e20436f6e73656e73757320666f72203130422e",
            "gasLimit": "0x47e7c4",
            "gasUsed": "0x0",
            "hash": "0x34a8b155f90b8fc22342fc8b5d1c969ed836a2f666c506e4017b570dc337e88c",
            "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
            "miner": "0x0000000000000000000000000000000000000000",
            "mixHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "nonce": 0,
            "number": "0x0",
            "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "receiptsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
            "signers": [],
            "size": "0x6ed",
            "stateRoot": "0xae22370df046aa8c4470a032ecc88609efc08438abe79fd9e7f134b077a11fb6",
            "timestamp": "0x5d162b70",
            "transactions": [],
            "transactionsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
            "uncles": []
        },
        {
            "difficulty": 0,
            "extraData": "0x",
            "gasLimit": "0x47f9bc",
            "gasUsed": "0x0",
            "hash": "0x9e91a1ebe860eab3821f0d731689ec3833863f445a6f79649ce2813782e36be2",
            "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
            "miner": "0x0b585f8daefbc68a311fbd4cb20d9174ad174016",
            "mixHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "nonce": 0,
            "number": "0x1",
            "parentHash": "0x34a8b155f90b8fc22342fc8b5d1c969ed836a2f666c506e4017b570dc337e88c",
            "receiptsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
            "signers": [
                "one1pdv9lrdwl0rg5vglh4xtyrv3wjk3wsqket7zxy",
                "one12fuf7x9rgtdgqg7vgq0962c556m3p7afsxgvll",
                "one1pf75h0t4am90z8uv3y0dgunfqp4lj8wr3t5rsp",
                "one1spshr72utf6rwxseaz339j09ed8p6f8ke370zj",
                "one1d2rngmem4x2c6zxsjjz29dlah0jzkr0k2n88wc",
                "one103q7qe5t2505lypvltkqtddaef5tzfxwsse4z7"
            ],
            "size": "0x33b",
            "stateRoot": "0xae22370df046aa8c4470a032ecc88609efc08438abe79fd9e7f134b077a11fb6",
            "timestamp": "0x5db74a3f",
            "transactions": [],
            "transactionsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
            "uncles": []
        }
    ]
}

API v2

Parameters

Number - starting block number
Number - ending block number
blockArgs - optional args struct in json format (should be used just with { })
1. fullTx - Bool: To show full tx or not
2. withSigners- Bool: Include block signes in blocks or not
3. inclStaking - Bool: To show staking txs or not

Returns

Array : returns blocks list in json format
- number - Number: The block number. null when its pending block.
- hash 32 Bytes - String: Hash of the block. null when its pending block.
- parentHash 32 Bytes - String: Hash of the parent block.
- nonce 8 Bytes - String: Hash of the generated proof-of-work. null when its pending block.
- logsBloom 256 Bytes - String: The bloom filter for the logs of the block. null when its pending block.
- transactionsRoot 32 Bytes - String: The root of the transaction trie of the block
- stateRoot 32 Bytes - String: The root of the final state trie of the block.
- miner - String: The address of the beneficiary to whom the mining rewards were given.
- difficulty - String: Integer of the difficulty for this block.
- extraData - String: The “extra data” field of this block.
- size - Number: Integer the size of this block in bytes.
- gasLimit - Number: The maximum gas allowed in this block.
- gasUsed - Number: The total used gas by all transactions in this block.
- timestamp - Number: The unix timestamp for when the block was collated.
- stakingTransactions - Array: Array of staking transactions object; absent if inclStaking is false, are present by default
- transactions - Array: Array of transaction objects; only hashes if fullTx is false, are hashes by default
- signers - Array: Array of validators one addresses who signed this block
- uncles - Array: Array of uncle hashes.

Sample Curl Request

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

Sample Curl Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": [
        {
            "difficulty": 0,
            "extraData": "0x",
            "gasLimit": 4716988,
            "gasUsed": 0,
            "hash": "0xdeca0d8c04a45b78bc0b6c1811bae6c2570b0cc4dc82ae11df2e09fd0194ce90",
            "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
            "miner": "0x0b585f8daefbc68a311fbd4cb20d9174ad174016",
            "mixHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "nonce": 0,
            "number": 1,
            "parentHash": "0x34a8b155f90b8fc22342fc8b5d1c969ed836a2f666c506e4017b570dc337e88c",
            "receiptsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
            "signers": [
                "one1pdv9lrdwl0rg5vglh4xtyrv3wjk3wsqket7zxy",
                "one12fuf7x9rgtdgqg7vgq0962c556m3p7afsxgvll",
                "one1pf75h0t4am90z8uv3y0dgunfqp4lj8wr3t5rsp",
                "one1spshr72utf6rwxseaz339j09ed8p6f8ke370zj",
                "one1d2rngmem4x2c6zxsjjz29dlah0jzkr0k2n88wc",
                "one1a50tun737ulcvwy0yvve0pvu5skq0kjargvhwe",
                "one103q7qe5t2505lypvltkqtddaef5tzfxwsse4z7"
            ],
            "size": 827,
            "stakingTransactions": [],
            "stateRoot": "0xae22370df046aa8c4470a032ecc88609efc08438abe79fd9e7f134b077a11fb6",
            "timestamp": 1580418265,
            "transactions": [],
            "transactionsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
            "uncles": []
        },
        {
            "difficulty": 0,
            "extraData": "0x",
            "gasLimit": 4721593,
            "gasUsed": 0,
            "hash": "0x0d7eb3f99bb28cecd5af7a19d809f917b1b210ad1fc10d5cf273e7cf32e416be",
            "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
            "miner": "0x0b585f8daefbc68a311fbd4cb20d9174ad174016",
            "mixHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "nonce": 0,
            "number": 2,
            "parentHash": "0xdeca0d8c04a45b78bc0b6c1811bae6c2570b0cc4dc82ae11df2e09fd0194ce90",
            "receiptsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
            "signers": [
                "one1pdv9lrdwl0rg5vglh4xtyrv3wjk3wsqket7zxy",
                "one12fuf7x9rgtdgqg7vgq0962c556m3p7afsxgvll",
                "one1pf75h0t4am90z8uv3y0dgunfqp4lj8wr3t5rsp",
                "one1spshr72utf6rwxseaz339j09ed8p6f8ke370zj",
                "one1d2rngmem4x2c6zxsjjz29dlah0jzkr0k2n88wc",
                "one1a50tun737ulcvwy0yvve0pvu5skq0kjargvhwe",
                "one103q7qe5t2505lypvltkqtddaef5tzfxwsse4z7"
            ],
            "size": 698,
            "stakingTransactions": [],
            "stateRoot": "0x4e37e8739fc27e85c95f38c1c8ac2d8a382c9086c0fcdfd7762904b2c80f067c",
            "timestamp": 1580418273,
            "transactions": [],
            "transactionsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
            "uncles": []
        }
    ]
}

Contract Related Methods

hmy_estimateGas

Generates and returns an estimate of how much gas is necessary to allow the transaction to complete. The transaction will not be added to the blockchain.

Parameters

See hmy_call parameters, expect that all properties are optional. If no gas limit is specified geth uses the block gas limit from the pending block as an upper bound. As a result the returned estimate might not be enough to executed the call/transaction when the amount of gas is higher than the pending block gas limit.

Returns

QUANTITY - the amount of gas used.

Example

// Request
curl -X POST "https://api.s0.b.hmny.io" --data '{"jsonrpc":"2.0","method":"hmy_estimateGas","params":[{see above}],"id":1}'

// Result
{
  "id":1,
  "jsonrpc": "2.0",
  "result": "0x5208" // 21000
}

hmy_getStorageAt

Returns the value from a storage position at a given address.

Parameters

DATA, 20 Bytes - address of the storage.
QUANTITY - integer of the position in the storage.
QUANTITY|TAG - integer block number, or the string "latest", "earliest" or "pending"

Returns

DATA - the value at this storage position.

Example

Calculating the correct position depends on the storage to retrieve. Consider the following contract deployed at 0x295a70b2de5e3953354a6a8344e616ed314d7251 by address 0x391694e7e0b0cce554cb130d723a9d27458f9298.

contract Storage {
    uint pos0;
    mapping(address => uint) pos1;

    function Storage() {
        pos0 = 1234;
        pos1[msg.sender] = 5678;
    }
}

Retrieving the value of pos0 is straight forward:

curl -X POST "https://api.s0.b.hmny.io" --data '{"jsonrpc":"2.0", "method": "hmy_getStorageAt", "params": ["0x295a70b2de5e3953354a6a8344e616ed314d7251", "0x0", "latest"], "id": 1}' localhost:8545

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

hmy_call

Executes a new message call immediately without creating a transaction on the block chain.

Parameters

Object - The transaction call object
from: DATA, 20 Bytes - (optional) The address the transaction is sent from.
to: DATA, 20 Bytes - The address the transaction is directed to.
gas: QUANTITY - (optional) Integer of the gas provided for the transaction execution. eth_call consumes zero gas, but this parameter may be needed by some executions.
gasPrice: QUANTITY - (optional) Integer of the gasPrice used for each paid gas
value: QUANTITY - (optional) Integer of the value sent with this transaction
data: DATA - (optional) Hash of the method signature and encoded parameters.
QUANTITY|TAG - integer block number, or the string "latest", "earliest" or "pending"

Returns

DATA - the return value of executed contract.

Example

// Request
curl -X POST "https://api.s0.b.hmny.io" --data '{
    "jsonrpc": "2.0",
    "method": "hmy_call",
    "params": [
        {
            "to": "0x08AE1abFE01aEA60a47663bCe0794eCCD5763c19"
        },
        "latest"
    ],
    "id": 1
}'

// Result
{
  "id":1,
  "jsonrpc": "2.0",
  "result": "0x"
}

hmy_getCode

GetCode

Get the code at a specific address.

Parameters

String - The address to get the code from.
String - Block to query for information. Usually latest, which specifies the most recent block.
Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns

String - The data at given address address.

Sample Curl Request

Sample Curl Response

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

 curl -d '{
  "jsonrpc":"2.0",
  "method":"hmy_blockNumber",
  "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": "0x4b0"
}

API v2

Returns

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

Sample Curl Request

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

Sample Curl Response

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

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

Sample Curl Response

API v2

Returns

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

Sample Curl Request

Sample Curl Response

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

curl -d '{
    "jsonrpc": "2.0",
    "method": "hmy_getEpoch",
    "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": "0xc"
}

API v2

Returns

uint64 - Current requested node shard epoch decimal format

Sample Curl Request

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

Sample Curl Response

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

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

Staking Related Methods

hmy_getCirculatingSupply

Get circulating ONE supply

Returns

Number - circulating supply

Sample Curl Request

Sample Curl Response

hmy_getTotalSupply

Get total ONE supply

Returns

Number - total supply

Sample Curl Request

Sample Curl Response

hmy_getStakingNetworkInfo

Get global staking info.

Returns

total-staking - Number - big.Int total staking by validators
circulating-supply - Float - current circulating supply
total-supply - Number - total ONE supply (12600000000)
median-raw-stake - Float - median raw validators stake
epoch-last-block - Number - previous epoch last block

Sample Curl Request

Sample Curl Response

hmy_getAllValidatorInformation

Get staking validator information for all validators.

Parameters

Number - page num default to page 1. Not possible to have all data at once.

Returns

Array of:

current-epoch-signing-percent
- current-epoch-signed - Number - epoch when last block was signed by validator
- current-epoch-to-sign - Number - current epoch
- percentage - Float - percentage of blocks signed
current-epoch-voting-power - Array of
- effective-stake - Float - effective validator stake
- shard-id - Number - shard id
- voting-power-adjusted - Float - voting power adjusted
- voting-power-raw - Float - voting power
validator
- availability:
  - num-of-blocks-to-sign - Number - big.Int number of blocks validator should have signed in active mode
  - num-blocks-signed - Number - big.Int number of blocks validator actually signed
- address - String - ECSDA validator address
- bls-public-keys - []String - array of validator bls public keys
- last-epoch-in-committee - Number - big.Int last epoch in committee
- min-self-delegation - Number - big.Int min self delegation
  - max-total-delegation - Number - big.Int max total delegated to this validator
- active - Bool - is valdiator currently active
- rate - Float - validator current commission rate
- max-rate - Float - max validator commission rate
- max-change-rate - Float - max validator commission rate change
- update-height - Number - big.Int last commission update block height
- name - String - validator name
- identity - String - validator text kyc identity
- website - String - validator website
- security-contact - String - validator security contact
- details - String - additional info
- creation-height - Number - big.Int block height when validator was created
- banned - Bool - is validator banned
- Delegations:
  - array of validator delegations, check out delegations format in hmy_getDelegationsBy...

Sample Curl Request

Sample Curl Response

hmy_getAllValidatorInformationByBlockNumber

Get staking validator information snapshot for all validators by blocknum.

Parameters

Number - page num default to page 1. Not possible to have all data at once.
Number - block number

Returns

Array of:

current-epoch-signing-percent
- current-epoch-signed - Number - epoch when last block was signed by validator
- current-epoch-to-sign - Number - current epoch
- percentage - Float - percentage of blocks signed
current-epoch-voting-power - Array of
- effective-stake - Float - effective validator stake
- shard-id - Number - shard id
- voting-power-adjusted - Float - voting power adjusted
- voting-power-raw - Float - voting power
validator
- availability:
  - num-of-blocks-to-sign - Number - big.Int number of blocks validator should have signed in active mode
  - num-blocks-signed - Number - big.Int number of blocks validator actually signed
- address - String - ECSDA validator address
- bls-public-keys - []String - array of validator bls public keys
- last-epoch-in-committee - Number - big.Int last epoch in committee
- min-self-delegation - Number - big.Int min self delegation
  - max-total-delegation - Number - big.Int max total delegated to this validator
- active - Bool - is valdiator currently active
- rate - Float - validator current commission rate
- max-rate - Float - max validator commission rate
- max-change-rate - Float - max validator commission rate change
- update-height - Number - big.Int last commission update block height
- name - String - validator name
- identity - String - validator text kyc identity
- website - String - validator website
- security-contact - String - validator security contact
- details - String - additional info
- creation-height - Number - big.Int block height when validator was created
- banned - Bool - is validator banned
- Delegations:
  - array of validator delegations, check out delegations format in hmy_getDelegationsBy...

Sample Curl Request

Sample Curl Response

hmy_getCurrentUtilityMetrics

Description

Works only for shard 0 (beacon chain).

Returns

AccumulatorSnapshot - Number - total staking
CurrentStakedPercentage - Float - total staking percentage from circulating supply now
Deviation - Float - deviation from average earned stake
Adjustment - Float - adjustment

Sample Curl Request

Sample Curl Response

hmy_getDelegationsByValidator

Parameters

String - validator bech32 address.

Returns

Array of:

validator_address - String - validator bech32 address
delegator_address - String - delegator bech32 address
amount - Number - big.Int amount delegated to validator
reward - Number - big.Int reward to validator for delegation
Undelegations - []RPCUndelegation:
- amount - Number - big.Int amount returned to delegator
- reward - Number - big.Int reward to validator

Sample Curl Request

Sample Curl Response

hmy_getDelegationsByDelegatorAndValidator

Parameters

String - delegator bech32 address.
String - validator bech32 address.

Returns

Array of:

validator_address - String - validator bech32 address
delegator_address - String - delegator bech32 address
amount - Number - big.Int amount delegated to validator
reward - Number - big.Int reward to validator for delegation
Undelegations - []RPCUndelegation:
- amount - Number - big.Int amount returned to delegator
- reward - Number - big.Int reward to validator

Sample Curl Request

Sample Curl Response

hmy_getDelegationsByDelegator

Parameters

String - delegator bech32 address.

Returns

Array of:

validator_address - String - validator bech32 address
delegator_address - String - delegator bech32 address
amount - Number - big.Int amount delegated to validator
reward - Number - big.Int reward to validator for delegation
Undelegations - []RPCUndelegation:
- amount - Number - big.Int amount returned to delegator
- reward - Number - big.Int reward to validator

Sample Curl Request

Sample Curl Response

hmy_getValidatorMetrics

Parameters

String - validator bech32 address.

Returns

NumJailed - Number - big.Int number of times validator was banned due to downtime
TotalEffectiveStake - Float - total validator effective stake from delegations
VotingPowerPerShard - []VotePerShard:
- shard-id - Number - shard id
- voting-power - Float - valdator voting power for this shard
BLSKeyPerShard - []KeyPerShard:
- shard-id - Number - shard id
- keys - []String - validator bls keys for this shard

Sample Curl Request

Sample Curl Response

hmy_getMedianRawStakeSnapshot

Returns active validators addresses list

Returns

Number - big.Int median raw stake of all validators

Sample Curl Request

Sample Curl Response

hmy_getElectedValidatorAddresses

hmy_getActiveValidatorsAddresses

Returns elected validators addresses list

Returns

Array
- String - validator address

Sample Curl Request

Sample Curl Response

hmy_getAllValidatorAddresses

Returns complete validators addresses list

Returns

Array
- String - validator address

Sample Curl Request

Sample Curl Response

hmy_getCurrentStakingErrorSink

API v1

Returns

Sample Curl Request

Sample Curl Response

API v2

Returns

Sample Curl Request

Sample Curl Response

hmy_getValidatorInformation

Get staking validator information.

Parameters

String - validator bech32 address.

Returns

current-epoch-signing-percent
- current-epoch-signed - Number - epoch when last block was signed by validator
- current-epoch-to-sign - Number - current epoch
- percentage - Float - percentage of blocks signed
current-epoch-voting-power - Array of
- effective-stake - Float - effective validator stake
- shard-id - Number - shard id
- voting-power-adjusted - Float - voting power adjusted
- voting-power-raw - Float - voting power
validator
- availability:
  - num-of-blocks-to-sign - Number - big.Int number of blocks validator should have signed in active mode
  - num-blocks-signed - Number - big.Int number of blocks validator actually signed
- address - String - ECSDA validator address
- bls-public-keys - []String - array of validator bls public keys
- last-epoch-in-committee - Number - big.Int last epoch in committee
- min-self-delegation - Number - big.Int min self delegation
  - max-total-delegation - Number - big.Int max total delegated to this validator
- active - Bool - is valdiator currently active
- rate - Float - validator current commission rate
- max-rate - Float - max validator commission rate
- max-change-rate - Float - max validator commission rate change
- update-height - Number - big.Int last commission update block height
- name - String - validator name
- identity - String - validator text kyc identity
- website - String - validator website
- security-contact - String - validator security contact
- details - String - additional info
- creation-height - Number - big.Int block height when validator was created
- banned - Bool - is validator banned
- Delegations:
  - array of validator delegations, check out delegations format in hmy_getDelegationsBy...

Sample Curl Request

Sample Curl Response

hmy_getValidators

Description

hmy_getValidators returns list of validators for a particular epoch in corresponding shard

API v1

Parameters

uint64 - epoch number

Returns

shardID - Uint32 - shard id
validators - Array : list of validators in below format
- address - String : one address
- balance - String : validator current balance (will be replaced with stake soon) 0x format

Sample Curl Request

curl -d '{
    "jsonrpc":"2.0",
    "method":"hmy_getValidators",
    "params":[0],
    "id":1

}' -H "Content-Type: application/json" -X POST "https://api.s0.b.hmny.io"

Sample Curl Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "shardID": 0,
        "validators": [
            {
                "address": "one1pdv9lrdwl0rg5vglh4xtyrv3wjk3wsqket7zxy",
                "balance": "0x3763284988b12fdb3"
            },
            {
                "address": "one12fuf7x9rgtdgqg7vgq0962c556m3p7afsxgvll",
                "balance": "0x376322519535f6db3"
            },
            {
                "address": "one1pf75h0t4am90z8uv3y0dgunfqp4lj8wr3t5rsp",
                "balance": "0x376322519535f6dbc"
            },
            {
                "address": "one1spshr72utf6rwxseaz339j09ed8p6f8ke370zj",
                "balance": "0x36f416a4047f9ddb3"
            },
            {
                "address": "one1d2rngmem4x2c6zxsjjz29dlah0jzkr0k2n88wc",
                "balance": "0x45a3027c55a812498"
            },
            {
                "address": "one1a50tun737ulcvwy0yvve0pvu5skq0kjargvhwe",
                "balance": "0x30f1a8ebe2ec1b6d8"
            },
            {
                "address": "one103q7qe5t2505lypvltkqtddaef5tzfxwsse4z7",
                "balance": "0x376322519535f6dbb"
            }
        ]
    }
}

API v2

Parameters

uint64 - epoch number

Returns

shardID - Uint32 - shard id
validators - Array : list of validators in below format
- address - String : one address
- balance - Number : validator current balance (will be replaced with stake soon)

Sample Curl Request

curl -d '{
    "jsonrpc":"2.0",
    "method":"hmyv2_getValidators",
    "params":[0],
    "id":1

}' -H "Content-Type: application/json" -X POST "https://api.s0.b.hmny.io"

Sample Curl Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "shardID": 0,
        "validators": [
            {
                "address": "one1pdv9lrdwl0rg5vglh4xtyrv3wjk3wsqket7zxy",
                "balance": 100000000000000000
            },
            {
                "address": "one12fuf7x9rgtdgqg7vgq0962c556m3p7afsxgvll",
                "balance": 100000000000000000
            },
            {
                "address": "one1pf75h0t4am90z8uv3y0dgunfqp4lj8wr3t5rsp",
                "balance": 100000000000000000
            },
            {
                "address": "one1spshr72utf6rwxseaz339j09ed8p6f8ke370zj",
                "balance": 100000000000000000
            },
            {
                "address": "one1d2rngmem4x2c6zxsjjz29dlah0jzkr0k2n88wc",
                "balance": 100000000000000000
            },
            {
                "address": "one1a50tun737ulcvwy0yvve0pvu5skq0kjargvhwe",
                "balance": 100000000000000000
            },
            {
                "address": "one103q7qe5t2505lypvltkqtddaef5tzfxwsse4z7",
                "balance": 100000000000000000
            }
        ]
    }
}

hmy_getSignedBlocks

Description

hmy_getSigned blocks returns number of blocks out of last 1500 validator has signed

Parameters

String - validator one address ("one1...")

Returns

Number - total number of signed blocks out of last 1500 blocks

Sample Curl Request

Sample Curl Response

hmy_isBlockSigner

Description

hmy_isBlockSigner returns true is validator signed a particular block or not

API v1

Parameters

String - block number in string 0x format
String - validator one address ("one1...")

Returns

Bool - true if validator signed block, false otherwise

Sample Curl Request

Sample Curl Response

API v2

Parameters

Number - block number
String - validator one address ("one1...")

Returns

Bool - true if validator signed block, false otherwise

Sample Curl Request

Sample Curl Response

hmy_getBlockSigners

Description

hmy_getBlocksSigners returns list of block signers

API v1

Parameters

String - block number in string 0x format

Returns

Array of String: one addresses list of validators who signed this block

Sample Curl Request

Sample Curl Response

API v2

Parameters

Number - block number

Returns

Array of String: one addresses list of validators who signed this block

Sample Curl Request

Sample Curl Response

Tracing Methods

trace_block

Get the block trace information

Returns

Json containing block trace information

Sample Curl Request

Sample Curl Response

trace_transaction

trace_block

Get the transaction trace information

Returns

JSON containing the trace information

Sample Curl Request

Sample Curl Response

Sample Code

This page provides examples of using the RPC methods in this section.

Setting Up an Account

const mnes = 'urge clog right example dish drill card maximum mix bachelor section select';
const password = 'some phrase';
const added_mnemonic = harmony.wallet.addByMnemonic(mnes, 0);
await harmony.wallet.encryptAccount(added_mnemonic.address, password);

Creating a Transaction Object

const txn_object = {
    nonce: id,
    gasPrice: new Unit(0).asWei().toWei(),
    gasLimit: new Unit(21000).asWei().toWei(),
    shardID: 0,
    to: getAddress('one129r9pj3sk0re76f7zs3qz92rggmdgjhtwge62k').checksum,
    value: new Unit('1000000000000000000').asWei().toWei(),
    data: '0x',
};

hmy_sendRawTransaction

const txn = harmony.transactions.newTx(txn_object);
const signed = await harmony.wallet.signTransaction(txn, harmony.wallet.signer, password);
console.log(signed.getRawTransaction());
const [Transaction, hash] = await signed.sendTransaction();
const confirmed = await Transaction.confirm(hash);
console.log('Transaction Receipt', confirmed.receipt);
if (confirmed.isConfirmed()) {
  console.log('transaction did go through');
}