Algod REST API. 4.7.4 to 5.0.0 API CHANGES

v1.0.0

Base URL

https://algo.nownodes.io

This page lists what changed in the Algod REST API between node versions 4.7.4 and 5.0.0. Only removed, added and changed methods are listed. Everything not mentioned here works exactly as described in the main Algod REST API reference.

Removed

POST /v2/teal/dryrun — removed in 5.0.0. Use POST /v2/transactions/simulate instead: it runs a transaction group against the current ledger state and reports the same execution information (opcode budget, logs, state deltas, optional execution trace).

Changed

POST /v2/transactions and POST /v2/transactions/async — new optional query parameter skip-pq-address-check.
POST /v2/transactions/simulate — new response fields group-usage, group-fees-paid and fees-paid.
GET /v2/accounts/{address}, GET /v2/accounts/{address}/applications/{application-id} and GET /v2/applications/{application-id} — application parameters may now carry family-box-access and foreign-box-reads.

About consensus version v42

Node 5.0.0 is the first release that supports consensus version v42 (post-quantum Falcon-1024 signatures, block load tracking, larger transactions and AVM v13). Mainnet upgrades to v42 at round 64318659. The response fields that v42 introduces — family-box-access and foreign-box-reads — are returned only after that round, and only for applications that set them. The new skip-pq-address-check parameter and the new fields of POST /v2/transactions/simulate are available immediately on 5.0.0, before the upgrade.

Authentication

api-keyAuthapiKey

API Key: api-key in header

Changelog algod 4.7.4 to 5.0.0

Accounts

Get account information.

GET

https://algo.nownodes.io/v2/accounts/{address}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Changed in 5.0.0. Every entry of created-apps may now carry family-box-access and foreign-box-reads. Set only from consensus version v42 onwards. Mainnet upgrades to v42 at round 64318659, until then the field is never returned.

Given a specific account public key, this call returns the accounts status, balance and spendable amounts

Parameters

formatstringjsonmsgpackquery

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

addressstringrequiredpath

An account public key

excludestringallnonequery

When set to all will exclude asset holdings, application local state, created asset parameters, any created application parameters. Defaults to none.

Response

200OK

AccountResponse wraps the Account type in a response.

400Bad Request

Bad request

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

default

Unknown Error

Get account information.

curl -X GET 'https://algo.nownodes.io/v2/accounts/{address}'

const response = await fetch('https://algo.nownodes.io/v2/accounts/{address}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://algo.nownodes.io/v2/accounts/{address}')
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

response = requests.get('https://algo.nownodes.io/v2/accounts/{address}')
data = response.json()

const response = await fetch('https://algo.nownodes.io/v2/accounts/{address}', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://algo.nownodes.io/v2/accounts/{address}";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "GET",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({});
console.log(result);

const response = await fetch('https://algo.nownodes.io/v2/accounts/{address}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://algo.nownodes.io/v2/accounts/{address}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://algo.nownodes.io/v2/accounts/{address}')
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

{
  "address": "string",
  "amount": 0,
  "amount-without-pending-rewards": 0,
  "apps-local-state": [
    {
      "id": 0,
      "key-value": [
        {
          "key": "string",
          "value": {
            "bytes": "string",
            "type": 0,
            "uint": 0
          }
        }
      ],
      "schema": {
        "num-byte-slice": 0,
        "num-uint": 0
      }
    }
  ],
  "apps-total-extra-pages": 0,
  "apps-total-schema": {
    "num-byte-slice": 0,
    "num-uint": 0
  },
  "assets": [
    {
      "amount": 0,
      "asset-id": 0,
      "is-frozen": true
    }
  ],
  "auth-addr": "string",
  "created-apps": [
    {
      "id": 0,
      "params": {
        "approval-program": "dGVzdA==",
        "clear-state-program": "dGVzdA==",
        "creator": "string",
        "extra-program-pages": 0,
        "family-box-access": true,
        "foreign-box-reads": true,
        "global-state": [
          {
            "key": "string",
            "value": {
              "bytes": "string",
              "type": 0,
              "uint": 0
            }
          }
        ],
        "global-state-schema": {
          "num-byte-slice": 0,
          "num-uint": 0
        },
        "local-state-schema": {
          "num-byte-slice": 0,
          "num-uint": 0
        }
      }
    }
  ],
  "created-assets": [
    {
      "index": 0,
      "params": {
        "clawback": "string",
        "creator": "string",
        "decimals": 0,
        "default-frozen": true,
        "freeze": "string",
        "manager": "string",
        "metadata-hash": "dGVzdA==",
        "name": "string",
        "name-b64": "dGVzdA==",
        "reserve": "string",
        "total": 0,
        "unit-name": "string",
        "unit-name-b64": "dGVzdA==",
        "url": "string",
        "url-b64": "dGVzdA=="
      }
    }
  ],
  "min-balance": 0,
  "participation": {
    "selection-participation-key": "dGVzdA==",
    "state-proof-key": "dGVzdA==",
    "vote-first-valid": 0,
    "vote-key-dilution": 0,
    "vote-last-valid": 0,
    "vote-participation-key": "dGVzdA=="
  },
  "pending-rewards": 0,
  "reward-base": 0,
  "rewards": 0,
  "round": 0,
  "sig-type": "sig",
  "status": "string",
  "total-apps-opted-in": 0,
  "total-assets-opted-in": 0,
  "total-box-bytes": 0,
  "total-boxes": 0,
  "total-created-apps": 0,
  "total-created-assets": 0
}

{
  "address": "string",
  "amount": 0,
  "amount-without-pending-rewards": 0,
  "apps-local-state": [
    {
      "id": 0,
      "key-value": [
        {
          "key": "string",
          "value": {
            "bytes": "string",
            "type": 0,
            "uint": 0
          }
        }
      ],
      "schema": {
        "num-byte-slice": 0,
        "num-uint": 0
      }
    }
  ],
  "apps-total-extra-pages": 0,
  "apps-total-schema": {
    "num-byte-slice": 0,
    "num-uint": 0
  },
  "assets": [
    {
      "amount": 0,
      "asset-id": 0,
      "is-frozen": true
    }
  ],
  "auth-addr": "string",
  "created-apps": [
    {
      "id": 0,
      "params": {
        "approval-program": "dGVzdA==",
        "clear-state-program": "dGVzdA==",
        "creator": "string",
        "extra-program-pages": 0,
        "family-box-access": true,
        "foreign-box-reads": true,
        "global-state": [
          {
            "key": "string",
            "value": {
              "bytes": "string",
              "type": 0,
              "uint": 0
            }
          }
        ],
        "global-state-schema": {
          "num-byte-slice": 0,
          "num-uint": 0
        },
        "local-state-schema": {
          "num-byte-slice": 0,
          "num-uint": 0
        }
      }
    }
  ],
  "created-assets": [
    {
      "index": 0,
      "params": {
        "clawback": "string",
        "creator": "string",
        "decimals": 0,
        "default-frozen": true,
        "freeze": "string",
        "manager": "string",
        "metadata-hash": "dGVzdA==",
        "name": "string",
        "name-b64": "dGVzdA==",
        "reserve": "string",
        "total": 0,
        "unit-name": "string",
        "unit-name-b64": "dGVzdA==",
        "url": "string",
        "url-b64": "dGVzdA=="
      }
    }
  ],
  "min-balance": 0,
  "participation": {
    "selection-participation-key": "dGVzdA==",
    "state-proof-key": "dGVzdA==",
    "vote-first-valid": 0,
    "vote-key-dilution": 0,
    "vote-last-valid": 0,
    "vote-participation-key": "dGVzdA=="
  },
  "pending-rewards": 0,
  "reward-base": 0,
  "rewards": 0,
  "round": 0,
  "sig-type": "sig",
  "status": "string",
  "total-apps-opted-in": 0,
  "total-assets-opted-in": 0,
  "total-box-bytes": 0,
  "total-boxes": 0,
  "total-created-apps": 0,
  "total-created-assets": 0
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

Get account information about a given app.

GET

https://algo.nownodes.io/v2/accounts/{address}/applications/{application-id}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Changed in 5.0.0. created-app may now carry family-box-access and foreign-box-reads. Set only from consensus version v42 onwards. Mainnet upgrades to v42 at round 64318659, until then the field is never returned.

Given a specific account public key and application ID, this call returns the account's application local state and global state (AppLocalState and AppParams, if either exists). Global state will only be returned if the provided address is the application's creator.

Parameters

formatstringjsonmsgpackquery

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

addressstringrequiredpath

An account public key

application-idintegerrequiredpath

An application identifier

Response

200OK

AccountApplicationResponse describes the account's application local state and global state (AppLocalState and AppParams, if either exists) for a specific application ID. Global state will only be returned if the provided address is the application's creator.

400Bad Request

Malformed address or application ID

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

default

Unknown Error

Get account information about a given app.

curl -X GET 'https://algo.nownodes.io/v2/accounts/{address}/applications/{application-id}'

const response = await fetch('https://algo.nownodes.io/v2/accounts/{address}/applications/{application-id}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://algo.nownodes.io/v2/accounts/{address}/applications/{application-id}')
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

response = requests.get('https://algo.nownodes.io/v2/accounts/{address}/applications/{application-id}')
data = response.json()

const response = await fetch('https://algo.nownodes.io/v2/accounts/{address}/applications/{application-id}', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://algo.nownodes.io/v2/accounts/{address}/applications/{application-id}";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "GET",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({});
console.log(result);

const response = await fetch('https://algo.nownodes.io/v2/accounts/{address}/applications/{application-id}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://algo.nownodes.io/v2/accounts/{address}/applications/{application-id}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://algo.nownodes.io/v2/accounts/{address}/applications/{application-id}')
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

{
  "app-local-state": {
    "id": 0,
    "key-value": [
      {
        "key": "string",
        "value": {
          "bytes": "string",
          "type": 0,
          "uint": 0
        }
      }
    ],
    "schema": {
      "num-byte-slice": 0,
      "num-uint": 0
    }
  },
  "created-app": {
    "approval-program": "dGVzdA==",
    "clear-state-program": "dGVzdA==",
    "creator": "string",
    "extra-program-pages": 0,
    "family-box-access": true,
    "foreign-box-reads": true,
    "global-state": [
      {
        "key": "string",
        "value": {
          "bytes": "string",
          "type": 0,
          "uint": 0
        }
      }
    ],
    "global-state-schema": {
      "num-byte-slice": 0,
      "num-uint": 0
    },
    "local-state-schema": {
      "num-byte-slice": 0,
      "num-uint": 0
    }
  },
  "round": 0
}

{
  "app-local-state": {
    "id": 0,
    "key-value": [
      {
        "key": "string",
        "value": {
          "bytes": "string",
          "type": 0,
          "uint": 0
        }
      }
    ],
    "schema": {
      "num-byte-slice": 0,
      "num-uint": 0
    }
  },
  "created-app": {
    "approval-program": "dGVzdA==",
    "clear-state-program": "dGVzdA==",
    "creator": "string",
    "extra-program-pages": 0,
    "family-box-access": true,
    "foreign-box-reads": true,
    "global-state": [
      {
        "key": "string",
        "value": {
          "bytes": "string",
          "type": 0,
          "uint": 0
        }
      }
    ],
    "global-state-schema": {
      "num-byte-slice": 0,
      "num-uint": 0
    },
    "local-state-schema": {
      "num-byte-slice": 0,
      "num-uint": 0
    }
  },
  "round": 0
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

Applications

Get application information.

GET

https://algo.nownodes.io/v2/applications/{application-id}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Changed in 5.0.0. params may now carry family-box-access and foreign-box-reads. Set only from consensus version v42 onwards. Mainnet upgrades to v42 at round 64318659, until then the field is never returned.

Given a application ID, it returns application information including creator, approval and clear programs, global and local schemas, and global state.

Parameters

application-idintegerrequiredpath

An application identifier

Response

200OK

Application information

400Bad Request

Bad Request

401Unauthorized

Invalid API Token

404Not Found

Application Not Found

500Internal Server Error

Internal Error

default

Unknown Error

Get application information.

curl -X GET 'https://algo.nownodes.io/v2/applications/{application-id}'

const response = await fetch('https://algo.nownodes.io/v2/applications/{application-id}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://algo.nownodes.io/v2/applications/{application-id}')
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

response = requests.get('https://algo.nownodes.io/v2/applications/{application-id}')
data = response.json()

const response = await fetch('https://algo.nownodes.io/v2/applications/{application-id}', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://algo.nownodes.io/v2/applications/{application-id}";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "GET",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({});
console.log(result);

const response = await fetch('https://algo.nownodes.io/v2/applications/{application-id}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://algo.nownodes.io/v2/applications/{application-id}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://algo.nownodes.io/v2/applications/{application-id}')
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

{
  "id": 0,
  "params": {
    "approval-program": "dGVzdA==",
    "clear-state-program": "dGVzdA==",
    "creator": "string",
    "extra-program-pages": 0,
    "family-box-access": true,
    "foreign-box-reads": true,
    "global-state": [
      {
        "key": "string",
        "value": {
          "bytes": "string",
          "type": 0,
          "uint": 0
        }
      }
    ],
    "global-state-schema": {
      "num-byte-slice": 0,
      "num-uint": 0
    },
    "local-state-schema": {
      "num-byte-slice": 0,
      "num-uint": 0
    }
  }
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

Transactions

Broadcasts a raw transaction or transaction group to the network.

POST

https://algo.nownodes.io/v2/transactions

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Changed in 5.0.0. New optional query parameter skip-pq-address-check.

Body

application/x-binary

The byte encoded signed transaction to broadcast to network

string<binary>

Parameters

skip-pq-address-checkbooleanquery

Skip post-quantum address checks, including the check that rejects PQ authorizer and LogicSig escrow (TEAL v13 or later) whose address is an Edwards25519 curve point. This should only be used if you understand the risks and know what you are doing. Added in 5.0.0. Accepts true or false; any other value is rejected with 400.

Response

200OK

Transaction ID of the submission.

400Bad Request

Bad Request - Malformed Algorand transaction

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Broadcasts a raw transaction or transaction group to the network.

curl -X POST 'https://algo.nownodes.io/v2/transactions' \
  -H 'Content-Type: application/x-binary' \
  -d '"<binary>"'

const response = await fetch('https://algo.nownodes.io/v2/transactions', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/x-binary',
  },
  body: JSON.stringify("<binary>"),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://algo.nownodes.io/v2/transactions')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/x-binary'
request.body = '"<binary>"'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

payload = "<binary>"

response = requests.post('https://algo.nownodes.io/v2/transactions', json=payload)
data = response.json()

const response = await fetch('https://algo.nownodes.io/v2/transactions', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/x-binary',
  },
  body: JSON.stringify("<binary>"),
});

const data = await response.json();

const endpoint = "https://algo.nownodes.io/v2/transactions";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "POST",
    headers: {
      "Content-Type": "application/x-binary",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest("<binary>");
console.log(result);

const response = await fetch('https://algo.nownodes.io/v2/transactions', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/x-binary',
  },
  body: JSON.stringify("<binary>"),
});

const data = await response.json();

import requests

payload = "<binary>"

response = requests.post('https://algo.nownodes.io/v2/transactions', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://algo.nownodes.io/v2/transactions')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/x-binary'
request.body = '"<binary>"'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

Request Body

"<binary>"

{
  "txId": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

Fast track for broadcasting a raw transaction or transaction group to the network through the tx handler without performing most of the checks and reporting detailed errors. Should be only used for development and performance testing.

POST

https://algo.nownodes.io/v2/transactions/async

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Changed in 5.0.0. New optional query parameter skip-pq-address-check.

Body

application/x-binary

The byte encoded signed transaction to broadcast to network

string<binary>

Parameters

skip-pq-address-checkbooleanquery

Response

200OK

Valid response

400Bad Request

Bad Request - Malformed Algorand transaction

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Fast track for broadcasting a raw transaction or transaction group to the network through the tx handler without performing most of the checks and reporting detailed errors. Should be only used for development and performance testing.

curl -X POST 'https://algo.nownodes.io/v2/transactions/async' \
  -H 'Content-Type: application/x-binary' \
  -d '"<binary>"'

const response = await fetch('https://algo.nownodes.io/v2/transactions/async', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/x-binary',
  },
  body: JSON.stringify("<binary>"),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://algo.nownodes.io/v2/transactions/async')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/x-binary'
request.body = '"<binary>"'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

payload = "<binary>"

response = requests.post('https://algo.nownodes.io/v2/transactions/async', json=payload)
data = response.json()

const response = await fetch('https://algo.nownodes.io/v2/transactions/async', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/x-binary',
  },
  body: JSON.stringify("<binary>"),
});

const data = await response.json();

const endpoint = "https://algo.nownodes.io/v2/transactions/async";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "POST",
    headers: {
      "Content-Type": "application/x-binary",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest("<binary>");
console.log(result);

const response = await fetch('https://algo.nownodes.io/v2/transactions/async', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/x-binary',
  },
  body: JSON.stringify("<binary>"),
});

const data = await response.json();

import requests

payload = "<binary>"

response = requests.post('https://algo.nownodes.io/v2/transactions/async', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://algo.nownodes.io/v2/transactions/async')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/x-binary'
request.body = '"<binary>"'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

Request Body

"<binary>"

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

Simulates a raw transaction or transaction group as it would be evaluated on the network. The simulation will use blockchain state from the latest committed round.

POST

https://algo.nownodes.io/v2/transactions/simulate

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Changed in 5.0.0. The response carries three new fields: group-usage and group-fees-paid for every transaction group, and fees-paid for every transaction in it.

Body

application/json

The transactions to simulate, along with any other inputs.

application/jsonSimulateRequest

Request type for simulation endpoint.

allow-empty-signaturesboolean

Allows transactions without signatures to be simulated as if they had correct signatures.

allow-more-loggingboolean

Lifts limits on log opcode usage during simulation.

allow-unnamed-resourcesboolean

Allows access to unnamed resources during simulation.

exec-trace-configSimulateTraceConfig

An object that configures simulation execution trace.

Show child attributes

enableboolean

A boolean option for opting in execution trace features simulation endpoint.

scratch-changeboolean

A boolean option enabling returning scratch slot changes together with execution trace during simulation.

stack-changeboolean

A boolean option enabling returning stack changes together with execution trace during simulation.

state-changeboolean

A boolean option enabling returning application state changes (global, local, and box changes) with the execution trace during simulation.

extra-opcode-budgetinteger

Applies extra opcode budget during simulation for each transaction group.

roundinteger

If provided, specifies the round preceding the simulation. State changes through this round will be used to run this simulation. Usually only the 4 most recent rounds will be available (controlled by the node config value MaxAcctLookback). If not specified, defaults to the latest available round.

txn-groupsArray<SimulateRequestTransactionGroup>required

The transaction groups to simulate.

Show child attributes

txnsArray<string>required

An atomic transaction group.

application/msgpackSimulateRequest

Request type for simulation endpoint.

allow-empty-signaturesboolean

Allows transactions without signatures to be simulated as if they had correct signatures.

allow-more-loggingboolean

Lifts limits on log opcode usage during simulation.

allow-unnamed-resourcesboolean

Allows access to unnamed resources during simulation.

exec-trace-configSimulateTraceConfig

An object that configures simulation execution trace.

Show child attributes

enableboolean

A boolean option for opting in execution trace features simulation endpoint.

scratch-changeboolean

A boolean option enabling returning scratch slot changes together with execution trace during simulation.

stack-changeboolean

A boolean option enabling returning stack changes together with execution trace during simulation.

state-changeboolean

A boolean option enabling returning application state changes (global, local, and box changes) with the execution trace during simulation.

extra-opcode-budgetinteger

Applies extra opcode budget during simulation for each transaction group.

roundinteger

txn-groupsArray<SimulateRequestTransactionGroup>required

The transaction groups to simulate.

Show child attributes

txnsArray<string>required

An atomic transaction group.

Parameters

formatstringjsonmsgpackquery

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Response

200OK

Result of a transaction group simulation.

400Bad Request

Bad Request

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Simulates a raw transaction or transaction group as it would be evaluated on the network. The simulation will use blockchain state from the latest committed round.

curl -X POST 'https://algo.nownodes.io/v2/transactions/simulate' \
  -H 'Content-Type: application/json' \
  -d '{
    "allow-empty-signatures": true,
    "allow-more-logging": true,
    "allow-unnamed-resources": true,
    "exec-trace-config": {
      "enable": true,
      "scratch-change": true,
      "stack-change": true,
      "state-change": true
    },
    "extra-opcode-budget": 0,
    "round": 0,
    "txn-groups": [
      {
        "txns": [
          "string"
        ]
      }
    ]
  }'

const response = await fetch('https://algo.nownodes.io/v2/transactions/simulate', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "allow-empty-signatures": true,
      "allow-more-logging": true,
      "allow-unnamed-resources": true,
      "exec-trace-config": {
        "enable": true,
        "scratch-change": true,
        "stack-change": true,
        "state-change": true
      },
      "extra-opcode-budget": 0,
      "round": 0,
      "txn-groups": [
        {
          "txns": [
            "string"
          ]
        }
      ]
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://algo.nownodes.io/v2/transactions/simulate')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "allow-empty-signatures": true,
    "allow-more-logging": true,
    "allow-unnamed-resources": true,
    "exec-trace-config": {
      "enable": true,
      "scratch-change": true,
      "stack-change": true,
      "state-change": true
    },
    "extra-opcode-budget": 0,
    "round": 0,
    "txn-groups": [
      {
        "txns": [
          "string"
        ]
      }
    ]
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

payload = {
  "allow-empty-signatures": True,
  "allow-more-logging": True,
  "allow-unnamed-resources": True,
  "exec-trace-config": {
    "enable": True,
    "scratch-change": True,
    "stack-change": True,
    "state-change": True
  },
  "extra-opcode-budget": 0,
  "round": 0,
  "txn-groups": [
    {
      "txns": [
        "string"
      ]
    }
  ]
}

response = requests.post('https://algo.nownodes.io/v2/transactions/simulate', json=payload)
data = response.json()

const response = await fetch('https://algo.nownodes.io/v2/transactions/simulate', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "allow-empty-signatures": true,
      "allow-more-logging": true,
      "allow-unnamed-resources": true,
      "exec-trace-config": {
        "enable": true,
        "scratch-change": true,
        "stack-change": true,
        "state-change": true
      },
      "extra-opcode-budget": 0,
      "round": 0,
      "txn-groups": [
        {
          "txns": [
            "string"
          ]
        }
      ]
    }),
});

const data = await response.json();

const endpoint = "https://algo.nownodes.io/v2/transactions/simulate";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({
    "allow-empty-signatures": true,
    "allow-more-logging": true,
    "allow-unnamed-resources": true,
    "exec-trace-config": {
      "enable": true,
      "scratch-change": true,
      "stack-change": true,
      "state-change": true
    },
    "extra-opcode-budget": 0,
    "round": 0,
    "txn-groups": [
      {
        "txns": [
          "string"
        ]
      }
    ]
  });
console.log(result);

const response = await fetch('https://algo.nownodes.io/v2/transactions/simulate', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "allow-empty-signatures": true,
      "allow-more-logging": true,
      "allow-unnamed-resources": true,
      "exec-trace-config": {
        "enable": true,
        "scratch-change": true,
        "stack-change": true,
        "state-change": true
      },
      "extra-opcode-budget": 0,
      "round": 0,
      "txn-groups": [
        {
          "txns": [
            "string"
          ]
        }
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "allow-empty-signatures": True,
  "allow-more-logging": True,
  "allow-unnamed-resources": True,
  "exec-trace-config": {
    "enable": True,
    "scratch-change": True,
    "stack-change": True,
    "state-change": True
  },
  "extra-opcode-budget": 0,
  "round": 0,
  "txn-groups": [
    {
      "txns": [
        "string"
      ]
    }
  ]
}

response = requests.post('https://algo.nownodes.io/v2/transactions/simulate', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://algo.nownodes.io/v2/transactions/simulate')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "allow-empty-signatures": true,
    "allow-more-logging": true,
    "allow-unnamed-resources": true,
    "exec-trace-config": {
      "enable": true,
      "scratch-change": true,
      "stack-change": true,
      "state-change": true
    },
    "extra-opcode-budget": 0,
    "round": 0,
    "txn-groups": [
      {
        "txns": [
          "string"
        ]
      }
    ]
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

Request Body

{
  "allow-empty-signatures": true,
  "allow-more-logging": true,
  "allow-unnamed-resources": true,
  "exec-trace-config": {
    "enable": true,
    "scratch-change": true,
    "stack-change": true,
    "state-change": true
  },
  "extra-opcode-budget": 0,
  "round": 0,
  "txn-groups": [
    {
      "txns": [
        "string"
      ]
    }
  ]
}

{
  "allow-empty-signatures": true,
  "allow-more-logging": true,
  "allow-unnamed-resources": true,
  "exec-trace-config": {
    "enable": true,
    "scratch-change": true,
    "stack-change": true,
    "state-change": true
  },
  "extra-opcode-budget": 0,
  "round": 0,
  "txn-groups": [
    {
      "txns": [
        "string"
      ]
    }
  ]
}

{
  "eval-overrides": {
    "allow-empty-signatures": true,
    "allow-unnamed-resources": true,
    "extra-opcode-budget": 0,
    "max-log-calls": 0,
    "max-log-size": 0
  },
  "exec-trace-config": {
    "enable": true,
    "scratch-change": true,
    "stack-change": true,
    "state-change": true
  },
  "initial-states": {
    "app-initial-states": [
      {
        "app-boxes": {
          "account": "string",
          "kvs": [
            {
              "key": "dGVzdA==",
              "value": {
                "bytes": "dGVzdA==",
                "type": 0,
                "uint": 0
              }
            }
          ]
        },
        "app-globals": {
          "account": "string",
          "kvs": [
            {
              "key": "dGVzdA==",
              "value": {
                "bytes": "dGVzdA==",
                "type": 0,
                "uint": 0
              }
            }
          ]
        },
        "app-locals": [
          {
            "account": "string",
            "kvs": [
              {
                "key": "dGVzdA==",
                "value": {
                  "bytes": "dGVzdA==",
                  "type": 0,
                  "uint": 0
                }
              }
            ]
          }
        ],
        "id": 0
      }
    ]
  },
  "last-round": 0,
  "txn-groups": [],
  "version": 0
}

{
  "eval-overrides": {
    "allow-empty-signatures": true,
    "allow-unnamed-resources": true,
    "extra-opcode-budget": 0,
    "max-log-calls": 0,
    "max-log-size": 0
  },
  "exec-trace-config": {
    "enable": true,
    "scratch-change": true,
    "stack-change": true,
    "state-change": true
  },
  "initial-states": {
    "app-initial-states": [
      {
        "app-boxes": {
          "account": "string",
          "kvs": [
            {
              "key": "dGVzdA==",
              "value": {
                "bytes": "dGVzdA==",
                "type": 0,
                "uint": 0
              }
            }
          ]
        },
        "app-globals": {
          "account": "string",
          "kvs": [
            {
              "key": "dGVzdA==",
              "value": {
                "bytes": "dGVzdA==",
                "type": 0,
                "uint": 0
              }
            }
          ]
        },
        "app-locals": [
          {
            "account": "string",
            "kvs": [
              {
                "key": "dGVzdA==",
                "value": {
                  "bytes": "dGVzdA==",
                  "type": 0,
                  "uint": 0
                }
              }
            ]
          }
        ],
        "id": 0
      }
    ]
  },
  "last-round": 0,
  "txn-groups": [],
  "version": 0
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

{
  "data": {},
  "message": "string"
}

Documentation

How to migrate to NOWNodes

Algod REST API. 4.7.4 to 5.0.0 API CHANGES

Removed

Changed

About consensus version v42

Authentication

Changelog algod 4.7.4 to 5.0.0

Accounts

Get account information.

Authorizations

Parameters

Response

Get account information about a given app.

Authorizations

Parameters

Response

Applications

Get application information.

Authorizations

Parameters

Response

Transactions

Broadcasts a raw transaction or transaction group to the network.

Authorizations

Body

Parameters

Response

Fast track for broadcasting a raw transaction or transaction group to the network through the tx handler without performing most of the checks and reporting detailed errors. Should be only used for development and performance testing.

Authorizations

Body

Parameters

Response

Simulates a raw transaction or transaction group as it would be evaluated on the network. The simulation will use blockchain state from the latest committed round.

Authorizations

Body

Parameters

Response