Chain API

Get information about a given block by block hash. Optionally with the list of its transactions.

GET /api/blockChain/block

Parameter	Type	Description	Default
blockHash	string	Block hash (optional)
includeTransactions	boolean	Include transactions (optional)	"false"

Responses

• 200: Success (BlockDto)

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Get information about a given block by block height. Optionally with the list of its transactions.

GET /api/blockChain/blockByHeight

Parameter	Type	Description	Default
blockHeight	integer	Block height (optional)
includeTransactions	boolean	Include transactions (optional)	"false"

Responses

• 200: Success (BlockDto)

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Get the height of the current chain.

GET /api/blockChain/blockHeight

Responses

• 200: Success (integer, int64)

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Get the current state about a given block.

GET /api/blockChain/blockState

Parameter	Type	Description
blockHash	string	Block hash (optional)

Responses

• 200: Success (BlockStateDto)

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Get the current status of the block chain.

GET /api/blockChain/chainStatus

Responses

• 200: Success (ChainStatusDto)

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Get the protobuf definitions related to a contract.

GET /api/blockChain/contractFileDescriptorSet

Parameter	Type	Description
address	string	Contract address (optional)

Responses

• 200: Success (string, byte)

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Execute a raw transaction.

POST /api/blockChain/executeRawTransaction

Parameters

Type	Name	Schema
Body	input	ExecuteRawTransactionDto (optional)

Responses

HTTP Code	Description	Schema
200	Success	string

Consumes

• 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

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Call a read-only method on a contract.

POST /api/blockChain/executeTransaction

Parameters

Type	Name	Schema
Body	input	ExecuteTransactionDto (optional)

Responses

HTTP Code	Description	Schema
200	Success	string

Consumes

• 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

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Get the merkle path of a transaction.

GET /api/blockChain/merklePathByTransactionId

Parameters

Type	Name	Schema
Query	transactionId	string (optional)

Responses

HTTP Code	Description	Schema
200	Success	MerklePathDto

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Creates an unsigned serialized transaction.

POST /api/blockChain/rawTransaction

Parameters

Type	Name	Schema
Body	input	CreateRawTransactionInput (optional)

Responses

HTTP Code	Description	Schema
200	Success	CreateRawTransactionOutput

Consumes

• 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

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Send a transaction.

POST /api/blockChain/sendRawTransaction

Parameters

Type	Name	Schema
Body	input	SendRawTransactionInput (optional)

Responses

HTTP Code	Description	Schema
200	Success	SendRawTransactionOutput

Consumes

• 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

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Broadcast a Transaction

POST /api/blockChain/sendTransaction

Parameters

Type	Name	Schema	Description	Required
Body	input	SendTransactionInput	-	No

Responses

HTTP Code	Description	Schema
200	Success	SendTransactionOutput

Consumes

• 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

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Broadcast Multiple Transactions

POST /api/blockChain/sendTransactions

Parameters

Type	Name	Schema	Description	Required
Body	input	SendTransactionsInput	-	No

Responses

HTTP Code	Description	Schema
200	Success	<string[]>

Consumes

• 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

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Estimate Transaction Fee

POST /api/blockChain/calculateTransactionFee

Parameters

Type	Name	Schema	Description	Required
Body	input	CalculateTransactionFeeInput	-	No

Responses

HTTP Code	Description	Schema
200	Success	CalculateTransactionFeeOutput

Consumes

• 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

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Get the Current Status of a Transaction

GET /api/blockChain/transactionResult

Parameters

Type	Name	Schema	Description	Required
Query	transactionId	string	Transaction ID	No

Responses

HTTP Code	Description	Schema
200	Success	TransactionResultDto

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Get the Transaction Pool Status

GET /api/blockChain/transactionPoolStatus

Responses

HTTP Code	Description	Schema
200	Success	GetTransactionPoolStatusOutput

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Get the Current Status of a Transaction

GET /api/blockChain/transactionResult

Parameters

Type	Name	Description	Schema
Query	transactionId	Optional. Transaction ID	string

Responses

HTTP Code	Description	Schema
200	Success	TransactionResultDto

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain

---

Get Multiple Transaction Results

GET /api/blockChain/transactionResults

Parameters

Type	Name	Description	Schema	Default
Query	blockHash	Optional. Block hash	string
Query	limit	Optional. Limit results	integer (int32)	10
Query	offset	Optional. Offset for pagination	integer (int32)	0

Responses

HTTP Code	Description	Schema
200	Success	TransactionResultDto[]

Produces

• text/plain; v=1.0
• application/json; v=1.0
• text/json; v=1.0
• application/x-protobuf; v=1.0

Tags

• BlockChain