Returns metadata about an output by its identifier.

GET 
http://127.0.0.1:14265/api/core/v3/outputs/:outputId/metadata

Returns metadata about 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 transactionId+outputIndex where outputIndex (u16) needs to be converted to little endian first. Hex-encoded with 0x prefix.
Example: 0xfa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a20100

Responses

200

Successful operation.

application/json

Schema

Schema

outputId stringrequired

The output identifier of requested output. Hex-encoded with 0x prefix.

blockId stringrequired

The block identifier that references the output. Hex-encoded with 0x prefix.

included required

slot integerrequired

The slot index in which the output is included.

transactionId stringrequired

The identifier of the transaction. Hex-encoded with 0x prefix.

commitmentId string

The commitment ID at which the output was included into the ledger.

spent

slot integerrequired

The slot index in which the output is spent.

transactionId stringrequired

The transaction ID that spent the output. Hex-encoded with 0x prefix.

commitmentId string

The commitment ID that includes the spending of the output.

latestCommitmentId stringrequired

The current latest commitment id for which the request was made.

Example (from schema)

{
  "outputId": "string",
  "blockId": "string",
  "included": {
    "slot": 0,
    "transactionId": "string",
    "commitmentId": "string"
  },
  "spent": {
    "slot": 0,
    "transactionId": "string",
    "commitmentId": "string"
  },
  "latestCommitmentId": "string"
}

unspent

{
  "outputId": "0x3477de28a45c565eed3603ab9e90ce0f0d38e8860a3c5ff64ccc70252aab7c9d000000004600",
  "blockId": "0x1aaaa9ad9c15c6cd601a5aa5bd61b85428263978a26343949dad9ff89635e7104f1f271b",
  "included": {
    "slot": 5,
    "transactionId": "0xfdd9e96bac5e4f029b3261c00cd3c74fb4c389184a2018c979d4f31fc1ef53c99add5c74",
    "commitmentId": "0xd20959ac38938fddee472bbfd47644da3087a39499cd04e86c9c70fa9c8c0516a81b8aea"
  },
  "latestCommitmentId": "0xba4456279dce23cfca37938685c039ea7c72001c1cd8becf72b195a8727cdfd07949d697"
}

spent

{
  "outputId": "0x3130f21c723fa597805763739f3a2a40b674af6b4071ef0494331b644a7e4d52000000001300",
  "blockId": "0x19e589687082d8f535779df3244908ad6a7b380906fb7ae24efb5fad8a5cfb92a8f8d9a3",
  "included": {
    "slot": 5,
    "transactionId": "0x3e766157614a3a0e13dbb937b5fb1ef5d1555479c19df80445d03a6710f39d75668bd326",
    "commitmentId": "0x7387ebe23a3ac1732fcdb6cef77fc003e1fa6e2dad89dd664df249d6aa2dbdc157dec2c6"
  },
  "spent": {
    "slot": 8,
    "transactionId": "0x3896f1ede7cbdacbbb4b17f13e953ad45ce0969ea34cc766b5dafe2a15b3e46f998ef4e5",
    "commitmentId": "0x26fa9fcbddcf944ced3fd16a73d9c8b2b49dc54dba7629b02da69f7e01249063e7398b2c"
  },
  "latestCommitmentId": "0x42a88617c2c4ba2b58f82c8b85524720cdbe3642401e7c613f215658d617c569d1219909"
}

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'http://127.0.0.1:14265/api/core/v3/outputs/:outputId/metadata' \
-H 'Accept: application/json'

Request Collapse all

Base URL

http://127.0.0.1:14265

Parameters

outputId — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!