Ethereum Core API

Summary

Returns a list of addresses owned by client.

Params

None

Result

Addresses owned by the client.

bytes

string

Hex representation of a variable length byte array

Pattern:

^0x([a-fA-F0-9]?)+$

Summary

Returns the number of most recent block.

Params

None

Result

blockNumberOrTag

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

blockNumberTag

string

The optional block height description

Summary

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

Params

• keccakOrPending

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

  null

  null

  Null

• blockNumberOrNull

  The block number or null when its the pending block

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

• transactionGas

  The gas limit provided by the sender in Wei

• transactionGasPrice

  The gas price willing to be paid by the sender in Wei

• keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• transactionInput

  The data field sent with the transaction

• transactionNonce

  The total number of prior transactions made by the sender

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

• To

  Destination address of the transaction. Null if it was a contract create.

  address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

  null

  null

  Null

• integerOrNull

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• transactionValue

  Value of Ether being transferred in Wei

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• transactionSigV

  ECDSA recovery id

• transactionSigR

  ECDSA signature r

• transactionSigS

  ECDSA signature s

blockNumberOrTag

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

blockNumberTag

string

The optional block height description

Result

returnValue

The return value of the executed contract

bytes

string

Hex representation of a variable length byte array

Pattern:

^0x([a-fA-F0-9]?)+$

Summary

Returns the currently configured chain id

Description

Returns the currently configured chain id, a value used in replay-protected transaction signing as introduced by [EIP-155](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-155.md).

Params

None

Result

chainId

hex format integer of the current chain id. Defaults are ETC=61, ETH=1, Morden=62.

chainId

string

Pattern:

^0x[a-fA-F\d]+$

Summary

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. Note that the estimate may be significantly more than the amount of gas actually used by the transaction, for a variety of reasons including EVM mechanics and node performance.

Params

• keccakOrPending

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

  null

  null

  Null

• blockNumberOrNull

  The block number or null when its the pending block

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

• transactionGas

  The gas limit provided by the sender in Wei

• transactionGasPrice

  The gas price willing to be paid by the sender in Wei

• keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• transactionInput

  The data field sent with the transaction

• transactionNonce

  The total number of prior transactions made by the sender

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

• To

  Destination address of the transaction. Null if it was a contract create.

  address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

  null

  null

  Null

• integerOrNull

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• transactionValue

  Value of Ether being transferred in Wei

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• transactionSigV

  ECDSA recovery id

• transactionSigR

  ECDSA signature r

• transactionSigS

  ECDSA signature s

Result

gasUsed

The amount of gas used

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

Summary

Returns the current price per gas in wei

Params

None

Result

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

Summary

Returns Ether balance of a given or account or contract

Params

The address of the account or contract

address

string

Pattern:

^0x[a-fA-F\d]{40}$

A BlockNumber at which to request the balance

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

Result

getBalanceResult

integerOrNull

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

null

null

Null

Summary

Gets a block for a given hash

Params

blockHash

string

The hex representation of the Keccak 256 of the RLP encoded block

Pattern:

^0x[a-fA-F\d]{64}$

If `true` it returns the full transaction objects, if `false` only the hashes of the transactions.

isTransactionsIncluded

boolean

Result

getBlockByHashResult

blockOrNull

The Block is the collection of relevant pieces of information (known as the block header), together with information corresponding to the comprised transactions, and a set of other block headers that are known to have a parent equal to the present block’s parent’s parent.

• blockNumberOrNull

  The block number or null when its the pending block

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• keccakOrPending

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

  null

  null

  Null

• blockHash

  string

  The hex representation of the Keccak 256 of the RLP encoded block

  Pattern:

  ^0x[a-fA-F\d]{64}$

• nonceOrNull

  Randomly selected number to satisfy the proof-of-work or null when its the pending block

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• blockShaUncles

  Keccak hash of the uncles data in the block

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• blockLogsBloom

  The bloom filter for the logs of the block or null when its the pending block

• blockTransactionsRoot

  The root of the transactions trie of the block.

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• blockStateRoot

  The root of the final state trie of the block

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• blockReceiptsRoot

  The root of the receipts trie of the block

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• addressOrNull

  address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

  null

  null

  Null

• blockDifficulty

  Integer of the difficulty for this block

• blockTotalDifficulty

  Integer of the total difficulty of the chain until this block

  integerOrNull

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• blockExtraData

  The 'extra data' field of this block

• blockSize

  Integer the size of this block in bytes

• blockGasLimit

  The maximum gas allowed in this block

• blockGasUsed

  The total used gas by all transactions in this block

• blockTimeStamp

  The unix timestamp for when the block was collated

• transactionsOrHashes

  Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter

• uncleHashes

  Array of uncle hashes

null

null

Null

Summary

Gets a block for a given number

Params

blockNumberOrTag

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

blockNumberTag

string

The optional block height description

If `true` it returns the full transaction objects, if `false` only the hashes of the transactions.

isTransactionsIncluded

boolean

Result

getBlockByNumberResult

blockOrNull

The Block is the collection of relevant pieces of information (known as the block header), together with information corresponding to the comprised transactions, and a set of other block headers that are known to have a parent equal to the present block’s parent’s parent.

• blockNumberOrNull

  The block number or null when its the pending block

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• keccakOrPending

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

  null

  null

  Null

• blockHash

  string

  The hex representation of the Keccak 256 of the RLP encoded block

  Pattern:

  ^0x[a-fA-F\d]{64}$

• nonceOrNull

  Randomly selected number to satisfy the proof-of-work or null when its the pending block

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• blockShaUncles

  Keccak hash of the uncles data in the block

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• blockLogsBloom

  The bloom filter for the logs of the block or null when its the pending block

• blockTransactionsRoot

  The root of the transactions trie of the block.

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• blockStateRoot

  The root of the final state trie of the block

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• blockReceiptsRoot

  The root of the receipts trie of the block

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• addressOrNull

  address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

  null

  null

  Null

• blockDifficulty

  Integer of the difficulty for this block

• blockTotalDifficulty

  Integer of the total difficulty of the chain until this block

  integerOrNull

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• blockExtraData

  The 'extra data' field of this block

• blockSize

  Integer the size of this block in bytes

• blockGasLimit

  The maximum gas allowed in this block

• blockGasUsed

  The total used gas by all transactions in this block

• blockTimeStamp

  The unix timestamp for when the block was collated

• transactionsOrHashes

  Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter

• uncleHashes

  Array of uncle hashes

null

null

Null

Summary

Returns the number of transactions in a block from a block matching the given block hash.

Params

blockHash

string

The hex representation of the Keccak 256 of the RLP encoded block

Pattern:

^0x[a-fA-F\d]{64}$

Result

blockTransactionCountByHash

The Number of total transactions in the given block

integerOrNull

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

null

null

Null

Summary

Returns the number of transactions in a block from a block matching the given block number.

Params

blockNumberOrTag

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

blockNumberTag

string

The optional block height description

Result

blockTransactionCountByHash

The Number of total transactions in the given block

integerOrNull

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

null

null

Null

Summary

Returns code at a given contract address

Params

The address of the contract

address

string

Pattern:

^0x[a-fA-F\d]{40}$

A BlockNumber of which the code existed

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

Result

bytes

bytes

string

Hex representation of a variable length byte array

Pattern:

^0x([a-fA-F0-9]?)+$

Summary

Returns an array of all logs matching a given filter object.

Params

A filter used to monitor the blockchain for log/events

• integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

• integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

• oneOrArrayOfAddresses

• Topics are order-dependent. Each topic can also be an array of DATA with 'or' options.

  dataWord

  string

  Hex representation of a 256 bit unit of data

  Pattern:

  ^0x([a-fA-F\d]{64})?$

Result

An array of all logs matching filter with given id.

An indexed event generated during a transaction

• LogAddress

  Sender of the transaction

  address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

• blockHash

  string

  The hex representation of the Keccak 256 of the RLP encoded block

  Pattern:

  ^0x[a-fA-F\d]{64}$

• integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

• LogData

  The data/input string sent along with the transaction

  bytes

  string

  Hex representation of a variable length byte array

  Pattern:

  ^0x([a-fA-F0-9]?)+$

• LogIndex

  The index of the event within its transaction, null when its pending

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

• logIsRemoved

  Whether or not the log was orphaned off the main chain

• Topics are order-dependent. Each topic can also be an array of DATA with 'or' options.

  dataWord

  string

  Hex representation of a 256 bit unit of data

  Pattern:

  ^0x([a-fA-F\d]{64})?$

• keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• integerOrNull

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

Summary

Gets a storage value from a contract address, a position, and an optional blockNumber

Params

address

string

Pattern:

^0x[a-fA-F\d]{40}$

position

string

Hex representation of the storage slot where the variable exists

Pattern:

^0x([a-fA-F0-9]?)+$

blockNumberOrTag

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

blockNumberTag

string

The optional block height description

Result

dataWord

dataWord

string

Hex representation of a 256 bit unit of data

Pattern:

^0x([a-fA-F\d]{64})?$

Summary

Returns the information about a transaction requested by the block hash and index of which it was mined.

Params

blockHash

string

The hex representation of the Keccak 256 of the RLP encoded block

Pattern:

^0x[a-fA-F\d]{64}$

The ordering in which a transaction is mined within its block.

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

Result

Returns a transaction or null

TransactionOrNull

• keccakOrPending

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

  null

  null

  Null

• blockNumberOrNull

  The block number or null when its the pending block

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

• transactionGas

  The gas limit provided by the sender in Wei

• transactionGasPrice

  The gas price willing to be paid by the sender in Wei

• keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• transactionInput

  The data field sent with the transaction

• transactionNonce

  The total number of prior transactions made by the sender

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

• To

  Destination address of the transaction. Null if it was a contract create.

  address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

  null

  null

  Null

• integerOrNull

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• transactionValue

  Value of Ether being transferred in Wei

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• transactionSigV

  ECDSA recovery id

• transactionSigR

  ECDSA signature r

• transactionSigS

  ECDSA signature s

null

null

Null

Summary

Returns the information about a transaction requested by the block number and index of which it was mined.

Params

blockNumberOrTag

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

blockNumberTag

string

The optional block height description

The ordering in which a transaction is mined within its block.

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

Result

Returns a transaction or null

TransactionOrNull

• keccakOrPending

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

  null

  null

  Null

• blockNumberOrNull

  The block number or null when its the pending block

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

• transactionGas

  The gas limit provided by the sender in Wei

• transactionGasPrice

  The gas price willing to be paid by the sender in Wei

• keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• transactionInput

  The data field sent with the transaction

• transactionNonce

  The total number of prior transactions made by the sender

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

• To

  Destination address of the transaction. Null if it was a contract create.

  address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

  null

  null

  Null

• integerOrNull

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• transactionValue

  Value of Ether being transferred in Wei

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• transactionSigV

  ECDSA recovery id

• transactionSigR

  ECDSA signature r

• transactionSigS

  ECDSA signature s

null

null

Null

Summary

Returns the information about a transaction requested by transaction hash.

Params

keccak

string

Hex representation of a Keccak 256 hash

Pattern:

^0x[a-fA-F\d]{64}$

Result

Returns a transaction or null

TransactionOrNull

• keccakOrPending

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

  null

  null

  Null

• blockNumberOrNull

  The block number or null when its the pending block

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

• transactionGas

  The gas limit provided by the sender in Wei

• transactionGasPrice

  The gas price willing to be paid by the sender in Wei

• keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• transactionInput

  The data field sent with the transaction

• transactionNonce

  The total number of prior transactions made by the sender

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

• To

  Destination address of the transaction. Null if it was a contract create.

  address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

  null

  null

  Null

• integerOrNull

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• transactionValue

  Value of Ether being transferred in Wei

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• transactionSigV

  ECDSA recovery id

• transactionSigR

  ECDSA signature r

• transactionSigS

  ECDSA signature s

null

null

Null

Summary

Returns the number of transactions sent from an address

Params

address

string

Pattern:

^0x[a-fA-F\d]{40}$

blockNumberOrTag

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

blockNumberTag

string

The optional block height description

Result

transactionCount

nonceOrNull

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

null

null

Null

Summary

Returns the receipt information of a transaction by its hash.

Params

keccak

string

Hex representation of a Keccak 256 hash

Pattern:

^0x[a-fA-F\d]{64}$

Result

transactionReceiptResult

returns either a receipt or null

transactionReceiptOrNull

The receipt of a transaction

• blockHash

  string

  The hex representation of the Keccak 256 of the RLP encoded block

  Pattern:

  ^0x[a-fA-F\d]{64}$

• integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

• ReceiptContractAddress

  The contract address created, if the transaction was a contract creation, otherwise null

  addressOrNull

  address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

  null

  null

  Null

• ReceiptCumulativeGasUsed

  The gas units used by the transaction

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

• address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

• ReceiptGasUsed

  The total gas used by the transaction

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

• logs

  An array of all the logs triggered during the transaction

• bloomFilter

  string

  A 2048 bit bloom filter from the logs of the transaction. Each log sets 3 bits though taking the low-order 11 bits of each of the first three pairs of bytes in a Keccak 256 hash of the log's byte series

• To

  Destination address of the transaction. Null if it was a contract create.

  address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

  null

  null

  Null

• keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• integerOrNull

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• ReceiptPostTransactionState

  The intermediate stateRoot directly after transaction execution.

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• ReceiptStatus

  Whether or not the transaction threw an error.

null

null

Null

Summary

Returns information about a uncle of a block by hash and uncle index position.

Params

blockHash

string

The hex representation of the Keccak 256 of the RLP encoded block

Pattern:

^0x[a-fA-F\d]{64}$

The ordering in which a uncle is included within its block.

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

Result

uncle

blockOrNull

The Block is the collection of relevant pieces of information (known as the block header), together with information corresponding to the comprised transactions, and a set of other block headers that are known to have a parent equal to the present block’s parent’s parent.

• blockNumberOrNull

  The block number or null when its the pending block

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• keccakOrPending

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

  null

  null

  Null

• blockHash

  string

  The hex representation of the Keccak 256 of the RLP encoded block

  Pattern:

  ^0x[a-fA-F\d]{64}$

• nonceOrNull

  Randomly selected number to satisfy the proof-of-work or null when its the pending block

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• blockShaUncles

  Keccak hash of the uncles data in the block

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• blockLogsBloom

  The bloom filter for the logs of the block or null when its the pending block

• blockTransactionsRoot

  The root of the transactions trie of the block.

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• blockStateRoot

  The root of the final state trie of the block

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• blockReceiptsRoot

  The root of the receipts trie of the block

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• addressOrNull

  address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

  null

  null

  Null

• blockDifficulty

  Integer of the difficulty for this block

• blockTotalDifficulty

  Integer of the total difficulty of the chain until this block

  integerOrNull

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• blockExtraData

  The 'extra data' field of this block

• blockSize

  Integer the size of this block in bytes

• blockGasLimit

  The maximum gas allowed in this block

• blockGasUsed

  The total used gas by all transactions in this block

• blockTimeStamp

  The unix timestamp for when the block was collated

• transactionsOrHashes

  Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter

• uncleHashes

  Array of uncle hashes

null

null

Null

Summary

Returns information about a uncle of a block by hash and uncle index position.

Params

The block in which the uncle was included

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

The ordering in which a uncle is included within its block.

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

Result

uncleResult

returns an uncle block or null

blockOrNull

The Block is the collection of relevant pieces of information (known as the block header), together with information corresponding to the comprised transactions, and a set of other block headers that are known to have a parent equal to the present block’s parent’s parent.

• blockNumberOrNull

  The block number or null when its the pending block

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• keccakOrPending

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

  null

  null

  Null

• blockHash

  string

  The hex representation of the Keccak 256 of the RLP encoded block

  Pattern:

  ^0x[a-fA-F\d]{64}$

• nonceOrNull

  Randomly selected number to satisfy the proof-of-work or null when its the pending block

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• blockShaUncles

  Keccak hash of the uncles data in the block

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• blockLogsBloom

  The bloom filter for the logs of the block or null when its the pending block

• blockTransactionsRoot

  The root of the transactions trie of the block.

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• blockStateRoot

  The root of the final state trie of the block

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• blockReceiptsRoot

  The root of the receipts trie of the block

  keccak

  string

  Hex representation of a Keccak 256 hash

  Pattern:

  ^0x[a-fA-F\d]{64}$

• addressOrNull

  address

  string

  Pattern:

  ^0x[a-fA-F\d]{40}$

  null

  null

  Null

• blockDifficulty

  Integer of the difficulty for this block

• blockTotalDifficulty

  Integer of the total difficulty of the chain until this block

  integerOrNull

  integer

  string

  Hex representation of the integer

  Pattern:

  ^0x[a-fA-F0-9]+$

  null

  null

  Null

• blockExtraData

  The 'extra data' field of this block

• blockSize

  Integer the size of this block in bytes

• blockGasLimit

  The maximum gas allowed in this block

• blockGasUsed

  The total used gas by all transactions in this block

• blockTimeStamp

  The unix timestamp for when the block was collated

• transactionsOrHashes

  Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter

• uncleHashes

  Array of uncle hashes

null

null

Null

Summary

Returns the number of uncles in a block from a block matching the given block hash.

Params

blockHash

string

The hex representation of the Keccak 256 of the RLP encoded block

Pattern:

^0x[a-fA-F\d]{64}$

Result

uncleCountResult

The Number of total uncles in the given block

integerOrNull

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

null

null

Null

Summary

Returns the number of uncles in a block from a block matching the given block number.

Params

blockNumberOrTag

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

blockNumberTag

string

The optional block height description

Result

The Number of total uncles in the given block

integerOrNull

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

null

null

Null

Summary

Returns the account- and storage-values of the specified account including the Merkle-proof.

Params

The address of the account or contract

address

string

Pattern:

^0x[a-fA-F\d]{40}$

storageKeys

A storage key is indexed from the solidity compiler by the order it is declared. For mappings it uses the keccak of the mapping key with its position (and recursively for X-dimensional mappings)

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

blockNumberOrTag

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

blockNumberTag

string

The optional block height description

Result

account

proofAccountOrNull

The merkle proofs of the specified account connecting them to the blockhash of the block specified

Properties

proofAccountAddress

The address of the account or contract of the request

address

string

Pattern:

^0x[a-fA-F\d]{40}$

The set of node values needed to traverse a patricia merkle tree (from root to leaf) to retrieve a value

bytes

string

Hex representation of a variable length byte array

Pattern:

^0x([a-fA-F0-9]?)+$

proofAccountBalance

The Ether balance of the account or contract of the request

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

proofAccountCodeHash

The code hash of the contract of the request (keccak(NULL) if external account)

keccak

string

Hex representation of a Keccak 256 hash

Pattern:

^0x[a-fA-F\d]{64}$

proofAccountNonce

The transaction count of the account or contract of the request

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

proofAccountStorageHash

The storage hash of the contract of the request (keccak(rlp(NULL)) if external account)

keccak

string

Hex representation of a Keccak 256 hash

Pattern:

^0x[a-fA-F\d]{64}$

Current block header PoW hash.

null

null

Null

Summary

Returns the hash of the current block, the seedHash, and the boundary condition to be met ('target').

Params

None

Result

work

Summary

Returns the number of hashes per second that the node is mining with.

Params

None

Result

hashesPerSecond

Integer of the number of hashes per second

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

Summary

Returns true if client is actively mining new blocks.

Params

None

Result

mining

Whether or not the client is mining

boolean

Summary

Returns the current ethereum protocol version.

Params

None

Result

protocolVersion

The current ethereum protocol version

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

Summary

Creates new message call transaction or a contract creation for signed transactions.

Params

The signed transaction data

bytes

string

Hex representation of a variable length byte array

Pattern:

^0x([a-fA-F0-9]?)+$

Result

transactionHash

The transaction hash, or the zero hash if the transaction is not yet available.

keccak

string

Hex representation of a Keccak 256 hash

Pattern:

^0x[a-fA-F\d]{64}$

Summary

Used for submitting a proof-of-work solution.

Params

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

dataWord

string

Hex representation of a 256 bit unit of data

Pattern:

^0x([a-fA-F\d]{64})?$

dataWord

string

Hex representation of a 256 bit unit of data

Pattern:

^0x([a-fA-F\d]{64})?$

Result

solutionValid

returns true if the provided solution is valid, otherwise false.

boolean

Summary

Returns an object with data about the sync status or false.

Params

None

Result

syncing

isSyncingResult

An object with sync status data

Properties

syncingDataStartingBlock

Block at which the import started (will only be reset, after the sync reached his head)

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

syncingDataCurrentBlock

The current block, same as eth_blockNumber

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

syncingDataHighestBlock

The estimated highest block

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

syncingDataKnownStates

The known states

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$

syncingDataPulledStates

The pulled states

integer

string

Hex representation of the integer

Pattern:

^0x[a-fA-F0-9]+$