Status

Get linked record status

Get the current state of a linked record that was written to the blockchain. It takes a few minutes before any transaction is confirmed to be on the blockchain.

GET{your-URL}/api/v1/linkedrecords/{txId}/status

Path parameters

txId*string

The transaction id of the linked record to query. Using a value other than one returned by the LinkedRecords methods produces undefined behavior.

Header parameters

Response

200400404500

The transaction has been published. The response is an application/json structure containing:

• confirmation: set if transaction has been included in a valid block
  • confirmedBlocks: Number of confirmations (blocks) at the time of request
  • blockHash: block hash if transaction has been included in a block
  • blockTimestamp: block header timestamp (field is set on best-effort basis)
  • merkleProof: A JSON object as defined in TSC Merkle Proof (https://tsc.bsvblockchain.org/standards/merkle-proof-standardised-format/#JSONform)
• updatable: true if published and linked record can be updated

Body

text/plainapplication/jsontext/json

confirmationConfirmation (object)

updatableboolean

Request

JavaScriptCurlPython

const response = await fetch('{your-URL}/api/v1/linkedrecords/{txId}/status', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200400404500

{
  "confirmation": {
    "confirmedBlocks": 0,
    "blockHash": "text",
    "blockTimestamp": "2024-12-03T17:16:39.327Z",
    "merkleProof": {
      "index": 0,
      "txOrId": "text",
      "target": "text",
      "nodes": [
        "text"
      ],
      "targetType": "text",
      "proofType": "text",
      "composite": false
    }
  },
  "updatable": false
}