logo

Chain API

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

1
GET /api/blockChain/block
ParameterTypeDescriptionDefault
blockHashstringBlock hash (optional)
includeTransactionsbooleanInclude 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.#

    1
    GET /api/blockChain/blockByHeight
    ParameterTypeDescriptionDefault
    blockHeightintegerBlock height (optional)
    includeTransactionsbooleanInclude 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.#

    1
    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.#

    1
    GET /api/blockChain/blockState
    ParameterTypeDescription
    blockHashstringBlock 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.#

    1
    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.#

    1
    GET /api/blockChain/contractFileDescriptorSet
    ParameterTypeDescription
    addressstringContract 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.#

    1
    POST /api/blockChain/executeRawTransaction

    Parameters#

    TypeNameSchema
    BodyinputExecuteRawTransactionDto (optional)

    Responses#

    HTTP CodeDescriptionSchema
    200Successstring

    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.#

    1
    POST /api/blockChain/executeTransaction

    Parameters#

    TypeNameSchema
    BodyinputExecuteTransactionDto (optional)

    Responses#

    HTTP CodeDescriptionSchema
    200Successstring

    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.#

    1
    GET /api/blockChain/merklePathByTransactionId

    Parameters#

    TypeNameSchema
    QuerytransactionIdstring (optional)

    Responses#

    HTTP CodeDescriptionSchema
    200SuccessMerklePathDto

    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.#

    1
    POST /api/blockChain/rawTransaction

    Parameters#

    TypeNameSchema
    BodyinputCreateRawTransactionInput (optional)

    Responses#

    HTTP CodeDescriptionSchema
    200SuccessCreateRawTransactionOutput

    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.#

    1
    POST /api/blockChain/sendRawTransaction

    Parameters#

    TypeNameSchema
    BodyinputSendRawTransactionInput (optional)

    Responses#

    HTTP CodeDescriptionSchema
    200SuccessSendRawTransactionOutput

    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#

    1
    POST /api/blockChain/sendTransaction

    Parameters#

    TypeNameSchemaDescriptionRequired
    BodyinputSendTransactionInput-No

    Responses#

    HTTP CodeDescriptionSchema
    200SuccessSendTransactionOutput

    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#

    1
    POST /api/blockChain/sendTransactions

    Parameters#

    TypeNameSchemaDescriptionRequired
    BodyinputSendTransactionsInput-No

    Responses#

    HTTP CodeDescriptionSchema
    200Success<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#

    1
    POST /api/blockChain/calculateTransactionFee

    Parameters#

    TypeNameSchemaDescriptionRequired
    BodyinputCalculateTransactionFeeInput-No

    Responses#

    HTTP CodeDescriptionSchema
    200SuccessCalculateTransactionFeeOutput

    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#

    1
    GET /api/blockChain/transactionResult

    Parameters#

    TypeNameSchemaDescriptionRequired
    QuerytransactionIdstringTransaction IDNo

    Responses#

    HTTP CodeDescriptionSchema
    200SuccessTransactionResultDto

    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#

    1
    GET /api/blockChain/transactionPoolStatus

    Responses#

    HTTP CodeDescriptionSchema
    200SuccessGetTransactionPoolStatusOutput

    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#

    1
    GET /api/blockChain/transactionResult

    Parameters#

    TypeNameDescriptionSchema
    QuerytransactionIdOptional. Transaction IDstring

    Responses#

    HTTP CodeDescriptionSchema
    200SuccessTransactionResultDto

    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#

    1
    GET /api/blockChain/transactionResults

    Parameters#

    TypeNameDescriptionSchemaDefault
    QueryblockHashOptional. Block hashstring
    QuerylimitOptional. Limit resultsinteger (int32)10
    QueryoffsetOptional. Offset for paginationinteger (int32)

    Responses#

    HTTP CodeDescriptionSchema
    200SuccessTransactionResultDto[]

    Produces#

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

    • Tags#

  • BlockChain

    • Edited on: 16 July 2024 04:34:28 GMT+0