Get information about a given block by block hash. Optionally with the list of its transactions.
GET /api/blockChain/block
Type
Name
Description
Schema
Default
Query
blockHash
optional
block hash
string
Query
include Transactions
optional
include transactions or not
boolean
"false"
HTTP Code
Description
Schema
200
Success
BlockDto
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Get information about a given block by block height. Optionally with the list of its transactions.
GET /api/blockChain/blockByHeight
Type
Name
Description
Schema
Default
Query
blockHeight
optional
block height
integer (int64)
Query
include Transactions
optional
include transactions or not
boolean
"false"
HTTP Code
Description
Schema
200
Success
BlockDto
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Get the height of the current chain.
GET /api/blockChain/blockHeight
HTTP Code
Description
Schema
200
Success
integer (int64)
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Get the current state about a given block
GET /api/blockChain/blockState
Type
Name
Description
Schema
Query
blockHash optional
block hash
string
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Get the current status of the block chain.
GET /api/blockChain/chainStatus
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Get the protobuf definitions related to a contract
GET /api/blockChain/contractFileDescriptorSet
Type
Name
Description
Schema
Query
address optional
contract address
string
HTTP Code
Description
Schema
200
Success
string (byte)
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
POST /api/blockChain/executeRawTransaction
HTTP Code
Description
Schema
200
Success
string
application/json-patch+json; v=1.0
application/json; v=1.0
text/json; v=1.0
application/*+json; v=1.0
application/x-protobuf; v=1.0
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Call a read-only method on a contract.
POST /api/blockChain/executeTransaction
HTTP Code
Description
Schema
200
Success
string
application/json-patch+json; v=1.0
application/json; v=1.0
text/json; v=1.0
application/*+json; v=1.0
application/x-protobuf; v=1.0
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Get the merkle path of a transaction.
GET /api/blockChain/merklePathByTransactionId
Type
Name
Schema
Query
transactionId optional
string
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Creates an unsigned serialized transaction
POST /api/blockChain/rawTransaction
application/json-patch+json; v=1.0
application/json; v=1.0
text/json; v=1.0
application/*+json; v=1.0
application/x-protobuf; v=1.0
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
POST /api/blockChain/sendRawTransaction
application/json-patch+json; v=1.0
application/json; v=1.0
text/json; v=1.0
application/*+json; v=1.0
application/x-protobuf; v=1.0
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
POST /api/blockChain/sendTransaction
application/json-patch+json; v=1.0
application/json; v=1.0
text/json; v=1.0
application/*+json; v=1.0
application/x-protobuf; v=1.0
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Broadcast multiple transactions
POST /api/blockChain/sendTransactions
HTTP Code
Description
Schema
200
Success
< string > array
application/json-patch+json; v=1.0
application/json; v=1.0
text/json; v=1.0
application/*+json; v=1.0
application/x-protobuf; v=1.0
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
POST /api/blockChain/calculateTransactionFee
application/json-patch+json; v=1.0
application/json; v=1.0
text/json; v=1.0
application/*+json; v=1.0
application/x-protobuf; v=1.0
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
GET /api/blockChain/taskQueueStatus
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Get the transaction pool status.
GET /api/blockChain/transactionPoolStatus
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Get the current status of a transaction
GET /api/blockChain/transactionResult
Type
Name
Description
Schema
Query
transactionId optional
transaction id
string
The transaction result DTO object returned contains the transaction that contains the parameter values used for the call. The node will return the byte array as a base64 encoded string if it can’t decode it.
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Get multiple transaction results.
GET /api/blockChain/transactionResults
Type
Name
Description
Schema
Default
Query
blockHash optional
block hash
string
Query
limit optional
limit
integer (int32)
10
Query
offset optional
offset
integer (int32)
0
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Get information about the node’s connection to the network.
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Attempts to add a node to the connected network nodes
HTTP Code
Description
Schema
200
401
Success
Unauthorized
boolean
application/json-patch+json; v=1.0
application/json; v=1.0
text/json; v=1.0
application/*+json; v=1.0
application/x-protobuf; v=1.0
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Attempts to remove a node from the connected network nodes
Type
Name
Description
Schema
Query
address optional
ip address
string
HTTP Code
Description
Schema
200
401
Success
Unauthorized
boolean
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Get peer info about the connected network nodes
Type
Name
Schema
Default
Query
withMetrics optional
boolean
"false"
HTTP Code
Description
Schema
200
Success
< PeerDto > array
text/plain; v=1.0
application/json; v=1.0
text/json; v=1.0
application/x-protobuf; v=1.0
Name
Description
Schema
Address optional
ip address
string
Name
Schema
Transactions optional
< string > array
TransactionsCount optional
integer (int32)
Name
Schema
BlockHash optional
string
Body optional
BlockBodyDto
Header optional
BlockHeaderDto
BlockSize optional
integer (int32)
Name
Schema
Bloom optional
string
ChainId optional
string
Extra optional
string
Height optional
integer (int64)
MerkleTreeRootOfTransactions optional
string
MerkleTreeRootOfWorldState optional
string
MerkleTreeRootOfTransactionState optional
string
PreviousBlockHash optional
string
SignerPubkey optional
string
Time optional
string (date-time)
Name
Schema
BlockHash optional
string
BlockHeight optional
integer (int64)
Changes optional
< string, string > map
Deletes optional
< string > array
PreviousHash optional
string
Name
Schema
BestChainHash optional
string
BestChainHeight optional
integer (int64)
Branches optional
< string, integer (int64) > map
ChainId optional
string
GenesisBlockHash optional
string
GenesisContractAddress optional
string
LastIrreversibleBlockHash optional
string
LastIrreversibleBlockHeight optional
integer (int64)
LongestChainHash optional
string
LongestChainHeight optional
integer (int64)
NotLinkedBlocks optional
< string, string > map
CreateRawTransactionInput
Name
Description
Schema
From required
from address
string
MethodName required
contract method name
string
Params required
contract method parameters
string
RefBlockHash required
refer block hash
string
RefBlockNumber required
refer block height
integer (int64)
To required
to address
string
CreateRawTransactionOutput
Name
Schema
RawTransaction optional
string
Name
Description
Schema
RawTransaction optional
raw transaction
string
Signature optional
signature
string
Name
Description
Schema
RawTransaction optional
raw transaction
string
Name
Description
Schema
Connections optional
total number of open connections between this node and other nodes
integer (int32)
ProtocolVersion optional
network protocol version
integer (int32)
Version optional
node version
string
GetTransactionPoolStatusOutput
Name
Schema
Queued optional
integer (int32)
Validated optional
integer (int32)
Name
Schema
Address optional
string
Indexed optional
< string > array
Name optional
string
NonIndexed optional
string
Name
Schema
Hash optional
string
IsLeftChildNode optional
boolean
Name
Schema
ActualMiningTimes optional
< string (date-time) > array
ExpectedMiningTime optional
string (date-time)
ImpliedIrreversibleBlockHeight optional
integer (int64)
InValue optional
string
MissedBlocks optional
integer (int64)
Order optional
integer (int32)
OutValue optional
string
PreviousInValue optional
string
ProducedBlocks optional
integer (int64)
ProducedTinyBlocks optional
integer (int32)
Name
Schema
BufferedAnnouncementsCount optional
integer (int32)
BufferedBlocksCount optional
integer (int32)
BufferedTransactionsCount optional
integer (int32)
ConnectionTime optional
integer (int64)
Inbound optional
boolean
IpAddress optional
string
ProtocolVersion optional
integer (int32)
RequestMetrics optional
< RequestMetric > array
ConnectionStatus optional
string
NodeVersion optional
string
Name
Schema
Info optional
string
MethodName optional
string
RequestTime optional
Timestamp
RoundTripTime optional
integer (int64)
Name
Schema
Co nfirmedIrreversibleBlockHeight optional
integer (int64)
Confirm edIrreversibleBlockRoundNumber optional
integer (int64)
Ext raBlockProducerOfPreviousRound optional
string
IsMinerListJustChanged optional
boolean
RealTimeMinerInformation optional
< string, MinerInRoundDto > map
RoundId optional
integer (int64)
RoundNumber optional
integer (int64)
TermNumber optional
integer (int64)
Name
Description
Schema
ReturnTransaction optional
return transaction detail or not
boolean
Signature optional
signature
string
Transaction optional
raw transaction
string
Name
Schema
Transaction optional
TransactionDto
TransactionId optional
string
Name
Description
Schema
RawTransaction optional
raw transaction
string
Name
Schema
TransactionId optional
string
Name
Description
Schema
RawTransactions optional
raw transactions
string
Name
Schema
Name optional
string
Size optional
integer (int32)
Name
Schema
Nanos optional
integer (int32)
Seconds optional
integer (int64)
Name
Schema
From optional
string
MethodName optional
string
Params optional
string
RefBlockNumber optional
integer (int64)
RefBlockPrefix optional
string
Signature optional
string
To optional
string
Name
Schema
BlockHash optional
string
BlockNumber optional
integer (int64)
Bloom optional
string
Error optional
string
Logs optional
< LogEventDto > array
ReturnValue optional
string
Status optional
string
Transaction optional
TransactionDto
TransactionId optional
string
TransactionSize optional
integer (int32)
CalculateTransactionFeeInput
Name
Schema
RawTrasaction optional
string
CalculateTransactionFeeOutput
Name
Schema
Success optional
bool
TransactionFee optional
Dictionary<string, long>
ResourceFee optional
Dictionary<string, long>