Find an output by its identifier.

GET 
/api/v1/outputs/:outputId

Find an output by its identifier.

Request

Path Parameters

outputId stringrequired

Identifier of the output encoded in hex. An output is identified by the concatenation of transaction_id+output_index.

Responses

200

Successful operation.

application/json

Schema

Schema

data objectrequired

messageId stringrequired

The message identifier that references the output.

transactionId stringrequired

The identifier of the transaction.

outputIndex integerrequired

The index of the output.

isSpent booleanrequired

Tells if the output is spent or not.

milestoneIndexSpent integer

The milestone index at which this output was spent.

transactionIdSpent string

The transaction this output was spent with.

output objectrequired

anyOf

SigLockedSingleOutput

type integerrequired

Set to value 0 to denote a SigLockedSingleOutput.

address objectrequired

anyOf

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.

amount integerrequired

The amount of tokens to deposit with this SigLockedSingleOutput output.

SigLockedDustAllowanceOutput

type integerrequired

Set to value 1 to denote a SigLockedDustAllowanceOutput.

address objectrequired

anyOf

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.

amount integerrequired

The amount of tokens to deposit with this SigLockedDustAllowanceOutput output.

ledgerIndex integerrequired

The current ledger index for which the request was made.

Example (from schema)

{
  "data": {
    "messageId": "string",
    "transactionId": "string",
    "outputIndex": 0,
    "isSpent": true,
    "milestoneIndexSpent": 0,
    "transactionIdSpent": "string",
    "ledgerIndex": 0
  }
}

unspent

{
  "data": {
    "messageId": "9cd745ef6800c8e8c80b09174ee4b250b3c43dfa62d7c6a4e61f848febf731a0",
    "transactionId": "1ee46e19f4219ee65afc10227d0ca22753f76ef32d1e922e5cbe3fbc9b5a5298",
    "outputIndex": 1,
    "isSpent": false,
    "output": {
      "type": 0,
      "address": {
        "type": 0,
        "address": "8eaf87ac1f52eb05f2c7c0c15502df990a228838dc37bd18de9503d69afd257d"
      },
      "amount": 1000
    },
    "ledgerIndex": 946704
  }
}

spent

{
  "data": {
    "messageId": "9cd745ef6800c8e8c80b09174ee4b250b3c43dfa62d7c6a4e61f848febf731a0",
    "transactionId": "1ee46e19f4219ee65afc10227d0ca22753f76ef32d1e922e5cbe3fbc9b5a5298",
    "outputIndex": 1,
    "isSpent": true,
    "milestoneIndexSpent": 946700,
    "transactionIdSpent": "af7579fb57746219561072c2cc0e4d0fbb8d493d075bd21bf25ae81a450c11ef",
    "output": {
      "type": 0,
      "address": {
        "type": 0,
        "address": "8eaf87ac1f52eb05f2c7c0c15502df990a228838dc37bd18de9503d69afd257d"
      },
      "amount": 1000
    },
    "ledgerIndex": 946704
  }
}

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"
  }
}

404

Unsuccessful operation: indicates that the requested data was not found.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 404,
    "message": "could not find data"
  }
}

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"
  }
}

Loading...