Sign in

v1

latestOpenAPI 3.0.02026-07-17224996.6 KB
Transactions

Get a Transaction Result by transaction ID or scheduled transaction ID.

Get transaction result by the transaction's ID. If the transaction is a scheduled transaction, it can alternatively be retrieved by the scheduled transaction ID field returned by the system contract.

get/transaction_results/{transaction_id}

Path parameters

transaction_idstring required

A transaction identifier. This may be a 64-character hex-encoded transaction ID (e.g. a1b2c3...) or a uint64 scheduled transaction ID returned by the system contract.

Query parameters

block_idstring hexadecimal

A 32-byte unique identifier for an entity.

A block ID optional parameter

collection_idstring hexadecimal

A 32-byte unique identifier for an entity.

A collection ID optional parameter.

expandstring[]

A comma-separated list indicating which properties of the content to expand.

selectstring[]

A comma-separated list indicating which properties of the content to return.

agreeing_executors_countstring uint64

A minimum number of execution receipts for the execution result.

required_executor_idsIdentifier[]

A set of execution node IDs, one of which must have produced the execution result.

include_executor_metadataboolean

Specifies whether or not to include the executor metadata in the response.

Response

OK

block_idstring hexadecimal required

A 32-byte unique identifier for an entity.

collection_idstring hexadecimal required

A 32-byte unique identifier for an entity.

execution'Pending' | 'Success' | 'Failure'

This value indicates whether the transaction execution succeded or not, this value should be checked when determining transaction success.

status'Pending' | 'Finalized' | 'Executed' | 'Sealed' | 'Expired' required

This value indicates the state of the transaction execution. Only sealed and expired are final and immutable states.

status_codeinteger required
error_messagestring required

Provided transaction error in case the transaction wasn't successful.

computation_usedstring uint64 required

Example response

{
  "collection_id": null,
  "error_message": "error_message",
  "execution": "Pending",
  "metadata": {
    "executor_metadata": {
      "execution_result_id": null,
      "executor_ids": [
        null,
        null
      ]
    }
  },
  "status_code": 0,
  "_links": {
    "_self": "_self"
  },
  "block_id": null,
  "computation_used": "computation_used",
  "events": [
    {
      "transaction_id": null,
      "payload": "",
      "transaction_index": "transaction_index",
      "type": "type",
      "event_index": "event_index"
    },
    {
      "transaction_id": null,
      "payload": "",
      "transaction_index": "transaction_index",
      "type": "type",
      "event_index": "event_index"
    }
  ],
  "status": "Pending"
}