Schedule Transactions

Overview

The Scheduled Transactions endpoints in the Hedera Mirror Node REST API allows developers to query scheduled transactions on the Hedera network. These endpoints are essential for tracking transaction scheduling, execution status, and metadata related to scheduled transactions.

Endpoints

The following endpoints are available for the Scheduled Transactions object:

Endpoint	Description
GET /api/v1/schedules	Retrieves a list of scheduled transactions on the network.
GET /api/v1/schedules/{id}	Fetches details of a specific scheduled transaction by ID.

Schedule Transactions

List schedules entities

get

Lists schedules on the network that govern the execution logic of scheduled transactions. This includes executed and non executed schedules.

Query parameters

account.idstringOptional

The ID of the account to return information for

Example: {"summary":"--","value":""}Pattern: ^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$

limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return

Default: 25Example: 2

orderundefined · enumOptional

The order in which items are listed

Default: ascExample: descPossible values:

schedule.idstringOptional

The ID of the schedule to return information for

Example: {"summary":"--","value":""}Pattern: ^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$

Responses

200

OK

application/json

400

Invalid parameter

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/schedules HTTP/1.1
Host: 
Accept: */*

{
  "schedules": [
    {
      "admin_key": {
        "_type": "ProtobufEncoded",
        "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"
      },
      "consensus_timestamp": "1586567700.453054000",
      "creator_account_id": "0.0.2",
      "deleted": false,
      "executed_timestamp": "1586567700.453054000",
      "expiration_time": "1586567700.453054000",
      "memo": "created on 02/10/2021",
      "payer_account_id": "0.0.2",
      "schedule_id": "0.0.2",
      "signatures": [
        {
          "consensus_timestamp": "1586567700.453054000",
          "public_key_prefix": "AAEBAwuqAwzB",
          "signature": "3q2+7wABAQMLqgMMwQ==",
          "type": "ED25519"
        }
      ],
      "transaction_body": "Kd6tvu8=",
      "wait_for_expiry": true
    }
  ],
  "links": {
    "next": null
  }
}

Response Details

Response Item	Description
schedules	List of schedules
admin_key	The admin key on the schedule
admin_key_type	The type of key
admin_key_key	The admin public key
consensus_timestamp	The consensus timestamp of when the schedule was created
creator_account_id	The account ID of the creator of the schedule
executed_timestamp	The timestamp at which the transaction that was scheduled was executed at
memo	A string of characters associated with the memo if set
payer_account_id	The account ID of the account paying for the execution of the transaction
schedule_id	The ID of the schedule entity
signatures	The list of keys that signed the transaction
signatures.public_key_prefix	The signatures public key prefix
signatures.signature	The signature of the key that signed the schedule transaction
signatures.type	The type of signature (ED5519 or ECDSA)
transaction_body	The transaction body of the transaction that was scheduled. The transaction body is base64 encoded binary protobuf data. Deserialize the data by using the ScheduleableTransactionBody proto parser.
wait_for_expiry	Whether or not the schedule transaction specified a specific time to expire by
links.next	Hyperlink to the next page of results

Get schedule by id

get

Returns schedule information based on the given schedule id

Path parameters

scheduleIdstring | nullableRequired

Network entity ID in the format of shard.realm.num

Example: 0.0.2Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

Responses

200

OK

application/json

400

Invalid parameter

application/json

404

Not Found

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/schedules/{scheduleId} HTTP/1.1
Host: 
Accept: */*

{
  "admin_key": {
    "_type": "ProtobufEncoded",
    "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"
  },
  "consensus_timestamp": "1586567700.453054000",
  "creator_account_id": "0.0.2",
  "deleted": false,
  "executed_timestamp": "1586567700.453054000",
  "expiration_time": "1586567700.453054000",
  "memo": "created on 02/10/2021",
  "payer_account_id": "0.0.2",
  "schedule_id": "0.0.2",
  "signatures": [
    {
      "consensus_timestamp": "1586567700.453054000",
      "public_key_prefix": "AAEBAwuqAwzB",
      "signature": "3q2+7wABAQMLqgMMwQ==",
      "type": "ED25519"
    }
  ],
  "transaction_body": "Kd6tvu8=",
  "wait_for_expiry": true
}

Response Details

Response Item	Description
adminKey	The admin key on the schedule
adminKey._type	The type of key
adminKey.key	The admin public key
consensus_timestamp	The consensus timestamp of when the schedule was created
creator_account_id	The account ID of the creator of the schedule
executed_timestamp	The timestamp at which the transaction that was scheduled was executed at
memo	A string of characters associated with the memo if set
payer_account_id	The account ID of the account paying for the execution of the transaction
schedule_id	The ID of the schedule entity
signatures	The list of keys that signed the transaction
signatures.consensus_timestamp	The consensus timestamp at which the signature was added
signatures.public_key_prefix	The signatures public key prefix
signatures.signature	The signature of the key that signed the schedule transaction
signatures.type	The type of signature (ED5519 or ECDSA)
transaction_body	The transaction body of the transaction that was scheduled. The transaction body is base64 encoded binary protobuf data. Deserialize the data by using the ScheduleableTransactionBody proto parser.
wait_for_expiry	Whether or not the schedule transaction specified a specific time to expire by