algod REST Paths

Methods

 

Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "amount" : 0,
  "address" : "address",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

AccountInformationResponse contains an account information Account

400

Bad Request String

401

Invalid API Token

500

Internal Error String

default

Unknown Error

 

Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "txnRoot" : "txnRoot",
  "period" : 5,
  "previousBlockHash" : "previousBlockHash",
  "seed" : "seed",
  "proposer" : "proposer",
  "nextProtocolVoteBefore" : 1,
  "nextProtocol" : "nextProtocol",
  "upgradeApprove" : true,
  "currentProtocol" : "currentProtocol",
  "balRoot" : "balRoot",
  "upgradePropose" : "upgradePropose",
  "round" : 5,
  "nextProtocolSwitchOn" : 6,
  "nextProtocolApprovals" : 0,
  "hash" : "hash",
  "timestamp" : 2,
  "txns" : {
    "transactions" : [ {
      "round" : 2,
      "tx" : "tx",
      "fee" : 0,
      "first-round" : 6,
      "noteb64" : [ 5, 5 ],
      "from" : "from",
      "payment" : {
        "amount" : 5,
        "to" : "to"
      },
      "type" : { },
      "last-round" : 1
    }, {
      "round" : 2,
      "tx" : "tx",
      "fee" : 0,
      "first-round" : 6,
      "noteb64" : [ 5, 5 ],
      "from" : "from",
      "payment" : {
        "amount" : 5,
        "to" : "to"
      },
      "type" : { },
      "last-round" : 1
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

BlockResponse contains block information Block

400

Bad Request String

401

Invalid API Token

500

Internal Error String

default

Unknown Error

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

Return type

Example data

Content-Type: application/json
{
  "totalTxns" : 0,
  "truncatedTxns" : {
    "transactions" : [ {
      "round" : 2,
      "tx" : "tx",
      "fee" : 0,
      "first-round" : 6,
      "noteb64" : [ 5, 5 ],
      "from" : "from",
      "payment" : {
        "amount" : 5,
        "to" : "to"
      },
      "type" : { },
      "last-round" : 1
    }, {
      "round" : 2,
      "tx" : "tx",
      "fee" : 0,
      "first-round" : 6,
      "noteb64" : [ 5, 5 ],
      "from" : "from",
      "payment" : {
        "amount" : 5,
        "to" : "to"
      },
      "type" : { },
      "last-round" : 1
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

PendingTransactionsResponse contains a (potentially truncated) list of transactions and the total number of transactions currently in the pool. PendingTransactions

401

Invalid API Token

500

Internal Error String

default

Unknown Error

 

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "nextConsensusVersionRound" : 1,
  "nextConsensusVersionSupported" : true,
  "lastConsensusVersion" : "lastConsensusVersion",
  "timeSinceLastRound" : 5,
  "nextConsensusVersion" : "nextConsensusVersion",
  "catchupTime" : 0,
  "lastRound" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

StatusResponse contains the node's status information NodeStatus

401

Invalid API Token

500

Internal Error String

default

Unknown Error

 

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "round" : 6,
  "onlineMoney" : 0,
  "totalMoney" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SupplyResponse contains the ledger supply information Supply

401

Invalid API Token

default

Unknown Error

 

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "versions" : [ "versions", "versions" ],
  "genesis_id" : "genesis_id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

VersionsResponse is the response to GET /versions Version


 

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Return type

Example data

Content-Type: application/json
{
  "txId" : "txId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

TransactionIDResponse contains a transaction information transactionID

400

Bad Request String

401

Invalid API Token

500

Internal Error String

default

Unknown Error

 

Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

Return type

Example data

Content-Type: application/json
{
  "awardee" : "awardee",
  "rewards" : {
    "Raw" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

RewardResponse contains a list of rewards for a specific address RewardList

400

Bad Request String

401

Invalid API Token

default

Unknown Error

 

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "fee" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

TransactionFeeResponse contains a suggested fee TransactionFee

401

Invalid API Token

default

Unknown Error


Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "round" : 2,
  "tx" : "tx",
  "fee" : 0,
  "first-round" : 6,
  "noteb64" : [ 5, 5 ],
  "from" : "from",
  "payment" : {
    "amount" : 5,
    "to" : "to"
  },
  "type" : { },
  "last-round" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

TransactionResponse contains a transaction information Transaction

400

Bad Request String

401

Invalid API Token

404

Transaction Not Found String

default

Unknown Error

Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

Return type

Example data

Content-Type: application/json
{
  "transactions" : [ {
    "round" : 2,
    "tx" : "tx",
    "fee" : 0,
    "first-round" : 6,
    "noteb64" : [ 5, 5 ],
    "from" : "from",
    "payment" : {
      "amount" : 5,
      "to" : "to"
    },
    "type" : { },
    "last-round" : 1
  }, {
    "round" : 2,
    "tx" : "tx",
    "fee" : 0,
    "first-round" : 6,
    "noteb64" : [ 5, 5 ],
    "from" : "from",
    "payment" : {
      "amount" : 5,
      "to" : "to"
    },
    "type" : { },
    "last-round" : 1
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

TransactionsResponse contains a list of transactions TransactionList

400

Bad Request String

401

Invalid API Token

500

Internal Error String

default

Unknown Error

Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

Example data

Content-Type: application/json
{
  "nextConsensusVersionRound" : 1,
  "nextConsensusVersionSupported" : true,
  "lastConsensusVersion" : "lastConsensusVersion",
  "timeSinceLastRound" : 5,
  "nextConsensusVersion" : "nextConsensusVersion",
  "catchupTime" : 0,
  "lastRound" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

StatusResponse contains the node's status information NodeStatus

400

Bad Request String

401

Invalid API Token

500

Internal Error String

default

Unknown Error