All pages
Powered by GitBook
1 of 3

Schedules

The Scheduled Transactions endpoints in the Hedera Mirror Node REST API allows developers to query scheduled transactions on the Hedera network.

Reference: https://docs.hedera.com/hedera/sdks-and-apis/rest-api/schedule-transactions

Get Schedules Entities

List schedules entities

This method will use 20 Compute Units.

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: descAvailable options:
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
curl -L \
  --url 'https://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/schedules'
{
  "schedules": [
    {
      "admin_key": {
        "_type": "ProtobufEncoded",
        "key": 10101
      },
      "consensus_timestamp": "1586567700.453054000",
      "creator_account_id": "0.1.2",
      "deleted": false,
      "executed_timestamp": "1586567700.453054000",
      "expiration_time": "1586567700.453054000",
      "memo": "created on 02/10/2021",
      "payer_account_id": "0.1.2",
      "schedule_id": "0.1.2",
      "signatures": [
        {
          "consensus_timestamp": "1586567700.453054000",
          "public_key_prefix": "AAEBAwuqAwzB",
          "signature": "3q2+7wABAQMLqgMMwQ==",
          "type": "ED25519"
        }
      ],
      "transaction_body": "Kd6tvu8=",
      "wait_for_expiry": true
    }
  ],
  "links": {
    "next": "/api/v1/transactions?timestamp=lt:1657598275.517984411"
  }
}

OK

Get Schedule by ID

Returns schedule information based on the given schedule id

This method will use 20 Compute Units.

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.1.2Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$
Responses
curl -L \
  --url 'https://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/schedules/{scheduleId}'
{
  "admin_key": {
    "_type": "ProtobufEncoded",
    "key": 10101
  },
  "consensus_timestamp": "1586567700.453054000",
  "creator_account_id": "0.1.2",
  "deleted": false,
  "executed_timestamp": "1586567700.453054000",
  "expiration_time": "1586567700.453054000",
  "memo": "created on 02/10/2021",
  "payer_account_id": "0.1.2",
  "schedule_id": "0.1.2",
  "signatures": [
    {
      "consensus_timestamp": "1586567700.453054000",
      "public_key_prefix": "AAEBAwuqAwzB",
      "signature": "3q2+7wABAQMLqgMMwQ==",
      "type": "ED25519"
    }
  ],
  "transaction_body": "Kd6tvu8=",
  "wait_for_expiry": true
}

OK