Returns all stored receipts.

GET 
/api/v1/receipts

Returns all stored receipts.

Request

Responses

200

Successful operation.

application/json

Schema

Schema

data objectrequired
receipts ReceiptTuple[]required
Array [
receipt ReceiptPayloadrequired
Contains a receipt and the index of the milestone which contained the receipt.
migratedAt integerrequired
final booleanrequired
funds MigratedFundsEntry[]required
Array [
tailTransactionHash stringrequired
address objectrequired
oneOf
Ed25519Address
type integerrequired
Set to value 0 to denote an Ed25519 Address.
address stringrequired
The hex-encoded BLAKE2b-256 hash of the Ed25519 public key.
deposit integerrequired
]
transaction TreasuryTransactionPayloadrequired
type integerrequired
Set to value 4 to denote a Treasury Payload.
input TreasuryInput
type integerrequired
Set to value 1 to denote a TreasuryInput.
milestoneId stringrequired
output TreasuryOutput
type integerrequired
Set to value 2 to denote a TreasuryOutput.
amount integerrequired
milestoneIndex integerrequired
]

Example (from schema)

{
  "data": {
    "receipts": [
      {
        "receipt": {
          "migratedAt": 0,
          "final": true,
          "funds": [
            {
              "tailTransactionHash": "string",
              "deposit": 0
            }
          ],
          "transaction": {
            "type": 0,
            "input": {
              "type": 0,
              "milestoneId": "string"
            },
            "output": {
              "type": 0,
              "amount": 0
            }
          }
        },
        "milestoneIndex": 0
      }
    ]
  }
}

default

{
  "data": {
    "receipts": [
      {
        "migratedAt": 1000,
        "final": false,
        "funds": [
          {
            "tailTransactionHash": "e0ce1933a900d02e0a43e2ba4e922d1a706a36a117ce1eb9ad0a74d39ee722c41b00cd227232efd76f5997e91bf8000000",
            "address": {
              "type": 0,
              "address": "5eec99d6ee4ba21aa536c3364bbf2b587cb98a7f2565b75d948b10083e2143f8"
            },
            "deposit": 1702000000
          }
        ],
        "transaction": {
          "input": {
            "type": 1,
            "milestoneId": "733ed2810f2333e9d6cd702c7d5c8264cd9f1ae454b61e75cf702c451f68611d"
          },
          "output": {
            "type": 2,
            "amount": 1702000000
          }
        }
      }
    ]
  }
}

400

Unsuccessful operation: indicates that the provided data is invalid.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 400,
    "message": "invalid data provided"
  }
}

403

Unsuccessful operation: indicates that the endpoint is not available for public use.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 403,
    "message": "not available for public use"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

503

Unsuccessful operation: indicates that the node is not synced.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 503,
    "message": "service unavailable"
  }
}

Loading...